In-app Chat
On this page

Interface

2026-07-24
ZIMLogUploadedCallbackZIMLoggedInCallback
ZIMTokenRenewedCallbackZIMExperimentalAPICalledCallback
ZIMUserNameUpdatedCallbackZIMUserAvatarUrlUpdatedCallback
ZIMUserExtendedDataUpdatedCallbackZIMUserCustomStatusUpdatedCallback
ZIMUserBadgeUpdatedCallbackZIMUsersInfoQueriedCallback
ZIMUserOfflinePushRuleUpdatedCallbackZIMSelfUserInfoQueriedCallback
ZIMUsersStatusQueriedCallbackZIMUsersStatusSubscribedCallback
ZIMUsersStatusUnsubscribedCallbackZIMSubscribedUserStatusListQueriedCallback
ZIMConversationQueriedCallbackZIMConversationListQueriedCallback
ZIMConversationTotalUnreadMessageCountQueriedCallbackZIMConversationDeletedCallback
ZIMConversationsAllDeletedCallbackZIMConversationUnreadMessageCountClearedCallback
ZIMConversationTotalUnreadMessageCountClearedCallbackZIMConversationNotificationStatusSetCallback
ZIMConversationMessageReceiptReadSentCallbackZIMConversationPinnedStateUpdatedCallback
ZIMConversationPinnedListQueriedCallbackZIMConversationDraftSetCallback
ZIMConversationMarkSetCallbackZIMConversationMessageDestructDurationSetCallback
ZIMConversationsSearchedCallbackZIMMessageSentCallback
ZIMMessageQueriedCallbackZIMMessageDeletedCallback
ZIMConversationMessagesAllDeletedCallbackZIMMessageRevokedCallback
ZIMMessageInsertedCallbackZIMMessageLocalExtendedDataUpdatedCallback
ZIMMessageReceiptsReadSentCallbackZIMMessageReceiptsInfoQueriedCallback
ZIMMediaDownloadedCallbackZIMMediaDownloadingProgress
ZIMMessagesSearchedCallbackZIMMessagesGlobalSearchedCallback
ZIMMessageReactionAddedCallbackZIMMessageReactionDeletedCallback
ZIMMessageReactionsAllDeletedCallbackZIMMessageReactionUserListQueriedCallback
ZIMCombineMessageDetailQueriedCallbackZIMMessageRepliedListQueriedCallback
ZIMMessageEditedCallbackZIMSendingMessageCancelledCallback
ZIMMessagePinnedCallbackZIMPinnedMessageListQueriedCallback
ZIMMessageExportingProgressZIMFileCacheQueriedCallback
ZIMFileCacheClearedCallbackZIMRoomCreatedCallback
ZIMRoomJoinedCallbackZIMRoomEnteredCallback
ZIMRoomSwitchedCallbackZIMRoomLeftCallback
ZIMRoomAllLeftCallbackZIMRoomMemberQueriedCallback
ZIMRoomMembersQueriedCallbackZIMRoomOnlineMemberCountQueriedCallback
ZIMRoomAttributesOperatedCallbackZIMRoomAttributesBatchOperatedCallback
ZIMRoomAttributesQueriedCallbackZIMRoomMembersAttributesOperatedCallback
ZIMRoomMembersAttributesQueriedCallbackZIMRoomMemberAttributesListQueriedCallback
ZIMGroupCreatedCallbackZIMGroupDismissedCallback
ZIMGroupJoinedCallbackZIMGroupLeftCallback
ZIMGroupUsersInvitedCallbackZIMGroupMemberKickedCallback
ZIMGroupOwnerTransferredCallbackZIMGroupNameUpdatedCallback
ZIMGroupAvatarUrlUpdatedCallbackZIMGroupNoticeUpdatedCallback
ZIMGroupAliasUpdatedCallbackZIMGroupInfoQueriedCallback
ZIMGroupAttributesOperatedCallbackZIMGroupAttributesQueriedCallback
ZIMGroupMemberRoleUpdatedCallbackZIMGroupMemberNicknameUpdatedCallback
ZIMGroupMemberInfoQueriedCallbackZIMGroupListQueriedCallback
ZIMGroupMemberListQueriedCallbackZIMGroupMemberCountQueriedCallback
ZIMGroupMessageReceiptMemberListQueriedCallbackZIMGroupMutedCallback
ZIMGroupMembersMutedCallbackZIMGroupMemberMutedListQueriedCallback
ZIMGroupsSearchedCallbackZIMGroupMembersSearchedCallback
ZIMGroupJoinModeUpdatedCallbackZIMGroupInviteModeUpdatedCallback
ZIMGroupBeInviteModeUpdatedCallbackZIMGroupJoinApplicationSentCallback
ZIMGroupJoinApplicationAcceptedCallbackZIMGroupJoinApplicationRejectedCallback
ZIMGroupInviteApplicationsSentCallbackZIMGroupInviteApplicationAcceptedCallback
ZIMGroupInviteApplicationRejectedCallbackZIMGroupApplicationListQueriedCallback
ZIMCallInvitationSentCallbackZIMCallingInvitationSentCallback
ZIMCallCancelSentCallbackZIMCallAcceptanceSentCallback
ZIMCallRejectionSentCallbackZIMCallJoinSentCallback
ZIMCallQuitSentCallbackZIMCallEndSentCallback
ZIMCallInvitationListQueriedCallbackZIMFriendAddedCallback
ZIMFriendsDeletedCallbackZIMFriendListQueriedCallback
ZIMFriendsInfoQueriedCallbackZIMFriendsRelationCheckedCallback
ZIMFriendApplicationSentCallbackZIMFriendApplicationAcceptedCallback
ZIMFriendApplicationRejectedCallbackZIMFriendApplicationListQueriedCallback
ZIMFriendAliasUpdatedCallbackZIMFriendAttributesUpdatedCallback
ZIMFriendsSearchedCallbackZIMBlacklistUsersAddedCallback
ZIMBlacklistUsersRemovedCallbackZIMBlacklistQueriedCallback
ZIMBlacklistCheckedCallbackZIMCommunityCreatedCallback
ZIMCommunityDismissedCallbackZIMCommunityJoinedCallback
ZIMCommunityLeftCallbackZIMCommunityListQueriedCallback
ZIMCommunityNameUpdatedCallbackZIMCommunityAvatarUrlUpdatedCallback
ZIMCommunityNoticeUpdatedCallbackZIMCommunityAttributesOperatedCallback
ZIMCommunityNotificationStatusSetCallbackZIMCommunityInfoQueriedCallback
ZIMCommunityUsersInvitedCallbackZIMCommunityMembersKickedCallback
ZIMCommunityMemberRoleUpdatedCallbackZIMCommunityOwnerTransferredCallback
ZIMCommunityMemberListQueriedCallbackZIMCommunityMembersQueriedCallback
ZIMCommunityChannelCreatedCallbackZIMCommunityChannelDismissedCallback
ZIMCommunityChannelNameUpdatedCallbackZIMCommunityChannelAvatarUrlUpdatedCallback
ZIMCommunityChannelNoticeUpdatedCallbackZIMCommunityChannelAttributesOperatedCallback
ZIMCommunityChannelsInfoQueriedCallbackZIMCommunityChannelListQueriedCallback
ZIMCommunityMembersMutedCallbackZIMCommunityChannelsMutedCallback

ZIMLogUploadedCallback

Methods

onLogUploaded

onLogUploaded
typedef std::function<void(const ZIMError& errorInfo)> ZIMLogUploadedCallback
Callback of the log upload result.

Parameters

NameTypeDescription
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMLoggedInCallback

Methods

onLoggedIn

onLoggedIn
typedef std::function<void(const ZIMError& errorInfo)> ZIMLoggedInCallback
Callback of the login result.

Parameters

NameTypeDescription
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

Details

After the developer login, execute the callback of the result.

  • Use cases:Developers can use the [errorCode] in the callback to determine whether the login is successful.
  • Triggered when:When the developer calls the [login] interface, the callback will be triggered.
  • Available since:1.2.0 and above.

ZIMTokenRenewedCallback

Methods

onTokenRenewed

onTokenRenewed
typedef std::function<void(const std::string& token, const ZIMError& errorInfo)> ZIMTokenRenewedCallback
Callback of the result of renewing the token.

Parameters

NameTypeDescription
tokenconst std::string&The renewed token.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMExperimentalAPICalledCallback

Methods

onExperimentalAPICalled

onExperimentalAPICalled
typedef std::function<void(const std::string& result, const ZIMError& errorInfo)> ZIMExperimentalAPICalledCallback
The result of called the experimental API.

Parameters

NameTypeDescription
resultconst std::string&The result returned by calling the experimental API in JSON string format. For details, please consult ZEGO technical support.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMUserNameUpdatedCallback

Methods

onUserNameUpdated

onUserNameUpdated
typedef std::function<void(const std::string& userName, const ZIMError& errorInfo)> ZIMUserNameUpdatedCallback
Update the user name callback.

Parameters

NameTypeDescription
userNameconst std::string&The updated user name.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMUserAvatarUrlUpdatedCallback

Methods

onUserAvatarUrlUpdated

onUserAvatarUrlUpdated
typedef std::function<void(const std::string& userAvatarUrl, const ZIMError& errorInfo)> ZIMUserAvatarUrlUpdatedCallback
Callback for updating the user avatar URL.

Parameters

NameTypeDescription
userAvatarUrlconst std::string&The updated user avatar URL.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMUserExtendedDataUpdatedCallback

Methods

onUserExtendedDataUpdated

onUserExtendedDataUpdated
typedef std::function<void(const std::string& extendedData, const ZIMError& errorInfo)> ZIMUserExtendedDataUpdatedCallback
Update the user extended data callback.

Parameters

NameTypeDescription
extendedDataconst std::string&The updated user extended data.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMUserCustomStatusUpdatedCallback

Methods

onUserCustomStatusUpdated

