V2NIMConversationGroupService.java

浏览该文件的文档.

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

import androidx.annotation.NonNull;
import com.netease.nimlib.sdk.v2.V2NIMFailureCallback;
import com.netease.nimlib.sdk.v2.V2NIMSuccessCallback;
import com.netease.nimlib.sdk.v2.conversation.model.V2NIMConversationGroup;
import com.netease.nimlib.sdk.v2.conversation.result.V2NIMConversationOperationResult;
import java.util.List;

/**
 * 会话分组协议
 */
public interface V2NIMConversationGroupService {

    /**
     * 创建会话分组
     *
     * @param name            分组名
     * @param conversationIds 会话id列表
     * @param serverExtension 服务器扩展字段
     * @param success         成功回调
     * @param failure         失败回调
     */
    void createConversationGroup(@NonNull String name, String serverExtension, List<String> conversationIds, V2NIMSuccessCallback<V2NIMConversationGroupResult> success,
            V2NIMFailureCallback failure);

    /**
     * 删除会话分组
     *
     * @param groupId 分组id
     * @param success 成功回调
     * @param failure 失败回调
     */
    void deleteConversationGroup(@NonNull String groupId, V2NIMSuccessCallback<Void> success, V2NIMFailureCallback failure);

    /**
     * 更新会话分组
     *
     * @param groupId         分组id
     * @param name            分组名
     * @param serverExtension 服务器扩展字段
     * @param success         成功回调
     * @param failure         失败回调
     */
    void updateConversationGroup(@NonNull String groupId, String name, String serverExtension, V2NIMSuccessCallback<Void> success,
            V2NIMFailureCallback failure);

    /**
     * 添加会话到分组
     *
     * @param groupId         分组id
     * @param conversationIds 会话id列表
     * @param success         成功回调
     * @param failure         失败回调
     */
    void addConversationsToGroup(@NonNull String groupId, @NonNull List<String> conversationIds, V2NIMSuccessCallback<List<V2NIMConversationOperationResult>> success,
            V2NIMFailureCallback failure);

    /**
     * 从会话分组移除会话
     *
     * @param groupId         分组id
     * @param conversationIds 会话id列表
     * @param success         成功回调
     * @param failure         失败回调
     */
    void removeConversationsFromGroup(@NonNull String groupId, @NonNull List<String> conversationIds, V2NIMSuccessCallback<List<V2NIMConversationOperationResult>> success,
            V2NIMFailureCallback failure);

    /**
     * 获取会话分组
     *
     * @param groupId 分组Id
     * @param success 成功回调
     * @param failure 失败回调
     */
    void getConversationGroup(@NonNull String groupId,V2NIMSuccessCallback<V2NIMConversationGroup> success, V2NIMFailureCallback failure);

    /**
     * 获取会话分组列表
     *
     * @param success 成功回调
     * @param failure 失败回调
     */
    void getConversationGroupList(V2NIMSuccessCallback<List<V2NIMConversationGroup>> success, V2NIMFailureCallback failure);

    /**
     * 获取会话分组列表
     *
     * @param groupIds 分组Id列表
     * @param success  成功回调
     * @param failure  失败回调
     */
    void getConversationGroupListByIds(@NonNull List<String> groupIds, V2NIMSuccessCallback<List<V2NIMConversationGroup>> success,
            V2NIMFailureCallback failure);

    /**
     * 添加会话分组监听
     *
     * @param listener
     */
    void addConversationGroupListener(@NonNull V2NIMConversationGroupListener listener);

    /**
     * 移除会话分组监听
     *
     * @param listener
     */
    void removeConversationGroupListener(@NonNull V2NIMConversationGroupListener listener);
}