融云 Unity IM SDK 5.X
cn_rongcloud_im_unity.RCIMEngine类 参考abstract

Public 成员函数

delegate void OnGetMessageDelegate (RCIMMessage message)
 
virtual void destroy ()
 销毁引擎 更多...
 
abstract void getMessageById (int messageId, OnGetMessageDelegate onGetMessage)
 根据消息 id 获取消息体(本地数据库索引唯一值)。 更多...
 
abstract void getMessageByUId (String messageUId, OnGetMessageDelegate onGetMessage)
 通过全局唯一 id 获取消息实体。 更多...
 
abstract int connect (string token, int timeout)
 连接融云服务器,在整个应用程序全局,只需要调用一次。调用此接口返回非业务错误码时,SDK 会启动重连机制进行重连;如果仍没有连接成功,会在设备网络状态变化时再次进行重连 更多...
 
abstract int disconnect (bool receivePush)
 断开链接。注:因为 SDK 在前后台切换或者网络出现异常都会自动重连,保证连接可靠性。 所以除非您的 App 逻辑需要登出,否则一般不需要调用此方法进行手动断开 更多...
 
abstract RCIMTextMessage createTextMessage (RCIMConversationType type, string targetId, string channelId, string text)
 构建文本消息 更多...
 
abstract RCIMImageMessage createImageMessage (RCIMConversationType type, string targetId, string channelId, string path)
 构建图片消息 更多...
 
abstract RCIMFileMessage createFileMessage (RCIMConversationType type, string targetId, string channelId, string path)
 构建文件消息 更多...
 
abstract RCIMSightMessage createSightMessage (RCIMConversationType type, string targetId, string channelId, string path, int duration)
 构建小视频消息 更多...
 
abstract RCIMVoiceMessage createVoiceMessage (RCIMConversationType type, string targetId, string channelId, string path, int duration)
 构建语音消息 (高清语音) 更多...
 
abstract RCIMReferenceMessage createReferenceMessage (RCIMConversationType type, string targetId, string channelId, RCIMMessage referenceMessage, string text)
 构建引用消息 更多...
 
abstract RCIMGIFMessage createGIFMessage (RCIMConversationType type, string targetId, string channelId, string path)
 构建 GIF 消息 更多...
 
abstract RCIMCustomMessage createCustomMessage (RCIMConversationType type, string targetId, string channelId, RCIMCustomMessagePolicy policy, string messageIdentifier, Dictionary< string, string > fields)
 构建自定义消息 更多...
 
abstract RCIMLocationMessage createLocationMessage (RCIMConversationType type, string targetId, string channelId, double longitude, double latitude, string poiName, string thumbnailPath)
 构建位置消息 更多...
 
abstract int sendMessage (RCIMMessage message)
 发送普通消息 更多...
 
abstract int sendMediaMessage (RCIMMediaMessage message)
 发送媒体消息 更多...
 
abstract int cancelSendingMediaMessage (RCIMMediaMessage message)
 取消发送媒体消息 更多...
 
abstract int downloadMediaMessage (RCIMMediaMessage message)
 下载媒体消息 更多...
 
abstract int cancelDownloadingMediaMessage (RCIMMediaMessage message)
 取消下载媒体消息 更多...
 
abstract int loadConversation (RCIMConversationType type, string targetId, string channelId)
 加载某个会话 更多...
 
abstract int loadConversations (List< RCIMConversationType > conversationTypes, string channelId, long startTime, int count)
 加载某些会话 更多...
 
abstract int removeConversation (RCIMConversationType type, string targetId, string channelId)
 移除某个会话 更多...
 
abstract int removeConversations (List< RCIMConversationType > conversationTypes, string channelId)
 根据会话类型移除会话 更多...
 
abstract int loadUnreadCount (RCIMConversationType type, string targetId, string channelId)
 加载某个会话的未读数。注:不支持聊天室! 更多...
 
abstract int loadTotalUnreadCount (string channelId)
 加载所有未读数 更多...
 
abstract int loadUnreadMentionedCount (RCIMConversationType type, string targetId, string channelId)
 获取会话中未读的 @ 消息。注:不支持聊天室! 更多...
 
abstract int loadUltraGroupAllUnreadCount ()
 获取当前用户加入的所有超级群会话的未读消息数的总和 更多...
 
abstract int loadUltraGroupAllUnreadMentionedCount ()
 获取当前用户加入的所有超级群会话中的未读 @ 消息数的总和 更多...
 
abstract int loadUltraGroupUnreadCount (string targetId)
 获取指定会话的未读消息数 更多...
 
abstract int loadUltraGroupUnreadMentionedCount (string targetId)
 获取超级群会话中被 @ 的消息数 更多...
 
abstract int loadUnreadCountByConversationTypes (List< RCIMConversationType > conversationTypes, string channelId, bool contain)
 根据会话类型加载未读数。注:不支持聊天室! 更多...
 
abstract int clearUnreadCount (RCIMConversationType type, string targetId, string channelId, long timestamp)
 清除某个会话中的未读消息数。注:不支持聊天室! 更多...
 
abstract int saveDraftMessage (RCIMConversationType type, string targetId, string channelId, string draft)
 保存会话草稿信息 更多...
 
abstract int loadDraftMessage (RCIMConversationType type, string targetId, string channelId)
 获取会话中的草稿信息 更多...
 
abstract int clearDraftMessage (RCIMConversationType type, string targetId, string channelId)
 删除指定会话中的草稿信息 更多...
 
abstract int loadBlockedConversations (List< RCIMConversationType > conversationTypes, string channelId)
 获取免打扰的会话列表 更多...
 
abstract int changeConversationTopStatus (RCIMConversationType type, string targetId, string channelId, bool top)
 设置会话的置顶状态。若会话不存在,调用此方法 SDK 自动创建会话并置顶 更多...
 
abstract int loadConversationTopStatus (RCIMConversationType type, string targetId, string channelId)
 获取会话的置顶状态 更多...
 
abstract int syncConversationReadStatus (RCIMConversationType type, string targetId, string channelId, long timestamp)
 同步会话阅读状态 更多...
 
abstract int sendTypingStatus (RCIMConversationType type, string targetId, string channelId, string currentType)
 向会话中发送正在输入的状态,目前只支持单聊 更多...
 
abstract int loadMessages (RCIMConversationType type, string targetId, string channelId, long sentTime, RCIMTimeOrder order, RCIMMessageOperationPolicy policy, int count)
 加载历史消息 更多...
 
abstract int loadFirstUnreadMessage (RCIMConversationType type, string targetId, string channelId)
 获取第一条未读消息 更多...
 
abstract int loadUnreadMentionedMessages (RCIMConversationType type, string targetId, string channelId)
 获取会话中未读的 @ 消息 更多...
 
abstract int insertMessage (RCIMMessage message)
 插入一条消息 更多...
 
abstract int insertMessages (List< RCIMMessage > messages)
 插入多条消息,不支持超级群 更多...
 
abstract int clearMessages (RCIMConversationType type, string targetId, string channelId, long timestamp, RCIMMessageOperationPolicy policy)
 
abstract int deleteLocalMessages (List< RCIMMessage > messages)
 
abstract int deleteMessages (RCIMConversationType type, string targetId, string channelId, List< RCIMMessage > messages)
 
abstract int recallMessage (RCIMMessage message)
 
abstract int sendPrivateReadReceiptMessage (string targetId, string channelId, long timestamp)
 发送某个会话中的消息阅读回执 更多...
 
abstract int sendGroupReadReceiptRequest (RCIMMessage message)
 发起消息已读回执请求 更多...
 
abstract int sendGroupReadReceiptResponse (string targetId, string channelId, List< RCIMMessage > messages)
 发送已读回执 更多...
 
abstract int updateMessageExpansion (string messageUId, Dictionary< string, string > expansion)
 更新消息扩展信息。每条消息携带扩展信息键值对最大值 300个,单次设置扩展信息键值对最大值 20个 更多...
 
abstract int removeMessageExpansionForKeys (string messageUId, List< string > keys)
 删除消息扩展信息中特定的键值对 更多...
 
abstract int changeMessageSentStatus (int messageId, RCIMSentStatus sentStatus)
 设置消息发送状态 更多...
 
abstract int changeMessageReceiveStatus (int messageId, RCIMReceivedStatus receivedStatus)
 
abstract int joinChatRoom (string targetId, int messageCount, bool autoCreate)
 加入聊天室 更多...
 
abstract int leaveChatRoom (string targetId)
 退出聊天室 更多...
 
abstract int loadChatRoomMessages (string targetId, long timestamp, RCIMTimeOrder order, int count)
 获取聊天室历史消息记录。注:必须先开通聊天室消息云存储功能 更多...
 
abstract int addChatRoomEntry (string targetId, string key, string value, bool deleteWhenLeft, bool overwrite)
 设置聊天室自定义属性 更多...
 
abstract int addChatRoomEntries (string targetId, Dictionary< string, string > entries, bool deleteWhenLeft, bool overwrite)
 批量设置聊天室自定义属性 更多...
 
abstract int loadChatRoomEntry (string targetId, string key)
 获取聊天室单个属性 更多...
 
abstract int loadAllChatRoomEntries (string targetId)
 获取聊天室所有属性 更多...
 
abstract int removeChatRoomEntry (string targetId, string key, bool force)
 删除聊天室自定义属性 更多...
 
abstract int removeChatRoomEntries (string targetId, List< string > keys, bool force)
 批量删除聊天室自定义属性 更多...
 
abstract int addToBlacklist (string userId)
 将某个用户加入黑名单。当你把对方加入黑名单后,对方再发消息时,就会提示“已被加入黑名单,消息发送失败”。 但你依然可以发消息个对方 更多...
 
abstract int removeFromBlacklist (string userId)
 将某个用户从黑名单中移出 更多...
 
abstract int loadBlacklistStatus (string userId)
 获取某用户是否在黑名单中 更多...
 
abstract int loadBlacklist ()
 获取当前用户设置的黑名单列表 更多...
 
abstract int searchMessages (RCIMConversationType type, string targetId, string channelId, string keyword, long startTime, int count)
 根据关键字搜索指定会话中的消息 更多...
 
abstract int searchMessagesByTimeRange (RCIMConversationType type, string targetId, string channelId, string keyword, long startTime, long endTime, int offset, int count)
 根据关键字搜索指定会话中某个时间段的消息 更多...
 
abstract int searchMessagesByUserId (string userId, RCIMConversationType type, string targetId, string channelId, long startTime, int count)
 根据用户 id 搜索指定会话中的消息 更多...
 
abstract int searchConversations (List< RCIMConversationType > conversationTypes, string channelId, List< RCIMMessageType > messageTypes, string keyword)
 根据关键字搜索会话 更多...
 
abstract int changeNotificationQuietHours (string startTime, int spanMins, RCIMPushNotificationQuietHoursLevel level)
 屏蔽某个时间段的消息提醒 更多...
 
abstract int removeNotificationQuietHours ()
 删除已设置的全局时间段消息提醒屏蔽 更多...
 
abstract int loadNotificationQuietHours ()
 查询已设置的时间段消息提醒屏蔽 更多...
 
abstract int changeConversationNotificationLevel (RCIMConversationType type, string targetId, string channelId, RCIMPushNotificationLevel level)
 设置会话的消息提醒状态。注:超级群调用该接口,channelId 为空时,相当于设置了 channelId 为空的频道的免打扰,不会屏蔽整个超级群会话下所有频道的免打扰 更多...
 
abstract int loadConversationNotificationLevel (RCIMConversationType type, string targetId, string channelId)
 获取会话的消息提醒状态 更多...
 
abstract int changeConversationTypeNotificationLevel (RCIMConversationType type, RCIMPushNotificationLevel level)
 设置会话类型的消息提醒状态。注:如要移除消息提醒状态,设置level为RCIMIWPushNotificationLevelDefault 更多...
 
abstract int loadConversationTypeNotificationLevel (RCIMConversationType type)
 获取会话类型的消息提醒状态 更多...
 
abstract int changeUltraGroupDefaultNotificationLevel (string targetId, RCIMPushNotificationLevel level)
 设置超级群的默认消息状态。一般由管理员设置的接口,针对超级群的所有群成员生效,针对超级群下所有频道生效,优先级较低。如果群成员自己超级群的免打扰级别,那么以群成员自己设置的为准 更多...
 
abstract int loadUltraGroupDefaultNotificationLevel (string targetId)
 获取超级群的默认消息状态 更多...
 
abstract int changeUltraGroupChannelDefaultNotificationLevel (string targetId, string channelId, RCIMPushNotificationLevel level)
 设置超级群频道的默认消息状态 更多...
 
abstract int loadUltraGroupChannelDefaultNotificationLevel (string targetId, string channelId)
 获取超级群频道的默认消息状态 更多...
 