onUserCustomStatusUpdated
typedef std::function<void(const std::string& customStatus, const ZIMError& errorInfo)> ZIMUserCustomStatusUpdatedCallback
The callback of the custom status update.

Parameters

NameTypeDescription
customStatusconst std::string&The updated user custom status.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMUserBadgeUpdatedCallback

Methods

onUserBadgeUpdated

onUserBadgeUpdated
typedef std::function<void(const ZIMError& errorInfo)> ZIMUserBadgeUpdatedCallback
Update the user badge callback.

Parameters

NameTypeDescription
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMUsersInfoQueriedCallback

Methods

onUsersInfoQueried

onUsersInfoQueried
typedef std::function<void(const std::vector<ZIMUserFullInfo>& userList, const std::vector<ZIMErrorUserInfo>& errorUserList, const ZIMError& errorInfo)> ZIMUsersInfoQueriedCallback
Query the userInfo callback.

Parameters

NameTypeDescription
userListconst std::vector<ZIMUserFullInfo>&The queried user information list.
errorUserListconst std::vector<ZIMErrorUserInfo>&The list of user IDs that failed to be queried.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMUserOfflinePushRuleUpdatedCallback

Methods

onUserOfflinePushRuleUpdated

onUserOfflinePushRuleUpdated
typedef std::function<void(const ZIMUserOfflinePushRule& offlinePushRule, const ZIMError& errorInfo)> ZIMUserOfflinePushRuleUpdatedCallback
Update the result callback of the user offline push rule.

Parameters

NameTypeDescription
offlinePushRuleconst ZIMUserOfflinePushRule&The updated user offline push rule.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMSelfUserInfoQueriedCallback

Methods

onSelfUserInfoQueried

onSelfUserInfoQueried
typedef std::function<void(const ZIMSelfUserInfo& selfUserInfo, const ZIMError& errorInfo)> ZIMSelfUserInfoQueriedCallback
Callback result of querying personal user information and rules.

Parameters

NameTypeDescription
selfUserInfoconst ZIMSelfUserInfo&The current user information and rules.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMUsersStatusQueriedCallback

Methods

onUsersStatusQueried

onUsersStatusQueried
typedef std::function<void(const std::vector<ZIMUserStatus>& userStatusList, const std::vector<ZIMErrorUserInfo>& errorUserList, const ZIMError& errorInfo)> ZIMUsersStatusQueriedCallback
Result callback of the queryUsersStatus interface for batch querying user online status.

Parameters

NameTypeDescription
userStatusListconst std::vector<ZIMUserStatus>&The queried user status list.
errorUserListconst std::vector<ZIMErrorUserInfo>&The list of user IDs that failed to be queried.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMUsersStatusSubscribedCallback

Methods

onUsersStatusSubscribed

onUsersStatusSubscribed
typedef std::function<void(const std::vector<ZIMErrorUserInfo>& errorUserList, const ZIMError& errorInfo)> ZIMUsersStatusSubscribedCallback
Callback for the operation results of the batch subscription interface.

Parameters

NameTypeDescription
errorUserListconst std::vector<ZIMErrorUserInfo>&The list of user IDs that failed to subscribe.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMUsersStatusUnsubscribedCallback

Methods

onUsersStatusUnsubscribed

onUsersStatusUnsubscribed
typedef std::function<void(const std::vector<ZIMErrorUserInfo>& errorUserList, const ZIMError& errorInfo)> ZIMUsersStatusUnsubscribedCallback
Callback for canceling the operations of subscribing interfaces in a batch.

Parameters

NameTypeDescription
errorUserListconst std::vector<ZIMErrorUserInfo>&The list of user IDs that failed to unsubscribe.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMSubscribedUserStatusListQueriedCallback

Methods

onSubscribedUserStatusListQueried

onSubscribedUserStatusListQueried
typedef std::function<void(const std::vector<ZIMUserStatusSubscription>& userStatusSubscriptionList, const ZIMError& errorInfo)> ZIMSubscribedUserStatusListQueriedCallback
Query for the current user subscription list operation results callback.

Parameters

NameTypeDescription
userStatusSubscriptionListconst std::vector<ZIMUserStatusSubscription>&The user status subscription list.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMConversationQueriedCallback

Methods

onConversationQueried

onConversationQueried
typedef std::function<void(ZIMConversation conversation, const ZIMError& errorInfo)> ZIMConversationQueriedCallback
Conversation query callback.

Parameters

NameTypeDescription
conversationZIMConversationThe queried conversation object.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMConversationListQueriedCallback

Methods

onConversationListQueried

onConversationListQueried
typedef std::function<void(const std::vector<ZIMConversation>& conversationList, const ZIMError& errorInfo)> ZIMConversationListQueriedCallback
Session list query callback.

Parameters

NameTypeDescription
conversationListconst std::vector<ZIMConversation>&The queried conversation list.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMConversationTotalUnreadMessageCountQueriedCallback

Methods

onConversationTotalUnreadMessageCountQueried

onConversationTotalUnreadMessageCountQueried
typedef std::function<void(unsigned int unreadMessageCount, const ZIMError& errorInfo)> ZIMConversationTotalUnreadMessageCountQueriedCallback
Query conversation unread total count callback.

Parameters

NameTypeDescription
unreadMessageCountunsigned intThe total count of unread messages across all conversations.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMConversationDeletedCallback

Methods

onConversationDeleted

onConversationDeleted
typedef std::function<void(const std::string& conversationID, ZIMConversationType conversationType, const ZIMError& errorInfo)> ZIMConversationDeletedCallback
Callback for conversation deletion.

Parameters

NameTypeDescription
conversationIDconst std::string&The ID of the deleted conversation.
conversationTypeZIMConversationTypeThe type of the deleted conversation.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMConversationsAllDeletedCallback

Methods

onConversationsAllDeleted

onConversationsAllDeleted
typedef std::function<void(const ZIMError& errorInfo)> ZIMConversationsAllDeletedCallback
Callback for conversations deletion.

Parameters

NameTypeDescription
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMConversationUnreadMessageCountClearedCallback

Methods

onConversationUnreadMessageCountCleared

onConversationUnreadMessageCountCleared
typedef std::function<void(const std::string& conversationID, ZIMConversationType conversationType, const ZIMError& errorInfo)> ZIMConversationUnreadMessageCountClearedCallback
Callback for session unread clearing.

Parameters

NameTypeDescription
conversationIDconst std::string&The conversation ID whose unread message count was cleared.
conversationTypeZIMConversationTypeThe conversation type whose unread message count was cleared.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMConversationTotalUnreadMessageCountClearedCallback

Methods

onConversationTotalUnreadMessageCountCleared

onConversationTotalUnreadMessageCountCleared
typedef std::function<void(const ZIMError& errorInfo)> ZIMConversationTotalUnreadMessageCountClearedCallback
Callback for sessions unread clearing.

Parameters

NameTypeDescription
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMConversationNotificationStatusSetCallback

Methods

onConversationNotificationStatusSet

onConversationNotificationStatusSet
typedef std::function<void(const std::string& conversationID, ZIMConversationType conversationType, const ZIMError& errorInfo)> ZIMConversationNotificationStatusSetCallback
Callback for conversation notification state settings.

Parameters

NameTypeDescription
conversationIDconst std::string&The conversation ID for which the notification status was set.
conversationTypeZIMConversationTypeThe conversation type for which the notification status was set.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMConversationMessageReceiptReadSentCallback

Methods

onConversationMessageReceiptReadSent

onConversationMessageReceiptReadSent
typedef std::function<void(const std::string& conversationID, ZIMConversationType conversationType, const ZIMError& errorInfo)> ZIMConversationMessageReceiptReadSentCallback
Callback interface for setting the read receipt conversation.

Parameters

NameTypeDescription
conversationIDconst std::string&The conversation ID for which the receipt was sent.
conversationTypeZIMConversationTypeThe conversation type for which the receipt was sent.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMConversationPinnedStateUpdatedCallback

Methods

onConversationPinnedStateUpdated

onConversationPinnedStateUpdated
typedef std::function<void(const std::string& conversationID, ZIMConversationType conversationType, const ZIMError& errorInfo)> ZIMConversationPinnedStateUpdatedCallback
Callback for conversation pinned state updated.

Parameters

NameTypeDescription
conversationIDconst std::string&The conversation ID whose pinned state was updated.
conversationTypeZIMConversationTypeThe conversation type whose pinned state was updated.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMConversationPinnedListQueriedCallback

Methods

onConversationPinnedListQueried

onConversationPinnedListQueried
typedef std::function<void(const std::vector<ZIMConversation>& conversationList, const ZIMError& errorInfo)> ZIMConversationPinnedListQueriedCallback
Callback for querying the pinned conversation list.

Parameters

NameTypeDescription
conversationListconst std::vector<ZIMConversation>&The queried pinned conversation list.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMConversationDraftSetCallback

Methods

onConversationDraftSet

onConversationDraftSet
typedef std::function<void(const std::string& conversationID, ZIMConversationType conversationType, const ZIMError& errorInfo)> ZIMConversationDraftSetCallback
Sets the callback for the session draft.

Parameters

NameTypeDescription
conversationIDconst std::string&The conversation ID for which the draft was set.
conversationTypeZIMConversationTypeThe conversation type for which the draft was set.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMConversationMarkSetCallback

Methods

onConversationMarkSet

onConversationMarkSet
typedef std::function<void(const std::vector<ZIMConversationBaseInfo>& failedConversationInfos, const ZIMError& errorInfo)> ZIMConversationMarkSetCallback
Callback for conversation mark set.

Parameters

NameTypeDescription
failedConversationInfosconst std::vector<ZIMConversationBaseInfo>&The list of conversation info objects that failed to have marks set.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMConversationMessageDestructDurationSetCallback

Methods

onConversationMessageDestructDurationSet

onConversationMessageDestructDurationSet
typedef std::function<void(const std::string& conversationID, ZIMConversationType conversationType, const ZIMError& errorInfo)> ZIMConversationMessageDestructDurationSetCallback
Callback for the result of setting the message self-destruction duration in a conversation.

