-
Notifications
You must be signed in to change notification settings - Fork 10
SDK API Naming Reference
zapcannon87 edited this page Apr 10, 2020
·
3 revisions
| feature | C request | S response/notification | flutter | objc | swift | java | javascript | dotNet | comment |
|---|---|---|---|---|---|---|---|---|---|
| 登入 | session/open | session/opened | Client#open | Client#open | Client#open | IMClient#open | Realtime.createIMClient | xxx | - |
| 登出 | session/close | session/closed | Client#close | Client#close | Client#close | IMClient#close | IMClient#close | xxx | - |
| 登出通知 | - | session/closed | onClose | client:didOfflineWithError: | client(_:event:sessionDidClose(error)) | onClientOffline | (IMClient) CONFLICT | xxx | - |
| 刷新 session token | session/refresh | session/refreshed | - | - | - | - | - | - | SDK 内部支持，不对外公开 |
| 创建会话 | conv/start | conv/started | Client#createConversation | Client#createConversation | Client#createConversation | IMClient#createConversation | IMClient#createConversation | xxx | - |
| 会话加入成员 | conv/add | conv/added | Conversation#join / Conversation#addMembers | Conversation#join / Conversation#addMembers | Conversation#join / Conversation#add(members) | Conversation#join / Conversation#addMembers | Conversation#join / Conversation#add | xxx | - |
| 加入会话通知 | - | conv/joined | onInvited | conversation:invitedByClientId: | client(_:conversation:event:joined) | onInvited(client, conv, operator) | INVITED | xxx | - |
| (其它)成员加入会话通知 | - | conv/members-joined | onMemberJoined | conversation:membersAdded:byClientId: | client(_:conversation:event:membersJoined) | onMemberJoined(client, conv, members) | MEMBERS_JOINED | xxx | - |
| 会话移除成员 | conv/remove | conv/removed | Conversation#quit / Conversation#removeMembers | Conversation#quit / Conversation#removeMembers | Conversation#leave / Conversation#remove(members) | Conversation#quit / Conversation#kickMembers | Conversation#quit / Conversation#remove | xxx | - |
| 离开会话通知 | - | conv/left | onKicked | conversation:kickedByClientId: | client(_:conversation:event:left) | onKicked(client, conv, operator) | KICKED | xxx | - |
| (其它)成员离开会话通知 | - | conv/members-left | onMembersLeft | conversation:membersRemoved:byClientId: | client(_:conversation:event:membersLeft) | onMemberLeft(client, conv, members) | MEMBERS_LEFT | xxx | - |
| 查询会话 | conv/query | conv/results | ConversationQuery#find | ConversationQuery#findConversations | ConversationQuery#findConversations | ConversationQuery#find | ConversationQuery#find | xxx | - |
| 获取会话人数，或暂态会话在线人数 | conv/count | conv/results | Conversation#countMembers | Conversation#countMembers | Conversation#countMembers | Conversation#getMemberCount | Conversation#count / ChatRoom#count | xxx | - |
| 获取暂态会话成员 | conv/members | conv/results | Not Support | Not Support | ChatRoom#getOnlineMembers | Not Support | Not Support | xxx | - |
| 查询是否是会话成员，或订阅了会话 | conv/is-member | conv/is-member | Not Support | Not Support | ServiceConversation#checkSubscription | Not Support | Not Support | xxx | - |
| 修改会话数据 | conv/update | conv/updated | Conversation#updateInfo | Conversation#update | Conversation#update(attribution) | Conversation#updateInfoInBackground | Conversation#set & Conversation#save | xxx | - |
| 会话数据修改通知 | - | conv/updated | onInfoUpdated | conversation:didUpdateAt:byClientId:updatedData: | client(_:conversation:event:dataUpdated) | onInfoChanged(client, conv, attr, operator) | INFO_UPDATED | xxx | - |
| 更新成员的会话属性 | conv/member-info-update | conv/member-info-updated | Not Support | Conversation#updateMemberRole | Conversation#update(role) | Conversation#updateMemberRole | Conversation#updateMemberRole | xxx | - |
| 成员的会话属性更新通知 | - | conv/member-info-updated | Not Support | conversation:didMemberInfoUpdateBy:memberId:role: | client(_:conversation:event:memberInfoChanged) | onMemberInfoUpdated(client, conv, memberInfo, attr, operator) | MEMBER_INFO_UPDATED | xxx | - |
| 关闭会话的离线推送通知 | conv/mute | conv/updated | Conversation#mute | Conversation#mute | Conversation#mute | Conversation#mute | Conversation#mute | xxx | - |
| 开启会话的离线推送通知 | conv/unmute | conv/updated | Conversation#unmute | Conversation#unmute | Conversation#unmute | Conversation#unmute | Conversation#unmute | xxx | - |
| 查询会话中成员接收消息状态 | conv/max-read | conv/max-read | Conversation#fetchReceiptTimestamps / onLastDeliveredAtUpdated / onLastReadAtUpdated | Conversation#fetchReceiptTimestamps / conversation:didUpdateForKey:(LastReadAt, LastDeliveredAt) | Conversation#fetchReceiptTimestamps / client(_:conversation:event:(lastDeliveredAtUpdated, lastReadAtUpdated)) | Conversation#fetchReceiptTimestamps | Conversation#fetchReceiptTimestamps | xxx | - |
| 发送消息 | direct | ack | Conversation#send | Conversation#sendMessage | Conversation#send(message) | Conversation#sendMessage | Conversation#send | xxx | - |
| 消息通知 | - | direct | onMessage | conversation:didReceiveCommonMessage: / conversation:didReceiveTypedMessage: | client(_:conversation:event:(message:received)) | onMessage(msg, conv, client) | MESSAGE | xxx | - |
| 消息回执通知 | - | rcp | onMessageDelivered / onMessageRead | conversation:messageDelivered: | client(_:conversation:event:(message:delivered, read)) | onLastDeliveredAtUpdated(client, conv) / onLastReadAtUpdated(client, conv) | LAST_DELIVERED_AT_UPDATE / LAST_READ_AT_UPDATE | xxx | - |
| 未读消息通知 | - | unread | onUnreadMessageCountUpdated | conversation:didUpdateForKey:(UnreadMessagesCount) | client(_:conversation:event:unreadMessageCountUpdated) | onUnreadMessagesCountUpdated(client, conv) | (IMClient) UNREAD_MESSAGES_COUNT_UPDATE | xxx | - |
| 客户端清除未读通知 | read | - | Conversation#read | Conversation#read | Conversation#read | Conversation#read | Conversation#read | xxx | - |
| 查询历史消息 | logs | logs | Conversation#queryMessages | Conversation#queryMessages | Conversation#queryMessage | Conversation#queryMessages | Conversation#queryMessages / Conversation#createMessagesIterator | xxx | - |
| 修改与撤回消息 | patch/modify | patch/modified | Conversation#recallMessage / Conversation#updateMessage | Conversation#recallMessage / Conversation#updateMessage | Conversation#recall(message) / Conversation#update(oldMessage) | Conversation#recallMessage / Conversation#updateMessage | Conversation#recall / Conversation#update | xxx | - |
| 消息修改与撤回通知 | - | patch/modified | onMessageUpdated / onMessageRecalled | conversation:messageHasBeenUpdated: | client(_:conversation:event:(message:updated)) | onMessageUpdated / onMessageRecalled | MESSAGE_RECALL / MESSAGE_UPDATE | xxx | - |
| 把成员加入到会话黑名单 | blacklist/block | blacklist/blocked | Not Support | Conversation#blockMembers | Conversation#block(members) | Conversation#blockMembers(members) | Conversation#blockMembers | xxx | - |
| 被拉黑通知 | - | conv/blocked | Not Support | conversation:didBlockBy: | client(_:conversation:event:blocked) | onBlocked(client, conv, operator) | BLOCKED | xxx | - |
| (其它)成员被拉黑通知 | - | conv/members-blocked | Not Support | conversation:didMembersBlockBy:memberIds: | client(_:conversation:event:membersBlocked) | onMemberBlocked(client, conv, members, operator) | MEMBERS_BLOCKED | xxx | - |
| 把成员从会话黑名单移除 | blacklist/unblock | blacklist/unblocked | Not Support | Conversation#unblockMembers | Conversation#unblock(members) | Conversation#unblockMembers(members) | Conversation#unblockMembers | xxx | - |
| 解除拉黑通知 | - | conv/unblocked | Not Support | conversation:didUnblockBy: | client(_:conversation:event:unblocked) | onUnblocked(client, conv, operator) | UNBLOCKED | xxx | - |
| (其它)成员解除拉黑通知 | - | conv/members-unblocked | Not Support | conversation:didMembersUnblockBy:memberIds: | client(_:conversation:event:membersUnblocked) | onMemberUnblocked(client, conv, members, operator) | MEMBERS_UNBLOCKED | xxx | - |
| 查询会话黑名单 | blacklist/query | blacklist/query-result | Not Support | Conversation#queryBlockedMembers | Conversation#getBlockedMembers | Conversation#queryBlockedMembers(offset, limit) | Conversation#queryBlockedMembers | xxx | - |
| 校验黑名单 | blacklist/check-block | blacklist/check-result | Not Support | Not Support | Conversation#checkBlocking | Not Support | Not Support | xxx | - |
| 对会话成员禁言 | conv/add-shutup | conv/shutup-added | Not Support | Conversation#muteMembers | Conversation#mute(members) | Conversation#muteMembers(members) | Conversation#muteMembers | xxx | - |
| 被禁言通知 | - | conv/shutuped | Not Support | conversation:didMuteBy: | client(_:conversation:event:muted) | onMuted(client, conv, operator) | MUTED | xxx | - |
| (其它)成员禁言通知 | - | conv/members-shutuped | Not Support | conversation:didMembersMuteBy:memberIds: | client(_:conversation:event:membersMuted) | onMemberMuted(client, conv, members, operator) | MEMBERS_MUTED | xxx | - |
| 对会话成员取消禁言 | conv/remove-shutup | conv/shutup-removed | Not Support | Conversation#unmuteMembers | Conversation#unmute(members) | Conversation#unmuteMembers | Conversation#unmuteMembers | xxx | - |
| 取消禁言通知 | - | conv/unshutuped | Not Support | conversation:didUnmuteBy: | client(_:conversation:event:unmuted) | onUnmuted(client, conv, operator) | UNMUTED | xxx | - |
| (其它)成员取消禁言通知 | - | conv/members-unshutuped | Not Support | conversation:didMembersUnmuteBy:memberIds: | client(_:conversation:event:membersUnmuted) | onMemberUnmuted(client, conv, members, operator) | MEMBERS_UNMUTED | xxx | - |
| 查询会话禁言列表 | conv/query-shutup | conv/shutup-result | Not Support | Conversation#queryMutedMembers | Conversation#getMutedMembers | Conversation#queryMutedMembers(offset, limit) | Conversation#queryMutedMembers | xxx | - |
| 校验禁言 | conv/check-shutup | conv/check-result | Not Support | Not Support | Conversation#checkMuting | Not Support | Not Support | xxx | - |
| 主动驱离 | - | goaway | - | - | - | - | - | - | SDK 内部支持，不对外公开 |