abstract int changePushContentShowStatus (bool showContent)
 设置是否显示远程推送内容详情,此功能需要从服务端开启用户设置功能 更多...
 
abstract int changePushLanguage (string language)
 设置推送语言 更多...
 
abstract int changePushReceiveStatus (bool receive)
 设置是否接收远程推送。前提:移动端未在线,Web 、MAC/PC 终端在线,移动端是否接收远程推送。此功能需要从服务端开启用户设置功能 更多...
 
abstract int sendGroupMessageToDesignatedUsers (RCIMMessage message, List< string > userIds)
 给指定的群成员发送消息 更多...
 
abstract int loadMessageCount (RCIMConversationType type, string targetId, string channelId)
 获取指定会话的消息总数 更多...
 
abstract int loadTopConversations (List< RCIMConversationType > conversationTypes, string channelId)
 根据会话类型,获取置顶会话列表 更多...
 
abstract int syncUltraGroupReadStatus (string targetId, string channelId, long timestamp)
 上报超级群的已读时间 更多...
 
abstract int loadConversationsForAllChannel (RCIMConversationType type, string targetId)
 获取特定会话下所有频道的会话列表,只支持超级群 更多...
 
abstract int modifyUltraGroupMessage (string messageUId, RCIMMessage message)
 修改消息 更多...
 
abstract int recallUltraGroupMessage (RCIMMessage message, bool deleteRemote)
 撤回超级群消息 更多...
 
abstract int clearUltraGroupMessages (string targetId, string channelId, long timestamp, RCIMMessageOperationPolicy policy)
 删除本地特定 channel 特点时间之前的消息 更多...
 
abstract int sendUltraGroupTypingStatus (string targetId, string channelId, RCIMUltraGroupTypingStatus typingStatus)
 发送超级群输入状态 更多...
 
abstract int clearUltraGroupMessagesForAllChannel (string targetId, long timestamp)
 删除本地所有 channel 特定时间之前的消息 更多...
 
abstract int loadBatchRemoteUltraGroupMessages (List< RCIMMessage > messages)
 从服务获取批量消息 更多...
 
abstract int updateUltraGroupMessageExpansion (string messageUId, Dictionary< string, string > expansion)
 更新超级群消息扩展信息 更多...
 
abstract int removeUltraGroupMessageExpansion (string messageUId, List< string > keys)
 删除超级群消息扩展信息中特定的键值对 更多...
 
abstract int changeLogLevel (RCIMLogLevel level)
 修改日志等级 更多...
 

静态 Public 成员函数

static RCIMEngine create (string appKey, RCIMEngineOptions options=null)
 创建接口引擎 更多...
 

Protected 成员函数

 RCIMEngine ()
 

属性

OnMessageReceivedDelegate onMessageReceived [get, set]
 收到消息的监听 更多...
 
OnConnectionStatusChangedDelegate onConnectionStatusChanged [get, set]
 网络状态变化 更多...
 
OnConversationTopStatusSyncedDelegate onConversationTopStatusSynced [get, set]
 会话状态置顶多端同步监听 更多...
 
OnRemoteMessageRecalledDelegate onRemoteMessageRecalled [get, set]
 撤回消息监听器 更多...
 
OnPrivateReadReceiptReceivedDelegate onPrivateReadReceiptReceived [get, set]
 单聊中收到消息回执的回调 更多...
 
OnRemoteMessageExpansionUpdatedDelegate onRemoteMessageExpansionUpdated [get, set]
 消息扩展信息更改的回调 更多...
 
OnRemoteMessageExpansionForKeyRemovedDelegate onRemoteMessageExpansionForKeyRemoved [get, set]
 消息扩展信息删除的回调 更多...
 
OnChatRoomMemberChangedDelegate onChatRoomMemberChanged [get, set]
 聊天室用户进入、退出聊天室监听 更多...
 
OnTypingStatusChangedDelegate onTypingStatusChanged [get, set]
 会话输入状态发生变化。对于单聊而言,当对方正在输入时,监听会触发一次;当对方不处于输入状态时,该监听还会触发一次,但回调里输入用户列表为空 更多...
 
OnConversationReadStatusSyncMessageReceivedDelegate onConversationReadStatusSyncMessageReceived [get, set]
 同步消息未读状态监听接口。多端登录,收到其它端清除某一会话未读数通知的时候 更多...
 
OnChatRoomEntriesSyncedDelegate onChatRoomEntriesSynced [get, set]
 聊天室 KV 同步完成的回调 更多...
 
OnChatRoomEntriesChangedDelegate onChatRoomEntriesChanged [get, set]
 聊天室 KV 发生变化的回调 更多...
 
OnRemoteUltraGroupMessageExpansionUpdatedDelegate onRemoteUltraGroupMessageExpansionUpdated [get, set]
 超级群消息 kv 被更新 更多...
 
OnRemoteUltraGroupMessageModifiedDelegate onRemoteUltraGroupMessageModified [get, set]
 超级群消息被更改 更多...
 
OnRemoteUltraGroupMessageRecalledDelegate onRemoteUltraGroupMessageRecalled [get, set]
 超级群消息被撤回 更多...
 
OnUltraGroupReadTimeReceivedDelegate onUltraGroupReadTimeReceived [get, set]
 超级群已读的监听 更多...
 
OnUltraGroupTypingStatusChangedDelegate onUltraGroupTypingStatusChanged [get, set]
 用户输入状态变化的回调。当客户端收到用户输入状态的变化时,会回调此接口,通知发生变化的会话以及当前正在输入的RCUltraGroupTypingStatusInfo列表 更多...
 
OnMessageBlockedDelegate onMessageBlocked [get, set]
 发送含有敏感词消息被拦截的回调 更多...
 
OnChatRoomStatusChangedDelegate onChatRoomStatusChanged [get, set]
 聊天室状态发生变化的监听 更多...
 
OnGroupMessageReadReceiptRequestReceivedDelegate onGroupMessageReadReceiptRequestReceived [get, set]
 收到群聊已读回执请求的监听 更多...
 
OnGroupMessageReadReceiptResponseReceivedDelegate onGroupMessageReadReceiptResponseReceived [get, set]
 收到群聊已读回执响应的监听 更多...
 
OnConnectedDelegate onConnected [get, set]
 connect 的接口监听,收到链接结果的回调 更多...
 
OnDatabaseOpenedDelegate onDatabaseOpened [get, set]
 connect 的接口监听,数据库打开时发生的回调 更多...
 
OnConversationLoadedDelegate onConversationLoaded [get, set]
 loadConversation 的接口监听 更多...
 
OnConversationsLoadedDelegate onConversationsLoaded [get, set]
 loadConversations 的接口监听 更多...
 
OnConversationRemovedDelegate onConversationRemoved [get, set]
 removeConversation 的接口监听 更多...
 
OnConversationsRemovedDelegate onConversationsRemoved [get, set]
 removeConversations 的接口监听 更多...
 
OnTotalUnreadCountLoadedDelegate onTotalUnreadCountLoaded [get, set]
 loadTotalUnreadCount 的接口监听 更多...
 
OnUnreadCountLoadedDelegate onUnreadCountLoaded [get, set]
 loadUnreadCount 的接口监听 更多...
 
OnUnreadCountByConversationTypesLoadedDelegate onUnreadCountByConversationTypesLoaded [get, set]
 loadUnreadCountByConversationTypes 的接口监听 更多...
 
OnUnreadMentionedCountLoadedDelegate onUnreadMentionedCountLoaded [get, set]
 loadUnreadMentionedCount 的接口监听 更多...
 
OnUltraGroupAllUnreadCountLoadedDelegate onUltraGroupAllUnreadCountLoaded [get, set]
 loadUltraGroupAllUnreadMentionedCount 的接口监听 更多...
 
OnUltraGroupAllUnreadMentionedCountLoadedDelegate onUltraGroupAllUnreadMentionedCountLoaded [get, set]
 loadUltraGroupAllUnreadMentionedCount 的接口监听 更多...
 
OnUnreadCountClearedDelegate onUnreadCountCleared [get, set]
 clearUnreadCount 的接口监听 更多...
 
OnDraftMessageSavedDelegate onDraftMessageSaved [get, set]
 saveDraftMessage 的接口监听 更多...
 
OnDraftMessageClearedDelegate onDraftMessageCleared [get, set]
 clearDraftMessage 的接口监听 更多...
 
OnDraftMessageLoadedDelegate onDraftMessageLoaded [get, set]
 loadDraftMessage 的接口监听 更多...
 
OnBlockedConversationsLoadedDelegate onBlockedConversationsLoaded [get, set]
 loadBlockedConversations 的接口监听 更多...
 
OnConversationTopStatusChangedDelegate onConversationTopStatusChanged [get, set]
 changeConversationTopStatus 的接口监听 更多...
 
OnConversationTopStatusLoadedDelegate onConversationTopStatusLoaded [get, set]
 loadConversationTopStatus 的接口监听 更多...
 
OnConversationReadStatusSyncedDelegate onConversationReadStatusSynced [get, set]
 syncConversationReadStatus 的接口监听 更多...
 
OnMessageAttachedDelegate onMessageAttached [get, set]
 sendMessage 的接口监听 更多...
 
OnMessageSentDelegate onMessageSent [get, set]
 sendMessage 的接口监听 更多...
 
OnMediaMessageAttachedDelegate onMediaMessageAttached [get, set]
 sendMediaMessage 的接口监听 更多...
 
OnMediaMessageSendingDelegate onMediaMessageSending [get, set]
 sendMediaMessage 的接口监听 更多...
 
OnSendingMediaMessageCanceledDelegate onSendingMediaMessageCanceled [get, set]
 cancelSendingMediaMessage 的接口监听 更多...
 
OnMediaMessageSentDelegate onMediaMessageSent [get, set]
 sendMediaMessage 的接口监听 更多...
 
OnMediaMessageDownloadingDelegate onMediaMessageDownloading [get, set]
 downloadMediaMessage 的接口监听 更多...
 
OnMediaMessageDownloadedDelegate onMediaMessageDownloaded [get, set]
 downloadMediaMessage 的接口监听 更多...
 
OnDownloadingMediaMessageCanceledDelegate onDownloadingMediaMessageCanceled [get, set]
 cancelDownloadingMediaMessage 的接口监听 更多...
 
OnMessagesLoadedDelegate onMessagesLoaded [get, set]
 loadMessages 的接口监听 更多...
 
OnUnreadMentionedMessagesLoadedDelegate onUnreadMentionedMessagesLoaded [get, set]
 loadUnreadMentionedMessages 的接口监听 更多...
 
OnFirstUnreadMessageLoadedDelegate onFirstUnreadMessageLoaded [get, set]
 loadFirstUnreadMessage 的接口监听 更多...
 
OnMessageInsertedDelegate onMessageInserted [get, set]
 insertMessage 的接口监听 更多...
 
OnMessagesInsertedDelegate onMessagesInserted [get, set]
 insertMessages 的接口监听 更多...
 
OnMessageClearedDelegate onMessageCleared [get, set]
 clearMessages 的接口监听 更多...
 
OnLocalMessagesDeletedDelegate onLocalMessagesDeleted [get, set]
 deleteLocalMessages 的接口监听 更多...
 
OnMessagesDeletedDelegate onMessagesDeleted [get, set]
 deleteMessages 的接口监听 更多...
 
OnMessageRecalledDelegate onMessageRecalled [get, set]
 recallMessage 的接口监听 更多...
 
OnPrivateReadReceiptMessageSentDelegate onPrivateReadReceiptMessageSent [get, set]
 sendPrivateReadReceiptMessage 的接口监听 更多...
 
OnMessageExpansionUpdatedDelegate onMessageExpansionUpdated [get, set]
 updateMessageExpansion 的接口监听 更多...
 
OnMessageExpansionForKeysRemovedDelegate onMessageExpansionForKeysRemoved [get, set]
 removeMessageExpansionForKeys 的接口监听 更多...
 
OnMessageReceiveStatusChangedDelegate onMessageReceiveStatusChanged [get, set]
 changeMessageReceiveStatus 的接口监听 更多...
 
OnMessageSentStatusChangedDelegate onMessageSentStatusChanged [get, set]
 changeMessageSentStatus 的接口监听 更多...
 
OnChatRoomJoinedDelegate onChatRoomJoined [get, set]
 joinChatRoom 的接口监听 更多...
 
OnChatRoomJoiningDelegate onChatRoomJoining [get, set]
 正在加入聊天室的回调 更多...
 
OnChatRoomLeftDelegate onChatRoomLeft [get, set]
 leaveChatRoom 的接口监听 更多...
 
OnChatRoomMessagesLoadedDelegate onChatRoomMessagesLoaded [get, set]
 loadChatRoomMessages 的接口监听 更多...
 
