V2NIMChatroomQueueService.java

浏览该文件的文档.

package com.netease.nimlib.sdk.v2.chatroom;

import com.netease.nimlib.sdk.v2.V2NIMFailureCallback;
import com.netease.nimlib.sdk.v2.V2NIMSuccessCallback;
import com.netease.nimlib.sdk.v2.chatroom.model.V2NIMChatroomQueueElement;
import com.netease.nimlib.sdk.v2.chatroom.params.V2NIMChatroomQueueOfferParams;
import java.util.List;

public interface V2NIMChatroomQueueService {

    /**
     * 聊天室队列新增或更新元素
     * @param offerParams 新增或更新元素参数
     * @param success 操作成功的回调
     * @param failure 操作失败的回调
     */
    void queueOffer(V2NIMChatroomQueueOfferParams offerParams, V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);
    /**
     * 取出头元素或者指定的元素
     * 仅管理员和创建者可以操作
     * @param elementKey
     *           如果为空表示取出头元素
     *           如果不为空， 取出指定的元素
     * @param success 操作成功的回调
     * @param failure 操作失败的回调
     */
    void queuePoll(String elementKey,V2NIMSuccessCallback<V2NIMChatroomQueueElement> success, V2NIMFailureCallback failure);

    /**
     * 排序列出所有元素
     * @param success 操作成功的回调
     * @param failure 操作失败的回调
     */
    void queueList(V2NIMSuccessCallback<List<V2NIMChatroomQueueElement>> success, V2NIMFailureCallback failure);

    /**
     * 查看队头元素， 不删除
     * @param success 操作成功的回调
     * @param failure 操作失败的回调
     */
    void queuePeek(V2NIMSuccessCallback<V2NIMChatroomQueueElement> success, V2NIMFailureCallback failure);

    /**
     * 清空队列
     * 仅管理员/创建者可以操作
     * @param success 操作成功的回调
     * @param failure 操作失败的回调
     */
    void queueDrop(V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);

    /**
     * 初始化队列
     * @param size 初始化队列的长度
     *             长度限制： 0~1000， 超过返回参数错误
     *             可以对现有队列做此操作，修改现有队列的长度上限；
     *             当前队列如果已经超过了新的限制，元素不会减少，但是新元素无法增加
     * @param success 操作成功的回调
     * @param failure 操作失败的回调
     */
    void queueInit(int size,V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);

    /**
     * 批量更新队列元素
     * @param elements 批量更新元素
     *                   size为空， size==0， size>100， 返回参数错误
     *                   key:长度限制：128字节
     *                   value：长度限制：4096字节
     * @param notificationEnabled 是否发送广播通知,317,默认为true
     * @param notificationExtension 本次操作生成的通知中的扩展字段，长度限制：2048字节
     * @param success 操作成功的回调，返回不存在的元素key列表
     * @param failure 操作失败的回调
     */
    void queueBatchUpdate(List<V2NIMChatroomQueueElement> elements,boolean notificationEnabled,String notificationExtension,V2NIMSuccessCallback<List<String>> success, V2NIMFailureCallback failure);

    /**
     * 添加聊天室队列监听器
     * @param listener 聊天室队列监听器
     */
    void addQueueListener(V2NIMChatroomQueueListener listener);

    /**
     * 移除聊天室队列监听器
     * @param listener 聊天室队列监听器
     */
    void removeQueueListener(V2NIMChatroomQueueListener listener);
}