Parameters

NameTypeDescription
conversationIDconst std::string&The ID of the conversation for which the setting was applied.
conversationTypeZIMConversationTypeThe type of the conversation for which the setting was applied.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMConversationsSearchedCallback

Methods

onConversationsSearched

onConversationsSearched
typedef std::function<void(const std::vector<ZIMConversationSearchInfo>& conversationSearchInfoList, unsigned int nextFlag, const ZIMError& errorInfo)> ZIMConversationsSearchedCallback
Search for the return of local conversations results based on local messages.

Parameters

NameTypeDescription
conversationSearchInfoListconst std::vector<ZIMConversationSearchInfo>&The list of searched conversation results.
nextFlagunsigned intAnchor for the next page query.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMMessageSentCallback

Methods

onMessageSent

onMessageSent
typedef std::function<void(ZIMMessage message, const ZIMError& errorInfo)> ZIMMessageSentCallback
Callback of the result of sending the message.

Parameters

NameTypeDescription
messageZIMMessageMessage object.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMMessageQueriedCallback

Methods

onMessageQueried

onMessageQueried
typedef std::function<void(const std::string& conversationID, ZIMConversationType conversationType, const std::vector<ZIMMessage>& messageList, const ZIMError& errorInfo)> ZIMMessageQueriedCallback
The developer uses this callback to get a list of queried messages, which can be used to display historical messages.

Parameters

NameTypeDescription
conversationIDconst std::string&Conversation ID.
conversationTypeZIMConversationTypeConversation type.
messageListconst std::vector<ZIMMessage>&Message list.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMMessageDeletedCallback

Methods

onMessageDeleted

onMessageDeleted
typedef std::function<void(const std::string& conversationID, ZIMConversationType conversationType, const ZIMError& errorInfo)> ZIMMessageDeletedCallback
A callback to delete a message.

Parameters

NameTypeDescription
conversationIDconst std::string&Conversation ID.
conversationTypeZIMConversationTypeConversation type.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMConversationMessagesAllDeletedCallback

Methods

onConversationMessagesAllDeleted

onConversationMessagesAllDeleted
typedef std::function<void(const ZIMError& errorInfo)> ZIMConversationMessagesAllDeletedCallback
Deletes callbacks of all messages for all sessions.

Parameters

NameTypeDescription
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMMessageRevokedCallback

Methods

onMessageRevoked

onMessageRevoked
typedef std::function<void(ZIMMessage message, const ZIMError& errorInfo)> ZIMMessageRevokedCallback
Retracted news consequential reconciliation.

Parameters

NameTypeDescription
messageZIMMessageMessage object.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMMessageInsertedCallback

Methods

onMessageInserted

onMessageInserted
typedef std::function<void(ZIMMessage message, const ZIMError& errorInfo)> ZIMMessageInsertedCallback
Callback of the result of inserting the message.

Parameters

NameTypeDescription
messageZIMMessageMessage object.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMMessageLocalExtendedDataUpdatedCallback

Methods

onMessageLocalExtendedDataUpdated

onMessageLocalExtendedDataUpdated
typedef std::function<void(ZIMMessage message, const ZIMError& errorInfo)> ZIMMessageLocalExtendedDataUpdatedCallback
Callback for updating message local extension fields.

Parameters

NameTypeDescription
messageZIMMessageMessage object.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMMessageReceiptsReadSentCallback

Methods

onMessageReceiptsReadSent

onMessageReceiptsReadSent
typedef std::function<void(const std::string& conversationID, ZIMConversationType conversationType, const std::vector<long long>& errorMessageIDs, const ZIMError& errorInfo)> ZIMMessageReceiptsReadSentCallback
Callback interface for setting the read receipt message.

Parameters

NameTypeDescription
conversationIDconst std::string&Conversation ID.
conversationTypeZIMConversationTypeConversation type.
errorMessageIDsconst std::vector<long long>&Error message ID list.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMMessageReceiptsInfoQueriedCallback

Methods

onMessageReceiptsInfoQueried

onMessageReceiptsInfoQueried
typedef std::function<void(const std::vector<ZIMMessageReceiptInfo>& infos, const std::vector<long long>& errorMessageIDs, const ZIMError& errorInfo)> ZIMMessageReceiptsInfoQueriedCallback
Callback interface for query receipt message read.

Parameters

NameTypeDescription
infosconst std::vector<ZIMMessageReceiptInfo>&Message receipt information list.
errorMessageIDsconst std::vector<long long>&Error message ID list.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMMediaDownloadedCallback

Methods

onMediaDownloaded

onMediaDownloaded
typedef std::function<void(ZIMMessage message, const ZIMError& errorInfo)> ZIMMediaDownloadedCallback
The result callback of the download completion of the media message.

Parameters

NameTypeDescription
messageZIMMessageMessage object.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMMediaDownloadingProgress

Methods

onMediaDownloadingProgress

onMediaDownloadingProgress
typedef std::function<void(ZIMMessage message, unsigned long long currentFileSize, unsigned long long totalFileSize)> ZIMMediaDownloadingProgress
Progress callback for downloading media messages.

Parameters

NameTypeDescription
messageZIMMessageMessage object.
currentFileSizeunsigned long longCurrent file size.
totalFileSizeunsigned long longTotal file size.

ZIMMessagesSearchedCallback

Methods

onMessagesSearched

onMessagesSearched
typedef std::function<void(const std::string& conversationID, ZIMConversationType conversationType, const std::vector<ZIMMessage>& messageList, ZIMMessage nextMessage, const ZIMError& errorInfo)> ZIMMessagesSearchedCallback
Return of local message search results.

Parameters

NameTypeDescription
conversationIDconst std::string&Conversation ID.
conversationTypeZIMConversationTypeConversation type.
messageListconst std::vector<ZIMMessage>&Message list.
nextMessageZIMMessageNext message object.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMMessagesGlobalSearchedCallback

Methods

onMessagesGlobalSearched

onMessagesGlobalSearched
typedef std::function<void(const std::vector<ZIMMessage>& messageList, ZIMMessage nextMessage, const ZIMError& errorInfo)> ZIMMessagesGlobalSearchedCallback
Return of local message search results.

Parameters

NameTypeDescription
messageListconst std::vector<ZIMMessage>&Message list.
nextMessageZIMMessageNext message object.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMMessageReactionAddedCallback

Methods

onMessageReactionAdded

onMessageReactionAdded
typedef std::function<void(const ZIMMessageReaction& reaction, const ZIMError& errorInfo)> ZIMMessageReactionAddedCallback
The addition of return for message reactions.

Parameters

NameTypeDescription
reactionconst ZIMMessageReaction&Message reaction object.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMMessageReactionDeletedCallback

Methods

onMessageReactionDeleted

onMessageReactionDeleted
typedef std::function<void(const ZIMMessageReaction& reaction, const ZIMError& errorInfo)> ZIMMessageReactionDeletedCallback
The delete of return for message reactions.

Parameters

NameTypeDescription
reactionconst ZIMMessageReaction&Message reaction object.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMMessageReactionsAllDeletedCallback

Methods

onMessageReactionsAllDeleted

onMessageReactionsAllDeleted
typedef std::function<void(const ZIMError& errorInfo)> ZIMMessageReactionsAllDeletedCallback
The delete of return for message reactions.

Parameters

NameTypeDescription
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMMessageReactionUserListQueriedCallback

Methods

onMessageReactionUserListQueried

onMessageReactionUserListQueried
typedef std::function<void(ZIMMessage message, const std::vector<ZIMMessageReactionUserFullInfo>& userInfoList, const std::string& reactionType, long long nextFlag, unsigned int totalCount, const ZIMError& errorInfo)> ZIMMessageReactionUserListQueriedCallback
The return of the query for the details of the reaction.

Parameters

NameTypeDescription
messageZIMMessageMessage object.
userInfoListconst std::vector<ZIMMessageReactionUserFullInfo>&List of user reaction information.
reactionTypeconst std::string&Message reaction type.
nextFlaglong longList query anchor, used to query the next page. The current value returns 0, which means that the list has been pulled out.
totalCountunsigned intTotal user count.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCombineMessageDetailQueriedCallback

Methods

onCombineMessageDetailQueried

onCombineMessageDetailQueried
typedef std::function<void(ZIMCombineMessage message, const ZIMError& errorInfo)> ZIMCombineMessageDetailQueriedCallback
Result callback for querying merge message details.

Parameters

NameTypeDescription
messageZIMCombineMessageCombine message object. The messageList in this object already contains the sub-message list of the merged message.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMMessageRepliedListQueriedCallback

Methods

onMessageRepliedListQueried

onMessageRepliedListQueried
typedef std::function<void(const std::vector<ZIMMessage>& messageList, long long nextFlag, const ZIMMessageRootRepliedInfo& rootRepliedInfo, const ZIMError& errorInfo)> ZIMMessageRepliedListQueriedCallback
The callback for querying the reply message list result.

Parameters

NameTypeDescription
messageListconst std::vector<ZIMMessage>&Message list.
nextFlaglong longList query anchor, used to query the next page. The current value returns 0, which means that the list has been pulled out.
rootRepliedInfoconst ZIMMessageRootRepliedInfo&Root message reply information.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMMessageEditedCallback

Methods

onMessageEdited

onMessageEdited
typedef std::function<void(ZIMMessage message, const ZIMError& errorInfo)> ZIMMessageEditedCallback
Callback of the result of editing the message.

Parameters

NameTypeDescription
messageZIMMessageMessage object.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMSendingMessageCancelledCallback

Methods

onSendingMessageCancelled

onSendingMessageCancelled
typedef std::function<void(const ZIMError& errorInfo)> ZIMSendingMessageCancelledCallback
Callback of the result of cancel sending the message.

Parameters

NameTypeDescription
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMMessagePinnedCallback

Methods

onMessagePinned

