圈组各端接口命名差异
更新时间: 2024/03/14 19:21:15
本文介绍 Android、iOS、Windows 和 Web(含圈组) 各端圈组核心接口的命名差异。
本文仅列举英文用词、用词顺序和名词单复数形式等导致的各端接口命名不一致。
服务器相关
服务器订阅
接口说明 |
Android |
iOS |
Windows | Web(含圈组) |
|---|---|---|---|---|
| 订阅服务器 | subscribeServer | subscribeServer:completion: | Subscribe(属于Server类) |
subscribeServer |
服务器搜索
接口说明 |
Android |
iOS |
Windows | Web(含圈组) |
|---|---|---|---|---|
| 根据关键字搜索某段时间内创建的服务器 | searchServerByPage | searchServerByPage:completion: | ServerSearchByPage | serverSearchByPage |
| 根据关键字搜索服务器成员 | searchServerMemberByPage | searchServerMemberByPage:completion: | ServerMemberSearch | serverMemberSearchByPage |
服务器成员管理相关
接口说明 |
Android |
iOS |
Windows | Web(含圈组) |
|---|---|---|---|---|
| 邀请用户加入服务器 | inviteServerMembers | inviteServerMembers:completion: | Invite | inviteServerMembers |
| 接受邀请 | acceptServerInvite | acceptServerInvite:completion: | AcceptInvite | acceptServerInvite |
| 拒绝邀请 | rejectServerInvite | rejectServerInvite:completion: | RejectInvite | rejectServerInvite |
| 申请加入服务器 | applyServerJoin | applyServerJoin:completion | Apply | applyServerJoin |
| 接受“加入服务器”的申请 | acceptServerApply | acceptServerApply:completion: | AcceptApply | acceptServerApply |
| - 拒绝“加入服务器”的申请 | rejectServerApply | rejectServerApply:completion: | Reject | rejectServerApply |
| 其他成员踢出服务器 | kickServerMembers | kickServerMembers:completion: | Kick | kickServerMembers |
| 主动退出服务器 | leaveServer | leaveServer:completion: | Leave | leaveServer |
| 封禁服务器成员 | banServerMember | banServerMember:completion: | BanMember | banServerMember |
| 分页查询封禁成员列表 | getBannedServerMembersByPage | getServerBanedMembersByPage:completion: | GetBannedMembersByPage | getBannedMembersByPage |
| 解封服务器成员 | unbanServerMember | unbanServerMember:completion: | UnbanMember | unbanServerMember |
频道相关
频道订阅
接口说明 |
Android |
iOS |
Windows | Web(含圈组) |
|---|---|---|---|---|
| 订阅服务器下的频道 | subscribeChannel | subscribeChannel:completion | Subscribe(属于Channel类) |
subscribeChannel |
频道搜索
接口说明 |
Android |
iOS |
Windows | Web(含圈组) |
|---|---|---|---|---|
| 根据关键字搜索某段时间内创建的频道 | searchChannelByPage | searchChannelByPage:completion: | ChannelSearchByPage | getChannelSearchByPage |
| 根据关键字搜索频道成员 | searchChannelMembers | searchServerChannelMember:completion: | ChannelMemberSearch | channelMemberSearch |
频道查询
接口说明 |
Android |
iOS |
Windows | Web(含圈组) |
|---|---|---|---|---|
| 分页查询频道成员列表 | getChannelMembersByPage | getChannelMembersByPage:completion: | GetMembersByPage | getMembersByPage |
频道未读信息
接口说明 |
Android |
iOS |
Windows | Web(含圈组) |
|---|---|---|---|---|
| 查询频道未读信息 | getChannelUnreadInfos | getChannelUnreadInfos:completion: | QueryUnreadInfo | getChannelUnreadInfos |
| 通过传入标记消息已读的时间戳更新频道未读数 | markMessageRead | markMessageRead:completion: | MarkRead(属于Message类) | markMessageRead |
频道黑白名单
接口说明 |
Android |
iOS |
Windows | Web(含圈组) |
|---|---|---|---|---|
| 更新频道黑白名单 | updateChannelBlackWhiteMembers | updateBlackWhiteMembers:completion: | UpdateWhiteBlackMembers | updateWhiteBlackMembers |
| 分页查询频道黑白名单成员 | getChannelBlackWhiteMembersByPage | getBlackWhiteMembersByPage:completion | GetWhiteBlackMembersPage | getWhiteBlackMembersPage |
| 根据传入的用户账号列表查询其中已被加入的黑白名单的用户 | getExistingChannelBlackWhiteMembers | getExistingChannelBlackWhiteMembers:completion: | GetExistingWhiteBlackMembers | getExistingWhiteBlackMembers |
| 更新频道黑白名单身份组 | updateChannelBlackWhiteRoles | updateBlackWhiteRole:completion: | UpdateWhiteBlackRole | updateWhiteBlackRole |
| 分页查询黑白名单身份组列表 | getChannelBlackWhiteRolesByPage | getBlackWhiteRolesByPage:completion: | GetWhiteBlackRolesPage | getWhiteBlackRolesPage |
| 根据传入的身份组 ID 列表批量查询其中被加入黑白名单的身份组 | getExistingChannelBlackWhiteRoles | getExistingChannelBlackWhiteRoles:completion: | GetExistingWhiteBlackRoles | getExistingWhiteBlackRoles |
频道分组
接口说明 |
Android |
iOS |
Windows | Web(含圈组) |
|---|---|---|---|---|
| 删除频道分组 | deleteChannelCategory | deleteChannelCategory:completion: | RemoveChannelCategory | removeChannelCategory |
| 根据频道分组 ID 查询频道分组 | getChannelCategories | getChannelCategories:completion | GetChannelCategoriesByID | getChannelCategoriesByID |
| 分页查询频道分组列表 | getChannelCategoriesByPage | getCategoriesInServerByPage:completion | GetChannelCategoriesPage | getChannelCategoriesPage |
| 分页查询频道分组下的频道列表 | getChannelsInCategoryByPage | getChannelsInCategoryByPage:completion | GetChannelCategoryChannelsPage | getChannelCategoryChannelsPage |
频道分组黑白名单
接口说明 |
Android |
iOS |
Windows | Web(含圈组) |
|---|---|---|---|---|
| 更新被加入频道分组黑白名单的身份组 | updateChannelCategoryBlackWhiteRoles | updateChannelCategoryBlackWhiteRole:completion: | UpdateChannelCategoryWhiteBlackRole | updateChannelCategoryWhiteBlackRole |
| 分页查询频道分组下被加入黑白名单的身份组列表 | getChannelCategoryBlackWhiteRolesByPage | getChannelCategoryBlackWhiteRolesByPage:completion: | GetChannelCategoryWhiteBlackRolesPage | getChannelCategoryWhiteBlackRolesPage |
| 更新频道分组黑白名单成员 | updateChannelCategoryBlackWhiteMembers | updateChannelCategoryBlackWhiteMembers:completion: | UpdateChannelCategoryWhiteBlackMembers | updateChannelCategoryWhiteBlackMembers |
| 分页查询频道分组黑白名单成员列表 | getChannelCategoryBlackWhiteMembersByPage | getChannelCategoryBlackWhiteMembersByPage:completion: | GetChannelCategoryWhiteBlackMembersPage | getChannelCategoryWhiteBlackMembersPage |
| 根据身份组 ID 查询频道分组黑白名单身份组列表 | getExistingChannelCategoryBlackWhiteRoles | getExistingChannelCategoryBlackWhiteRoles:completion: | GetExistingChannelCategoryWhiteBlackRoles | getExistingChannelCategoryWhiteBlackRoles |
| 根据成员 ID 查询频道分组黑白名单列表 | getExistingChannelCategoryBlackWhiteMembers | getExistingChannelCategoryBlackWhiteMembers:completion | GetExistingChannelCategoryWhiteBlackMembers | getChannelCategoryWhiteBlackMembers |
身份组相关
服务器身份组
接口说明 |
Android |
iOS |
Windows | Web(含圈组) |
|---|---|---|---|---|
| 添加身份组成员 | addMembersToServerRole | addServerRoleMembers:completion: | AddMembersToServerRole | AddMembersToServerRole |
| 移除身份组成员 | removeMembersFromServerRole | removeServerRoleMember:completion: | RemoveMembersFromServerRole | removeMembersFromServerRole |
| 分页查询某服务器身份组下的的成员列表 | getMembersFromServerRole | getServerRoleMembers: completion: | GetMembersFromServerRole | getMembersFromServerRole |
| 根据某用户的accid分页查询该用户所属的服务器身份组列表 | getServerRolesByAccid | getServerRolesByAccid:completion: | GetRolesByAccid | getServerRolesByAccid |
频道分组身份组
接口说明 |
Android |
iOS |
Windows | Web(含圈组) |
|---|---|---|---|---|
| 分页查询频道分组身份组 | getChannelCategoryRoles | getChannelCategoryRoles:completion: | GetChannelCategoryRolesPage | getChannelCategoryRole |
| 查询频道分组某人的定制权限 | getChannelCategoryMemberRoles | getChannelCategoryMemberRoles:completion: | GetChannelCategoryMemberRolesPage | getChannelCategoryMemberRole |
消息相关
接口说明 |
Android |
iOS |
Windows | Web(含圈组) |
|---|---|---|---|---|
| 发送消息 | sendMessage | sendMessage:toSession:error: sendMessage:toSession:completion: |
Send(属于Message类) | sendMessage |
| 将消息标记为已读 | markMessageRead | markMessageRead:completion: | MarkRead | markMessageRead |
| 重发消息 | resendMessage | resendMessage:error: | 无单独的重发接口,Send 接口可标记消息为重发消息 | resendMessage |
| 撤回消息 | revokeMessage | revokeMessage:completion: | Revoke | revokeMessage |
| 更新消息 | updateMessage | updateMessage:completion: | Update(属于Message)类 | updateMessage |
| 删除消息 | deleteMessage | deleteMessage:completion: | Delete | deleteMessage |
| 引用一条消息进行回复 | replyMessage | reply:to:error: reply:to:completion: |
Reply | replyMessage |
| 批量查询根消息的meta信息 | getMessageThreadInfos | batchGetMessageThreadInfo:completion: | GetThreadRootMessagesMeta | getThreadRootMessagesMeta |
| 添加快捷评论 | addQuickComment | addQuickCommentType:toMessage:completion: | AddQuickComment | AddQuickComment |
| 移除快捷评论 | removeQuickComment | deleteQuickCommentType:toMessage:completion: | RemoveQuickComment | removeQuickComment |
| 查询快捷评论列表 | getQuickComments | fetchQuickComments:completion: | GetQuickComments | getQuickComments |
| 发送正在输入事件 | sendTypingEvent | sendMessageTypingEvent | SendTypingEvent | sendTypingEvent |
| 获得多个频道的最后一条消息 | getLastMessageOfChannels | getLastMessageOfChannels:completion: | GetLastMessages | getLastMessageOfChannels |
| 查询历史消息 | getMessageHistory | getMessageHistory:completion: | GetMessages | getHistoryMessage |
| 查询本地消息缓存 | getMessageCache | getMessageCache:completion: | GetMessagesCache | 无查询本地缓存接口 |
系统通知相关
接口说明 |
Android |
iOS |
Windows | Web(含圈组) |
|---|---|---|---|---|
| 发送自定义系统通知 | sendSystemNotification | sendSystemNotification:completion: | Send(属于SystemNotification类) | sendSystemNotification |
| 重发自定义系统通知 | resendSystemNotification | resendSystemNotification:completion: | 无单独的重发接口,Send 接口可标记通知为重发通知 | 无单独的重发接口,sendSystemNotification接口可标记通知为重发通知 |
| 更新系统通知 | updateSystemNotification | updateSystemNotification:completion: | Update(属于SystemNotification类) | updateSystemNotification |
此文档是否对你有帮助?