OnChatRoomEntryAddedDelegate onChatRoomEntryAdded [get, set]
 addChatRoomEntry 的接口监听 更多...
 
OnChatRoomEntriesAddedDelegate onChatRoomEntriesAdded [get, set]
 addChatRoomEntries 的接口监听 更多...
 
OnChatRoomEntryLoadedDelegate onChatRoomEntryLoaded [get, set]
 loadChatRoomEntry 的接口监听 更多...
 
OnAllChatRoomEntriesLoadedDelegate onAllChatRoomEntriesLoaded [get, set]
 loadAllChatRoomEntries 的接口监听 更多...
 
OnChatRoomEntryRemovedDelegate onChatRoomEntryRemoved [get, set]
 removeChatRoomEntry 的接口监听 更多...
 
OnChatRoomEntriesRemovedDelegate onChatRoomEntriesRemoved [get, set]
 removeChatRoomEntries 的接口监听 更多...
 
OnBlacklistAddedDelegate onBlacklistAdded [get, set]
 addToBlacklist 的接口监听 更多...
 
OnBlacklistRemovedDelegate onBlacklistRemoved [get, set]
 removeFromBlacklist 的接口监听 更多...
 
OnBlacklistStatusLoadedDelegate onBlacklistStatusLoaded [get, set]
 loadBlacklistStatus 的接口监听 更多...
 
OnBlacklistLoadedDelegate onBlacklistLoaded [get, set]
 loadBlacklist 的接口监听 更多...
 
OnMessagesSearchedDelegate onMessagesSearched [get, set]
 searchMessages 的接口监听 更多...
 
OnMessagesSearchedByTimeRangeDelegate onMessagesSearchedByTimeRange [get, set]
 searchMessagesByTimeRange 的接口监听 更多...
 
OnMessagesSearchedByUserIdDelegate onMessagesSearchedByUserId [get, set]
 searchMessagesByUserId 的接口监听 更多...
 
OnConversationsSearchedDelegate onConversationsSearched [get, set]
 searchConversations 的接口监听 更多...
 
OnGroupReadReceiptRequestSentDelegate onGroupReadReceiptRequestSent [get, set]
 sendGroupReadReceiptRequest 的接口监听 更多...
 
OnGroupReadReceiptResponseSentDelegate onGroupReadReceiptResponseSent [get, set]
 sendGroupReadReceiptResponse 的接口监听 更多...
 
OnNotificationQuietHoursChangedDelegate onNotificationQuietHoursChanged [get, set]
 changeNotificationQuietHours 的接口回调 更多...
 
OnNotificationQuietHoursRemovedDelegate onNotificationQuietHoursRemoved [get, set]
 removeNotificationQuietHours 的接口回调 更多...
 
OnNotificationQuietHoursLoadedDelegate onNotificationQuietHoursLoaded [get, set]
 loadNotificationQuietHours 的接口回调 更多...
 
OnConversationNotificationLevelChangedDelegate onConversationNotificationLevelChanged [get, set]
 changeConversationNotificationLevel 的接口回调 更多...
 
OnConversationNotificationLevelLoadedDelegate onConversationNotificationLevelLoaded [get, set]
 loadConversationNotificationLevel 的接口回调 更多...
 
OnConversationTypeNotificationLevelChangedDelegate onConversationTypeNotificationLevelChanged [get, set]
 changeConversationTypeNotificationLevel 的接口回调 更多...
 
OnConversationTypeNotificationLevelLoadedDelegate onConversationTypeNotificationLevelLoaded [get, set]
 loadConversationTypeNotificationLevel 的接口回调 更多...
 
OnUltraGroupDefaultNotificationLevelChangedDelegate onUltraGroupDefaultNotificationLevelChanged [get, set]
 changeUltraGroupDefaultNotificationLevel 的接口回调 更多...
 
OnUltraGroupDefaultNotificationLevelLoadedDelegate onUltraGroupDefaultNotificationLevelLoaded [get, set]
 loadUltraGroupDefaultNotificationLevel 的接口回调 更多...
 
OnUltraGroupChannelDefaultNotificationLevelChangedDelegate onUltraGroupChannelDefaultNotificationLevelChanged [get, set]
 changeUltraGroupChannelDefaultNotificationLevel 的接口回调 更多...
 
OnUltraGroupChannelDefaultNotificationLevelLoadedDelegate onUltraGroupChannelDefaultNotificationLevelLoaded [get, set]
 loadUltraGroupChannelDefaultNotificationLevel 的接口回调 更多...
 
OnPushContentShowStatusChangedDelegate onPushContentShowStatusChanged [get, set]
 changePushContentShowStatus 的接口监听 更多...
 
OnPushLanguageChangedDelegate onPushLanguageChanged [get, set]
 changePushLanguage 的接口监听 更多...
 
OnPushReceiveStatusChangedDelegate onPushReceiveStatusChanged [get, set]
 changePushReceiveStatus 的接口监听 更多...
 
OnMessageCountLoadedDelegate onMessageCountLoaded [get, set]
 loadMessageCount 的接口监听 更多...
 
OnTopConversationsLoadedDelegate onTopConversationsLoaded [get, set]
 
OnGroupMessageToDesignatedUsersAttachedDelegate onGroupMessageToDesignatedUsersAttached [get, set]
 sendGroupMessageToDesignatedUsers 的接口回调。消息存入数据库的回调 更多...
 
OnGroupMessageToDesignatedUsersSentDelegate onGroupMessageToDesignatedUsersSent [get, set]
 sendGroupMessageToDesignatedUsers 的接口回调。消息发送完成的回调 更多...
 
OnUltraGroupReadStatusSyncedDelegate onUltraGroupReadStatusSynced [get, set]
 syncUltraGroupReadStatus 的接口监听 更多...
 
OnConversationsLoadedForAllChannelDelegate onConversationsLoadedForAllChannel [get, set]
 loadConversationsForAllChannel 的接口监听 更多...
 
OnUltraGroupUnreadMentionedCountLoadedDelegate onUltraGroupUnreadMentionedCountLoaded [get, set]
 loadUltraGroupUnreadMentionedCount 的接口监听 更多...
 
OnUltraGroupUnreadCountLoadedDelegate onUltraGroupUnreadCountLoaded [get, set]
 
OnUltraGroupMessageModifiedDelegate onUltraGroupMessageModified [get, set]
 modifyUltraGroupMessage 的接口监听 更多...
 
OnUltraGroupMessageRecalledDelegate onUltraGroupMessageRecalled [get, set]
 recallUltraGroupMessage 的接口监听 更多...
 
OnUltraGroupMessagesClearedDelegate onUltraGroupMessagesCleared [get, set]
 clearUltraGroupMessages 的接口监听 更多...
 
OnUltraGroupMessagesClearedForAllChannelDelegate onUltraGroupMessagesClearedForAllChannel [get, set]
 clearUltraGroupMessagesForAllChannel 的接口监听 更多...
 
OnUltraGroupTypingStatusSentDelegate onUltraGroupTypingStatusSent [get, set]
 sendUltraGroupTypingStatus 的接口监听 更多...
 
OnBatchRemoteUltraGroupMessagesLoadedDelegate onBatchRemoteUltraGroupMessagesLoaded [get, set]
 loadBatchRemoteUltraGroupMessages 的接口监听 更多...
 
OnUltraGroupMessageExpansionUpdatedDelegate onUltraGroupMessageExpansionUpdated [get, set]
 updateUltraGroupMessageExpansion 的接口监听 更多...
 
OnUltraGroupMessageExpansionRemovedDelegate onUltraGroupMessageExpansionRemoved [get, set]
 removeUltraGroupMessageExpansion 的接口监听 更多...
 

构造及析构函数说明

◆ RCIMEngine()

cn_rongcloud_im_unity.RCIMEngine.RCIMEngine ( )
protected

成员函数说明

◆ OnGetMessageDelegate()

delegate void cn_rongcloud_im_unity.RCIMEngine.OnGetMessageDelegate ( RCIMMessage  message)

◆ create()

static RCIMEngine cn_rongcloud_im_unity.RCIMEngine.create ( string  appKey,
RCIMEngineOptions  options = null 
)
static

创建接口引擎

参数
appKey开发者后台获取的 AppKey
options引擎配置项
返回

◆ destroy()

virtual void cn_rongcloud_im_unity.RCIMEngine.destroy ( )
virtual

销毁引擎

◆ getMessageById()

abstract void cn_rongcloud_im_unity.RCIMEngine.getMessageById ( int  messageId,
OnGetMessageDelegate  onGetMessage 
)
pure virtual

根据消息 id 获取消息体(本地数据库索引唯一值)。

参数
messageId消息的 messageId,可在消息对象中获取

◆ getMessageByUId()

abstract void cn_rongcloud_im_unity.RCIMEngine.getMessageByUId ( String  messageUId,
OnGetMessageDelegate  onGetMessage 
)
pure virtual

通过全局唯一 id 获取消息实体。

参数
messageUId消息的 messageUid,可在消息对象中获取,且只有发送成功的消息才会有值。

◆ connect()

abstract int cn_rongcloud_im_unity.RCIMEngine.connect ( string  token,
int  timeout 
)
pure virtual

连接融云服务器,在整个应用程序全局,只需要调用一次。调用此接口返回非业务错误码时,SDK 会启动重连机制进行重连;如果仍没有连接成功,会在设备网络状态变化时再次进行重连

参数
token调用 server api 获取到的 token
timeout连接超时时间,单位:秒。timeLimit <= 0,则 IM 将一直连接,直到连接成功或者无法连接(如 token 非法)。timeLimit > 0,则 IM 将最多连接 timeLimit 秒。如果在 timeLimit 秒内连接成功,后面再发生了网络变化或前后台切换,SDK 会自动重连; 如果在 timeLimit 秒无法连接成功则不再进行重连,通过 listener 告知连接超时,您需要再自行调用 connect 接口
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onConnected

接口回调可以监听

◆ disconnect()

abstract int cn_rongcloud_im_unity.RCIMEngine.disconnect ( bool  receivePush)
pure virtual

断开链接。注:因为 SDK 在前后台切换或者网络出现异常都会自动重连,保证连接可靠性。 所以除非您的 App 逻辑需要登出,否则一般不需要调用此方法进行手动断开

参数
receivePush退出后是否接收 push,true:断开后接收远程推送,false:断开后不再接收远程推送
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码

◆ createTextMessage()

abstract RCIMTextMessage cn_rongcloud_im_unity.RCIMEngine.createTextMessage ( RCIMConversationType  type,
string  targetId,
string  channelId,
string  text 
)
pure virtual

构建文本消息

参数
type会话类型,
targetId会话 ID
channelId频道 ID,仅支持超级群使用,其他会话类型传 null 即可
text文本内容
返回
文本消息实体

◆ createImageMessage()

abstract RCIMImageMessage cn_rongcloud_im_unity.RCIMEngine.createImageMessage ( RCIMConversationType  type,
string  targetId,
string  channelId,
string  path 
)
pure virtual

构建图片消息

参数
type会话类型
targetId会话 ID
channelId频道 ID,仅支持超级群使用,其他会话类型传 null 即可
path图片消息的本地路径,必须为有效路径
返回
图片消息实体

◆ createFileMessage()

abstract RCIMFileMessage cn_rongcloud_im_unity.RCIMEngine.createFileMessage ( RCIMConversationType  type,
string  targetId,
string  channelId,
string  path 
)
pure virtual

构建文件消息

参数
type会话类型
targetId会话 ID
channelId频道 ID,仅支持超级群使用,其他会话类型传 null 即可
path文件消息的本地路径,必须为有效路径
返回
文件消息实体

◆ createSightMessage()

abstract RCIMSightMessage cn_rongcloud_im_unity.RCIMEngine.createSightMessage ( RCIMConversationType  type,
string  targetId,
string  channelId,
string  path,
int  duration 
)
pure virtual

构建小视频消息

参数
type会话类型
targetId会话 ID
channelId频道 ID,仅支持超级群使用,其他会话类型传 null 即可
path小视频消息的本地路径,必须为有效路径
duration小视频消息的视频时长
返回
视频消息实体

◆ createVoiceMessage()

abstract RCIMVoiceMessage cn_rongcloud_im_unity.RCIMEngine.createVoiceMessage ( RCIMConversationType  type,
string  targetId,
string  channelId,
string  path,
int  duration 
)
pure virtual

构建语音消息 (高清语音)

参数
type会话类型
targetId会话 ID
channelId频道 ID,仅支持超级群使用,其他会话类型传 null 即可
path语音消息的本地路径,必须为有效路径
duration语音消息的消息时长
返回
语音消息的实体

◆ createReferenceMessage()