onMessagePinned
typedef std::function<void(const ZIMError& errorInfo)> ZIMMessagePinnedCallback
Callback of the result of the message to be pinned or unpinned.

Parameters

NameTypeDescription
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMPinnedMessageListQueriedCallback

Methods

onPinnedMessageListQueried

onPinnedMessageListQueried
typedef std::function<void(const std::vector<ZIMMessage>& messageList, const ZIMError& errorInfo)> ZIMPinnedMessageListQueriedCallback
The developer uses this callback to get a list of queried pinned messages, which can be used to display pinned messages.

Parameters

NameTypeDescription
messageListconst std::vector<ZIMMessage>&Message list.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMMessageExportingProgress

Methods

onMessageExportingProgress

onMessageExportingProgress
typedef std::function<void(unsigned long long exportedMessageCount, unsigned long long totalMessageCount)> ZIMMessageExportingProgress
Progress callback of the exported message.

Parameters

NameTypeDescription
exportedMessageCountunsigned long longThe number of exported messages.
totalMessageCountunsigned long longThe total number of messages.

ZIMFileCacheQueriedCallback

Methods

onFileCacheQueried

onFileCacheQueried
typedef std::function<void(const ZIMFileCacheInfo& fileCacheInfo, const ZIMError& errorInfo)> ZIMFileCacheQueriedCallback
Callback for querying the results of the local cache.

Parameters

NameTypeDescription
fileCacheInfoconst ZIMFileCacheInfo&File cache information.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMFileCacheClearedCallback

Methods

onFileCacheCleared

onFileCacheCleared
typedef std::function<void(const ZIMError& errorInfo)> ZIMFileCacheClearedCallback
Clears the callback of the local cache result.

Parameters

NameTypeDescription
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMRoomCreatedCallback

Methods

onRoomCreated

onRoomCreated
typedef std::function<void(const ZIMRoomFullInfo& roomInfo, const ZIMError& errorInfo)> ZIMRoomCreatedCallback
Callback of the result of creating the room.

Parameters

NameTypeDescription
roomInfoconst ZIMRoomFullInfo&Room information.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMRoomJoinedCallback

Methods

onRoomJoined

onRoomJoined
typedef std::function<void(const ZIMRoomFullInfo& roomInfo, const ZIMError& errorInfo)> ZIMRoomJoinedCallback
Callback of the result of joining the room.

Parameters

NameTypeDescription
roomInfoconst ZIMRoomFullInfo&Room information.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMRoomEnteredCallback

Methods

onRoomEntered

onRoomEntered
typedef std::function<void(const ZIMRoomFullInfo& roomInfo, const ZIMError& errorInfo)> ZIMRoomEnteredCallback
Callback of the result of entering the room.

Parameters

NameTypeDescription
roomInfoconst ZIMRoomFullInfo&Room information.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMRoomSwitchedCallback

Methods

onRoomSwitched

onRoomSwitched
typedef std::function<void(const ZIMRoomFullInfo& roomInfo, const ZIMError& errorInfo)> ZIMRoomSwitchedCallback
Callback of the result of switched rooms.

Parameters

NameTypeDescription
roomInfoconst ZIMRoomFullInfo&Room information.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMRoomLeftCallback

Methods

onRoomLeft

onRoomLeft
typedef std::function<void(const std::string& roomID, const ZIMError& errorInfo)> ZIMRoomLeftCallback
Callback of the result of leaving the room.

Parameters

NameTypeDescription
roomIDconst std::string&Room ID.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMRoomAllLeftCallback

Methods

onRoomAllLeft

onRoomAllLeft
typedef std::function<void(const std::vector<std::string>& roomIDs, const ZIMError& errorInfo)> ZIMRoomAllLeftCallback
Callback for the results of leaving all rooms.

Parameters

NameTypeDescription
roomIDsconst std::vector<std::string>&Room ID list.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMRoomMemberQueriedCallback

Methods

onRoomMemberQueried

onRoomMemberQueried
typedef std::function<void(const std::string& roomID, const std::vector<ZIMUserInfo>& memberList, const std::string& nextFlag, const ZIMError& errorInfo)> ZIMRoomMemberQueriedCallback
Callback of the result of querying the room members list.

Parameters

NameTypeDescription
roomIDconst std::string&Room ID.
memberListconst std::vector<ZIMUserInfo>&Room member list.
nextFlagconst std::string&Used to query the next page. The current value returns an empty string, which means that the list has been pulled out.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMRoomMembersQueriedCallback

Methods

onRoomMembersQueried

onRoomMembersQueried
typedef std::function<void(const std::string& roomID, const std::vector<ZIMRoomMemberInfo>& memberList, const std::vector<ZIMErrorUserInfo>& errorUserList, const ZIMError& errorInfo)> ZIMRoomMembersQueriedCallback
Callback for the result of querying the specified member of the room.

Parameters

NameTypeDescription
roomIDconst std::string&Room ID.
memberListconst std::vector<ZIMRoomMemberInfo>&Room member list.
errorUserListconst std::vector<ZIMErrorUserInfo>&Error member list.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMRoomOnlineMemberCountQueriedCallback

Methods

onRoomOnlineMemberCountQueried

onRoomOnlineMemberCountQueried
typedef std::function<void(const std::string& roomID, unsigned int count, const ZIMError& errorInfo)> ZIMRoomOnlineMemberCountQueriedCallback
Callback of the result of querying the online members count in the room.

Parameters

NameTypeDescription
roomIDconst std::string&Room ID.
countunsigned intOnline member count.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMRoomAttributesOperatedCallback

Methods

onRoomAttributesOperated

onRoomAttributesOperated
typedef std::function<void(const std::string& roomID, const std::vector<std::string>& errorKeys, const ZIMError& errorInfo)> ZIMRoomAttributesOperatedCallback
The return of the operation result of the room attribute.

Parameters

NameTypeDescription
roomIDconst std::string&Room ID.
errorKeysconst std::vector<std::string>&Error key list.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMRoomAttributesBatchOperatedCallback

Methods

onRoomAttributesBatchOperated

onRoomAttributesBatchOperated
typedef std::function<void(const std::string& roomID, const ZIMError& errorInfo)> ZIMRoomAttributesBatchOperatedCallback
The return of the result of the room attribute combination operation.

Parameters

NameTypeDescription
roomIDconst std::string&Room ID.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMRoomAttributesQueriedCallback

Methods

onRoomAttributesQueried

onRoomAttributesQueried
typedef std::function<void(const std::string& roomID, const std::unordered_map<std::string, std::string>& roomAttributes, const ZIMError& errorInfo)> ZIMRoomAttributesQueriedCallback
Return of room attribute query results.

Parameters

NameTypeDescription
roomIDconst std::string&Room ID.
roomAttributesconst std::unordered_map<std::string, std::string>&Room attributes.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMRoomMembersAttributesOperatedCallback

Methods

onRoomMembersAttributesOperated

onRoomMembersAttributesOperated
typedef std::function<void(const std::string& roomID, const std::vector<ZIMRoomMemberAttributesOperatedInfo>& infos, const std::vector<std::string>& errorUserList, const ZIMError& errorInfo)> ZIMRoomMembersAttributesOperatedCallback
Callback of the result of setting room member attributes.

Parameters

NameTypeDescription
roomIDconst std::string&Room ID.
infosconst std::vector<ZIMRoomMemberAttributesOperatedInfo>&Room member attribute operation information list.
errorUserListconst std::vector<std::string>&Error member list.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMRoomMembersAttributesQueriedCallback

Methods

onRoomMembersAttributesQueried

onRoomMembersAttributesQueried
typedef std::function<void(const std::string& roomID, const std::vector<ZIMRoomMemberAttributesInfo>& infos, const ZIMError& errorInfo)> ZIMRoomMembersAttributesQueriedCallback
Returns the results of batch query of room user attributes.

Parameters

NameTypeDescription
roomIDconst std::string&Room ID.
infosconst std::vector<ZIMRoomMemberAttributesInfo>&Room member attribute information list.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMRoomMemberAttributesListQueriedCallback

Methods

onRoomMemberAttributesListQueried

onRoomMemberAttributesListQueried
typedef std::function<void(const std::string& roomID, const std::vector<ZIMRoomMemberAttributesInfo>& infos, const std::string& nextFlag, const ZIMError& errorInfo)> ZIMRoomMemberAttributesListQueriedCallback
Returns the query result of the user attribute list in the room.

Parameters

NameTypeDescription
roomIDconst std::string&Room ID.
infosconst std::vector<ZIMRoomMemberAttributesInfo>&Room member attribute information list.
nextFlagconst std::string&Used to query the next page. The current value returns 0, which means that the list has been pulled out.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupCreatedCallback

Methods

onGroupCreated

onGroupCreated
typedef std::function<void(const ZIMGroupFullInfo& groupInfo, const std::vector<ZIMGroupMemberInfo>& userList, const std::vector<ZIMErrorUserInfo>& errorUserList, const ZIMError& errorInfo)> ZIMGroupCreatedCallback
Returns the result of creating a group.

Parameters

NameTypeDescription
groupInfoconst ZIMGroupFullInfo&Group information.
userListconst std::vector<ZIMGroupMemberInfo>&Group member information list.
errorUserListconst std::vector<ZIMErrorUserInfo>&Error member list.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupDismissedCallback

Methods

onGroupDismissed

onGroupDismissed
typedef std::function<void(const std::string& groupID, const ZIMError& errorInfo)> ZIMGroupDismissedCallback
Returns the result of dismissing the group.

Parameters

NameTypeDescription
groupIDconst std::string&Group ID.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupJoinedCallback

Methods

onGroupJoined

onGroupJoined
typedef std::function<void(const ZIMGroupFullInfo& groupInfo, const ZIMError& errorInfo)> ZIMGroupJoinedCallback
Returns the result of joining the group.

Parameters

NameTypeDescription
groupInfoconst ZIMGroupFullInfo&Group information.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupLeftCallback

Methods

onGroupLeft

