ChatRoomService.java

浏览该文件的文档.

package com.netease.nimlib.sdk.chatroom;

import androidx.annotation.NonNull;

import com.netease.nimlib.apt.annotation.NIMService;
import com.netease.nimlib.sdk.AbortableFuture;
import com.netease.nimlib.sdk.InvocationFuture;
import com.netease.nimlib.sdk.antispam.model.AntiSpamConfig;
import com.netease.nimlib.sdk.chatroom.constant.ChatRoomModeEnum;
import com.netease.nimlib.sdk.chatroom.constant.MemberQueryType;
import com.netease.nimlib.sdk.chatroom.model.ChatRoomInfo;
import com.netease.nimlib.sdk.chatroom.model.ChatRoomSpatialLocation;
import com.netease.nimlib.sdk.chatroom.model.ChatRoomMember;
import com.netease.nimlib.sdk.chatroom.model.ChatRoomMemberUpdate;
import com.netease.nimlib.sdk.chatroom.model.ChatRoomMessage;
import com.netease.nimlib.sdk.chatroom.model.ChatRoomTagsInfo;
import com.netease.nimlib.sdk.chatroom.model.ChatRoomUpdateInfo;
import com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData;
import com.netease.nimlib.sdk.chatroom.model.EnterChatRoomResultData;
import com.netease.nimlib.sdk.chatroom.model.GetMessagesByTagsParam;
import com.netease.nimlib.sdk.chatroom.model.MemberOption;
import com.netease.nimlib.sdk.msg.constant.MsgTypeEnum;
import com.netease.nimlib.sdk.msg.model.QueryDirectionEnum;
import com.netease.nimlib.sdk.robot.model.NimRobotInfo;
import com.netease.nimlib.sdk.util.Entry;

import java.util.List;
import java.util.Map;

@NIMService("聊天室服务")
public interface ChatRoomService {
    AbortableFuture<EnterChatRoomResultData> enterChatRoom(EnterChatRoomData roomData);

    AbortableFuture<EnterChatRoomResultData> enterChatRoomEx(EnterChatRoomData roomData, int retryCount);

    int getEnterErrorCode(String roomId);

    void exitChatRoom(String roomId);

    void exitChatRooms(ChatRoomModeEnum mode);

    InvocationFuture<Void> sendMessage(ChatRoomMessage msg, boolean resend);


    AbortableFuture<Void> downloadAttachment(ChatRoomMessage msg, boolean thumb);

    InvocationFuture<List<ChatRoomMessage>> pullMessageHistory(String roomId, long startTime, int limit);

    InvocationFuture<List<ChatRoomMessage>> pullMessageHistoryEx(String roomId, long startTime, int limit, QueryDirectionEnum direction);


    InvocationFuture<List<ChatRoomMessage>> pullMessageHistoryExType(String roomId, long startTime, int limit, QueryDirectionEnum direction, MsgTypeEnum[] typeEnums);

    InvocationFuture<List<ChatRoomMessage>> getMessagesByTags(GetMessagesByTagsParam param);

    InvocationFuture<ChatRoomInfo> fetchRoomInfo(String roomId);

    InvocationFuture<List<ChatRoomMember>> fetchRoomMembers(String roomId, MemberQueryType memberQueryType, long time, int limit);

    InvocationFuture<List<ChatRoomMember>> fetchRoomMembersByTag(String roomId, String tag, long time, int limit);

    InvocationFuture<List<ChatRoomMember>> fetchRoomMembersByIds(String roomId, List<String> accounts);

    InvocationFuture<Long> queryTagMembersCount(String roomId, String tag);

    InvocationFuture<ChatRoomMember> markChatRoomBlackList(boolean isAdd, MemberOption memberOption);

    InvocationFuture<ChatRoomMember> markChatRoomMutedList(boolean isAdd, MemberOption memberOption);

    InvocationFuture<Void> markChatRoomTempMute(boolean needNotify, long duration, MemberOption memberOption);

    InvocationFuture<Void> markChatRoomTempMuteByTag(String roomId, String targetTag, boolean needNotify, long duration, Map<String, Object> notifyExtension, String notifyTargetTags);

    InvocationFuture<ChatRoomMember> markChatRoomManager(boolean isAdd, MemberOption memberOption);

    InvocationFuture<ChatRoomMember> markNormalMember(boolean isAdd, MemberOption memberOption);

    InvocationFuture<Void> kickMember(String roomId, String account, Map<String, Object> notifyExtension);

    InvocationFuture<Void> updateRoomInfo(String roomId, ChatRoomUpdateInfo chatRoomUpdateInfo, boolean needNotify, Map<String, Object> notifyExtension);

    InvocationFuture<Void> updateRoomInfo(String roomId, ChatRoomUpdateInfo chatRoomUpdateInfo, boolean needNotify, Map<String, Object> notifyExtension,
        AntiSpamConfig antiSpamConfig);

    InvocationFuture<Void> updateMyRoomRole(String roomId, ChatRoomMemberUpdate chatRoomMemberUpdate, boolean needNotify, Map<String, Object> notifyExtension);

    InvocationFuture<Void> updateMyRoomRole(String roomId, ChatRoomMemberUpdate chatRoomMemberUpdate, boolean needNotify, Map<String, Object> notifyExtension,AntiSpamConfig antiSpamConfig);

    InvocationFuture<Void> updateQueue(String roomId, String key, String value);

    InvocationFuture<Void> updateQueueEx(String roomId, String key, String value, boolean isTransient);

    InvocationFuture<Void> updateQueue(String roomId, String key, String value, boolean isTransient, String elementAccid);


    InvocationFuture<List<String>> batchUpdateQueue(String roomId, List<Entry<String, String>> queues, boolean needNotify, Map<String, Object> notifyExt);

    InvocationFuture<Entry<String, String>> pollQueue(String roomId, String key);

    InvocationFuture<List<Entry<String, String>>> fetchQueue(String roomId);

    InvocationFuture<Void> dropQueue(String roomId);

    InvocationFuture<List<NimRobotInfo>> pullAllRobots(String roomId);

    InvocationFuture<Void> updateChatRoomTags(String roomId, ChatRoomTagsInfo tagsInfo);

    InvocationFuture<Void> updateLocation(String roomId, ChatRoomSpatialLocation location);
}