abstract RCIMReferenceMessage cn_rongcloud_im_unity.RCIMEngine.createReferenceMessage ( RCIMConversationType  type,
string  targetId,
string  channelId,
RCIMMessage  referenceMessage,
string  text 
)
pure virtual

构建引用消息

参数
type会话类型
targetId会话 ID
channelId频道 ID,仅支持超级群使用,其他会话类型传 null 即可
referenceMessage引用的消息
text引用的文本内容
返回
引用消息实体

◆ createGIFMessage()

abstract RCIMGIFMessage cn_rongcloud_im_unity.RCIMEngine.createGIFMessage ( RCIMConversationType  type,
string  targetId,
string  channelId,
string  path 
)
pure virtual

构建 GIF 消息

参数
type会话类型
targetId会话 ID
channelId频道 ID,仅支持超级群使用,其他会话类型传 null 即可
pathGIF 消息的本地路径
返回
GIF 消息实体

◆ createCustomMessage()

abstract RCIMCustomMessage cn_rongcloud_im_unity.RCIMEngine.createCustomMessage ( RCIMConversationType  type,
string  targetId,
string  channelId,
RCIMCustomMessagePolicy  policy,
string  messageIdentifier,
Dictionary< string, string >  fields 
)
pure virtual

构建自定义消息

参数
type会话类型
targetId会话 ID
channelId频道 ID,仅支持超级群使用,其他会话类型传 null 即可
policy消息的存储策略
messageIdentifier消息的标识符,需唯一
fields消息的内容键值对
返回
自定义消息实体

◆ createLocationMessage()

abstract RCIMLocationMessage cn_rongcloud_im_unity.RCIMEngine.createLocationMessage ( RCIMConversationType  type,
string  targetId,
string  channelId,
double  longitude,
double  latitude,
string  poiName,
string  thumbnailPath 
)
pure virtual

构建位置消息

参数
type会话类型
targetId会话 ID
channelId频道 ID,仅支持超级群使用,其他会话类型传 null 即可
longitude经度
latitude纬度
poiNamePOI 信息
thumbnailPath缩略图本地路径,必须为有效路径
返回
位置消息实体

◆ sendMessage()

abstract int cn_rongcloud_im_unity.RCIMEngine.sendMessage ( RCIMMessage  message)
pure virtual

发送普通消息

参数
message发送的消息实体
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onMessageAttached

接口回调可以监听

onMessageSent

◆ sendMediaMessage()

abstract int cn_rongcloud_im_unity.RCIMEngine.sendMediaMessage ( RCIMMediaMessage  message)
pure virtual

发送媒体消息

参数
message发送的媒体消息实体
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onMediaMessageSending

接口回调可以监听

onMediaMessageAttached onMediaMessageSent

◆ cancelSendingMediaMessage()

abstract int cn_rongcloud_im_unity.RCIMEngine.cancelSendingMediaMessage ( RCIMMediaMessage  message)
pure virtual

取消发送媒体消息

参数
message需要取消发送的媒体消息实体
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onSendingMediaMessageCanceled

接口回调可以监听

◆ downloadMediaMessage()

abstract int cn_rongcloud_im_unity.RCIMEngine.downloadMediaMessage ( RCIMMediaMessage  message)
pure virtual

下载媒体消息

参数
message需要下载的媒体消息实体
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onMediaMessageDownloaded

onMediaMessageDownloading

◆ cancelDownloadingMediaMessage()

abstract int cn_rongcloud_im_unity.RCIMEngine.cancelDownloadingMediaMessage ( RCIMMediaMessage  message)
pure virtual

取消下载媒体消息

参数
message需要取消下载的媒体消息实体
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onDownloadingMediaMessageCanceled

◆ loadConversation()

abstract int cn_rongcloud_im_unity.RCIMEngine.loadConversation ( RCIMConversationType  type,
string  targetId,
string  channelId 
)
pure virtual

加载某个会话

参数
type会话类型
targetId会话 ID
channelId频道 ID,仅支持超级群使用,其他会话类型传 null 即可
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onConversationLoaded

◆ loadConversations()

abstract int cn_rongcloud_im_unity.RCIMEngine.loadConversations ( List< RCIMConversationType conversationTypes,
string  channelId,
long  startTime,
int  count 
)
pure virtual

加载某些会话

参数
conversationTypes会话类型
channelId频道 ID,仅支持超级群使用,其他会话类型传 null 即可
startTime时间戳(毫秒),获取小于此时间戳的会话,传 0 为查询最新数据
count查询的数量, 0 < count <= 50
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onConversationsLoaded

◆ removeConversation()

abstract int cn_rongcloud_im_unity.RCIMEngine.removeConversation ( RCIMConversationType  type,
string  targetId,
string  channelId 
)
pure virtual

移除某个会话

参数
type会话类型
targetId会话 ID
channelId频道 ID,仅支持超级群使用,其他会话类型传 null 即可
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onConversationRemoved

◆ removeConversations()

abstract int cn_rongcloud_im_unity.RCIMEngine.removeConversations ( List< RCIMConversationType conversationTypes,
string  channelId 
)
pure virtual

根据会话类型移除会话

参数
conversationTypes会话类型集合
channelId频道 ID,仅支持超级群使用,其他会话类型传 null 即可
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onConversationsRemoved

◆ loadUnreadCount()

abstract int cn_rongcloud_im_unity.RCIMEngine.loadUnreadCount ( RCIMConversationType  type,
string  targetId,
string  channelId 
)
pure virtual

加载某个会话的未读数。注:不支持聊天室!

参数
type会话类型
targetId会话 ID
channelId频道 ID,仅支持超级群使用,其他会话类型传 null 即可
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onUnreadCountLoaded

◆ loadTotalUnreadCount()

abstract int cn_rongcloud_im_unity.RCIMEngine.loadTotalUnreadCount ( string  channelId)
pure virtual

加载所有未读数

参数
channelId频道 ID,仅支持超级群使用,其他会话类型传 null 即可
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onTotalUnreadCountLoaded

◆ loadUnreadMentionedCount()

abstract int cn_rongcloud_im_unity.RCIMEngine.loadUnreadMentionedCount ( RCIMConversationType  type,
string  targetId,
string  channelId 
)
pure virtual

获取会话中未读的 @ 消息。注:不支持聊天室!

参数
type会话类型
targetId会话 ID
channelId频道 ID,仅支持超级群使用,其他会话类型传 null 即可
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onUnreadMentionedCountLoaded

◆ loadUltraGroupAllUnreadCount()

abstract int cn_rongcloud_im_unity.RCIMEngine.loadUltraGroupAllUnreadCount ( )
pure virtual

获取当前用户加入的所有超级群会话的未读消息数的总和

返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onUltraGroupAllUnreadCountLoaded

◆ loadUltraGroupAllUnreadMentionedCount()

abstract int cn_rongcloud_im_unity.RCIMEngine.loadUltraGroupAllUnreadMentionedCount ( )
pure virtual

获取当前用户加入的所有超级群会话中的未读 @ 消息数的总和

返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onUltraGroupAllUnreadMentionedCountLoaded

◆ loadUltraGroupUnreadCount()

abstract int cn_rongcloud_im_unity.RCIMEngine.loadUltraGroupUnreadCount ( string  targetId)
pure virtual

获取指定会话的未读消息数

参数
targetId会话 ID
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onUltraGroupUnreadCountLoaded

◆ loadUltraGroupUnreadMentionedCount()

abstract int cn_rongcloud_im_unity.RCIMEngine.loadUltraGroupUnreadMentionedCount ( string  targetId)
pure virtual

获取超级群会话中被 @ 的消息数

参数
targetId会话 ID
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onUltraGroupUnreadMentionedCountLoaded

◆ loadUnreadCountByConversationTypes()

abstract int cn_rongcloud_im_unity.RCIMEngine.loadUnreadCountByConversationTypes ( List< RCIMConversationType conversationTypes,
string  channelId,
bool  contain 
)
pure virtual

根据会话类型加载未读数。注:不支持聊天室!

参数
conversationTypes会话类型集合
channelId频道 ID,仅支持超级群使用,其他会话类型传 null 即可
contain是否包含免打扰消息的未读消息数
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onUnreadCountByConversationTypesLoaded

◆ clearUnreadCount()

abstract int cn_rongcloud_im_unity.RCIMEngine.clearUnreadCount ( RCIMConversationType  type,
string  targetId,
string  channelId,
long  timestamp 
)
pure virtual

清除某个会话中的未读消息数。注:不支持聊天室!

参数
type会话类型
targetId会话 ID
channelId频道 ID,仅支持超级群使用,其他会话类型传 null 即可
timestamp该会话已阅读的最后一条消息的发送时间戳,传 0 代表清除所有未读
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onUnreadCountCleared

◆ saveDraftMessage()

abstract int cn_rongcloud_im_unity.RCIMEngine.saveDraftMessage ( RCIMConversationType  type,
string  targetId,
string  channelId,
string  draft 
)
pure virtual

保存会话草稿信息

参数
type会话类型
targetId会话 ID
channelId频道 ID,仅支持超级群使用,其他会话类型传 null 即可
draft草稿的文字内容
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onDraftMessageSaved

◆ loadDraftMessage()

abstract int cn_rongcloud_im_unity.RCIMEngine.loadDraftMessage ( RCIMConversationType  type,
string  targetId,
string  channelId 
)
pure virtual

获取会话中的草稿信息

参数
type会话类型
targetId会话 ID
channelId频道 ID,仅支持超级群使用,其他会话类型传 null 即可
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onDraftMessageLoaded

◆ clearDraftMessage()

abstract int cn_rongcloud_im_unity.RCIMEngine.clearDraftMessage ( RCIMConversationType  type,
string  targetId,
string  channelId 
)
pure virtual

删除指定会话中的草稿信息

参数
type会话类型
targetId会话 ID
channelId频道 ID,仅支持超级群使用,其他会话类型传 null 即可
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onDraftMessageCleared

◆ loadBlockedConversations()

abstract int cn_rongcloud_im_unity.RCIMEngine.loadBlockedConversations ( List< RCIMConversationType conversationTypes,
string  channelId 
)
pure virtual

获取免打扰的会话列表

参数
conversationTypes会话类型集合
channelId频道 ID,仅支持超级群使用,其他会话类型传 null 即可
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onBlockedConversationsLoaded

◆ changeConversationTopStatus()

abstract int cn_rongcloud_im_unity.RCIMEngine.changeConversationTopStatus ( RCIMConversationType  type,
string  targetId,
string  channelId,
bool  top 
)
pure virtual

设置会话的置顶状态。若会话不存在,调用此方法 SDK 自动创建会话并置顶

参数
type会话类型
targetId会话 ID
channelId频道 ID,仅支持超级群使用,其他会话类型传 null 即可
top是否置顶
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onConversationTopStatusChanged

◆ loadConversationTopStatus()

abstract int cn_rongcloud_im_unity.RCIMEngine.loadConversationTopStatus ( RCIMConversationType  type,
string  targetId,
string  channelId 
)
pure virtual

获取会话的置顶状态

参数
type会话类型
targetId会话 ID
channelId频道 ID,仅支持超级群使用,其他会话类型传 null 即可
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onConversationTopStatusLoaded

◆ syncConversationReadStatus()

abstract int cn_rongcloud_im_unity.RCIMEngine.syncConversationReadStatus ( RCIMConversationType  type,
string  targetId,
string  channelId,
long  timestamp 
)
pure virtual

同步会话阅读状态

参数
type会话类型
targetId会话 ID
channelId频道 ID,仅支持超级群使用,其他会话类型传 null 即可
timestamp会话中已读的最后一条消息的发送时间戳
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onConversationReadStatusSynced

◆ sendTypingStatus()

abstract int cn_rongcloud_im_unity.RCIMEngine.sendTypingStatus ( RCIMConversationType  type,
string  targetId,
string  channelId,
string  currentType 
)
pure virtual

向会话中发送正在输入的状态,目前只支持单聊

参数
type会话类型
targetId会话 ID
channelId频道 ID,仅支持超级群使用,其他会话类型传 null 即可
currentType当前的状态
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码

◆ loadMessages()

abstract int cn_rongcloud_im_unity.RCIMEngine.loadMessages ( RCIMConversationType  type,
string  targetId,
string  channelId,
long  sentTime,
RCIMTimeOrder  order,
RCIMMessageOperationPolicy  policy,
int  count 
)
pure virtual

加载历史消息

参数
type会话类型
targetId会话 ID
channelId频道 ID,仅支持超级群使用,其他会话类型传 null 即可
sentTime当前消息时间戳
order获取消息的方向。BEFORE:获取 sentTime 之前的消息 (时间递减),AFTER:获取 sentTime 之后的消息 (时间递增)
policy消息的加载策略。LOCAL:只加载本地,REMOTE:只加载远端,LOCAL_REMOTE:本地远端都加载
count获取的消息数量,0 < count <= 20
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onMessagesLoaded