onGroupLeft
typedef std::function<void(const std::string& groupID, const ZIMError& errorInfo)> ZIMGroupLeftCallback
Return of the result of leaving the group.

Parameters

NameTypeDescription
groupIDconst std::string&Group ID.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupUsersInvitedCallback

Methods

onGroupUsersInvited

onGroupUsersInvited
typedef std::function<void(const std::string& groupID, const std::vector<ZIMGroupMemberInfo>& userList, const std::vector<ZIMErrorUserInfo>& errorUserList, const ZIMError& errorInfo)> ZIMGroupUsersInvitedCallback
The result of the user being invited to the group is returned.

Parameters

NameTypeDescription
groupIDconst std::string&Group ID.
userListconst std::vector<ZIMGroupMemberInfo>&Group member information list.
errorUserListconst std::vector<ZIMErrorUserInfo>&Error member list.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupMemberKickedCallback

Methods

onGroupMemberKicked

onGroupMemberKicked
typedef std::function<void(const std::string& groupID, const std::vector<std::string>& kickedUserIDList, const std::vector<ZIMErrorUserInfo>& errorUserList, const ZIMError& errorInfo)> ZIMGroupMemberKickedCallback
Returns the result of kicking out a group member.

Parameters

NameTypeDescription
groupIDconst std::string&Group ID.
kickedUserIDListconst std::vector<std::string>&List of user IDs kicked out.
errorUserListconst std::vector<ZIMErrorUserInfo>&Error member list.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupOwnerTransferredCallback

Methods

onGroupOwnerTransferred

onGroupOwnerTransferred
typedef std::function<void(const std::string& groupID, const std::string& toUserID, const ZIMError& errorInfo)> ZIMGroupOwnerTransferredCallback
Returns the result of the group owner assignment.

Parameters

NameTypeDescription
groupIDconst std::string&Group ID.
toUserIDconst std::string&New group owner user ID.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupNameUpdatedCallback

Methods

onGroupNameUpdated

onGroupNameUpdated
typedef std::function<void(const std::string& groupID, const std::string& groupName, const ZIMError& errorInfo)> ZIMGroupNameUpdatedCallback
Returns the result of the group name update.

Parameters

NameTypeDescription
groupIDconst std::string&Group ID.
groupNameconst std::string&Group name.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupAvatarUrlUpdatedCallback

Methods

onGroupAvatarUrlUpdated

onGroupAvatarUrlUpdated
typedef std::function<void(const std::string& groupID, const std::string& groupAvatarUrl, const ZIMError& errorInfo)> ZIMGroupAvatarUrlUpdatedCallback
Returns the result of the group avatar URL update.

Parameters

NameTypeDescription
groupIDconst std::string&Group ID.
groupAvatarUrlconst std::string&Group avatar URL.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupNoticeUpdatedCallback

Methods

onGroupNoticeUpdated

onGroupNoticeUpdated
typedef std::function<void(const std::string& groupID, const std::string& groupNotice, const ZIMError& errorInfo)> ZIMGroupNoticeUpdatedCallback
The return of the results of the group announcement update.

Parameters

NameTypeDescription
groupIDconst std::string&Group ID.
groupNoticeconst std::string&Group notice.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupAliasUpdatedCallback

Methods

onGroupAliasUpdated

onGroupAliasUpdated
typedef std::function<void(const std::string& groupID, const std::string& groupAlias, const ZIMError& errorInfo)> ZIMGroupAliasUpdatedCallback
Returns the result of the group alias update.

Parameters

NameTypeDescription
groupIDconst std::string&Group ID.
groupAliasconst std::string&Group alias.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupInfoQueriedCallback

Methods

onGroupInfoQueried

onGroupInfoQueried
typedef std::function<void(const ZIMGroupFullInfo& groupInfo, const ZIMError& errorInfo)> ZIMGroupInfoQueriedCallback
Returns the result of querying group information.

Parameters

NameTypeDescription
groupInfoconst ZIMGroupFullInfo&Group information.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupAttributesOperatedCallback

Methods

onGroupAttributesOperated

onGroupAttributesOperated
typedef std::function<void(const std::string& groupID, const std::vector<std::string>& errorKeys, const ZIMError& errorInfo)> ZIMGroupAttributesOperatedCallback
Returns the result of a group attribute operation.

Parameters

NameTypeDescription
groupIDconst std::string&Group ID.
errorKeysconst std::vector<std::string>&Error keys.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupAttributesQueriedCallback

Methods

onGroupAttributesQueried

onGroupAttributesQueried
typedef std::function<void(const std::string& groupID, const std::unordered_map<std::string, std::string>& groupAttributes, const ZIMError& errorInfo)> ZIMGroupAttributesQueriedCallback
The return of query group attribute results.

Parameters

NameTypeDescription
groupIDconst std::string&Group ID.
groupAttributesconst std::unordered_map<std::string, std::string>&Group attributes.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupMemberRoleUpdatedCallback

Methods

onGroupMemberRoleUpdated

onGroupMemberRoleUpdated
typedef std::function<void(const std::string& groupID, const std::string& forUserID, ZIMGroupMemberRole role, const ZIMError& errorInfo)> ZIMGroupMemberRoleUpdatedCallback
Returns the result of the member role update.

Parameters

NameTypeDescription
groupIDconst std::string&Group ID.
forUserIDconst std::string&User ID.
roleZIMGroupMemberRoleUser role.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupMemberNicknameUpdatedCallback

Methods

onGroupMemberNicknameUpdated

onGroupMemberNicknameUpdated
typedef std::function<void(const std::string& groupID, const std::string& forUserID, const std::string& nickname, const ZIMError& errorInfo)> ZIMGroupMemberNicknameUpdatedCallback
Returns the result of the group member's nickname update.

Parameters

NameTypeDescription
groupIDconst std::string&Group ID.
forUserIDconst std::string&User ID.
nicknameconst std::string&User nickname.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupMemberInfoQueriedCallback

Methods

onGroupMemberInfoQueried

onGroupMemberInfoQueried
typedef std::function<void(const std::string& groupID, const ZIMGroupMemberInfo& userInfo, const ZIMError& errorInfo)> ZIMGroupMemberInfoQueriedCallback
Returns the result of the group member query.

Parameters

NameTypeDescription
groupIDconst std::string&Group ID.
userInfoconst ZIMGroupMemberInfo&Group member user information.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupListQueriedCallback

Methods

onGroupListQueried

onGroupListQueried
typedef std::function<void(const std::vector<ZIMGroup>& groupList, long long nextFlag, const ZIMError& errorInfo)> ZIMGroupListQueriedCallback
Returns the results of the query group list.

Parameters

NameTypeDescription
groupListconst std::vector<ZIMGroup>&Group list.
nextFlaglong longThe pagination anchor returned by the SDK is 0 if it means the list has been completely queried, and non-0 if it means there is still data to be queried.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupMemberListQueriedCallback

Methods

onGroupMemberListQueried

onGroupMemberListQueried
typedef std::function<void(const std::string& groupID, const std::vector<ZIMGroupMemberInfo>& userList, unsigned int nextFlag, const ZIMError& errorInfo)> ZIMGroupMemberListQueriedCallback
Returns the result of querying the group member list.

Parameters

NameTypeDescription
groupIDconst std::string&Group ID.
userListconst std::vector<ZIMGroupMemberInfo>&Group member list.
nextFlagunsigned intUsed to query the next page. The current value returns 0, which means that the list has been pulled out.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupMemberCountQueriedCallback

Methods

onGroupMemberCountQueried

onGroupMemberCountQueried
typedef std::function<void(const std::string& groupID, unsigned int count, const ZIMError& errorInfo)> ZIMGroupMemberCountQueriedCallback
Returns the result of querying the group member count.

Parameters

NameTypeDescription
groupIDconst std::string&Group ID.
countunsigned intGroup member count.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupMessageReceiptMemberListQueriedCallback

Methods

onGroupMessageReceiptMemberListQueried

onGroupMessageReceiptMemberListQueried
typedef std::function<void(const std::string& groupID, const std::vector<ZIMGroupMemberInfo>& userList, unsigned int nextFlag, const ZIMError& errorInfo)> ZIMGroupMessageReceiptMemberListQueriedCallback
Callback interface for querying the specific read/unread member list of group receipt messages.

Parameters

NameTypeDescription
groupIDconst std::string&Group ID.
userListconst std::vector<ZIMGroupMemberInfo>&Group member list.
nextFlagunsigned intUsed to query the next page. The current value returns 0, which means that the list has been pulled out.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupMutedCallback

Methods

onGroupMuted

onGroupMuted
typedef std::function<void(const std::string& groupID, bool isMute, const ZIMGroupMuteInfo& mutedInfo, const ZIMError& errorInfo)> ZIMGroupMutedCallback
Returns the result of the group mute info update.

Parameters

NameTypeDescription
groupIDconst std::string&Group ID.
isMuteboolWhether to mute.
mutedInfoconst ZIMGroupMuteInfo&Group mute information.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupMembersMutedCallback

Methods

onGroupMembersMuted

onGroupMembersMuted
typedef std::function<void(const std::string& groupID, bool isMute, int duration, const std::vector<std::string>& mutedUserIDs, const std::vector<ZIMErrorUserInfo>& errorUserList, const ZIMError& errorInfo)> ZIMGroupMembersMutedCallback
Returns the result of the group members mute info update.

Parameters

NameTypeDescription
groupIDconst std::string&Group ID.
isMuteboolWhether to mute.
durationintMute duration.
mutedUserIDsconst std::vector<std::string>&List of muted member userIDs.
errorUserListconst std::vector<ZIMErrorUserInfo>&List of user information that failed to be muted.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupMemberMutedListQueriedCallback

Methods

onGroupMemberMutedListQueried

onGroupMemberMutedListQueried
typedef std::function<void(const std::string& groupID, unsigned long long nextFlag, const std::vector<ZIMGroupMemberInfo>& userList, const ZIMError& errorInfo)> ZIMGroupMemberMutedListQueriedCallback
Returns the result of querying the group muted member list.

