# RongIMClient

public abstract class RongIMClient

IM 客户端核心类。 所有 IM 相关方法、监听器都由此调用和设置。 只能在主进程调用。

## Constructors

RongIMClient
Link copied to clipboard
public void RongIMClient()

## Types

BlacklistStatus
Link copied to clipboard
public enum BlacklistStatus
是否在黑名单中状态。
Callback
Link copied to clipboard
public abstract class Callback
ChatRoomActionListener
Link copied to clipboard
public interface ChatRoomActionListener
聊天室操作监听器
ConnectCallback
Link copied to clipboard
public abstract class ConnectCallback
连接服务器回调类。
ConnectionErrorCode
Link copied to clipboard
public enum ConnectionErrorCode
建立连接返回的错误码
ConnectionStatusListener
Link copied to clipboard
public interface ConnectionStatusListener
连接状态监听器，获取连接相关状态。
ConversationStatusListener
Link copied to clipboard
public interface ConversationStatusListener
会话状态（置顶和免打扰）多端同步监听
CreateDiscussionCallback
Link copied to clipboard
public abstract class CreateDiscussionCallback extends RongIMClient.ResultCallback<T>
创建讨论组的回调。
DatabaseOpenStatus
Link copied to clipboard
public enum DatabaseOpenStatus
数据库打开枚举
DefaultOperationCallback
Link copied to clipboard
public class DefaultOperationCallback
DestructCountDownTimerListener
Link copied to clipboard
public interface DestructCountDownTimerListener
焚烧倒计时回调接口。
DiscussionInviteStatus
Link copied to clipboard
public enum DiscussionInviteStatus
讨论组邀请状态。
DownloadMediaCallback
Link copied to clipboard
public abstract class DownloadMediaCallback extends RongIMClient.ResultCallback<T>
下载文件的回调。
EncryptedSessionConnectionListener
Link copied to clipboard
public interface EncryptedSessionConnectionListener
加密会话信令建立状态监听。 发起 : onEncryptedSessionRequest 响应 : onEncryptedSessionResponse 建立成功 : onEncryptedSessionEstablished 取消加密会话 : onEncryptedSessionCanceled 结束加密会话 : onEncryptedSessionTerminated
ErrorCode
Link copied to clipboard
public enum ErrorCode
RongIMClient ErrorCode
GetBlacklistCallback
Link copied to clipboard
public abstract class GetBlacklistCallback extends RongIMClient.ResultCallback<T>
获取黑名单回调。
GetNotificationQuietHoursCallback
Link copied to clipboard
public abstract class GetNotificationQuietHoursCallback extends RongIMClient.ResultCallback<T>
获取消息通知免打扰时间的回调。
KVStatusListener
Link copied to clipboard
public interface KVStatusListener
聊天室 KV 状态变化的监听
MediaType
Link copied to clipboard
public enum MediaType
文件类型枚举。
MessageExpansionListener
Link copied to clipboard
public interface MessageExpansionListener
OnRecallMessageListener
Link copied to clipboard
public interface OnRecallMessageListener
撤回消息监听器
OnReceiveDestructionMessageListener
Link copied to clipboard
public interface OnReceiveDestructionMessageListener
阅后即焚消息接收监听器
OnReceiveMessageListener
Link copied to clipboard
public interface OnReceiveMessageListener
接收消息的监听器。 注意:请切换线程，处理耗时操作。
OnReceiveMessageWrapperListener
Link copied to clipboard
public abstract class OnReceiveMessageWrapperListener
接收消息的监听器。 注意:请切换线程，处理耗时操作。 此接口可以替换 OnReceiveMessageListener 用于解决接收大量消息时，界面频繁刷新问题。 该接口会返回 left 和 hasPackage 参数，两者可以配合使用判断何时拉取完离线消息。
OperationCallback
Link copied to clipboard
public abstract class OperationCallback extends RongIMClient.Callback
执行操作回调。
PushLanguage
Link copied to clipboard
public enum PushLanguage
远程推送语言类型
RCLogInfoListener
Link copied to clipboard
public interface RCLogInfoListener
Log 输出监听
ReadReceiptListener
Link copied to clipboard
public interface ReadReceiptListener
消息回执监听器。 收到消息回执时会回调 onReadReceiptReceived 。
RealTimeLocationListener
Link copied to clipboard
public interface RealTimeLocationListener
实时位置共享监听。
ResultCallback
Link copied to clipboard
public abstract class ResultCallback<T>
泛型类，用于 API 中功能的回调处理。
SearchType
Link copied to clipboard
public enum SearchType
搜索类型枚举。
SendImageMessageCallback
Link copied to clipboard
public abstract class SendImageMessageCallback extends RongIMClient.SendMessageCallback
发送图片消息的回调。
SendImageMessageWithUploadListenerCallback
Link copied to clipboard
public abstract class SendImageMessageWithUploadListenerCallback
发送图片消息回调。 如果需要将图片上传到自己服务器，请使用这个回调。
SendMediaMessageCallback
Link copied to clipboard
public abstract class SendMediaMessageCallback extends RongIMClient.SendImageMessageCallback
发送多媒体类消息的回调。
SendMessageCallback
Link copied to clipboard
public abstract class SendMessageCallback extends RongIMClient.ResultCallback<T>
发送消息的回调。
SyncCallback
Link copied to clipboard
public abstract class SyncCallback<T> extends RongIMClient.ResultCallback<T>
SyncConversationReadStatusListener
Link copied to clipboard
public interface SyncConversationReadStatusListener
同步消息未读状态监听接口。 多端登录，收到其它端清除某一会话未读数通知的时候，回调 `onSyncConversationReadStatus`。
TimestampOrder
Link copied to clipboard
public enum TimestampOrder
TypingStatusListener
Link copied to clipboard
public interface TypingStatusListener
输入状态监听器，当输入状态发生变化时，会回调onTypingStatusChanged
UploadImageStatusListener
Link copied to clipboard
public class UploadImageStatusListener
图片上传状态监听。 如果使用者自己上传图片，那么需要通过调用 UploadImageStatusListener 中的方法将上传进度更新在 UI 上显示。 该 listener 通过 SendImageMessageWithUploadListenerCallback 返回实例供使用者使用。
UploadMediaCallback
Link copied to clipboard
public abstract class UploadMediaCallback extends RongIMClient.ResultCallback<T>
上传媒体文件的回调。

## Functions