◆ loadFirstUnreadMessage()

abstract int cn_rongcloud_im_unity.RCIMEngine.loadFirstUnreadMessage ( RCIMConversationType  type,
string  targetId,
string  channelId 
)
pure virtual

获取第一条未读消息

参数
type会话类型
targetId会话 ID
channelId频道 ID,仅支持超级群使用,其他会话类型传 null 即可
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onFirstUnreadMessageLoaded

◆ loadUnreadMentionedMessages()

abstract int cn_rongcloud_im_unity.RCIMEngine.loadUnreadMentionedMessages ( RCIMConversationType  type,
string  targetId,
string  channelId 
)
pure virtual

获取会话中未读的 @ 消息

参数
type会话类型
targetId会话 ID
channelId频道 ID,仅支持超级群使用,其他会话类型传 null 即可
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onUnreadMentionedMessagesLoaded

◆ insertMessage()

abstract int cn_rongcloud_im_unity.RCIMEngine.insertMessage ( RCIMMessage  message)
pure virtual

插入一条消息

参数
message插入的消息
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onMessageInserted

◆ insertMessages()

abstract int cn_rongcloud_im_unity.RCIMEngine.insertMessages ( List< RCIMMessage messages)
pure virtual

插入多条消息,不支持超级群

参数
messages插入的消息集合
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onMessagesInserted

◆ clearMessages()

abstract int cn_rongcloud_im_unity.RCIMEngine.clearMessages ( RCIMConversationType  type,
string  targetId,
string  channelId,
long  timestamp,
RCIMMessageOperationPolicy  policy 
)
pure virtual

参数
type会话类型
targetId会话 ID
channelId频道 ID,仅支持超级群使用,其他会话类型传 null 即可
timestamp清除消息截止时间戳,0 <= recordTime <= 当前会话最后一条消息的 sentTime, 0 清除所有消息,其他值清除小于等于 recordTime 的消息
policy清除的策略
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onMessageCleared

◆ deleteLocalMessages()

abstract int cn_rongcloud_im_unity.RCIMEngine.deleteLocalMessages ( List< RCIMMessage messages)
pure virtual

参数
messages消息集合
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onLocalMessagesDeleted

◆ deleteMessages()

abstract int cn_rongcloud_im_unity.RCIMEngine.deleteMessages ( RCIMConversationType  type,
string  targetId,
string  channelId,
List< RCIMMessage messages 
)
pure virtual

参数
type会话类型
targetId会话 ID
channelId频道 ID,仅支持超级群使用,其他会话类型传 null 即可
messages消息集合
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onMessagesDeleted

◆ recallMessage()

abstract int cn_rongcloud_im_unity.RCIMEngine.recallMessage ( RCIMMessage  message)
pure virtual

参数
message需要被撤回的消息
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onMessageRecalled

◆ sendPrivateReadReceiptMessage()

abstract int cn_rongcloud_im_unity.RCIMEngine.sendPrivateReadReceiptMessage ( string  targetId,
string  channelId,
long  timestamp 
)
pure virtual

发送某个会话中的消息阅读回执

参数
targetId会话 ID
channelId频道 ID,仅支持超级群使用,其他会话类型传 null 即可
timestamp该会话中已读的最后一条消息的发送时间戳
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onPrivateReadReceiptMessageSent

◆ sendGroupReadReceiptRequest()

abstract int cn_rongcloud_im_unity.RCIMEngine.sendGroupReadReceiptRequest ( RCIMMessage  message)
pure virtual

发起消息已读回执请求

参数
message需要请求已读回执的消息
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onGroupReadReceiptRequestSent

◆ sendGroupReadReceiptResponse()

abstract int cn_rongcloud_im_unity.RCIMEngine.sendGroupReadReceiptResponse ( string  targetId,
string  channelId,
List< RCIMMessage messages 
)
pure virtual

发送已读回执

参数
targetId会话 ID
channelId频道 ID,仅支持超级群使用,其他会话类型传 null 即可
messages会话中需要发送已读回执的消息列表
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onGroupReadReceiptResponseSent

◆ updateMessageExpansion()

abstract int cn_rongcloud_im_unity.RCIMEngine.updateMessageExpansion ( string  messageUId,
Dictionary< string, string >  expansion 
)
pure virtual

更新消息扩展信息。每条消息携带扩展信息键值对最大值 300个,单次设置扩展信息键值对最大值 20个

参数
messageUId消息的 messageUid,可在消息对象中获取,且只有发送成功的消息才会有值
expansion要更新的消息扩展信息键值对,类型是 HashMap;Key 支持大小写英文字母、数字、部分特殊符号 + = - _ 的组合方式,不支持汉字。Value 可以输入空格
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onMessageExpansionUpdated

◆ removeMessageExpansionForKeys()

abstract int cn_rongcloud_im_unity.RCIMEngine.removeMessageExpansionForKeys ( string  messageUId,
List< string >  keys 
)
pure virtual

删除消息扩展信息中特定的键值对

参数
messageUId消息的 messageUid,可在消息对象中获取,且只有发送成功的消息才会有值
keys消息扩展信息中待删除的 key 的列表,类型是 ArrayList
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onMessageExpansionForKeysRemoved

◆ changeMessageSentStatus()

abstract int cn_rongcloud_im_unity.RCIMEngine.changeMessageSentStatus ( int  messageId,
RCIMSentStatus  sentStatus 
)
pure virtual

设置消息发送状态

参数
messageId消息的 messageId,可在消息对象中获取
sentStatus要修改的状态
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onMessageSentStatusChanged

◆ changeMessageReceiveStatus()

abstract int cn_rongcloud_im_unity.RCIMEngine.changeMessageReceiveStatus ( int  messageId,
RCIMReceivedStatus  receivedStatus 
)
pure virtual

参数
messageId消息的 messageId,可在消息对象中获取
receivedStatus要修改的状态
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onMessageReceiveStatusChanged

◆ joinChatRoom()

abstract int cn_rongcloud_im_unity.RCIMEngine.joinChatRoom ( string  targetId,
int  messageCount,
bool  autoCreate 
)
pure virtual

加入聊天室

参数
targetId会话 ID
messageCount进入聊天室拉取消息数目,-1 时不拉取任何消息,0 时拉取 10 条消息,最多只能拉取 50
autoCreate是否创建聊天室,TRUE 如果聊天室不存在,sdk 会创建聊天室并加入,如果已存在,则直接加入
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onChatRoomJoined

◆ leaveChatRoom()

abstract int cn_rongcloud_im_unity.RCIMEngine.leaveChatRoom ( string  targetId)
pure virtual

退出聊天室

参数
targetId会话 ID
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onChatRoomLeft

◆ loadChatRoomMessages()

abstract int cn_rongcloud_im_unity.RCIMEngine.loadChatRoomMessages ( string  targetId,
long  timestamp,
RCIMTimeOrder  order,
int  count 
)
pure virtual

获取聊天室历史消息记录。注:必须先开通聊天室消息云存储功能

参数
targetId会话 ID
timestamp起始的消息发送时间戳
order拉取顺序 0:倒序,1:正序
count要获取的消息数量,0 < count <= 50
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onChatRoomMessagesLoaded

◆ addChatRoomEntry()

abstract int cn_rongcloud_im_unity.RCIMEngine.addChatRoomEntry ( string  targetId,
string  key,
string  value,
bool  deleteWhenLeft,
bool  overwrite 
)
pure virtual

设置聊天室自定义属性

参数
targetId会话 ID
key聊天室属性名称,Key 支持大小写英文字母、数字、部分特殊符号 + = - _ 的组合方式,最大长度 128 个字符
value聊天室属性对应的值,最大长度 4096 个字符
deleteWhenLeft用户掉线或退出时,是否自动删除该 Key、Value 值
overwrite如果当前 key 存在,是否进行覆盖
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onChatRoomEntryAdded

◆ addChatRoomEntries()

abstract int cn_rongcloud_im_unity.RCIMEngine.addChatRoomEntries ( string  targetId,
Dictionary< string, string >  entries,
bool  deleteWhenLeft,
bool  overwrite 
)
pure virtual

批量设置聊天室自定义属性

参数
targetId会话 ID
entries聊天室属性
deleteWhenLeft用户掉线或退出时,是否自动删除该 Key、Value 值
overwrite是否强制覆盖
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onChatRoomEntriesAdded

◆ loadChatRoomEntry()

abstract int cn_rongcloud_im_unity.RCIMEngine.loadChatRoomEntry ( string  targetId,
string  key 
)
pure virtual

获取聊天室单个属性

参数
targetId会话 ID
key聊天室属性键值
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onChatRoomEntryLoaded

◆ loadAllChatRoomEntries()

abstract int cn_rongcloud_im_unity.RCIMEngine.loadAllChatRoomEntries ( string  targetId)
pure virtual

获取聊天室所有属性

参数
targetId会话 ID
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onAllChatRoomEntriesLoaded

◆ removeChatRoomEntry()

abstract int cn_rongcloud_im_unity.RCIMEngine.removeChatRoomEntry ( string  targetId,
string  key,
bool  force 
)
pure virtual

删除聊天室自定义属性

参数
targetId会话 ID
key聊天室属性键值
force是否强制删除
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onChatRoomEntryRemoved

◆ removeChatRoomEntries()

abstract int cn_rongcloud_im_unity.RCIMEngine.removeChatRoomEntries ( string  targetId,
List< string >  keys,
bool  force 
)
pure virtual

批量删除聊天室自定义属性

参数
targetId会话 ID
keys聊天室属性
force是否强制覆盖
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onChatRoomEntriesRemoved

◆ addToBlacklist()

abstract int cn_rongcloud_im_unity.RCIMEngine.addToBlacklist ( string  userId)
pure virtual

将某个用户加入黑名单。当你把对方加入黑名单后,对方再发消息时,就会提示“已被加入黑名单,消息发送失败”。 但你依然可以发消息个对方

参数
userId用户 Id
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onBlacklistAdded

◆ removeFromBlacklist()

abstract int cn_rongcloud_im_unity.RCIMEngine.removeFromBlacklist ( string  userId)
pure virtual

将某个用户从黑名单中移出

参数
userId用户 Id
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onBlacklistRemoved

◆ loadBlacklistStatus()

abstract int cn_rongcloud_im_unity.RCIMEngine.loadBlacklistStatus ( string  userId)
pure virtual

获取某用户是否在黑名单中

参数
userId用户 Id
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onBlacklistStatusLoaded

◆ loadBlacklist()

abstract int cn_rongcloud_im_unity.RCIMEngine.loadBlacklist ( )
pure virtual

获取当前用户设置的黑名单列表

返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onBlacklistLoaded

◆ searchMessages()

abstract int cn_rongcloud_im_unity.RCIMEngine.searchMessages ( RCIMConversationType  type,
string  targetId,
string  channelId,
string  keyword,
long  startTime,
int  count 
)
pure virtual

根据关键字搜索指定会话中的消息

参数
type会话类型
targetId会话 ID
channelId频道 ID,仅支持超级群使用,其他会话类型传 null 即可
keyword搜索的关键字
startTime查询 beginTime 之前的消息, 传 0 时从最新消息开始搜索,从该时间往前搜索
count查询的数量,0 < count <= 50
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onMessagesSearched

◆ searchMessagesByTimeRange()

abstract int cn_rongcloud_im_unity.RCIMEngine.searchMessagesByTimeRange ( RCIMConversationType  type,
string  targetId,
string  channelId,
string  keyword,
long  startTime,
long  endTime,
int  offset,
int  count 
)
pure virtual

根据关键字搜索指定会话中某个时间段的消息

参数
type会话类型
targetId会话 ID
channelId频道 ID,仅支持超级群使用,其他会话类型传 null 即可
keyword搜索的关键字
startTime开始时间
endTime结束时间
offset偏移量
count返回的搜索结果数量,0 < count <= 50
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onMessagesSearchedByTimeRange

◆ searchMessagesByUserId()

abstract int cn_rongcloud_im_unity.RCIMEngine.searchMessagesByUserId ( string  userId,
RCIMConversationType  type,
string  targetId,
string  channelId,
long  startTime,
int  count 
)
pure virtual

根据用户 id 搜索指定会话中的消息

参数
userId用户 id
type会话类型
targetId会话 ID
channelId频道 ID,仅支持超级群使用,其他会话类型传 null 即可
startTime查询记录的起始时间, 传 0 时从最新消息开始搜索,从该时间往前搜索
count返回的搜索结果数量 0 < count <= 50
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onMessagesSearchedByUserId

◆ searchConversations()

abstract int cn_rongcloud_im_unity.RCIMEngine.searchConversations ( List< RCIMConversationType conversationTypes,
string  channelId,
List< RCIMMessageType messageTypes,
string  keyword 
)
pure virtual