Parameters

NameTypeDescription
groupIDconst std::string&Group ID.
nextFlagunsigned long longUsed to query the next page. The current value returns 0, which means that the list has been pulled out.
userListconst std::vector<ZIMGroupMemberInfo>&Group member list.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupsSearchedCallback

Methods

onGroupsSearched

onGroupsSearched
typedef std::function<void(const std::vector<ZIMGroupSearchInfo>& groupSearchInfoList, unsigned int nextFlag, const ZIMError& errorInfo)> ZIMGroupsSearchedCallback
Returns the result of search a group.

Parameters

NameTypeDescription
groupSearchInfoListconst std::vector<ZIMGroupSearchInfo>&Group search information list.
nextFlagunsigned intUsed to query the next page. The current value returns 0, which means that the list has been pulled out.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupMembersSearchedCallback

Methods

onGroupMembersSearched

onGroupMembersSearched
typedef std::function<void(const std::string& groupID, const std::vector<ZIMGroupMemberInfo>& userList, unsigned int nextFlag, const ZIMError& errorInfo)> ZIMGroupMembersSearchedCallback
Returns the result of search a group members.

Parameters

NameTypeDescription
groupIDconst std::string&Group ID.
userListconst std::vector<ZIMGroupMemberInfo>&Group member list.
nextFlagunsigned intUsed to query the next page. The current value returns 0, which means that the list has been pulled out.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupJoinModeUpdatedCallback

Methods

onGroupJoinModeUpdated

onGroupJoinModeUpdated
typedef std::function<void(const std::string& groupID, ZIMGroupJoinMode mode, const ZIMError& errorInfo)> ZIMGroupJoinModeUpdatedCallback
The return of the results of the group verification mode update.

Parameters

NameTypeDescription
groupIDconst std::string&Group ID.
modeZIMGroupJoinModeGroup join mode.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupInviteModeUpdatedCallback

Methods

onGroupInviteModeUpdated

onGroupInviteModeUpdated
typedef std::function<void(const std::string& groupID, ZIMGroupInviteMode mode, const ZIMError& errorInfo)> ZIMGroupInviteModeUpdatedCallback
The return of the results of the group verification mode update.

Parameters

NameTypeDescription
groupIDconst std::string&Group ID.
modeZIMGroupInviteModeGroup invite mode.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupBeInviteModeUpdatedCallback

Methods

onGroupBeInviteModeUpdated

onGroupBeInviteModeUpdated
typedef std::function<void(const std::string& groupID, ZIMGroupBeInviteMode mode, const ZIMError& errorInfo)> ZIMGroupBeInviteModeUpdatedCallback
The return of the results of the group verification mode update.

Parameters

NameTypeDescription
groupIDconst std::string&Group ID.
modeZIMGroupBeInviteModeGroup be invite mode.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupJoinApplicationSentCallback

Methods

onGroupJoinApplicationSent

onGroupJoinApplicationSent
typedef std::function<void(const std::string& groupID, const ZIMError& errorInfo)> ZIMGroupJoinApplicationSentCallback
The return of the results of the group join application sent.

Parameters

NameTypeDescription
groupIDconst std::string&Group ID.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupJoinApplicationAcceptedCallback

Methods

onGroupJoinApplicationAccepted

onGroupJoinApplicationAccepted
typedef std::function<void(const std::string& groupID, const std::string& userID, const ZIMError& errorInfo)> ZIMGroupJoinApplicationAcceptedCallback
The return of the results of the group join application accept.

Parameters

NameTypeDescription
groupIDconst std::string&Group ID.
userIDconst std::string&User ID.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupJoinApplicationRejectedCallback

Methods

onGroupJoinApplicationRejected

onGroupJoinApplicationRejected
typedef std::function<void(const std::string& groupID, const std::string& userID, const ZIMError& errorInfo)> ZIMGroupJoinApplicationRejectedCallback
The return of the results of the group join application reject.

Parameters

NameTypeDescription
groupIDconst std::string&Group ID.
userIDconst std::string&User ID.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupInviteApplicationsSentCallback

Methods

onGroupInviteApplicationsSent

onGroupInviteApplicationsSent
typedef std::function<void(const std::string& groupID, const std::vector<ZIMErrorUserInfo>& errorUserList, const ZIMError& errorInfo)> ZIMGroupInviteApplicationsSentCallback
The return of the results of the group invite application sent.

Parameters

NameTypeDescription
groupIDconst std::string&Group ID.
errorUserListconst std::vector<ZIMErrorUserInfo>&Invite failed user information list.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupInviteApplicationAcceptedCallback

Methods

onGroupInviteApplicationAccepted

onGroupInviteApplicationAccepted
typedef std::function<void(const ZIMGroupFullInfo& groupInfo, const std::string& inviterUserID, const ZIMError& errorInfo)> ZIMGroupInviteApplicationAcceptedCallback
The return of the results of the group invite application accept.

Parameters

NameTypeDescription
groupInfoconst ZIMGroupFullInfo&Group information.
inviterUserIDconst std::string&Inviter user ID.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupInviteApplicationRejectedCallback

Methods

onGroupInviteApplicationRejected

onGroupInviteApplicationRejected
typedef std::function<void(const std::string& groupID, const std::string& inviterUserID, const ZIMError& errorInfo)> ZIMGroupInviteApplicationRejectedCallback
The return of the results of the group invite application accept.

Parameters

NameTypeDescription
groupIDconst std::string&Group information.
inviterUserIDconst std::string&Inviter user ID.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMGroupApplicationListQueriedCallback

Methods

onGroupApplicationListQueried

onGroupApplicationListQueried
typedef std::function<void(const std::vector<ZIMGroupApplicationInfo>& applicationList, unsigned long long nextFlag, const ZIMError& errorInfo)> ZIMGroupApplicationListQueriedCallback
Query the callback of group application list.

Parameters

NameTypeDescription
applicationListconst std::vector<ZIMGroupApplicationInfo>&Group application information list.
nextFlagunsigned long longPagination flag, used to get the next page. The current value returns 0, indicating that all data has been pulled out.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCallInvitationSentCallback

Methods

onCallInvitationSent

onCallInvitationSent
typedef std::function<void(const std::string& callID, const ZIMCallInvitationSentInfo& info, const ZIMError& errorInfo)> ZIMCallInvitationSentCallback
Action callback for sending a call invitation.

Parameters

NameTypeDescription
callIDconst std::string&Call ID.
infoconst ZIMCallInvitationSentInfo&Call invitation information.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCallingInvitationSentCallback

Methods

onCallingInvitationSent

onCallingInvitationSent
typedef std::function<void(const std::string& callID, const ZIMCallingInvitationSentInfo& info, const ZIMError& errorInfo)> ZIMCallingInvitationSentCallback
Callback result of inviting the current call.

Parameters

NameTypeDescription
callIDconst std::string&Call ID.
infoconst ZIMCallingInvitationSentInfo&Calling invitation information.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCallCancelSentCallback

Methods

onCallCancelSent

onCallCancelSent
typedef std::function<void(const std::string& callID, const std::vector<std::string>& errorInvitees, const ZIMError& errorInfo)> ZIMCallCancelSentCallback
Callback for the action to cancel the call invitation.

Parameters

NameTypeDescription
callIDconst std::string&Call ID.
errorInviteesconst std::vector<std::string>&Call invitation failed user ID list.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCallAcceptanceSentCallback

Methods

onCallAcceptanceSent

onCallAcceptanceSent
typedef std::function<void(const std::string& callID, const ZIMError& errorInfo)> ZIMCallAcceptanceSentCallback
Action callback for accepting call invitations.

Parameters

NameTypeDescription
callIDconst std::string&Call ID.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCallRejectionSentCallback

Methods

onCallRejectionSent

onCallRejectionSent
typedef std::function<void(const std::string& callID, const ZIMError& errorInfo)> ZIMCallRejectionSentCallback
Action callback for rejecting a call invitation.

Parameters

NameTypeDescription
callIDconst std::string&Call ID.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCallJoinSentCallback

Methods

onCallJoinSent

onCallJoinSent
typedef std::function<void(const std::string& callID, const ZIMCallJoinSentInfo& info, const ZIMError& errorInfo)> ZIMCallJoinSentCallback
Result callback of joining the call invitation.

Parameters

NameTypeDescription
callIDconst std::string&Call ID.
infoconst ZIMCallJoinSentInfo&Call join information.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCallQuitSentCallback

Methods

onCallQuitSent

onCallQuitSent
typedef std::function<void(const std::string& callID, const ZIMCallQuitSentInfo& info, const ZIMError& errorInfo)> ZIMCallQuitSentCallback
Quit the callback closure of the call invitation operation.

Parameters

NameTypeDescription
callIDconst std::string&Call ID.
infoconst ZIMCallQuitSentInfo&Call quit information.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCallEndSentCallback

Methods

onCallEndSent

onCallEndSent
typedef std::function<void(const std::string& callID, const ZIMCallEndedSentInfo& info, const ZIMError& errorInfo)> ZIMCallEndSentCallback
Result callback of ending the call invitation.

Parameters

NameTypeDescription
callIDconst std::string&Call ID.
infoconst ZIMCallEndedSentInfo&Call end information.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCallInvitationListQueriedCallback

Methods

onCallInvitationListQueried

onCallInvitationListQueried
typedef std::function<void(const std::vector<ZIMCallInfo>& callList, long long nextFlag, const ZIMError& errorInfo)> ZIMCallInvitationListQueriedCallback
Result Callback of querying the call list.

Parameters

NameTypeDescription
callListconst std::vector<ZIMCallInfo>&Call information list.
nextFlaglong longPagination flag, used to get the next page. The current value returns 0, indicating that all data has been pulled out.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMFriendAddedCallback

Methods

onFriendAdded

onFriendAdded
typedef std::function<void(const ZIMFriendInfo& friendInfo, const ZIMError& errorInfo)> ZIMFriendAddedCallback
Add a friend result callback.