addMemberToDiscussion
Link copied to clipboard
public abstract void addMemberToDiscussion(String discussionId, List<String> userIdList, RongIMClient.OperationCallback callback)
将用户加入讨论组。
addOnReceiveMessageListener
Link copied to clipboard
public static boolean addOnReceiveMessageListener(OnReceiveMessageWrapperListener listener)
添加接收消息事件的监听器。 注意:建议设置应用生命周期的全局监听器。
addRealTimeLocationListener
Link copied to clipboard
public abstract void addRealTimeLocationListener(ConversationType conversationType, String targetId, RongIMClient.RealTimeLocationListener listener)
添加位置共享监听。
addToBlacklist
Link copied to clipboard
public abstract void addToBlacklist(String userId, RongIMClient.OperationCallback callback)
将某个用户加入黑名单。 将对方加入黑名单后，对方再发消息时，提示"您的消息已经发出, 但被对方拒收"。但您仍然可以给对方发送消息。
appOnStart
Link copied to clipboard
public abstract void appOnStart()
通知 SDK 应用回到前台。 注意：该方法必须在 init 之后调用。
batchInsertMessage
Link copied to clipboard
public abstract void batchInsertMessage(List<Message> messages, RongIMClient.ResultCallback<Boolean> callback)
批量插入接收的消息（该消息只插入本地数据库，实际不会发送给服务器和对方） Message 下列属性会被入库，其余属性会被抛弃 conversationType 会话类型 targetId 会话 ID messageDirection 消息方向 senderUserId 发送者 ID receivedStatus 接收状态；消息方向为接收方且未调用 message.getReceivedStatus().
beginDestructMessage
Link copied to clipboard
public abstract void beginDestructMessage(Message message, RongIMClient.DestructCountDownTimerListener pListener)
开始焚烧消息，仅支持单聊。
bindChatRoomWithRTCRoom
Link copied to clipboard
public abstract void bindChatRoomWithRTCRoom(String chatRoomId, String RTCRoomId, RongIMClient.OperationCallback callback)
绑定chatRoom和RTCRoom，当在RTCRoom开启时如需调用ChatRoom调用此方法。
cancelDownloadMediaMessage
Link copied to clipboard
public abstract void cancelDownloadMediaMessage(Message message, RongIMClient.OperationCallback callback)
取消多媒体消息下载。
cancelSDKHeartBeat
Link copied to clipboard
public abstract void cancelSDKHeartBeat()
取消 wakelock 心跳，在连接成功之后调用，整个应用程序全局只需要调用一次。
cancelSendMediaMessage
Link copied to clipboard
public abstract void cancelSendMediaMessage(Message message, RongIMClient.OperationCallback callback)
取消发送多媒体文件。
cleanHistoryMessages
Link copied to clipboard
public abstract void cleanHistoryMessages(ConversationType conversationType, String targetId, long recordTime, boolean cleanRemote, RongIMClient.OperationCallback callback)
删除指定时间戳之前的消息，可选择是否同时删除服务器端消息 此方法可从服务器端清除历史消息，但是必须先开通历史消息云存储功能。 根据会话类型和会话 id 清除某一会话指定时间戳之前的本地数据库消息（服务端历史消息）， 清除成功后只能从本地数据库（服务端）获取到该时间戳之后的历史消息。
cleanRemoteHistoryMessages
Link copied to clipboard
public abstract void cleanRemoteHistoryMessages(ConversationType conversationType, String targetId, long recordTime, RongIMClient.OperationCallback callback)
清除服务器上存储的历史消息。 根据会话类型和目标会话 id 清除某一会话指定时间戳之前的服务端历史消息, 清除成功后只能从服务端获取到该时间戳之后的历史消息。注意：必须先开通历史消息云存储功能！
clearConversations
Link copied to clipboard
public abstract void clearConversations(RongIMClient.ResultCallback callback, Array<ConversationType> conversationTypes)
清空指定会话类型列表中的所有会话及会话消息。
clearMessages
Link copied to clipboard
public abstract void clearMessages(ConversationType conversationType, String targetId, RongIMClient.ResultCallback<Boolean> callback)
删除某个会话中的所有消息。 注意：不支持聊天室！
clearMessagesUnreadStatus
Link copied to clipboard
public abstract void clearMessagesUnreadStatus(ConversationType conversationType, String targetId, RongIMClient.ResultCallback<Boolean> callback)
public abstract void clearMessagesUnreadStatus(ConversationType conversationType, String targetId, long timestamp, RongIMClient.OperationCallback callback)
清除某个会话中的未读消息数。 注意：不支持聊天室！
clearTextMessageDraft
Link copied to clipboard
public abstract void clearTextMessageDraft(ConversationType conversationType, String targetId, RongIMClient.ResultCallback<Boolean> callback)
删除指定会话中的草稿信息。
connect
Link copied to clipboard
public static RongIMClient connect(String token, RongIMClient.ConnectCallback connectCallback)
连接融云服务器，在整个应用程序全局，只需要调用一次，需在 init 之后调用。 调用此接口返回非业务错误码时，SDK 会启动重连机制进行重连；如果仍没有连接成功，会在设备网络状态变化时再次进行重连。如果您使用 IMKit，请使用 RongIM 中的同名方法建立与融云服务器的连接，而不要使用此方法。调用该接口，SDK 会在连接失败之后尝试重连，将出现以下两种情况： 第一、连接成功，回调 onSuccess(userId)。 第二、出现 SDK 无法处理的错误，回调 onError(errorCode)（如 token 非法），并不再重连。 如果您不想一直进行重连，可以使用 connect(String,int,ConnectCallback) 接口并设置连接超时时间 timeLimit
public static RongIMClient connect(String token, int timeLimit, RongIMClient.ConnectCallback connectCallback)
连接融云服务器，在整个应用程序全局，只需要调用一次，需在 init 之后调用。 调用此接口返回非业务错误码时，SDK 会启动重连机制进行重连；如果仍没有连接成功，会在设备网络状态变化时再次进行重连。如果您使用 IMKit，请使用 RongIM 中的同名方法建立与融云服务器的连接，而不要使用此方法。
createDiscussion
Link copied to clipboard
public abstract void createDiscussion(String name, List<String> userIdList, RongIMClient.CreateDiscussionCallback callback)
创建讨论组。
deleteMessages
Link copied to clipboard
public abstract void deleteMessages(Array<int> messageIds, RongIMClient.ResultCallback<Boolean> callback)
删除消息。
public abstract void deleteMessages(ConversationType conversationType, String targetId, RongIMClient.ResultCallback<Boolean> callback)
删除某个会话中的所有消息。 此接口删除指定会话中数据库的所有消息，同时会清理数据库空间，减少占用空间。
deleteRemoteMessages
Link copied to clipboard
public abstract void deleteRemoteMessages(ConversationType conversationType, String targetId, Array<Message> messages, RongIMClient.OperationCallback callback)
批量删除某个会话中的指定远端消息（同时删除对应的本地消息）。 一次批量操作仅支持删除属于同一个会话的消息，请确保消息列表中的所有消息来自同一会话，一次最多删除 100 条消息。注意：不支持聊天室！5.6.9版本以下不支持超级群会话类型，从 5.6.
disconnect
Link copied to clipboard
public abstract void disconnect()
断开与融云服务器的连接，但仍然接收远程推送。 若想断开连接后不接受远程推送消息，可以调用logout。注意：因为 SDK 在前后台切换或者网络出现异常都会自动重连，保证连接可靠性。 所以除非您的 App 逻辑需要登出，否则一般不需要调用此方法进行手动断开。
public abstract void disconnect(boolean isReceivePush)
断开与融云服务器的连接，根据参数选择是否继续接收远程推送。
downloadMedia
Link copied to clipboard
public abstract void downloadMedia(ConversationType conversationType, String targetId, RongIMClient.MediaType mediaType, String imageUrl, RongIMClient.DownloadMediaCallback callback)
下载多媒体文件。 如果本地缓存中包含此文件，则从本地缓存中直接获取，否则将从服务器端下载。
downloadMediaFile
Link copied to clipboard
public abstract void downloadMediaFile(String fileUniqueId, String fileUrl, String fileName, String path, IRongCallback.IDownloadMediaFileCallback callback)
下载文件。 支持断点续传，对应的暂停下载须调用 pauseDownloadMediaFile。
downloadMediaMessage
Link copied to clipboard
public abstract void downloadMediaMessage(Message message, IRongCallback.IDownloadMediaMessageCallback callback)
下载多媒体文件。
evaluateCustomService
Link copied to clipboard
public abstract void evaluateCustomService(String kefuId, boolean isRobotResolved, String knowledgeId)
public abstract void evaluateCustomService(String kefuId, int source, String suggest, String dialogId)
public abstract void evaluateCustomService(String kefuId, int source, CSEvaSolveStatus resolvestatus, String tagText, String suggest, String dialogId, String extra)
评价机器人客服，用于人工机器人分开评价。 当建立客服连接时，返回的 CustomServiceConfig.
public abstract void evaluateCustomService(String kefuId, int source, CSEvaSolveStatus solveStatus, String suggest, String dialogId)
评价机器人客服，用于人工机器人统一评价。 当建立客服连接时，返回的 CustomServiceConfig.
forceRemoveChatRoomEntry
Link copied to clipboard
public abstract void forceRemoveChatRoomEntry(String chatRoomId, String key, Boolean sendNotification, String notificationExtra, RongIMClient.OperationCallback callback)
强制删除聊天室自定义属性。 注意：必须先开通聊天室状态存储功能。
forceSetChatRoomEntry
Link copied to clipboard
public abstract void forceSetChatRoomEntry(String chatRoomId, String key, String value, boolean sendNotification, boolean autoDelete, String notificationExtra, RongIMClient.OperationCallback callback)
强制设置聊天室自定义属性。 key 不存在，增加属性； key 已存在，更新属性的值。注意：必须先开通聊天室状态存储功能。
getAllChatRoomEntries
Link copied to clipboard
public abstract void getAllChatRoomEntries(String chatRoomId, RongIMClient.ResultCallback<Map<String, String>> callback)
获取聊天室所有属性。 注意：必须先开通聊天室状态存储功能。
getBlacklist
Link copied to clipboard
public abstract void getBlacklist(RongIMClient.GetBlacklistCallback callback)
获取当前用户设置的黑名单列表。
getBlacklistStatus
Link copied to clipboard
public abstract void getBlacklistStatus(String userId, RongIMClient.ResultCallback<RongIMClient.BlacklistStatus> callback)
获取某用户是否在黑名单中。
getBlockedConversationList
Link copied to clipboard
public abstract void getBlockedConversationList(RongIMClient.ResultCallback<List<Conversation>> callback, Array<ConversationType> conversationTypes)
获取免打扰的会话列表。
getChatRoomEntry
Link copied to clipboard
public abstract void getChatRoomEntry(String chatRoomId, String key, RongIMClient.ResultCallback<Map<String, String>> callback)
获取聊天室单个属性。 注意：必须先开通聊天室状态存储功能。
getChatroomHistoryMessages
Link copied to clipboard
public abstract void getChatroomHistoryMessages(String targetId, long recordTime, int count, RongIMClient.TimestampOrder order, IRongCallback.IChatRoomHistoryMessageCallback callback)
获取聊天室历史消息。 从服务器端获取聊天室之前的历史消息，如果指定时间 0，则从存储的第一条消息开始拉取。注意：必须先开通聊天室消息云存储功能。
getChatRoomInfo
Link copied to clipboard
public abstract void getChatRoomInfo(String chatRoomId, int defMemberCount, ChatRoomMemberOrder order, RongIMClient.ResultCallback<ChatRoomInfo> callback)
获取聊天室的信息（包含部分成员信息和当前聊天室中的成员总数）。 注意： 因为聊天室一般成员数量巨大，权衡效率和用户体验，目前返回的聊天室信息仅包含不多于 20 人的成员信息和当前成员总数。 如果您使用 RC_ChatRoom_Member_Asc 升序方式查询，将返回最早加入的成员信息列表； 如果您使用 RC_ChatRoom_Member_Desc 降序方式查询，将返回最晚加入的成员信息列表。 上述两种方式查询，返回的成员列表都是按加入时间从旧到新。 `
getConversation
Link copied to clipboard
public abstract void getConversation(ConversationType conversationType, String targetId, RongIMClient.ResultCallback<Conversation> callback)
获取单个会话信息。
getConversationList
Link copied to clipboard
public abstract void getConversationList(RongIMClient.ResultCallback<List<Conversation>> callback)
获取当前用户本地会话列表，该方法返回的是以下类型的会话列表：私聊，群组，讨论组，系统会话。 此方法会从本地数据库中，读取会话列表。返回的会话列表排序规则为:按照时间从前往后排列，如果有置顶的会话，则置顶的会话会排列在前面。 如果您需要获取其它类型的会话列表,可以使用getConversationList 。 需要在连接数据库打开回调 `OnDatabaseOpened` 后调用，ConnectCallback 。
public abstract void getConversationList(RongIMClient.ResultCallback<List<Conversation>> callback, Array<ConversationType> conversationTypes)
根据会话类型，获取当前用户的本地会话列表。
getConversationListByPage
Link copied to clipboard
public abstract void getConversationListByPage(RongIMClient.ResultCallback<List<Conversation>> callback, long timeStamp, int count, Array<ConversationType> conversationTypes)
分页获取会话列表。
getConversationNotificationStatus
Link copied to clipboard
public abstract void getConversationNotificationStatus(ConversationType conversationType, String targetId, RongIMClient.ResultCallback<ConversationNotificationStatus> callback)
获取会话消息提醒状态。 注意：不支持聊天室！
getCurrentConnectionStatus
Link copied to clipboard
public abstract RongIMClient.ConnectionStatusListener.ConnectionStatus getCurrentConnectionStatus()
获取当前 IM 服务连接状态。
getCurrentProxy
Link copied to clipboard
public abstract RCIMProxy getCurrentProxy()
getCurrentUserId
Link copied to clipboard
public abstract String getCurrentUserId()
获取当前连接用户的信息。
getDeltaTime
Link copied to clipboard
public abstract long getDeltaTime()
获取本地时间与服务器时间的时间差。 消息发送成功后，SDK 与服务器同步时间，消息所在数据库中存储的时间就是服务器时间。 System.
getDiscussion
Link copied to clipboard
public abstract void getDiscussion(String discussionId, RongIMClient.ResultCallback<Discussion> callback)
获取讨论组的信息。
getDownloadInfo
Link copied to clipboard
public abstract void getDownloadInfo(String tag, RongIMClient.ResultCallback<DownloadInfo> callback)
获取媒体文件下载信息。 注意：此方法只适用断点续传下载。
getGIFLimitSize
Link copied to clipboard
public abstract int getGIFLimitSize()
获取允许发送 GIF 图片大小最大值。
getHistoryMessages
Link copied to clipboard
@Deprecated()
public abstract List<Message> getHistoryMessages(ConversationType conversationType, String targetId, int oldestMessageId, int count)
@Deprecated()
public abstract List<Message> getHistoryMessages(ConversationType conversationType, String targetId, String objectName, int oldestMessageId, int count)
获取会话中符合条件的消息列表。
public abstract void getHistoryMessages(ConversationType conversationType, String targetId, int oldestMessageId, int count, RongIMClient.ResultCallback<List<Message>> callback)
获取会话中，从指定消息之前、指定数量的、指定消息类型的最新消息实体。
public abstract void getHistoryMessages(ConversationType conversationType, String targetId, String objectName, int oldestMessageId, int count, RongIMClient.ResultCallback<List<Message>> callback)
获取会话中符合条件的消息列表。 返回的消息中不包含 oldestMessageId 对应那条消息，如果会话中的消息数量小于参数 count 的值，会将该会话中的所有消息返回。 如：oldestMessageId 为 10，count 为 2，会返回 messageId 为 9 和 8 的 Message 对象列表。
public abstract void getHistoryMessages(ConversationType conversationType, String targetId, long sentTime, int before, int after, RongIMClient.ResultCallback<List<Message>> resultCallback)
在会话中搜索指定消息的前 `before` 数量和 `after` 数量的消息。 返回的消息列表中会包含指定的消息。消息列表时间顺序从新到旧。
public abstract void getHistoryMessages(ConversationType conversationType, String targetId, String objectName, int baseMessageId, int count, GetMessageDirection direction, RongIMClient.ResultCallback<List<Message>> callback)
获取会话中符合条件的消息列表。 如：获取 messageId 为 22 的之前的 10条 图片消息，则相应参数为 getHistoryMessages(conversationType, targetId, "RC:ImgMsg", 22, 10, true, resultCallback)。
public abstract void getHistoryMessages(ConversationType conversationType, String targetId, List<String> objectNames, long timestamp, int count, GetMessageDirection direction, RongIMClient.ResultCallback<List<Message>> callback)
获取会话中符合条件的消息列表。 如： 要获取 messageId 为 22 的之前的 10 条图片消息，和文字消息 objectNames 为字符串 List

    objectNames.add("RC:ImgMsg");
    objectNames.add("RC:TxtMsg");

Content copied to clipboard
则相应参数为 getHistoryMessages(conversationType, targetId, objectNames, 22, 10, true, resultCallback)。
getInstance
Link copied to clipboard
public static RongIMClient getInstance()
获取 IMLib 接口类实例，需在执行 init 方法初始化 SDK 后获取, 否则返回值为 NULL。
getLatestMessages
Link copied to clipboard
public abstract void getLatestMessages(ConversationType conversationType, String targetId, int count, RongIMClient.ResultCallback<List<Message>> callback)
获取指定会话的最新消息。
getMessage
Link copied to clipboard
public abstract void getMessage(int messageId, RongIMClient.ResultCallback<Message> callback)
根据消息 id 获取消息体（数据库索引唯一值）。
getMessageByUid
Link copied to clipboard
public abstract void getMessageByUid(String uid, RongIMClient.ResultCallback<Message> callback)
通过全局唯一 id 获取消息实体。
getMessageCount
Link copied to clipboard
public abstract void getMessageCount(ConversationType conversationType, String targetId, RongIMClient.ResultCallback<Integer> callback)
获取指定会话的消息总数。
getNotificationQuietHours
Link copied to clipboard
public abstract void getNotificationQuietHours(RongIMClient.GetNotificationQuietHoursCallback callback)
获取消息通知免打扰时间。
getOfflineMessageDuration
Link copied to clipboard
public abstract void getOfflineMessageDuration(RongIMClient.ResultCallback<String> callback)
获取离线消息时间（以天为单位）。
getPrivateDownloadToken
Link copied to clipboard
@Deprecated()
public abstract void getPrivateDownloadToken(String fileName, ResultCallback<String> callback)
此接口仅适用于私有云 SDK 调用，当前版本不再适用，私有云用户使用新接口 getMediaUploadAuthorInfo
getPublicServiceList
Link copied to clipboard
public abstract void getPublicServiceList(RongIMClient.ResultCallback<PublicServiceProfileList> callback)
获取己关注公共账号列表。
getPublicServiceProfile
Link copied to clipboard
public abstract void getPublicServiceProfile(PublicServiceType publicServiceType, String publicServiceId, RongIMClient.ResultCallback<PublicServiceProfile> callback)
获取某公共服务信息。
getPushContentShowStatus
Link copied to clipboard
public abstract void getPushContentShowStatus(RongIMClient.ResultCallback<Boolean> callback)
获取是否显示远程推送内容详情设置。
getPushLanguage
Link copied to clipboard
public abstract void getPushLanguage(RongIMClient.ResultCallback<RongIMClient.PushLanguage> callback)
获取远程推送语言设置。
getPushReceiveStatus
Link copied to clipboard
public abstract void getPushReceiveStatus(RongIMClient.ResultCallback<Boolean> callback)
获取是否接收远程推送的设置。 前提: 移动端不在线，Web 、MAC/PC 终端在线，移动端是否接收远程推送。
getRealTimeLocation
Link copied to clipboard
public abstract RealTimeLocationErrorCode getRealTimeLocation(ConversationType conversationType, String targetId)
获取 RealTimeLocation 实例。 使用时，每次进入会话，获取该会话对应的实例，以此判断位置共享业务是否可用或者正在进行中。 如果获取实例失败，返回 error code，对应具体的失败信息。 如果返回成功，使用者可以设置监听，发起位置共享。 如果返回正在进行中，则是对方已发起位置共享，使用者可以设置监听，加入。 如果返回其他失败信息，使用者可以据此做出相应的提示。
getRealTimeLocationCurrentState
Link copied to clipboard
public abstract RealTimeLocationStatus getRealTimeLocationCurrentState(ConversationType conversationType, String targetId)
获取位置共享状态。
getRealTimeLocationParticipants
Link copied to clipboard
public abstract List<String> getRealTimeLocationParticipants(ConversationType conversationType, String targetId)
获取位置共享的所有成员。
getRemoteHistoryMessages
Link copied to clipboard
public abstract void getRemoteHistoryMessages(ConversationType conversationType, String targetId, RemoteHistoryMsgOption remoteHistoryMsgOption, RongIMClient.ResultCallback<List<Message>> callback)
获取指定会话远端历史消息。 此功能需要在融云开发者后台开启历史消息云存储功能。注意：不支持聊天室！
public abstract void getRemoteHistoryMessages(ConversationType conversationType, String targetId, long dateTime, int count, RongIMClient.ResultCallback<List<Message>> callback)
从服务器端获取指定时间之前的历史消息。 区别于 getHistoryMessages，该接口是从融云服务器中拉取。从服务端拉取消息后，客户端会做排重，返回排重后的数据。通常用于更换新设备后，拉取历史消息。 使用的时候，建议优先通过 getHistoryMessages 从本地数据库拉取历史消息， 当本地数据库没有历史消息后，再通过此接口获取服务器历史消息，时间戳传入本地数据库里最早的消息时间戳。注意： 1.
getSendTimeByMessageId
Link copied to clipboard
public abstract long getSendTimeByMessageId(int messageId)
根据消息 id 获取消息发送时间。
getTextMessageDraft
Link copied to clipboard
public abstract void getTextMessageDraft(ConversationType conversationType, String targetId, RongIMClient.ResultCallback<String> callback)
获取会话中的草稿信息。
getTheFirstUnreadMessage
Link copied to clipboard
public abstract void getTheFirstUnreadMessage(ConversationType conversationType, String targetId, RongIMClient.ResultCallback<Message> callback)
获取第一条未读消息。
getTopConversationList
Link copied to clipboard
public abstract void getTopConversationList(RongIMClient.ResultCallback<List<Conversation>> callback, Array<ConversationType> conversationTypes)
根据会话类型,获取置顶会话列表
getTopForegroundActivity
Link copied to clipboard
public abstract Activity getTopForegroundActivity()
获取处于前台的最上层 Activity。
getTotalUnreadCount
Link copied to clipboard
public abstract void getTotalUnreadCount(RongIMClient.ResultCallback<Integer> callback)
获取所有会话的总未读消息数。 注意：不包含聊天室，聊天室消息不计数。
public abstract void getTotalUnreadCount(RongIMClient.ResultCallback<Integer> callback, Array<Conversation> conversations)
获取所有指定会话的总未读消息数。 注意：不包含聊天室，聊天室消息不计数。
getTypingUserListFromConversation
Link copied to clipboard
public abstract Collection<TypingStatus> getTypingUserListFromConversation(ConversationType conversationType, String targetId)
获取会话正在输入的用户列表
getUnreadCount
Link copied to clipboard
public abstract void getUnreadCount(Array<ConversationType> conversationTypes, RongIMClient.ResultCallback<Integer> callback)
public abstract void getUnreadCount(RongIMClient.ResultCallback<Integer> callback, Array<ConversationType> conversationTypes)
public abstract void getUnreadCount(Array<ConversationType> conversationTypes, boolean containBlocked, RongIMClient.ResultCallback<Integer> callback)
获取指定会话类型的总未读消息数。 注意：不包含聊天室，聊天室消息不计数。
public abstract void getUnreadCount(ConversationType conversationType, String targetId, RongIMClient.ResultCallback<Integer> callback)
获取指定会话的未读消息数。 注意：不包含聊天室，聊天室消息不计数。
getUnreadMentionedMessages
Link copied to clipboard
public abstract void getUnreadMentionedMessages(ConversationType conversationType, String targetId, RongIMClient.ResultCallback<List<Message>> callback)
获取会话中未读的 @ 消息。
getVendorToken
Link copied to clipboard
public abstract void getVendorToken(RongIMClient.ResultCallback<String> resultCallback)
获取登录者身份认证信息。 第三方厂商通过使用此接口获取 token，然后与厂商的注册信息一起去融云服务器做认证。
getVersion
Link copied to clipboard
public static String getVersion()
getVideoLimitTime
Link copied to clipboard
public abstract int getVideoLimitTime()
获取允许发送视频文件的最大时长。
init
Link copied to clipboard
public static void init(Context context)
public static void init(Context context, String appKey)
public static void init(Context context, String appKey, boolean enablePush)
public static void init(Context context, String appKey, boolean enablePush, Boolean isMainProcess)
初始化 SDK，在整个应用程序全局只需要调用一次, 建议在 Application 继承类中调用。
public static void init(Application application, String appKey)
初始化融云 SDK，在整个应用程序全局只需要调用一次。 只能在主进程调用，建议在 Application 继承类中调用。
insertIncomingMessage
Link copied to clipboard
public abstract void insertIncomingMessage(ConversationType type, String targetId, String senderUserId, ReceivedStatus receivedStatus, MessageContent content, RongIMClient.ResultCallback<Message> resultCallback)
public abstract void insertIncomingMessage(ConversationType type, String targetId, String senderUserId, ReceivedStatus receivedStatus, MessageContent content, long sentTime, RongIMClient.ResultCallback<Message> resultCallback)
向本地会话中插入一条消息，方向为接收。 这条消息只是插入本地会话，不会实际发送给服务器和对方。插入消息需为入库消息，即 ISPERSISTED，否者会回调 PARAMETER_ERROR。
insertOutgoingMessage
Link copied to clipboard
public abstract void insertOutgoingMessage(ConversationType type, String targetId, SentStatus sentStatus, MessageContent content, RongIMClient.ResultCallback<Message> resultCallback)
向本地会话中插入一条消息。 这条消息只是插入本地会话，不会实际发送给服务器和对方。 插入消息需为入库消息，即ISPERSISTED，否者会回调 PARAMETER_ERROR
public abstract void insertOutgoingMessage(ConversationType type, String targetId, SentStatus sentStatus, MessageContent content, long sentTime, RongIMClient.ResultCallback<Message> resultCallback)
向本地会话中插入一条消息，方向为发送。 这条消息只是插入本地会话，不会实际发送给服务器和对方。 插入消息需为入库消息，即 ISPERSISTED，否者会回调 PARAMETER_ERROR
isFileDownloading
Link copied to clipboard
public abstract boolean isFileDownloading(int messageId)
public abstract boolean isFileDownloading(String uid)
判断文件是否正在下载中。 注意：此方法只适用断点续传下载。
joinChatRoom
Link copied to clipboard
public abstract void joinChatRoom(String chatRoomId, int defMessageCount, RongIMClient.OperationCallback callback)
加入聊天室。 如果聊天室不存在，SDK 会创建聊天室并加入，如果已存在，则直接加入。 可以通过传入的 defMessageCount 设置加入聊天室成功之后需要获取的历史消息数量。 -1 表示不获取任何历史消息，0 表示不特殊设置而使用 sdk 默认的设置（默认为获取 10 条），defMessageCount `0 < defMessageCount <= 50` 为获取的消息数量，最大值为 50。
joinExistChatRoom
Link copied to clipboard
public abstract void joinExistChatRoom(String chatRoomId, int defMessageCount, RongIMClient.OperationCallback callback)
加入已存在的聊天室。 如果聊天室不存在，则加入失败。加入聊天室时，可以设置拉取聊天室消息数目。
joinRealTimeLocation
Link copied to clipboard
public abstract RealTimeLocationErrorCode joinRealTimeLocation(ConversationType conversationType, String targetId)
加入位置共享。
leaveMessageCustomService
Link copied to clipboard
public abstract void leaveMessageCustomService(String kefuId, Map<String, String> contentMap, RongIMClient.OperationCallback operationCallback)
客服留言。
logout
Link copied to clipboard
public abstract void logout()
断开与融云服务器的连接，并且不再接收远程推送消息。 若想断开连接后仍然接受远程推送消息，可以调用 disconnect
pauseDownloadMediaFile
Link copied to clipboard
public abstract void pauseDownloadMediaFile(String fileUniqueId, RongIMClient.OperationCallback callback)
暂停多媒体文件下载。
pauseDownloadMediaMessage
Link copied to clipboard
public abstract void pauseDownloadMediaMessage(Message message, RongIMClient.OperationCallback callback)
暂停多媒体消息下载。
quitChatRoom
Link copied to clipboard
public abstract void quitChatRoom(String chatRoomId, RongIMClient.OperationCallback callback)
退出聊天室。
quitDiscussion
Link copied to clipboard
public abstract void quitDiscussion(String discussionId, RongIMClient.OperationCallback callback)
退出当前讨论组。
quitRealTimeLocation
Link copied to clipboard
public abstract void quitRealTimeLocation(ConversationType conversationType, String targetId)
退出位置共享。
recallMessage
Link copied to clipboard
public abstract void recallMessage(Message message, String pushContent, RongIMClient.ResultCallback<RecallNotificationMessage> callback)
撤回消息
registerMessageType
Link copied to clipboard
@Deprecated()
public static void registerMessageType(Class<? extends MessageContent> messageContentClass)
注册自定义消息类型 请在初始化之后，连接之前调用该方法注册自定义消息。
public static void registerMessageType(List<Class<? extends MessageContent>> messageContentClassList)
批量注册自定义消息类型 请在初始化之后，连接之前调用该方法注册自定义消息。
removeChatRoomEntry
Link copied to clipboard
public abstract void removeChatRoomEntry(String chatRoomId, String key, Boolean sendNotification, String notificationExtra, RongIMClient.OperationCallback callback)
删除聊天室自定义属性。 注意： 1.
removeConversation
Link copied to clipboard
public abstract void removeConversation(ConversationType conversationType, String targetId, RongIMClient.ResultCallback<Boolean> callback)
从会话列表中移除某一会话。 此方法不删除会话内的消息。如果此会话中有新的消息，该会话将重新在会话列表中显示，并显示最近的历史消息。
removeFromBlacklist
Link copied to clipboard
public abstract void removeFromBlacklist(String userId, RongIMClient.OperationCallback callback)
将某个用户从黑名单中移出。
removeMemberFromDiscussion
Link copied to clipboard
public abstract void removeMemberFromDiscussion(String discussionId, String userId, RongIMClient.OperationCallback callback)
讨论组踢人，将用户移出讨论组。 如果当前登陆用户不是此讨论组的创建者并且此讨论组没有开放加人权限，则会返回错误。不能使用此接口将自己移除，否则会返回错误。 如果您需要退出该讨论组，可以使用 quitDiscussion 方法。
removeMessageExpansion
Link copied to clipboard
public abstract void removeMessageExpansion(List<String> keyArray, String messageUId, RongIMClient.OperationCallback callback)
删除消息扩展信息中特定的键值对
removeNotificationQuietHours
Link copied to clipboard
public abstract void removeNotificationQuietHours(RongIMClient.OperationCallback callback)
移除消息通知免打扰时间。
removeOnReceiveMessageListener
Link copied to clipboard
public static boolean removeOnReceiveMessageListener(OnReceiveMessageWrapperListener listener)
移除接收消息事件的监听器。
removeRealTimeLocationObserver
Link copied to clipboard
public abstract void removeRealTimeLocationObserver(ConversationType conversationType, String targetId)
移除位置共享监听。
saveTextMessageDraft
Link copied to clipboard
public abstract void saveTextMessageDraft(ConversationType conversationType, String targetId, String content, RongIMClient.ResultCallback<Boolean> callback)
保存会话草稿信息。
searchConversations
Link copied to clipboard
public abstract void searchConversations(String keyword, Array<ConversationType> conversationTypes, Array<String> objectNames, RongIMClient.ResultCallback<List<SearchConversationResult>> resultCallback)
根据关键字搜索会话。 此方法可快速返回匹配的会话列表，并且会话中包含已匹配的消息数量。通过 {SearchConversationResult#getMatchCount()} 得到。注意：如果需要自定义消息也能被搜索到，需要在自定义消息中实现 getSearchableWord 方法。
searchMessages
Link copied to clipboard
public abstract void searchMessages(ConversationType conversationType, String targetId, String keyword, int count, long beginTime, RongIMClient.ResultCallback<List<Message>> resultCallback)
根据关键字搜索指定会话中的消息。 注意：如果需要自定义消息也能被搜索到，需要在自定义消息中实现 getSearchableWord 方法。
searchMessagesByUser
Link copied to clipboard
public abstract void searchMessagesByUser(ConversationType conversationType, String targetId, String userId, int count, long beginTime, RongIMClient.ResultCallback<List<Message>> resultCallback)
根据用户 id 搜索指定会话中的消息。 注意：如果需要自定义消息也能被搜索到，需要在自定义消息中实现 getSearchableWord 方法。
searchPublicService
Link copied to clipboard
public abstract void searchPublicService(RongIMClient.SearchType searchType, String keywords, RongIMClient.ResultCallback<PublicServiceProfileList> callback)
搜索公众服务。
searchPublicServiceByType
Link copied to clipboard
public abstract void searchPublicServiceByType(PublicServiceType publicServiceType, RongIMClient.SearchType searchType, String keywords, RongIMClient.ResultCallback<PublicServiceProfileList> callback)
按公众服务类型搜索公众服务。
selectCustomServiceGroup
Link copied to clipboard
public abstract void selectCustomServiceGroup(String kefuId, String groupId)
发送转人工客服消息
sendDirectionalMediaMessage
Link copied to clipboard
public abstract void sendDirectionalMediaMessage(Message message, Array<String> userIds, String pushContent, String pushData, IRongCallback.ISendMediaMessageCallback callback)
发送定向多媒体消息。 向会话中特定的某些用户发送消息，会话中其他用户不会收到消息。 发送前构造 Message 消息实体，消息实体中的 content 必须为多媒体消息。 例如：ImageMessage 、 或其他继承自 MediaMessageContent 的消息。 从 5.6.
sendDirectionalMessage
Link copied to clipboard
public abstract void sendDirectionalMessage(ConversationType type, String targetId, MessageContent content, Array<String> userIds, String pushContent, String pushData, IRongCallback.ISendMessageCallback callback)
发送定向消息。 此方法用于在群组、超级群中发送消息给其中的部分用户，其它用户不会收到这条消息。 通过 中的方法回调发送的消息状态及消息体。 此方法只能发送非多媒体消息，多媒体消息如ImageMessageFileMessage 或其他继承自 的消息须调用 sendDirectionalMediaMessage 如果您使用 IMLib，可以使用此方法发送定向消息；如果您使用 IMKit，请使用 RongIM 中的同名方法发送定向消息，否则不会自动更新 UI。 从 5.6.
sendImageMessage
Link copied to clipboard
public abstract void sendImageMessage(Message message, String pushContent, String pushData, RongIMClient.SendImageMessageCallback callback)
发送图片消息。 如果您使用IMLib，可以使用此方法发送图片消息；如果您使用 IMKit，请使用 RongIM 中的同名方法发送图片消息，否则不会自动更新 UI。
public abstract void sendImageMessage(Message message, String pushContent, String pushData, RongIMClient.SendImageMessageWithUploadListenerCallback callback)
发送图片消息。 该方法将图片上传到自己的服务器发送，同时更新图片状态。 使用该方法在上传图片时，会回调 io.rong.imlib.RongIMClient.
public abstract void sendImageMessage(ConversationType type, String targetId, MessageContent content, String pushContent, String pushData, RongIMClient.SendImageMessageCallback callback)
发送图片消息。 如果您使用IMLib，可以使用此方法发送图片消息； 如果您使用 IMKit，请使用 RongIM 中的同名方法发送图片消息，否则不会自动更新 UI。
sendLocationMessage
Link copied to clipboard
public abstract void sendLocationMessage(Message message, String pushContent, String pushData, IRongCallback.ISendMessageCallback sendMessageCallback)
发送地理位置消息。 发送前构造 Message 消息实体，消息实体中的 content 必须为 LocationMessage, 否则返回失败。 其中的缩略图地址 scheme 只支持 file:// 和 http://。也可不设置缩略图地址，传入 NULL。
sendMediaMessage
Link copied to clipboard
public abstract void sendMediaMessage(Message message, String pushContent, String pushData, IRongCallback.ISendMediaMessageCallback callback)
public abstract void sendMediaMessage(Message message, String pushContent, String pushData, SendMessageOption option, IRongCallback.ISendMediaMessageCallback callback)
发送多媒体消息。 发送前构造 Message 消息实体，消息实体中的 content 必须为多媒体消息。 例如：ImageMessage 、 或其他继承自 MediaMessageContent 的消息。
public abstract void sendMediaMessage(Message message, String pushContent, String pushData, IRongCallback.ISendMediaMessageCallbackWithUploader callback)
public abstract void sendMediaMessage(Message message, String pushContent, String pushData, SendMessageOption option, IRongCallback.ISendMediaMessageCallbackWithUploader callback)
发送多媒体消息，可以使用该方法将多媒体文件上传到自己的服务器。 上传多媒体文件时，会回调 onAttached 此回调中携带 IRongCallback.MediaMessageUploader 对象，使用者只需要调用此对象中的 update 更新进度 success 更新成功状态，并告知上传成功后的文件地址 error 更新失败状态 cancel ()} 更新取消状态
sendMessage
Link copied to clipboard
public abstract void sendMessage(Message message, String pushContent, String pushData, IRongCallback.ISendMessageCallback callback)
public abstract void sendMessage(Message message, String pushContent, String pushData, SendMessageOption option, IRongCallback.ISendMessageCallback callback)
发送消息。 通过 io.rong.imlib.IRongCallback.
public abstract void sendMessage(ConversationType type, String targetId, MessageContent content, String pushContent, String pushData, IRongCallback.ISendMessageCallback callback)
根据会话类型，发送消息。 通过 io.rong.imlib.IRongCallback.
sendPing
Link copied to clipboard
public abstract void sendPing()
OEM 实现心跳对齐，发送 Ping 接口 1.后台 WakeLock 心跳 2.
sendReadReceiptMessage
Link copied to clipboard
public abstract void sendReadReceiptMessage(ConversationType conversationType, String targetId, long timestamp)
发送某个会话中的消息阅读回执 使用 IMLib 可以注册监听 setReadReceiptListener；使用 IMkit 直接设置 rc_config.
public abstract void sendReadReceiptMessage(ConversationType conversationType, String targetId, long timestamp, IRongCallback.ISendMessageCallback callback)
发送某个会话中的消息阅读回执。 使用 IMLib 可以注册监听 setReadReceiptListener；使用 IMkit 直接设置 rc_config.
sendReadReceiptRequest
Link copied to clipboard
public abstract void sendReadReceiptRequest(Message message, RongIMClient.OperationCallback callback)
发起消息已读回执请求（只支持群组和讨论组）。 注意：只能对自己发送的消息发起消息已读回执请求。
sendReadReceiptResponse
Link copied to clipboard
public abstract void sendReadReceiptResponse(ConversationType type, String targetId, List<Message> messageList, RongIMClient.OperationCallback callback)
发送已读回执（只支持群组和讨论组）
sendTypingStatus
Link copied to clipboard
public abstract void sendTypingStatus(ConversationType conversationType, String targetId, String typingContentType)
向会话中发送正在输入的状态，目前只支持单聊。
setAppVer
Link copied to clipboard
public abstract void setAppVer(String appVer)
设置集成融云 SDK 的用户应用版本信息。 注意：需在 init 之后调用。
setChatRoomActionListener
Link copied to clipboard
public static void setChatRoomActionListener(RongIMClient.ChatRoomActionListener listener)
设置聊天室操作监听。 开发者可以通过设置监听，获取加入聊天室的状态回调。
setChatRoomEntry
Link copied to clipboard
public abstract void setChatRoomEntry(String chatRoomId, String key, String value, boolean sendNotification, boolean autoDelete, String notificationExtra, RongIMClient.OperationCallback callback)
设置聊天室自定义属性。 key 不存在，增加属性； key 已存在，只能更新当前用户设置的属性值。注意：必须先开通聊天室状态存储功能。
setConnectionStatusListener
Link copied to clipboard
public static void setConnectionStatusListener(RongIMClient.ConnectionStatusListener listener)
设置连接状态变化的监听器。 当回调的状态为 TOKEN_INCORRECT, 需要获取正确的token, 并主动调用connect。 如果使用 IMKit，使用 RongIM 中同名方法 `setConnectionStatusListener` 。 removeNotificationQuietHours
setConversationNotificationStatus
Link copied to clipboard
public abstract void setConversationNotificationStatus(ConversationType conversationType, String targetId, ConversationNotificationStatus notificationStatus, RongIMClient.ResultCallback<ConversationNotificationStatus> callback)
设置会话消息提醒状态。 注意：不支持聊天室！
setConversationStatusListener
Link copied to clipboard
public abstract void setConversationStatusListener(RongIMClient.ConversationStatusListener listener)
设置会话状态（置顶和免打扰）多端同步监听
setConversationToTop
Link copied to clipboard
public abstract void setConversationToTop(ConversationType conversationType, String id, boolean isTop, RongIMClient.ResultCallback<Boolean> callback)
设置会话的置顶状态。 会话置顶：设置此会话在会话列表的第一条（当有多个会话置顶时，按照设置时间排序，先设置的在前）。 例：依次设置 A、B、C 会话置顶，会话排序依次为 A、B、C。 会话不存在时设置置顶，会在会话列表生成会话；设置置顶之后删除会话，置顶设置自动失效。
public abstract void setConversationToTop(ConversationType conversationType, String id, boolean isTop, boolean needCreate, RongIMClient.ResultCallback<Boolean> callback)
设置会话的置顶状态。 若会话不存在，调用此方法 SDK 自动创建会话并置顶。
setCustomServiceHumanEvaluateListener
Link copied to clipboard
public abstract void setCustomServiceHumanEvaluateListener(OnHumanEvaluateListener listener)
设置人工评价监听。 当人工评价有标签等配置时，在回调中返回配置。
setDiscussionInviteStatus
Link copied to clipboard
public abstract void setDiscussionInviteStatus(String discussionId, RongIMClient.DiscussionInviteStatus status, RongIMClient.OperationCallback callback)
设置讨论组成员邀请权限。
setDiscussionName
Link copied to clipboard
public abstract void setDiscussionName(String discussionId, String name, RongIMClient.OperationCallback callback)
设置讨论组名称。
setKVStatusListener
Link copied to clipboard
public abstract void setKVStatusListener(RongIMClient.KVStatusListener listener)
设置聊天室 KV 状态变化的监听
setMessageBlockListener
Link copied to clipboard
public abstract void setMessageBlockListener(MessageBlockListener listener)
设置发送含有敏感词消息被拦截的监听
setMessageExpansionListener
Link copied to clipboard
public abstract void setMessageExpansionListener(RongIMClient.MessageExpansionListener listener)
设置消息扩展监听
setMessageExtra
Link copied to clipboard
public abstract void setMessageExtra(int messageId, String value, RongIMClient.ResultCallback<Boolean> callback)
设置本地消息的附加信息。 用于扩展消息的使用场景。设置后可以通过 getHistoryMessages 取出带附加信息的消息。注意：只能用于本地使用，无法同步给远程用户。
setMessageReadTime
Link copied to clipboard
public abstract void setMessageReadTime(long messageId, long timestamp, RongIMClient.OperationCallback callback)
设置消息已读时间。
setMessageReceivedStatus
Link copied to clipboard
public abstract void setMessageReceivedStatus(int messageId, ReceivedStatus receivedStatus, RongIMClient.ResultCallback<Boolean> callback)
设置消息接收状态。
setMessageSentStatus
Link copied to clipboard
public abstract void setMessageSentStatus(Message message, RongIMClient.ResultCallback<Boolean> callback)
设置消息发送状态。
setNotificationQuietHours
Link copied to clipboard
public abstract void setNotificationQuietHours(String startTime, int spanMinutes, RongIMClient.OperationCallback callback)
设置消息通知免打扰时间。
setOfflineMessageDuration
Link copied to clipboard
public abstract void setOfflineMessageDuration(int duration, RongIMClient.ResultCallback<Long> callback)
设置离线消息在服务端的存储时间（以天为单位）。 注意：该功能需要客户提工单，在服务端开通此功能后，客户端调用该方法才生效。
setOnRecallMessageListener
Link copied to clipboard
public static void setOnRecallMessageListener(RongIMClient.OnRecallMessageListener listener)
设置撤回消息监听器
setOnReceiveDestructionMessageListener
Link copied to clipboard
public abstract void setOnReceiveDestructionMessageListener(RongIMClient.OnReceiveDestructionMessageListener listener)
设置阅后即焚消息接收监听器
setOnReceiveMessageListener
Link copied to clipboard
@Deprecated()
public static void setOnReceiveMessageListener(OnReceiveMessageListener listener)
设置接收消息事件的监听器。 注意:建议设置应用生命周期的全局监听器。
setProxy
Link copied to clipboard
public abstract boolean setProxy(RCIMProxy proxy)
setPushContentShowStatus
Link copied to clipboard
public abstract void setPushContentShowStatus(boolean showStatus, RongIMClient.OperationCallback callback)
设置是否显示远程推送内容详情。 注意：此功能需要从服务端开启用户设置功能。
setPushLanguage
Link copied to clipboard
public abstract void setPushLanguage(RongIMClient.PushLanguage language, RongIMClient.OperationCallback callback)
设置远程推送语言，目前支持中文和英文。 注意：此功能需要从服务端开启用户设置功能。
setPushLanguageCode
Link copied to clipboard
public abstract void setPushLanguageCode(String language, RongIMClient.OperationCallback callback)
设置推送内容的自然语言。
setPushReceiveStatus
Link copied to clipboard
public abstract void setPushReceiveStatus(boolean receiveStatus, RongIMClient.OperationCallback callback)
设置是否接收远程推送。 前提：移动端未在线，Web 、MAC/PC 终端在线，移动端是否接收远程推送。注意：此功能需要从服务端开启用户设置功能。
setRCLogInfoListener
Link copied to clipboard
public static void setRCLogInfoListener(RongIMClient.RCLogInfoListener listener)
设置 Log 输出监听。 注意：需要在 connect 之前调用！
setReadReceiptListener
Link copied to clipboard
public static void setReadReceiptListener(RongIMClient.ReadReceiptListener listener)
设置消息回执监听器。 当收到消息回执时回调 onReadReceiptReceived。
setReconnectKickEnable
Link copied to clipboard
public abstract void setReconnectKickEnable(boolean enable)
设置断线重连时是否踢出重连设备。 用户没有开通多设备登录功能的前提下，同一个账号在一台新设备上登录的时候，会把这个账号在之前登录的设备上踢出。 由于 SDK 有断线重连功能，存在下面情况： 用户在 A 设备登录，A 设备网络不稳定，没有连接成功，SDK 启动重连机制。 用户此时又在 B 设备登录，B 设备连接成功。 A 设备网络稳定之后，用户在 A 设备连接成功，B 设备被踢出。 这个接口就是为这种情况加的。 设置 enable 为 `true` 时，SDK 重连的时候发现此时已有别的设备连接成功，不再强行踢出已有设备，而是踢出重连设备。 此方法需要在 init之前调用。
setRLogFileMaxSize
Link copied to clipboard
public abstract void setRLogFileMaxSize(long pSize)
设置业务日志文件大小，默认 1M。 接口及时生效，超过设置大小压缩成 zip 文件存放到本地。
setRLogLevel
Link copied to clipboard
public abstract void setRLogLevel(int pLevel)
设置业务日志写文件等级。 接口及时生效。
setServerInfo
Link copied to clipboard
public static void setServerInfo(String naviServer, String fileServer)
设置私有部署的导航服务器和媒体服务器地址。 可以支持设置 http://cn.xxx.com 或 https://cn.xxx.com 或 cn.xxx.com， 如果设置成 cn.xxx.
setStatisticDomain
Link copied to clipboard
public static void setStatisticDomain(String domain)
配置数据上传地址 （非必须）。 配置此地址，SDK 会在初始化时把设备相关信息上传到私有云节点。影响到的功能是开发者后台的广播推送功能，如果私有云客户没有配置该地址，那从后台发推送时，客户端是收不到的。普通的 IM 推送不受影响。 设置数据上传服务器地址。 可以支持设置 http://cn.xxx.com 或者 https://cn.xxx.com 或者 cn.xxx.com。 如果设置成 cn.xxx.
setSyncConversationReadStatusListener
Link copied to clipboard
public abstract void setSyncConversationReadStatusListener(RongIMClient.SyncConversationReadStatusListener listener)
设置多端同步会话阅读状态监听。
setTypingStatusListener
Link copied to clipboard
public static void setTypingStatusListener(RongIMClient.TypingStatusListener listener)
设置输入状态监听器。 当输入状态发生变化时，回调 onTypingStatusChanged。 对于单聊而言，当对方正在输入时，监听会触发一次；当对方不处于输入状态时，该监听还会触发一次，但回调里输入用户列表为空。
setUploadCallback
Link copied to clipboard
public abstract void setUploadCallback(UploadCallback pCallback)
设置上传 RLog 日志到服务器的回调
startCustomService
Link copied to clipboard
public abstract void startCustomService(String kefuId, ICustomServiceListener listener, CSCustomServiceInfo customServiceInfo)
启动客服服务。
startRealTimeLocation
Link copied to clipboard
public abstract RealTimeLocationErrorCode startRealTimeLocation(ConversationType conversationType, String targetId)
发起位置共享。
stopCustomService
Link copied to clipboard
public abstract void stopCustomService(String kefuId)
退出客服服务。
stopDestructMessage
Link copied to clipboard
public abstract void stopDestructMessage(Message message)
取消焚烧消息，仅支持单聊。
subscribePublicService
Link copied to clipboard
public abstract void subscribePublicService(PublicServiceType publicServiceType, String publicServiceId, RongIMClient.OperationCallback callback)
订阅公众号。
supportResumeBrokenTransfer
Link copied to clipboard
public abstract void supportResumeBrokenTransfer(String url, RongIMClient.ResultCallback<Boolean> callback)
判断是否支持断点续传。
switchAppKey
Link copied to clipboard
public abstract void switchAppKey(String appKey)
切换 appKey。 当一个应用对应多个环境， 即多个 appKey 时， 调用此方法实现融云 SDK 热切换。 注意: 调用此方法后, 还需要再次调用 init 和 connect,传入新 appKey 对应的 token，重新初始化和连接。
switchToHumanMode
Link copied to clipboard
public abstract void switchToHumanMode(String kefuId)
切换到人工客服模式。 切换的结果需要在 onModeChanged 方法回调中处理。 如果客服没有分组， 则直接切人工模式；如果客服有分组，那么需要在回调onSelectGroup 中去弹出分组选择窗口并选择分组，之后在这个回调中调用 selectCustomServiceGroup 根据客服 id 和 分组 id 切换到人工模式。 客服模式 io.rong.imlib.cs.model.
syncConversationReadStatus
Link copied to clipboard
public abstract void syncConversationReadStatus(ConversationType type, String targetId, long timestamp, RongIMClient.OperationCallback callback)
同步会话阅读状态。
testProxy
Link copied to clipboard
public abstract void testProxy(RCIMProxy proxy, String testHost, RongIMClient.Callback callback)
unsubscribePublicService
Link copied to clipboard
public abstract void unsubscribePublicService(PublicServiceType publicServiceType, String publicServiceId, RongIMClient.OperationCallback callback)
取消订阅公众号。
updateConversationInfo
Link copied to clipboard
public abstract void updateConversationInfo(ConversationType conversationType, String targetId, String title, String portrait, RongIMClient.ResultCallback callback)
更新会话信息。
updateMessageExpansion
Link copied to clipboard
public abstract void updateMessageExpansion(Map<String, String> expansion, String messageUId, RongIMClient.OperationCallback callback)
更新消息扩展信息 每条消息携带扩展信息键值对最大值 300个，单次设置扩展信息键值对最大值 20个
updateRealTimeLocationStatus
Link copied to clipboard
public abstract void updateRealTimeLocationStatus(ConversationType conversationType, String targetId, double latitude, double longitude, RealTimeLocationType realTimeLocationType)
更新位置共享信息。
uploadRLog
Link copied to clipboard
public abstract void uploadRLog()
上传 RLog 日志 在 connect 成功后调用