根据关键字搜索会话

参数
conversationTypes会话类型集合
channelId频道 ID,仅支持超级群使用,其他会话类型传 null 即可
messageTypes搜索的消息类型
keyword搜索的关键字
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onConversationsSearched

◆ changeNotificationQuietHours()

abstract int cn_rongcloud_im_unity.RCIMEngine.changeNotificationQuietHours ( string  startTime,
int  spanMins,
RCIMPushNotificationQuietHoursLevel  level 
)
pure virtual

屏蔽某个时间段的消息提醒

参数
startTime开始消息免打扰时间,格式为 HH:MM:SS
spanMins需要消息免打扰分钟数,0 < spanMins < 1440( 比如,您设置的起始时间是 00:00, 结束时间为 01:00,则 spanMins 为 60 分钟。设置为 1439 代表全天免打扰 (23 60 + 59 = 1439 ))
level消息通知级别
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onNotificationQuietHoursChanged

◆ removeNotificationQuietHours()

abstract int cn_rongcloud_im_unity.RCIMEngine.removeNotificationQuietHours ( )
pure virtual

删除已设置的全局时间段消息提醒屏蔽

返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码

◆ loadNotificationQuietHours()

abstract int cn_rongcloud_im_unity.RCIMEngine.loadNotificationQuietHours ( )
pure virtual

查询已设置的时间段消息提醒屏蔽

返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码

◆ changeConversationNotificationLevel()

abstract int cn_rongcloud_im_unity.RCIMEngine.changeConversationNotificationLevel ( RCIMConversationType  type,
string  targetId,
string  channelId,
RCIMPushNotificationLevel  level 
)
pure virtual

设置会话的消息提醒状态。注:超级群调用该接口,channelId 为空时,相当于设置了 channelId 为空的频道的免打扰,不会屏蔽整个超级群会话下所有频道的免打扰

参数
type会话类型
targetId会话 ID
channelId频道 ID,仅支持超级群使用,其他会话类型传 null 即可
level消息通知级别
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onConversationNotificationLevelChanged

◆ loadConversationNotificationLevel()

abstract int cn_rongcloud_im_unity.RCIMEngine.loadConversationNotificationLevel ( RCIMConversationType  type,
string  targetId,
string  channelId 
)
pure virtual

获取会话的消息提醒状态

参数
type会话类型
targetId会话 ID
channelId频道 ID,仅支持超级群使用,其他会话类型传 null 即可
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onConversationNotificationLevelLoaded

◆ changeConversationTypeNotificationLevel()

abstract int cn_rongcloud_im_unity.RCIMEngine.changeConversationTypeNotificationLevel ( RCIMConversationType  type,
RCIMPushNotificationLevel  level 
)
pure virtual

设置会话类型的消息提醒状态。注:如要移除消息提醒状态,设置level为RCIMIWPushNotificationLevelDefault

参数
type会话类型
level消息通知级别
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onConversationTypeNotificationLevelChanged

◆ loadConversationTypeNotificationLevel()

abstract int cn_rongcloud_im_unity.RCIMEngine.loadConversationTypeNotificationLevel ( RCIMConversationType  type)
pure virtual

获取会话类型的消息提醒状态

参数
type会话类型
返回
[onConversationTypeNotificationLevelLoaded]

◆ changeUltraGroupDefaultNotificationLevel()

abstract int cn_rongcloud_im_unity.RCIMEngine.changeUltraGroupDefaultNotificationLevel ( string  targetId,
RCIMPushNotificationLevel  level 
)
pure virtual

设置超级群的默认消息状态。一般由管理员设置的接口,针对超级群的所有群成员生效,针对超级群下所有频道生效,优先级较低。如果群成员自己超级群的免打扰级别,那么以群成员自己设置的为准

参数
targetId会话 ID
level消息通知级别
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onUltraGroupDefaultNotificationLevelChanged

◆ loadUltraGroupDefaultNotificationLevel()

abstract int cn_rongcloud_im_unity.RCIMEngine.loadUltraGroupDefaultNotificationLevel ( string  targetId)
pure virtual

获取超级群的默认消息状态

参数
targetId会话 ID
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onUltraGroupDefaultNotificationLevelLoaded

◆ changeUltraGroupChannelDefaultNotificationLevel()

abstract int cn_rongcloud_im_unity.RCIMEngine.changeUltraGroupChannelDefaultNotificationLevel ( string  targetId,
string  channelId,
RCIMPushNotificationLevel  level 
)
pure virtual

设置超级群频道的默认消息状态

参数
targetId会话 ID
channelId频道 ID,仅支持超级群使用,其他会话类型传 null 即可
level消息通知级别
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onUltraGroupChannelDefaultNotificationLevelChanged

◆ loadUltraGroupChannelDefaultNotificationLevel()

abstract int cn_rongcloud_im_unity.RCIMEngine.loadUltraGroupChannelDefaultNotificationLevel ( string  targetId,
string  channelId 
)
pure virtual

获取超级群频道的默认消息状态

参数
targetId会话 ID
channelId频道 ID,仅支持超级群使用
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onUltraGroupChannelDefaultNotificationLevelLoaded

◆ changePushContentShowStatus()

abstract int cn_rongcloud_im_unity.RCIMEngine.changePushContentShowStatus ( bool  showContent)
pure virtual

设置是否显示远程推送内容详情,此功能需要从服务端开启用户设置功能

参数
showContent是否显示远程推送内容
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onPushContentShowStatusChanged

◆ changePushLanguage()

abstract int cn_rongcloud_im_unity.RCIMEngine.changePushLanguage ( string  language)
pure virtual

设置推送语言

参数
language推送语言, 目前仅支持 en_us、zh_cn、ar_sa
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onPushLanguageChanged

◆ changePushReceiveStatus()

abstract int cn_rongcloud_im_unity.RCIMEngine.changePushReceiveStatus ( bool  receive)
pure virtual

设置是否接收远程推送。前提:移动端未在线,Web 、MAC/PC 终端在线,移动端是否接收远程推送。此功能需要从服务端开启用户设置功能

参数
receive是否接收
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onPushReceiveStatusChanged

◆ sendGroupMessageToDesignatedUsers()

abstract int cn_rongcloud_im_unity.RCIMEngine.sendGroupMessageToDesignatedUsers ( RCIMMessage  message,
List< string >  userIds 
)
pure virtual

给指定的群成员发送消息

参数
message要发送的消息
userIds群成员集合
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onGroupMessageToDesignatedUsersAttached

onGroupMessageToDesignatedUsersSent

◆ loadMessageCount()

abstract int cn_rongcloud_im_unity.RCIMEngine.loadMessageCount ( RCIMConversationType  type,
string  targetId,
string  channelId 
)
pure virtual

获取指定会话的消息总数

参数
type会话类型
targetId会话 ID
channelId频道 ID,仅支持超级群使用,其他会话类型传 null 即可
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onMessageCountLoaded

◆ loadTopConversations()

abstract int cn_rongcloud_im_unity.RCIMEngine.loadTopConversations ( List< RCIMConversationType conversationTypes,
string  channelId 
)
pure virtual

根据会话类型,获取置顶会话列表

参数
conversationTypes会话类型集合
channelId频道 ID,仅支持超级群使用,其他会话类型传 null 即可
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onTopConversationsLoaded

◆ syncUltraGroupReadStatus()

abstract int cn_rongcloud_im_unity.RCIMEngine.syncUltraGroupReadStatus ( string  targetId,
string  channelId,
long  timestamp 
)
pure virtual

上报超级群的已读时间

参数
targetId会话 ID
channelId频道 ID,仅支持超级群使用,其他会话类型传 null 即可
timestamp已读时间
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onUltraGroupReadStatusSynced

◆ loadConversationsForAllChannel()

abstract int cn_rongcloud_im_unity.RCIMEngine.loadConversationsForAllChannel ( RCIMConversationType  type,
string  targetId 
)
pure virtual

获取特定会话下所有频道的会话列表,只支持超级群

参数
type会话类型
targetId会话 ID
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onConversationsLoadedForAllChannel

◆ modifyUltraGroupMessage()

abstract int cn_rongcloud_im_unity.RCIMEngine.modifyUltraGroupMessage ( string  messageUId,
RCIMMessage  message 
)
pure virtual

修改消息

参数
messageUId消息的 messageUid,可在消息对象中获取,且只有发送成功的消息才会有值
message要修改的 message
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onUltraGroupMessageModified

◆ recallUltraGroupMessage()

abstract int cn_rongcloud_im_unity.RCIMEngine.recallUltraGroupMessage ( RCIMMessage  message,
bool  deleteRemote 
)
pure virtual

撤回超级群消息

参数
message需要撤回的消息
deleteRemote是否删除远端消息
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onUltraGroupMessageRecalled

◆ clearUltraGroupMessages()

abstract int cn_rongcloud_im_unity.RCIMEngine.clearUltraGroupMessages ( string  targetId,
string  channelId,
long  timestamp,
RCIMMessageOperationPolicy  policy 
)
pure virtual

删除本地特定 channel 特点时间之前的消息

参数
targetId会话 ID
channelId频道 ID,仅支持超级群使用,其他会话类型传 null 即可
timestamp时间戳
policy清除策略
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onUltraGroupMessagesCleared

◆ sendUltraGroupTypingStatus()

abstract int cn_rongcloud_im_unity.RCIMEngine.sendUltraGroupTypingStatus ( string  targetId,
string  channelId,
RCIMUltraGroupTypingStatus  typingStatus 
)
pure virtual

发送超级群输入状态

参数
targetId会话 ID
channelId频道 ID,仅支持超级群使用,其他会话类型传 null 即可
typingStatus
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onUltraGroupTypingStatusSent

◆ clearUltraGroupMessagesForAllChannel()

abstract int cn_rongcloud_im_unity.RCIMEngine.clearUltraGroupMessagesForAllChannel ( string  targetId,
long  timestamp 
)
pure virtual

删除本地所有 channel 特定时间之前的消息

参数
targetId会话 ID
timestamp时间戳
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onUltraGroupMessagesClearedForAllChannel

◆ loadBatchRemoteUltraGroupMessages()

abstract int cn_rongcloud_im_unity.RCIMEngine.loadBatchRemoteUltraGroupMessages ( List< RCIMMessage messages)
pure virtual

从服务获取批量消息

参数
messages获取的消息集合
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onBatchRemoteUltraGroupMessagesLoaded

◆ updateUltraGroupMessageExpansion()

abstract int cn_rongcloud_im_unity.RCIMEngine.updateUltraGroupMessageExpansion ( string  messageUId,
Dictionary< string, string >  expansion 
)
pure virtual

更新超级群消息扩展信息

参数
messageUId消息的 messageUid,可在消息对象中获取,且只有发送成功的消息才会有值
expansion更新的消息扩展信息键值对,类型是 HashMap;Key 支持大小写英文字母、数字、部分特殊符号 + = - _ 的组合方式,不支持汉字。Value 可以输入空格
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onUltraGroupMessageExpansionUpdated

◆ removeUltraGroupMessageExpansion()

abstract int cn_rongcloud_im_unity.RCIMEngine.removeUltraGroupMessageExpansion ( string  messageUId,
List< string >  keys 
)
pure virtual

删除超级群消息扩展信息中特定的键值对

参数
messageUId消息的 messageUid,可在消息对象中获取,且只有发送成功的消息才会有值
keys消息扩展信息中待删除的 key 的列表,类型是 ArrayList
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码
参见
onUltraGroupMessageExpansionRemoved

◆ changeLogLevel()

abstract int cn_rongcloud_im_unity.RCIMEngine.changeLogLevel ( RCIMLogLevel  level)
pure virtual

修改日志等级

参数
level日志级别
返回
当次接口操作的状态码。0 代表调用成功 具体结果需要实现接口回调,非 0 代表当前接口调用操作失败,不会触发接口回调,详细错误参考错误码

属性说明

◆ onMessageReceived

OnMessageReceivedDelegate cn_rongcloud_im_unity.RCIMEngine.onMessageReceived
getset

收到消息的监听

◆ onConnectionStatusChanged

OnConnectionStatusChangedDelegate cn_rongcloud_im_unity.RCIMEngine.onConnectionStatusChanged
getset

网络状态变化

◆ onConversationTopStatusSynced

OnConversationTopStatusSyncedDelegate cn_rongcloud_im_unity.RCIMEngine.onConversationTopStatusSynced
getset

会话状态置顶多端同步监听

◆ onRemoteMessageRecalled

OnRemoteMessageRecalledDelegate cn_rongcloud_im_unity.RCIMEngine.onRemoteMessageRecalled
getset

撤回消息监听器

◆ onPrivateReadReceiptReceived