Parameters

NameTypeDescription
friendInfoconst ZIMFriendInfo&Friend information.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMFriendsDeletedCallback

Methods

onFriendsDeleted

onFriendsDeleted
typedef std::function<void(const std::vector<ZIMErrorUserInfo>& errorUserList, const ZIMError& errorInfo)> ZIMFriendsDeletedCallback
Return results of deleting friends.

Parameters

NameTypeDescription
errorUserListconst std::vector<ZIMErrorUserInfo>&Friend information.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMFriendListQueriedCallback

Methods

onFriendListQueried

onFriendListQueried
typedef std::function<void(const std::vector<ZIMFriendInfo>& friendList, unsigned int nextFlag, const ZIMError& errorInfo)> ZIMFriendListQueriedCallback
The returned result of querying the friends list.

Parameters

NameTypeDescription
friendListconst std::vector<ZIMFriendInfo>&Friend information list.
nextFlagunsigned intPagination flag, used to get the next page. The current value returns 0, indicating that all data has been pulled out.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMFriendsInfoQueriedCallback

Methods

onFriendsInfoQueried

onFriendsInfoQueried
typedef std::function<void(const std::vector<ZIMFriendInfo>& friendInfos, const std::vector<ZIMErrorUserInfo>& errorUserList, const ZIMError& errorInfo)> ZIMFriendsInfoQueriedCallback
Return results of querying friend information in batches.

Parameters

NameTypeDescription
friendInfosconst std::vector<ZIMFriendInfo>&Friend information list.
errorUserListconst std::vector<ZIMErrorUserInfo>&Friend information.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMFriendsRelationCheckedCallback

Methods

onFriendsRelationChecked

onFriendsRelationChecked
typedef std::function<void(const std::vector<ZIMFriendRelationInfo>& relationInfos, const std::vector<ZIMErrorUserInfo>& errorUserList, const ZIMError& errorInfo)> ZIMFriendsRelationCheckedCallback
Check the friend relationship result.

Parameters

NameTypeDescription
relationInfosconst std::vector<ZIMFriendRelationInfo>&Friend relationship information list.
errorUserListconst std::vector<ZIMErrorUserInfo>&Friend information.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMFriendApplicationSentCallback

Methods

onFriendApplicationSent

onFriendApplicationSent
typedef std::function<void(const ZIMFriendApplicationInfo& applicationInfo, const ZIMError& errorInfo)> ZIMFriendApplicationSentCallback
The result of sending a friend application.

Parameters

NameTypeDescription
applicationInfoconst ZIMFriendApplicationInfo&Friend application information.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMFriendApplicationAcceptedCallback

Methods

onFriendApplicationAccepted

onFriendApplicationAccepted
typedef std::function<void(const ZIMFriendInfo& friendInfo, const ZIMError& errorInfo)> ZIMFriendApplicationAcceptedCallback
Accept the returned result of friend application.

Parameters

NameTypeDescription
friendInfoconst ZIMFriendInfo&Friend information.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMFriendApplicationRejectedCallback

Methods

onFriendApplicationRejected

onFriendApplicationRejected
typedef std::function<void(const ZIMUserInfo& userInfo, const ZIMError& errorInfo)> ZIMFriendApplicationRejectedCallback
Accept the returned result of friend application.

Parameters

NameTypeDescription
userInfoconst ZIMUserInfo&User information.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMFriendApplicationListQueriedCallback

Methods

onFriendApplicationListQueried

onFriendApplicationListQueried
typedef std::function<void(const std::vector<ZIMFriendApplicationInfo>& applicationList, unsigned int nextFlag, const ZIMError& errorInfo)> ZIMFriendApplicationListQueriedCallback
The result of sending a friend application.

Parameters

NameTypeDescription
applicationListconst std::vector<ZIMFriendApplicationInfo>&Friend application information list.
nextFlagunsigned intPagination flag, used to get the next page. The current value returns 0, indicating that all data has been pulled out.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMFriendAliasUpdatedCallback

Methods

onFriendAliasUpdated

onFriendAliasUpdated
typedef std::function<void(const ZIMFriendInfo& friendInfo, const ZIMError& errorInfo)> ZIMFriendAliasUpdatedCallback
Return results of updating friend alias.

Parameters

NameTypeDescription
friendInfoconst ZIMFriendInfo&Friend information.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMFriendAttributesUpdatedCallback

Methods

onFriendAttributesUpdated

onFriendAttributesUpdated
typedef std::function<void(const ZIMFriendInfo& friendInfo, const ZIMError& errorInfo)> ZIMFriendAttributesUpdatedCallback
Return results of updating friend attributes.

Parameters

NameTypeDescription
friendInfoconst ZIMFriendInfo&Friend information.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMFriendsSearchedCallback

Methods

onFriendsSearched

onFriendsSearched
typedef std::function<void(const std::vector<ZIMFriendInfo>& friendInfos, unsigned int nextFlag, const ZIMError& errorInfo)> ZIMFriendsSearchedCallback
Search results returned by local friends.

Parameters

NameTypeDescription
friendInfosconst std::vector<ZIMFriendInfo>&Friend information list.
nextFlagunsigned intPagination flag, used to get the next page. The current value returns 0, indicating that all data has been pulled out.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMBlacklistUsersAddedCallback

Methods

onBlacklistUsersAdded

onBlacklistUsersAdded
typedef std::function<void(const std::vector<ZIMErrorUserInfo>& errorUserList, const ZIMError& errorInfo)> ZIMBlacklistUsersAddedCallback
Callback for operation results of adding users to the blacklist.

Parameters

NameTypeDescription
errorUserListconst std::vector<ZIMErrorUserInfo>&User information.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMBlacklistUsersRemovedCallback

Methods

onBlacklistUsersRemoved

onBlacklistUsersRemoved
typedef std::function<void(const std::vector<ZIMErrorUserInfo>& errorUserList, const ZIMError& errorInfo)> ZIMBlacklistUsersRemovedCallback
The callback result of the operation to remove the user from the blacklist.

Parameters

NameTypeDescription
errorUserListconst std::vector<ZIMErrorUserInfo>&User information.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMBlacklistQueriedCallback

Methods

onBlacklistQueried

onBlacklistQueried
typedef std::function<void(const std::vector<ZIMUserInfo>& blacklist, unsigned int nextFlag, const ZIMError& errorInfo)> ZIMBlacklistQueriedCallback
Query the blacklist result callback.

Parameters

NameTypeDescription
blacklistconst std::vector<ZIMUserInfo>&Blacklist user information list.
nextFlagunsigned intPagination flag, used to get the next page. The current value returns 0, indicating that all data has been pulled out.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMBlacklistCheckedCallback

Methods

onBlacklistChecked

onBlacklistChecked
typedef std::function<void(bool isUserInBlacklist, const ZIMError& errorInfo)> ZIMBlacklistCheckedCallback
Blacklist check result callback.

Parameters

NameTypeDescription
isUserInBlacklistboolWhether in blacklist.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityCreatedCallback

Methods

onCommunityCreated

onCommunityCreated
typedef std::function<void(const ZIMCommunityFullInfo& communityInfo, const ZIMError& errorInfo)> ZIMCommunityCreatedCallback
Callback of the result of creating a community.

Parameters

NameTypeDescription
communityInfoconst ZIMCommunityFullInfo&Community information.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityDismissedCallback

Methods

onCommunityDismissed

onCommunityDismissed
typedef std::function<void(const std::string& communityID, const ZIMError& errorInfo)> ZIMCommunityDismissedCallback
Callback of the result of dismissing a community.

Parameters

NameTypeDescription
communityIDconst std::string&Community ID.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityJoinedCallback

Methods

onCommunityJoined

onCommunityJoined
typedef std::function<void(const ZIMCommunityFullInfo& communityInfo, const ZIMError& errorInfo)> ZIMCommunityJoinedCallback
Callback of the result of joining a community.

Parameters

NameTypeDescription
communityInfoconst ZIMCommunityFullInfo&Community information.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityLeftCallback

Methods

onCommunityLeft

onCommunityLeft
typedef std::function<void(const std::string& communityID, const ZIMError& errorInfo)> ZIMCommunityLeftCallback
Callback of the result of leaving a community.

Parameters

NameTypeDescription
communityIDconst std::string&Community ID.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityListQueriedCallback

Methods

onCommunityListQueried

onCommunityListQueried
typedef std::function<void(const std::vector<ZIMCommunity>& communityList, long long nextFlag, const ZIMError& errorInfo)> ZIMCommunityListQueriedCallback
Callback of the result of querying the community list.

Parameters

NameTypeDescription
communityListconst std::vector<ZIMCommunity>&Community list.
nextFlaglong longNext query community list flag.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityNameUpdatedCallback

Methods

onCommunityNameUpdated

onCommunityNameUpdated
typedef std::function<void(const std::string& communityID, const std::string& communityName, const ZIMError& errorInfo)> ZIMCommunityNameUpdatedCallback
Callback of the result of updating the community name.

Parameters

NameTypeDescription
communityIDconst std::string&Community ID.
communityNameconst std::string&Community name.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityAvatarUrlUpdatedCallback

Methods

onCommunityAvatarUrlUpdated

onCommunityAvatarUrlUpdated
typedef std::function<void(const std::string& communityID, const std::string& communityAvatarUrl, const ZIMError& errorInfo)> ZIMCommunityAvatarUrlUpdatedCallback
Callback of the result of updating the community avatar URL.

Parameters

NameTypeDescription
communityIDconst std::string&Community ID.
communityAvatarUrlconst std::string&Community avatar URL.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityNoticeUpdatedCallback

Methods

onCommunityNoticeUpdated

onCommunityNoticeUpdated
typedef std::function<void(const std::string& communityID, const std::string& communityNotice, const ZIMError& errorInfo)> ZIMCommunityNoticeUpdatedCallback
Callback of the result of updating the community notice.

Parameters

