|
HyphenateChatSDK 5.0.0
|
即时通讯 IM 是一个高度可靠的全球通信平台,用户可以进行一对一单聊、群组聊天或聊天室聊天。用户可以通过发送文本消息、分享图片、音频、视频、文件、表情符号和位置进行沟通。
| 方法 | 描述 | 起始版本 |
|---|---|---|
initializeSDKWithOptions: | 初始化SDK。 | V5.0.0 |
loginWithUsername:token:completion: | 使用用户ID和token登录聊天服务器。 | V5.0.0 |
renewToken: | 更新token。 | V5.0.0 |
logout:completion: | 退出登录账号。 | V5.0.0 |
currentUsername | 获取当前登录用户的用户ID。 | V5.0.0 |
isConnected | 检查SDK是否已连接到聊天服务器。 | V5.0.0 |
isLoggedIn | 检查用户是否已登录聊天应用。 | V5.0.0 |
dataSyncType | 设置登录后需要自动同步的数据类型,默认同步会话数据。 | V5.0.0 |
addDelegate: | 添加代理。 | V5.0.0 |
addLogDelegate:delegateQueue: | 添加SDK的日志回调代理。 | V5.0.0 |
groupManager | 获取GroupManager类。 | V5.0.0 |
pushManager | 获取PushManager类。 | V5.0.0 |
roomManager | 获取RoomManager类。 | V5.0.0 |
chatManager | 获取ChatManager类。 | V5.0.0 |
userInfoManager | 获取UserInfoManager类。 | V5.0.0 |
contactManager | 获取ContactManager类。 | V5.0.0 |
presenceManager | 获取presenceManager类。 | V5.0.0 |
threadManager | 获取ChatThreadManager类。 | V5.0.0 |
| 事件 | 描述 | 起始版本 |
|---|---|---|
connectionStateDidChange: | 当SDK连接状态发生变化时触发。 | V5.0.0 |
tokenDidExpire: | 当token过期时触发。 | V5.0.0 |
tokenWillExpire: | 当token即将过期时触发。 | V5.0.0 |
logDidOutput: | 当有日志输出时触发。 | V5.0.0 |
onOfflineMessageSyncStart | 开始从服务器拉取离线消息时触发。 | V5.0.0 |
onOfflineMessageSyncFinish | 从服务器拉取离线消息结束时触发。 | V5.0.0 |
syncDataStartWithType: | 登录后的数据同步开始时触发。 | V5.0.0 |
syncDataFinished:type: | 登录后的数据同步结束时触发。同步成功、失败、超时或断连结束时都会触发。 | V5.0.0 |
onDatabaseOpened:username: | 登录后的数据库打开完成时触发,回调返回打开结果(成功时错误信息为 nil)和当前用户 ID。 | V5.0.0 |
| 事件 | 描述 | 起始版本 |
|---|---|---|
messagesDidReceive: | 当收到消息时触发。 | V5.0.0 |
cmdMessagesDidReceive: | 当收到cmd消息时触发。 | V5.0.0 |
onMessageReadReceipts: | 当收到消息已读回执时触发,单聊和群聊统一使用该回调。 | V5.0.0 |
messagesDidDeliver: | 当收到送达回执时触发。 | V5.0.0 |
messagesInfoDidRecall: | 当收到的消息被撤回时触发。 | V5.0.0 |
messageStatusDidChange | 当收到消息状态变更通知时触发,包括消息ID的变更。 | V5.0.0 |
messageReactionDidChange: | 当消息Reaction发生变化时触发。 | V5.0.0 |
conversationListDidUpdate: | 当会话列表更新时触发。 | V5.0.0 |
onMessagePinChanged | 当消息置顶状态发生变更时触发。 | V5.0.0 |
onMessageContentChanged | 当消息内容变更时触发。 | V5.0.0 |
onStreamMessagesReceived | 当收到流式消息时触发。 | V5.0.0 |
| 方法 | 描述 | 起始版本 |
|---|---|---|
conversationId | 获取会话ID,具体取决于会话类型。 | V5.0.0 |
unreadMessagesCount | 获取会话中的未读消息数量。 | V5.0.0 |
messagesCount | 获取本地数据库中会话的所有消息数量。 | V5.0.0 |
isChatThread | 检查当前会话是否为Thread会话。 | V5.0.0 |
loadMoreMsgFromDB | 从本地数据库加载消息,从特定消息ID开始。 | V5.0.0 |
deleteMessageWithId:error: | 在本地数据库中删除特定消息。 | V5.0.0 |
latestMessage | 获取会话中的最新消息。 | V5.0.0 |
lastReceivedMessage | 获取会话中的最新接收消息。 | V5.0.0 |
conversationName | 获取会话名称;单聊为对方昵称,群聊为群组名称。 | V5.0.0 |
conversationAvatar | 获取会话头像;单聊为对方头像,群聊为群组头像。 | V5.0.0 |
deleteAllMessages: | 删除会话中的所有消息。 | V5.0.0 |
ext | 会话的扩展字段。 | V5.0.0 |
insertMessage | 在本地数据库中向会话插入消息。 | V5.0.0 |
appendMessage | 在本地数据库中将消息插入到会话的末尾。 | V5.0.0 |
updateMessage | 更新本地数据库中的消息。 | V5.0.0 |
status | 消息发送或接收状态。 | V5.0.0 |
chatType | 获取聊天消息类型。 | V5.0.0 |
body | 消息正文。 | V5.0.0 |
timestamp | 服务器接收消息时的Unix时间戳。 | V5.0.0 |
localTime | 消息的本地时间戳。 | V5.0.0 |
isChatThreadMessage | 消息是否为Thread消息。 | V5.0.0 |
chatThread | 获取Thread的概述。 | V5.0.0 |
from | 获取消息发送者的用户ID。 | V5.0.0 |
to | 消息接收者的用户ID。 | V5.0.0 |
messageId | 消息ID。 | V5.0.0 |
ext | 消息的扩展属性,类型为字典。 | V5.0.0 |
isRead | 消息是否已读。 | V5.0.0 |
isPeerRead | 消息接收方是否已发送或消息发送方是否已收到消息已读回执。 | V5.0.0 |
isNeedReadReceipt | 消息是否需要已读回执,需在发送前设置,单聊和群聊消息均生效。 | V5.0.0 |
groupReadReceiptCount | 收到的群组消息已读回执数量。 | V5.0.0 |
isDeliverAcked | 消息是否已成功送达。 | V5.0.0 |
isListened | 语音消息是否已被收听。 | V5.0.0 |
direction | 消息的收发方向。 | V5.0.0 |
conversationId | 获取会话ID。 | V5.0.0 |
reactionList | 获取Reaction列表。 | V5.0.0 |
onlineState | 是否在线消息。 | V5.0.0 |
pinnedInfo | 消息的置顶操作信息。 | V5.0.0 |
senderInfo | 消息发送者的用户属性信息。 | V5.0.0 |
messageId | 已读回执对应的消息 ID。 | V5.0.0 |
conversationId | 已读回执对应的会话 ID。 | V5.0.0 |
isPeerReceipt | 单聊消息接收方是否已发送已读回执。 | V5.0.0 |
readCount | 群聊消息已读人数。 | V5.0.0 |
| 方法 | 描述 | 起始版本 |
|---|---|---|
getAllContacts | 从本地数据库获取所有联系人及其备注、用户属性和添加时间。 | V5.0.0 |
setContactRemark | 设置联系人备注。 | V5.0.0 |
getContact | 获取联系人信息。 | V5.0.0 |
addUserToBlackList | 将用户添加到黑名单。 | V5.0.0 |
removeUserFromBlackList | 从黑名单中移除联系人。 | V5.0.0 |
getBlackList | 获取本地黑名单。 | V5.0.0 |
getBlackListFromServerWithCompletion: | 从服务器获取黑名单。 | V5.0.0 |
approveFriendRequestFromUser | 接受好友邀请。 | V5.0.0 |
declineFriendRequestFromUser | 拒绝好友邀请。 | V5.0.0 |
getContacts | 获取本地缓存的联系人用户 ID 列表(NSArray<NSString *>)。 | V5.0.0 |
getSelfIdsOnOtherPlatformWithCompletion: | 获取当前账号在其他平台或设备上的登录 ID 列表。 | V5.0.0 |
addDelegate | 添加联系人变更监听。 | V5.0.0 |
| 事件 | 描述 | 起始版本 |
|---|---|---|
friendshipDidAddByUser: | 当用户被其他用户添加为联系人时触发。 | V5.0.0 |
friendshipDidRemoveByUser: | 当用户被其他用户从联系人列表中移除时触发。 | V5.0.0 |
friendRequestDidReceiveFromUser:message: | 当用户收到好友请求时触发。 | V5.0.0 |
friendRequestDidApproveByUser: | 当好友请求被批准时触发。 | V5.0.0 |
onFriendRequestDeclined | 当好友请求被拒绝时触发。 | V5.0.0 |
onFriendInfoChanged: | 当好友信息发生变化时触发。 | V5.0.0 |
| 方法 | 描述 | 起始版本 |
|---|---|---|
createGroup | 创建群组,可设置群组头像。 | V5.0.0 |
destroyGroup | 销毁群组。 | V5.0.0 |
leaveGroup | 离开群组。 | V5.0.0 |
joinPublicGroup | 加入一个公共群组。 | V5.0.0 |
addMembers | 将用户添加到群组中。 | V5.0.0 |
removeMembersFromGroup | 从群组中移除成员。 | V5.0.0 |
getGroupSpecificationFromServerWithId | 从服务器获取群组信息。 | V5.0.0 |
getJoinedGroupsCountFromServer | 从服务器获取当前用户已加入的群组数量。 | V5.0.0 |
updateGroupSubject | 更改群组名称。 | V5.0.0 |
updateGroupAvatar | 更改群组头像。 | V5.0.0 |
updateGroup | 批量更新群组属性。 | V5.0.0 |
updateDescription | 更改群组描述。 | V5.0.0 |
acceptInvitationFromGroup | 接受群组邀请。 | V5.0.0 |
declineGroupInvitation | 拒绝群组邀请。 | V5.0.0 |
approveJoinGroupRequest | 批准入群申请。 | V5.0.0 |
declineJoinGroupRequest | 拒绝群组请求。 | V5.0.0 |
requestToJoinPublicGroup | 请求加入公共群组。 | V5.0.0 |
blockGroup | 阻止群组消息。 | V5.0.0 |
unblockGroup | 取消阻止群组消息。 | V5.0.0 |
blockMembers | 将用户添加到群组黑名单。 | V5.0.0 |
unblockMembers | 从群组黑名单中移除用户。 | V5.0.0 |
getGroupBlacklistFromServer | 获取群组黑名单(带分页)。 | V5.0.0 |
getGroupMemberListFromServer | 获取群组成员列表(带分页)。 | V5.0.0 |
updateGroupOwner | 转移群组所有权。 | V5.0.0 |
addAdmin | 添加群组管理员。 | V5.0.0 |
removeAdmin | 移除群组管理员。 | V5.0.0 |
muteMembers | 禁言群组成员。 | V5.0.0 |
unmuteMembers | 取消禁言群组成员。 | V5.0.0 |
getGroupMuteListFromServer | 从服务器获取群组禁言列表。 | V5.0.0 |
addWhiteListMembers | 将成员添加到白名单列表。 | V5.0.0 |
removeWhiteListMembers | 从白名单列表中移除成员。 | V5.0.0 |
getGroupWhiteListFromServer | 从服务器获取群组白名单列表。 | V5.0.0 |
updateGroupAnnouncement | 更新群组公告。 | V5.0.0 |
asyncFetchGroupAnnouncement | 从服务器获取群组公告。 | V5.0.0 |
uploadGroupSharedFileWithId | 上传群组共享文件。 | V5.0.0 |
getGroupFileList | 从服务器获取共享文件列表。 | V5.0.0 |
removeGroupSharedFile | 移除群组共享文件。 | V5.0.0 |
downloadGroupSharedFile | 下载群组共享文件。 | V5.0.0 |
getJoinedGroups | 获取当前用户的所有群组(从缓存中)。 | V5.0.0 |
setMemberAttribute | 设置群成员自定义属性。 | V5.0.0 |
fetchMemberAttribute | 获取单个群成员的所有自定义属性。 | V5.0.0 |
fetchMembersAttributes | 按属性键获取多个群成员的自定义属性。 | V5.0.0 |
updateGroupNamecard | 修改当前用户在群组中的群名片。 | V5.0.0 |
getGroupNamecardWithGroupId | 获取本地缓存的群成员名片。 | V5.0.0 |
addDelegate | 添加群组变更监听器。 | V5.0.0 |
| 方法 | 描述 | 起始版本 |
|---|---|---|
joinChatRoom | 加入聊天室。 | V5.0.0 |
leaveChatroom | 退出聊天室。 | V5.0.0 |
getChatroomsFromServer | 从服务器获取聊天室数据,支持分页。 | V5.0.0 |
getChatroomSpecificationFromServer | 从服务器获取聊天室的详细信息。 | V5.0.0 |
updateSubject | 修改聊天室名称。 | V5.0.0 |
updateDescription | 修改聊天室描述。 | V5.0.0 |
getChatroomMemberListFromServer | 获取聊天室成员列表。 | V5.0.0 |
muteMembers | 在聊天室中禁言成员。 | V5.0.0 |
unmuteMembers | 在聊天室中取消禁言成员。 | V5.0.0 |
addAdmin | 添加聊天室管理员。 | V5.0.0 |
removeAdmin | 移除聊天室管理员的管理权限。 | V5.0.0 |
getChatroomMuteListFromServer | 从服务器获取禁言聊天室成员列表。 | V5.0.0 |
removeMembers | 从聊天室中移除成员。 | V5.0.0 |
blockMembers | 将成员添加到聊天室的黑名单中。 | V5.0.0 |
unblockMembers | 从聊天室的黑名单中移除成员。 | V5.0.0 |
getChatroomBlacklistFromServer | 获取聊天室黑名单,支持分页。 | V5.0.0 |
addWhiteListMembers | 将成员添加到聊天室的白名单中。 | V5.0.0 |
removeWhiteListMembers | 从聊天室的白名单中移除成员。 | V5.0.0 |
getChatroomWhiteListFromServer | 从服务器获取聊天室的白名单。 | V5.0.0 |
muteAllMembers | 禁言所有成员。 | V5.0.0 |
unmuteAllMembers | 取消禁言所有成员。 | V5.0.0 |
updateChatroomAnnouncement | 更新聊天室公告。 | V5.0.0 |
getChatroomAnnouncement | 从服务器获取聊天室公告。 | V5.0.0 |
setChatroomAttributes | 添加自定义聊天室属性。 | V5.0.0 |
setChatroomAttribute | 设置自定义聊天室属性。 | V5.0.0 |
setChatroomAttributesForced | 强制设置自定义聊天室属性。 | V5.0.0 |
setChatroomAttributeForced | 强制设置自定义聊天室属性。 | V5.0.0 |
fetchChatroomAttributes | 根据属性键列表获取聊天室的自定义属性列表。 | V5.0.0 |
fetchChatroomAllAttributes | 获取聊天室的所有自定义属性。 | V5.0.0 |
removeChatroomAttributes | 根据属性键列表移除自定义聊天室属性。 | V5.0.0 |
removeChatroomAttribute | 移除自定义聊天室属性。 | V5.0.0 |
removeChatroomAttributesForced | 强制移除自定义聊天室属性。 | V5.0.0 |
removeChatroomAttributeForced | 强制移除自定义聊天室属性。 | V5.0.0 |
addDelegate | 添加聊天室事件监听器。 | V5.0.0 |
| 事件 | 描述 | 起始版本 |
|---|---|---|
didDismissFromChatroom | 当当前用户被移出聊天室时触发。 | V5.0.0 |
userDidJoinChatroom | 当其他成员加入聊天室时触发。 | V5.0.0 |
userDidLeaveChatroom | 当其他成员退出聊天室时触发。 | V5.0.0 |
onMuteListAdded | 当聊天室成员被添加到禁言列表时触发。 | V5.0.0 |
onMuteListRemoved | 当聊天室成员从禁言列表中移除时触发。 | V5.0.0 |
onWhiteListAdded | 当聊天室成员被添加到白名单时触发。 | V5.0.0 |
onWhiteListRemoved | 当聊天室成员从白名单中移除时触发。 | V5.0.0 |
chatroomAllMemberMuteChanged | 当聊天室中的全员禁言状态变更时触发。 | V5.0.0 |
onAdminAdded | 当聊天室成员被设置为管理员时触发。 | V5.0.0 |
onAdminRemoved | 当聊天室成员从管理员列表中移除时触发。 | V5.0.0 |
chatroomOwnerDidUpdate | 当聊天室的拥有者更改时触发。 | V5.0.0 |
chatroomAnnouncementDidUpdate | 当聊天室公告更改时触发。 | V5.0.0 |
chatroomSpecificationDidUpdate: | 当聊天室详情更改时触发。 | V5.0.0 |
chatroomAttributesDidUpdated | 当自定义聊天室属性更新时触发。 | V5.0.0 |
chatroomAttributesDidRemoved | 当自定义聊天室属性被移除时触发。 | V5.0.0 |
| 方法 | 描述 | 起始版本 |
|---|---|---|
publishPresence | 发布自定义的在线状态。 | V5.0.0 |
subscribePresences | 订阅用户的在线状态。 | V5.0.0 |
unsubscribePresences | 取消订阅用户的在线状态。 | V5.0.0 |
fetchSubscribedMembers | 使用分页获取已订阅的用户的列表。 | V5.0.0 |
fetchPresenceStatus | 获取用户的当前在线状态。 | V5.0.0 |
addDelegate | 添加监听器。 | V5.0.0 |
| 事件 | 描述 | 起始版本 |
|---|---|---|
presenceStatusDidChanged: | 当订阅的用户的在线状态更新时触发。 | V5.0.0 |
| 方法 | 描述 | 起始版本 |
|---|---|---|
createChatThread | 创建 Thread。 | V5.0.0 |
joinChatThread | 加入 Thread。 | V5.0.0 |
destroyChatThread | 销毁 Thread。 | V5.0.0 |
leaveChatThread | 离开 Thread。 | V5.0.0 |
getChatThreadFromServer | 从服务器获取 Thread 详细信息。 | V5.0.0 |
updateChatThreadName | 更改 Thread 名称。 | V5.0.0 |
removeMemberFromChatThread | 从 Thread 中移除成员。 | V5.0.0 |
getChatThreadMembers | 分页获取 Thread 成员列表。 | V5.0.0 |
getJoinedChatThreadsFromServer | 分页获取当前用户已加入的 Thread 列表。 | V5.0.0 |
getJoinedChatThreadsFromServer | 分页获取当前用户在指定群组中已加入的 Thread 列表。 | V5.0.0 |
getChatThreadsFromServer | 分页获取指定群组中的 Thread 列表。 | V5.0.0 |
getChatThreadLatestMessage | 从服务器获取指定 Thread 的最后一条回复。 | V5.0.0 |
addDelegate | 添加 Thread 事件监听器。 | V5.0.0 |
| 事件 | 描述 | 起始版本 |
|---|---|---|
onChatThreadCreated | 当 Thread 被创建时触发。 | V5.0.0 |
onChatThreadUpdated | 当 Thread 被更新时触发。 | V5.0.0 |
onChatThreadDestroyed | 当 Thread 被销毁时触发。 | V5.0.0 |
onChatThreadUserRemoved | 当当前用户被群主或群管理员从 Thread 中移除时触发。 | V5.0.0 |
| 方法 | 描述 | 起始版本 |
|---|---|---|
getPushConfigsFromServer | 从服务器获取推送配置。 | V5.0.0 |
updatePushDisplayName | 更新当前用户的推送显示昵称。 | V5.0.0 |
setSilentModeForConversation | 修改会话的免打扰设置。 | V5.0.0 |
clearRemindTypeForConversation | 清除会话的离线推送通知类型设置。 | V5.0.0 |
getSilentModeForConversation | 获取会话的免打扰设置。 | V5.0.0 |
setSilentModeForAll | 设置当前登录用户的免打扰设置。 | V5.0.0 |
getSilentModeForAll | 获取当前登录用户的免打扰设置。 | V5.0.0 |
getSilentModeForConversations | 批量获取指定会话的免打扰设置。 | V5.0.0 |
bindDeviceToken | 绑定 APNs Token。 | V5.0.0 |
registerPushKitToken | 绑定 VoIP Token。 | V5.0.0 |
| 方法 | 描述 | 起始版本 |
|---|---|---|
updateOwnInfo | 修改当前用户的用户属性。 | V5.0.0 |
updateOwnInfoByAttribute | 修改当前用户的用户属性。 | V5.0.0 |
fetchUserInfoByUserId | 根据用户ID获取用户属性。 | V5.0.0 |
fetchUserInfoByAttribute | 根据用户ID和属性类型获取用户属性。 | V5.0.0 |
getUserInfoByIds | 根据用户 ID 从本地缓存获取用户属性。 | V5.0.0 |
subscribeUsersInfo | 订阅非好友用户的用户属性更新事件。 | V5.0.0 |
unsubscribeUsersInfo | 取消订阅非好友用户的用户属性更新事件。 | V5.0.0 |
fetchSubscribedUsers | 获取已订阅属性更新事件的非好友用户属性。 | V5.0.0 |
addDelegate | 添加用户属性变更监听器。 | V5.0.0 |
| 事件 | 描述 | 起始版本 |
|---|---|---|
onSelfUserInfoUpdate | 当前登录用户的用户属性变更时触发。 | V5.0.0 |
onUserInfoUpdate | 其他用户的用户属性变更时批量触发。 | V5.0.0 |