OnPrivateReadReceiptReceivedDelegate cn_rongcloud_im_unity.RCIMEngine.onPrivateReadReceiptReceived
getset

单聊中收到消息回执的回调

◆ onRemoteMessageExpansionUpdated

OnRemoteMessageExpansionUpdatedDelegate cn_rongcloud_im_unity.RCIMEngine.onRemoteMessageExpansionUpdated
getset

消息扩展信息更改的回调

◆ onRemoteMessageExpansionForKeyRemoved

OnRemoteMessageExpansionForKeyRemovedDelegate cn_rongcloud_im_unity.RCIMEngine.onRemoteMessageExpansionForKeyRemoved
getset

消息扩展信息删除的回调

◆ onChatRoomMemberChanged

OnChatRoomMemberChangedDelegate cn_rongcloud_im_unity.RCIMEngine.onChatRoomMemberChanged
getset

聊天室用户进入、退出聊天室监听

◆ onTypingStatusChanged

OnTypingStatusChangedDelegate cn_rongcloud_im_unity.RCIMEngine.onTypingStatusChanged
getset

会话输入状态发生变化。对于单聊而言,当对方正在输入时,监听会触发一次;当对方不处于输入状态时,该监听还会触发一次,但回调里输入用户列表为空

◆ onConversationReadStatusSyncMessageReceived

OnConversationReadStatusSyncMessageReceivedDelegate cn_rongcloud_im_unity.RCIMEngine.onConversationReadStatusSyncMessageReceived
getset

同步消息未读状态监听接口。多端登录,收到其它端清除某一会话未读数通知的时候

◆ onChatRoomEntriesSynced

OnChatRoomEntriesSyncedDelegate cn_rongcloud_im_unity.RCIMEngine.onChatRoomEntriesSynced
getset

聊天室 KV 同步完成的回调

◆ onChatRoomEntriesChanged

OnChatRoomEntriesChangedDelegate cn_rongcloud_im_unity.RCIMEngine.onChatRoomEntriesChanged
getset

聊天室 KV 发生变化的回调

◆ onRemoteUltraGroupMessageExpansionUpdated

OnRemoteUltraGroupMessageExpansionUpdatedDelegate cn_rongcloud_im_unity.RCIMEngine.onRemoteUltraGroupMessageExpansionUpdated
getset

超级群消息 kv 被更新

◆ onRemoteUltraGroupMessageModified

OnRemoteUltraGroupMessageModifiedDelegate cn_rongcloud_im_unity.RCIMEngine.onRemoteUltraGroupMessageModified
getset

超级群消息被更改

◆ onRemoteUltraGroupMessageRecalled

OnRemoteUltraGroupMessageRecalledDelegate cn_rongcloud_im_unity.RCIMEngine.onRemoteUltraGroupMessageRecalled
getset

超级群消息被撤回

◆ onUltraGroupReadTimeReceived

OnUltraGroupReadTimeReceivedDelegate cn_rongcloud_im_unity.RCIMEngine.onUltraGroupReadTimeReceived
getset

超级群已读的监听

◆ onUltraGroupTypingStatusChanged

OnUltraGroupTypingStatusChangedDelegate cn_rongcloud_im_unity.RCIMEngine.onUltraGroupTypingStatusChanged
getset

用户输入状态变化的回调。当客户端收到用户输入状态的变化时,会回调此接口,通知发生变化的会话以及当前正在输入的RCUltraGroupTypingStatusInfo列表

◆ onMessageBlocked

OnMessageBlockedDelegate cn_rongcloud_im_unity.RCIMEngine.onMessageBlocked
getset

发送含有敏感词消息被拦截的回调

◆ onChatRoomStatusChanged

OnChatRoomStatusChangedDelegate cn_rongcloud_im_unity.RCIMEngine.onChatRoomStatusChanged
getset

聊天室状态发生变化的监听

◆ onGroupMessageReadReceiptRequestReceived

OnGroupMessageReadReceiptRequestReceivedDelegate cn_rongcloud_im_unity.RCIMEngine.onGroupMessageReadReceiptRequestReceived
getset

收到群聊已读回执请求的监听

◆ onGroupMessageReadReceiptResponseReceived

OnGroupMessageReadReceiptResponseReceivedDelegate cn_rongcloud_im_unity.RCIMEngine.onGroupMessageReadReceiptResponseReceived
getset

收到群聊已读回执响应的监听

◆ onConnected

OnConnectedDelegate cn_rongcloud_im_unity.RCIMEngine.onConnected
getset

connect 的接口监听,收到链接结果的回调

◆ onDatabaseOpened

OnDatabaseOpenedDelegate cn_rongcloud_im_unity.RCIMEngine.onDatabaseOpened
getset

connect 的接口监听,数据库打开时发生的回调

◆ onConversationLoaded

OnConversationLoadedDelegate cn_rongcloud_im_unity.RCIMEngine.onConversationLoaded
getset

loadConversation 的接口监听

◆ onConversationsLoaded

OnConversationsLoadedDelegate cn_rongcloud_im_unity.RCIMEngine.onConversationsLoaded
getset

loadConversations 的接口监听

◆ onConversationRemoved

OnConversationRemovedDelegate cn_rongcloud_im_unity.RCIMEngine.onConversationRemoved
getset

removeConversation 的接口监听

◆ onConversationsRemoved

OnConversationsRemovedDelegate cn_rongcloud_im_unity.RCIMEngine.onConversationsRemoved
getset

removeConversations 的接口监听

◆ onTotalUnreadCountLoaded

OnTotalUnreadCountLoadedDelegate cn_rongcloud_im_unity.RCIMEngine.onTotalUnreadCountLoaded
getset

loadTotalUnreadCount 的接口监听

◆ onUnreadCountLoaded

OnUnreadCountLoadedDelegate cn_rongcloud_im_unity.RCIMEngine.onUnreadCountLoaded
getset

loadUnreadCount 的接口监听

◆ onUnreadCountByConversationTypesLoaded

OnUnreadCountByConversationTypesLoadedDelegate cn_rongcloud_im_unity.RCIMEngine.onUnreadCountByConversationTypesLoaded
getset

loadUnreadCountByConversationTypes 的接口监听

◆ onUnreadMentionedCountLoaded

OnUnreadMentionedCountLoadedDelegate cn_rongcloud_im_unity.RCIMEngine.onUnreadMentionedCountLoaded
getset

loadUnreadMentionedCount 的接口监听

◆ onUltraGroupAllUnreadCountLoaded

OnUltraGroupAllUnreadCountLoadedDelegate cn_rongcloud_im_unity.RCIMEngine.onUltraGroupAllUnreadCountLoaded
getset

loadUltraGroupAllUnreadMentionedCount 的接口监听

◆ onUltraGroupAllUnreadMentionedCountLoaded

OnUltraGroupAllUnreadMentionedCountLoadedDelegate cn_rongcloud_im_unity.RCIMEngine.onUltraGroupAllUnreadMentionedCountLoaded
getset

loadUltraGroupAllUnreadMentionedCount 的接口监听

◆ onUnreadCountCleared

OnUnreadCountClearedDelegate cn_rongcloud_im_unity.RCIMEngine.onUnreadCountCleared
getset

clearUnreadCount 的接口监听

◆ onDraftMessageSaved

OnDraftMessageSavedDelegate cn_rongcloud_im_unity.RCIMEngine.onDraftMessageSaved
getset

saveDraftMessage 的接口监听

◆ onDraftMessageCleared

OnDraftMessageClearedDelegate cn_rongcloud_im_unity.RCIMEngine.onDraftMessageCleared
getset

clearDraftMessage 的接口监听

◆ onDraftMessageLoaded

OnDraftMessageLoadedDelegate cn_rongcloud_im_unity.RCIMEngine.onDraftMessageLoaded
getset

loadDraftMessage 的接口监听

◆ onBlockedConversationsLoaded

OnBlockedConversationsLoadedDelegate cn_rongcloud_im_unity.RCIMEngine.onBlockedConversationsLoaded
getset

loadBlockedConversations 的接口监听

◆ onConversationTopStatusChanged

OnConversationTopStatusChangedDelegate cn_rongcloud_im_unity.RCIMEngine.onConversationTopStatusChanged
getset

changeConversationTopStatus 的接口监听

◆ onConversationTopStatusLoaded

OnConversationTopStatusLoadedDelegate cn_rongcloud_im_unity.RCIMEngine.onConversationTopStatusLoaded
getset

loadConversationTopStatus 的接口监听

◆ onConversationReadStatusSynced

OnConversationReadStatusSyncedDelegate cn_rongcloud_im_unity.RCIMEngine.onConversationReadStatusSynced
getset

syncConversationReadStatus 的接口监听

◆ onMessageAttached

OnMessageAttachedDelegate cn_rongcloud_im_unity.RCIMEngine.onMessageAttached
getset

sendMessage 的接口监听

◆ onMessageSent

OnMessageSentDelegate cn_rongcloud_im_unity.RCIMEngine.onMessageSent
getset

sendMessage 的接口监听

◆ onMediaMessageAttached

OnMediaMessageAttachedDelegate cn_rongcloud_im_unity.RCIMEngine.onMediaMessageAttached
getset

sendMediaMessage 的接口监听

◆ onMediaMessageSending

OnMediaMessageSendingDelegate cn_rongcloud_im_unity.RCIMEngine.onMediaMessageSending
getset

sendMediaMessage 的接口监听

◆ onSendingMediaMessageCanceled

OnSendingMediaMessageCanceledDelegate cn_rongcloud_im_unity.RCIMEngine.onSendingMediaMessageCanceled
getset

cancelSendingMediaMessage 的接口监听

◆ onMediaMessageSent

OnMediaMessageSentDelegate cn_rongcloud_im_unity.RCIMEngine.onMediaMessageSent
getset

sendMediaMessage 的接口监听

◆ onMediaMessageDownloading

OnMediaMessageDownloadingDelegate cn_rongcloud_im_unity.RCIMEngine.onMediaMessageDownloading
getset

downloadMediaMessage 的接口监听

◆ onMediaMessageDownloaded

OnMediaMessageDownloadedDelegate cn_rongcloud_im_unity.RCIMEngine.onMediaMessageDownloaded
getset

downloadMediaMessage 的接口监听

◆ onDownloadingMediaMessageCanceled

OnDownloadingMediaMessageCanceledDelegate cn_rongcloud_im_unity.RCIMEngine.onDownloadingMediaMessageCanceled
getset

cancelDownloadingMediaMessage 的接口监听

◆ onMessagesLoaded

OnMessagesLoadedDelegate cn_rongcloud_im_unity.RCIMEngine.onMessagesLoaded
getset

loadMessages 的接口监听

◆ onUnreadMentionedMessagesLoaded

OnUnreadMentionedMessagesLoadedDelegate cn_rongcloud_im_unity.RCIMEngine.onUnreadMentionedMessagesLoaded
getset

loadUnreadMentionedMessages 的接口监听

◆ onFirstUnreadMessageLoaded

OnFirstUnreadMessageLoadedDelegate cn_rongcloud_im_unity.RCIMEngine.onFirstUnreadMessageLoaded
getset

loadFirstUnreadMessage 的接口监听

◆ onMessageInserted

OnMessageInsertedDelegate cn_rongcloud_im_unity.RCIMEngine.onMessageInserted
getset

insertMessage 的接口监听

◆ onMessagesInserted

OnMessagesInsertedDelegate cn_rongcloud_im_unity.RCIMEngine.onMessagesInserted
getset

insertMessages 的接口监听

◆ onMessageCleared

OnMessageClearedDelegate cn_rongcloud_im_unity.RCIMEngine.onMessageCleared
getset

clearMessages 的接口监听

◆ onLocalMessagesDeleted

OnLocalMessagesDeletedDelegate cn_rongcloud_im_unity.RCIMEngine.onLocalMessagesDeleted
getset

deleteLocalMessages 的接口监听

◆ onMessagesDeleted

OnMessagesDeletedDelegate cn_rongcloud_im_unity.RCIMEngine.onMessagesDeleted
getset

deleteMessages 的接口监听

◆ onMessageRecalled

OnMessageRecalledDelegate cn_rongcloud_im_unity.RCIMEngine.onMessageRecalled
getset

recallMessage 的接口监听

◆ onPrivateReadReceiptMessageSent

OnPrivateReadReceiptMessageSentDelegate cn_rongcloud_im_unity.RCIMEngine.onPrivateReadReceiptMessageSent
getset

sendPrivateReadReceiptMessage 的接口监听

◆ onMessageExpansionUpdated

OnMessageExpansionUpdatedDelegate cn_rongcloud_im_unity.RCIMEngine.onMessageExpansionUpdated
getset

updateMessageExpansion 的接口监听

◆ onMessageExpansionForKeysRemoved