NameTypeDescription
communityIDconst std::string&Community ID.
communityNoticeconst std::string&Community notice.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityAttributesOperatedCallback

Methods

onCommunityAttributesOperated

onCommunityAttributesOperated
typedef std::function<void(const std::string& communityID, const std::vector<std::string>& errorKeys, const ZIMError& errorInfo)> ZIMCommunityAttributesOperatedCallback
Callback of the result of operating community attributes.

Parameters

NameTypeDescription
communityIDconst std::string&Community ID.
errorKeysconst std::vector<std::string>&Error keys.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityNotificationStatusSetCallback

Methods

onCommunityNotificationStatusSet

onCommunityNotificationStatusSet
typedef std::function<void(const std::string& communityID, const ZIMError& errorInfo)> ZIMCommunityNotificationStatusSetCallback
Callback of the result of setting the community notification status.

Parameters

NameTypeDescription
communityIDconst std::string&Community ID.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityInfoQueriedCallback

Methods

onCommunityInfoQueried

onCommunityInfoQueried
typedef std::function<void(const ZIMCommunityFullInfo& communityInfo, const ZIMError& errorInfo)> ZIMCommunityInfoQueriedCallback
Callback of the result of querying community information.

Parameters

NameTypeDescription
communityInfoconst ZIMCommunityFullInfo&Community information.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityUsersInvitedCallback

Methods

onCommunityUsersInvited

onCommunityUsersInvited
typedef std::function<void(const std::string& communityID, const std::vector<ZIMErrorUserInfo>& errorUserList, const ZIMError& errorInfo)> ZIMCommunityUsersInvitedCallback
Callback of the result of inviting users into the community.

Parameters

NameTypeDescription
communityIDconst std::string&Community ID.
errorUserListconst std::vector<ZIMErrorUserInfo>&The error userID list
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityMembersKickedCallback

Methods

onCommunityMembersKicked

onCommunityMembersKicked
typedef std::function<void(const std::string& communityID, const std::vector<ZIMErrorUserInfo>& errorUserList, const ZIMError& errorInfo)> ZIMCommunityMembersKickedCallback
Callback of the result of kicking members from the community.

Parameters

NameTypeDescription
communityIDconst std::string&Community ID.
errorUserListconst std::vector<ZIMErrorUserInfo>&The error userID list
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityMemberRoleUpdatedCallback

Methods

onCommunityMemberRoleUpdated

onCommunityMemberRoleUpdated
typedef std::function<void(const std::string& communityID, const std::string& forUserID, ZIMCommunityMemberRole memberRole, const ZIMError& errorInfo)> ZIMCommunityMemberRoleUpdatedCallback
Callback of the result of updating a community member's role.

Parameters

NameTypeDescription
communityIDconst std::string&Community ID.
forUserIDconst std::string&The user ID of the target user.
memberRoleZIMCommunityMemberRolemember role value
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityOwnerTransferredCallback

Methods

onCommunityOwnerTransferred

onCommunityOwnerTransferred
typedef std::function<void(const std::string& communityID, const std::string& toUserID, const ZIMError& errorInfo)> ZIMCommunityOwnerTransferredCallback
Callback of the result of transferring the community owner.

Parameters

NameTypeDescription
communityIDconst std::string&Community ID.
toUserIDconst std::string&The user ID of the new community owner.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityMemberListQueriedCallback

Methods

onCommunityMemberListQueried

onCommunityMemberListQueried
typedef std::function<void(const std::string& communityID, const std::vector<ZIMCommunityMemberInfo>& memberList, long long nextFlag, const ZIMError& errorInfo)> ZIMCommunityMemberListQueriedCallback
Callback of the result of querying the community member list.

Parameters

NameTypeDescription
communityIDconst std::string&Community ID.
memberListconst std::vector<ZIMCommunityMemberInfo>&Community member list.
nextFlaglong longAnchor for the next community member list query.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityMembersQueriedCallback

Methods

onCommunityMembersQueried

onCommunityMembersQueried
typedef std::function<void(const std::string& communityID, const std::vector<ZIMCommunityMemberInfo>& memberList, const std::vector<ZIMErrorUserInfo>& errorUserList, const ZIMError& errorInfo)> ZIMCommunityMembersQueriedCallback
Callback of the result of querying specific community members.

Parameters

NameTypeDescription
communityIDconst std::string&Community ID.
memberListconst std::vector<ZIMCommunityMemberInfo>&List of queried community members.
errorUserListconst std::vector<ZIMErrorUserInfo>&List of users that failed to be queried.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityChannelCreatedCallback

Methods

onCommunityChannelCreated

onCommunityChannelCreated
typedef std::function<void(const ZIMCommunityChannelFullInfo& channelInfo, const ZIMError& errorInfo)> ZIMCommunityChannelCreatedCallback
Callback of the result of creating a community channel.

Parameters

NameTypeDescription
channelInfoconst ZIMCommunityChannelFullInfo&Community channel information.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityChannelDismissedCallback

Methods

onCommunityChannelDismissed

onCommunityChannelDismissed
typedef std::function<void(const std::string& communityID, const std::string& channelID, const ZIMError& errorInfo)> ZIMCommunityChannelDismissedCallback
Callback of the result of dismissing a community channel.

Parameters

NameTypeDescription
communityIDconst std::string&Community ID.
channelIDconst std::string&Community channel ID
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityChannelNameUpdatedCallback

Methods

onCommunityChannelNameUpdated

onCommunityChannelNameUpdated
typedef std::function<void(const std::string& communityID, const std::string& channelID, const std::string& channelName, const ZIMError& errorInfo)> ZIMCommunityChannelNameUpdatedCallback
Callback of the result of updating the community channel name.

Parameters

NameTypeDescription
communityIDconst std::string&Community ID.
channelIDconst std::string&Community channel ID
channelNameconst std::string&Community channel name.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityChannelAvatarUrlUpdatedCallback

Methods

onCommunityChannelAvatarUrlUpdated

onCommunityChannelAvatarUrlUpdated
typedef std::function<void(const std::string& communityID, const std::string& channelID, const std::string& channelAvatarUrl, const ZIMError& errorInfo)> ZIMCommunityChannelAvatarUrlUpdatedCallback
Callback of the result of updating the community channel avatar URL.

Parameters

NameTypeDescription
communityIDconst std::string&Community ID.
channelIDconst std::string&Community channel ID
channelAvatarUrlconst std::string&Community avatar URL.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityChannelNoticeUpdatedCallback

Methods

onCommunityChannelNoticeUpdated

onCommunityChannelNoticeUpdated
typedef std::function<void(const std::string& communityID, const std::string& channelID, const std::string& channelNotice, const ZIMError& errorInfo)> ZIMCommunityChannelNoticeUpdatedCallback
Callback of the result of updating the community channel notice.

Parameters

NameTypeDescription
communityIDconst std::string&Community ID.
channelIDconst std::string&Community channel ID
channelNoticeconst std::string&Community channel notice.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityChannelAttributesOperatedCallback

Methods

onCommunityChannelAttributesOperated

onCommunityChannelAttributesOperated
typedef std::function<void(const std::string& communityID, const std::string& channelID, const std::vector<std::string>& errorKeys, const ZIMError& errorInfo)> ZIMCommunityChannelAttributesOperatedCallback
Callback of the result of operating community channel attributes.

Parameters

NameTypeDescription
communityIDconst std::string&Community ID.
channelIDconst std::string&Community channel ID.
errorKeysconst std::vector<std::string>&Error keys.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityChannelsInfoQueriedCallback

Methods

onCommunityChannelsInfoQueried

onCommunityChannelsInfoQueried
typedef std::function<void(const std::string& communityID, const std::vector<ZIMCommunityChannelFullInfo>& channelInfos, const std::vector<std::string>& errorChannelIDs, const ZIMError& errorInfo)> ZIMCommunityChannelsInfoQueriedCallback
Callback of the result of querying community channel information.

Parameters

NameTypeDescription
communityIDconst std::string&Community ID.
channelInfosconst std::vector<ZIMCommunityChannelFullInfo>&List of queried community channels.
errorChannelIDsconst std::vector<std::string>&List of channel IDs that failed to be queried.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityChannelListQueriedCallback

Methods

onCommunityChannelListQueried

onCommunityChannelListQueried
typedef std::function<void(const std::string& communityID, const std::vector<ZIMCommunityChannel>& channelList, long long nextFlag, const ZIMError& errorInfo)> ZIMCommunityChannelListQueriedCallback
Callback of the result of querying the community channel list.

Parameters

NameTypeDescription
communityIDconst std::string&Community ID.
channelListconst std::vector<ZIMCommunityChannel>&Community channel list.
nextFlaglong longAnchor for the next channel list query.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityMembersMutedCallback

Methods

onCommunityMembersMuted

onCommunityMembersMuted
typedef std::function<void(const std::string& communityID, const std::string& channelID, bool isMute, const std::vector<ZIMErrorUserInfo>& errorUserList, const ZIMError& errorInfo)> ZIMCommunityMembersMutedCallback
Callback of the result of muting community members.

Parameters

NameTypeDescription
communityIDconst std::string&Community ID.
channelIDconst std::string&The channel ID. Empty means muted at the community level.
isMuteboolWhether to mute the members.
errorUserListconst std::vector<ZIMErrorUserInfo>&List of users that failed to be muted.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

ZIMCommunityChannelsMutedCallback

Methods

onCommunityChannelsMuted

onCommunityChannelsMuted
typedef std::function<void(const std::string& communityID, bool isMute, const std::vector<std::string>& errorChannelIDs, const ZIMError& errorInfo)> ZIMCommunityChannelsMutedCallback
Callback of the result of muting community channels.

Parameters

NameTypeDescription
communityIDconst std::string&Community ID.
isMuteboolWhether to mute the channels.
errorChannelIDsconst std::vector<std::string>&List of channel IDs that failed to be muted.
errorInfoconst ZIMError&Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.

Previous

Class

Next

Struct

On this page

Back to top