OnMessageExpansionForKeysRemovedDelegate cn_rongcloud_im_unity.RCIMEngine.onMessageExpansionForKeysRemoved
getset

removeMessageExpansionForKeys 的接口监听

◆ onMessageReceiveStatusChanged

OnMessageReceiveStatusChangedDelegate cn_rongcloud_im_unity.RCIMEngine.onMessageReceiveStatusChanged
getset

changeMessageReceiveStatus 的接口监听

◆ onMessageSentStatusChanged

OnMessageSentStatusChangedDelegate cn_rongcloud_im_unity.RCIMEngine.onMessageSentStatusChanged
getset

changeMessageSentStatus 的接口监听

◆ onChatRoomJoined

OnChatRoomJoinedDelegate cn_rongcloud_im_unity.RCIMEngine.onChatRoomJoined
getset

joinChatRoom 的接口监听

◆ onChatRoomJoining

OnChatRoomJoiningDelegate cn_rongcloud_im_unity.RCIMEngine.onChatRoomJoining
getset

正在加入聊天室的回调

◆ onChatRoomLeft

OnChatRoomLeftDelegate cn_rongcloud_im_unity.RCIMEngine.onChatRoomLeft
getset

leaveChatRoom 的接口监听

◆ onChatRoomMessagesLoaded

OnChatRoomMessagesLoadedDelegate cn_rongcloud_im_unity.RCIMEngine.onChatRoomMessagesLoaded
getset

loadChatRoomMessages 的接口监听

◆ onChatRoomEntryAdded

OnChatRoomEntryAddedDelegate cn_rongcloud_im_unity.RCIMEngine.onChatRoomEntryAdded
getset

addChatRoomEntry 的接口监听

◆ onChatRoomEntriesAdded

OnChatRoomEntriesAddedDelegate cn_rongcloud_im_unity.RCIMEngine.onChatRoomEntriesAdded
getset

addChatRoomEntries 的接口监听

◆ onChatRoomEntryLoaded

OnChatRoomEntryLoadedDelegate cn_rongcloud_im_unity.RCIMEngine.onChatRoomEntryLoaded
getset

loadChatRoomEntry 的接口监听

◆ onAllChatRoomEntriesLoaded

OnAllChatRoomEntriesLoadedDelegate cn_rongcloud_im_unity.RCIMEngine.onAllChatRoomEntriesLoaded
getset

loadAllChatRoomEntries 的接口监听

◆ onChatRoomEntryRemoved

OnChatRoomEntryRemovedDelegate cn_rongcloud_im_unity.RCIMEngine.onChatRoomEntryRemoved
getset

removeChatRoomEntry 的接口监听

◆ onChatRoomEntriesRemoved

OnChatRoomEntriesRemovedDelegate cn_rongcloud_im_unity.RCIMEngine.onChatRoomEntriesRemoved
getset

removeChatRoomEntries 的接口监听

◆ onBlacklistAdded

OnBlacklistAddedDelegate cn_rongcloud_im_unity.RCIMEngine.onBlacklistAdded
getset

addToBlacklist 的接口监听

◆ onBlacklistRemoved

OnBlacklistRemovedDelegate cn_rongcloud_im_unity.RCIMEngine.onBlacklistRemoved
getset

removeFromBlacklist 的接口监听

◆ onBlacklistStatusLoaded

OnBlacklistStatusLoadedDelegate cn_rongcloud_im_unity.RCIMEngine.onBlacklistStatusLoaded
getset

loadBlacklistStatus 的接口监听

◆ onBlacklistLoaded

OnBlacklistLoadedDelegate cn_rongcloud_im_unity.RCIMEngine.onBlacklistLoaded
getset

loadBlacklist 的接口监听

◆ onMessagesSearched

OnMessagesSearchedDelegate cn_rongcloud_im_unity.RCIMEngine.onMessagesSearched
getset

searchMessages 的接口监听

◆ onMessagesSearchedByTimeRange

OnMessagesSearchedByTimeRangeDelegate cn_rongcloud_im_unity.RCIMEngine.onMessagesSearchedByTimeRange
getset

searchMessagesByTimeRange 的接口监听

◆ onMessagesSearchedByUserId

OnMessagesSearchedByUserIdDelegate cn_rongcloud_im_unity.RCIMEngine.onMessagesSearchedByUserId
getset

searchMessagesByUserId 的接口监听

◆ onConversationsSearched

OnConversationsSearchedDelegate cn_rongcloud_im_unity.RCIMEngine.onConversationsSearched
getset

searchConversations 的接口监听

◆ onGroupReadReceiptRequestSent

OnGroupReadReceiptRequestSentDelegate cn_rongcloud_im_unity.RCIMEngine.onGroupReadReceiptRequestSent
getset

sendGroupReadReceiptRequest 的接口监听

◆ onGroupReadReceiptResponseSent

OnGroupReadReceiptResponseSentDelegate cn_rongcloud_im_unity.RCIMEngine.onGroupReadReceiptResponseSent
getset

sendGroupReadReceiptResponse 的接口监听

◆ onNotificationQuietHoursChanged

OnNotificationQuietHoursChangedDelegate cn_rongcloud_im_unity.RCIMEngine.onNotificationQuietHoursChanged
getset

changeNotificationQuietHours 的接口回调

◆ onNotificationQuietHoursRemoved

OnNotificationQuietHoursRemovedDelegate cn_rongcloud_im_unity.RCIMEngine.onNotificationQuietHoursRemoved
getset

removeNotificationQuietHours 的接口回调

◆ onNotificationQuietHoursLoaded

OnNotificationQuietHoursLoadedDelegate cn_rongcloud_im_unity.RCIMEngine.onNotificationQuietHoursLoaded
getset

loadNotificationQuietHours 的接口回调

◆ onConversationNotificationLevelChanged

OnConversationNotificationLevelChangedDelegate cn_rongcloud_im_unity.RCIMEngine.onConversationNotificationLevelChanged
getset

changeConversationNotificationLevel 的接口回调

◆ onConversationNotificationLevelLoaded

OnConversationNotificationLevelLoadedDelegate cn_rongcloud_im_unity.RCIMEngine.onConversationNotificationLevelLoaded
getset

loadConversationNotificationLevel 的接口回调

◆ onConversationTypeNotificationLevelChanged

OnConversationTypeNotificationLevelChangedDelegate cn_rongcloud_im_unity.RCIMEngine.onConversationTypeNotificationLevelChanged
getset

changeConversationTypeNotificationLevel 的接口回调

◆ onConversationTypeNotificationLevelLoaded

OnConversationTypeNotificationLevelLoadedDelegate cn_rongcloud_im_unity.RCIMEngine.onConversationTypeNotificationLevelLoaded
getset

loadConversationTypeNotificationLevel 的接口回调

◆ onUltraGroupDefaultNotificationLevelChanged

OnUltraGroupDefaultNotificationLevelChangedDelegate cn_rongcloud_im_unity.RCIMEngine.onUltraGroupDefaultNotificationLevelChanged
getset

changeUltraGroupDefaultNotificationLevel 的接口回调

◆ onUltraGroupDefaultNotificationLevelLoaded

OnUltraGroupDefaultNotificationLevelLoadedDelegate cn_rongcloud_im_unity.RCIMEngine.onUltraGroupDefaultNotificationLevelLoaded
getset

loadUltraGroupDefaultNotificationLevel 的接口回调

◆ onUltraGroupChannelDefaultNotificationLevelChanged

OnUltraGroupChannelDefaultNotificationLevelChangedDelegate cn_rongcloud_im_unity.RCIMEngine.onUltraGroupChannelDefaultNotificationLevelChanged
getset

changeUltraGroupChannelDefaultNotificationLevel 的接口回调

◆ onUltraGroupChannelDefaultNotificationLevelLoaded

OnUltraGroupChannelDefaultNotificationLevelLoadedDelegate cn_rongcloud_im_unity.RCIMEngine.onUltraGroupChannelDefaultNotificationLevelLoaded
getset

loadUltraGroupChannelDefaultNotificationLevel 的接口回调

◆ onPushContentShowStatusChanged

OnPushContentShowStatusChangedDelegate cn_rongcloud_im_unity.RCIMEngine.onPushContentShowStatusChanged
getset

changePushContentShowStatus 的接口监听

◆ onPushLanguageChanged

OnPushLanguageChangedDelegate cn_rongcloud_im_unity.RCIMEngine.onPushLanguageChanged
getset

changePushLanguage 的接口监听

◆ onPushReceiveStatusChanged

OnPushReceiveStatusChangedDelegate cn_rongcloud_im_unity.RCIMEngine.onPushReceiveStatusChanged
getset

changePushReceiveStatus 的接口监听

◆ onMessageCountLoaded

OnMessageCountLoadedDelegate cn_rongcloud_im_unity.RCIMEngine.onMessageCountLoaded
getset

loadMessageCount 的接口监听

◆ onTopConversationsLoaded

OnTopConversationsLoadedDelegate cn_rongcloud_im_unity.RCIMEngine.onTopConversationsLoaded
getset

◆ onGroupMessageToDesignatedUsersAttached

OnGroupMessageToDesignatedUsersAttachedDelegate cn_rongcloud_im_unity.RCIMEngine.onGroupMessageToDesignatedUsersAttached
getset

sendGroupMessageToDesignatedUsers 的接口回调。消息存入数据库的回调

◆ onGroupMessageToDesignatedUsersSent

OnGroupMessageToDesignatedUsersSentDelegate cn_rongcloud_im_unity.RCIMEngine.onGroupMessageToDesignatedUsersSent
getset

sendGroupMessageToDesignatedUsers 的接口回调。消息发送完成的回调

◆ onUltraGroupReadStatusSynced

OnUltraGroupReadStatusSyncedDelegate cn_rongcloud_im_unity.RCIMEngine.onUltraGroupReadStatusSynced
getset

syncUltraGroupReadStatus 的接口监听

◆ onConversationsLoadedForAllChannel

OnConversationsLoadedForAllChannelDelegate cn_rongcloud_im_unity.RCIMEngine.onConversationsLoadedForAllChannel
getset

loadConversationsForAllChannel 的接口监听

◆ onUltraGroupUnreadMentionedCountLoaded

OnUltraGroupUnreadMentionedCountLoadedDelegate cn_rongcloud_im_unity.RCIMEngine.onUltraGroupUnreadMentionedCountLoaded
getset

loadUltraGroupUnreadMentionedCount 的接口监听

◆ onUltraGroupUnreadCountLoaded

OnUltraGroupUnreadCountLoadedDelegate cn_rongcloud_im_unity.RCIMEngine.onUltraGroupUnreadCountLoaded
getset

◆ onUltraGroupMessageModified

OnUltraGroupMessageModifiedDelegate cn_rongcloud_im_unity.RCIMEngine.onUltraGroupMessageModified
getset

modifyUltraGroupMessage 的接口监听

◆ onUltraGroupMessageRecalled

OnUltraGroupMessageRecalledDelegate cn_rongcloud_im_unity.RCIMEngine.onUltraGroupMessageRecalled
getset

recallUltraGroupMessage 的接口监听

◆ onUltraGroupMessagesCleared

OnUltraGroupMessagesClearedDelegate cn_rongcloud_im_unity.RCIMEngine.onUltraGroupMessagesCleared
getset

clearUltraGroupMessages 的接口监听

◆ onUltraGroupMessagesClearedForAllChannel

OnUltraGroupMessagesClearedForAllChannelDelegate cn_rongcloud_im_unity.RCIMEngine.onUltraGroupMessagesClearedForAllChannel
getset

clearUltraGroupMessagesForAllChannel 的接口监听

◆ onUltraGroupTypingStatusSent

OnUltraGroupTypingStatusSentDelegate cn_rongcloud_im_unity.RCIMEngine.onUltraGroupTypingStatusSent
getset

sendUltraGroupTypingStatus 的接口监听

◆ onBatchRemoteUltraGroupMessagesLoaded

OnBatchRemoteUltraGroupMessagesLoadedDelegate cn_rongcloud_im_unity.RCIMEngine.onBatchRemoteUltraGroupMessagesLoaded
getset

loadBatchRemoteUltraGroupMessages 的接口监听

◆ onUltraGroupMessageExpansionUpdated

OnUltraGroupMessageExpansionUpdatedDelegate cn_rongcloud_im_unity.RCIMEngine.onUltraGroupMessageExpansionUpdated
getset

updateUltraGroupMessageExpansion 的接口监听

◆ onUltraGroupMessageExpansionRemoved

OnUltraGroupMessageExpansionRemovedDelegate cn_rongcloud_im_unity.RCIMEngine.onUltraGroupMessageExpansionRemoved
getset

removeUltraGroupMessageExpansion 的接口监听


该类的文档由以下文件生成: