Interface
ZIMLogUploadedCallback
Methods
onLogUploaded
typedef std::function<void(const ZIMError& errorInfo)> ZIMLogUploadedCallbackParameters
| Name | Type | Description |
|---|---|---|
| errorInfo | const 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
typedef std::function<void(const ZIMError& errorInfo)> ZIMLoggedInCallbackParameters
| Name | Type | Description |
|---|---|---|
| errorInfo | const 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
typedef std::function<void(const std::string& token, const ZIMError& errorInfo)> ZIMTokenRenewedCallbackParameters
| Name | Type | Description |
|---|---|---|
| token | const std::string& | The renewed token. |
| errorInfo | const 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
typedef std::function<void(const std::string& result, const ZIMError& errorInfo)> ZIMExperimentalAPICalledCallbackParameters
| Name | Type | Description |
|---|---|---|
| result | const std::string& | The result returned by calling the experimental API in JSON string format. For details, please consult ZEGO technical support. |
| errorInfo | const 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
typedef std::function<void(const std::string& userName, const ZIMError& errorInfo)> ZIMUserNameUpdatedCallbackParameters
| Name | Type | Description |
|---|---|---|
| userName | const std::string& | The updated user name. |
| errorInfo | const 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
typedef std::function<void(const std::string& userAvatarUrl, const ZIMError& errorInfo)> ZIMUserAvatarUrlUpdatedCallbackParameters
| Name | Type | Description |
|---|---|---|
| userAvatarUrl | const std::string& | The updated user avatar URL. |
| errorInfo | const 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
typedef std::function<void(const std::string& extendedData, const ZIMError& errorInfo)> ZIMUserExtendedDataUpdatedCallbackParameters
| Name | Type | Description |
|---|---|---|
| extendedData | const std::string& | The updated user extended data. |
| errorInfo | const 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
typedef std::function<void(const std::string& customStatus, const ZIMError& errorInfo)> ZIMUserCustomStatusUpdatedCallbackParameters
| Name | Type | Description |
|---|---|---|
| customStatus | const std::string& | The updated user custom status. |
| errorInfo | const 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
typedef std::function<void(const ZIMError& errorInfo)> ZIMUserBadgeUpdatedCallbackParameters
| Name | Type | Description |
|---|---|---|
| errorInfo | const 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
typedef std::function<void(const std::vector<ZIMUserFullInfo>& userList, const std::vector<ZIMErrorUserInfo>& errorUserList, const ZIMError& errorInfo)> ZIMUsersInfoQueriedCallbackParameters
| Name | Type | Description |
|---|---|---|
| userList | const std::vector<ZIMUserFullInfo>& | The queried user information list. |
| errorUserList | const std::vector<ZIMErrorUserInfo>& | The list of user IDs that failed to be queried. |
| errorInfo | const 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
typedef std::function<void(const ZIMUserOfflinePushRule& offlinePushRule, const ZIMError& errorInfo)> ZIMUserOfflinePushRuleUpdatedCallbackParameters
| Name | Type | Description |
|---|---|---|
| offlinePushRule | const ZIMUserOfflinePushRule& | The updated user offline push rule. |
| errorInfo | const 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
typedef std::function<void(const ZIMSelfUserInfo& selfUserInfo, const ZIMError& errorInfo)> ZIMSelfUserInfoQueriedCallbackParameters
| Name | Type | Description |
|---|---|---|
| selfUserInfo | const ZIMSelfUserInfo& | The current user information and rules. |
| errorInfo | const 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
typedef std::function<void(const std::vector<ZIMUserStatus>& userStatusList, const std::vector<ZIMErrorUserInfo>& errorUserList, const ZIMError& errorInfo)> ZIMUsersStatusQueriedCallbackParameters
| Name | Type | Description |
|---|---|---|
| userStatusList | const std::vector<ZIMUserStatus>& | The queried user status list. |
| errorUserList | const std::vector<ZIMErrorUserInfo>& | The list of user IDs that failed to be queried. |
| errorInfo | const 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
typedef std::function<void(const std::vector<ZIMErrorUserInfo>& errorUserList, const ZIMError& errorInfo)> ZIMUsersStatusSubscribedCallbackParameters
| Name | Type | Description |
|---|---|---|
| errorUserList | const std::vector<ZIMErrorUserInfo>& | The list of user IDs that failed to subscribe. |
| errorInfo | const 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
typedef std::function<void(const std::vector<ZIMErrorUserInfo>& errorUserList, const ZIMError& errorInfo)> ZIMUsersStatusUnsubscribedCallbackParameters
| Name | Type | Description |
|---|---|---|
| errorUserList | const std::vector<ZIMErrorUserInfo>& | The list of user IDs that failed to unsubscribe. |
| errorInfo | const 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
typedef std::function<void(const std::vector<ZIMUserStatusSubscription>& userStatusSubscriptionList, const ZIMError& errorInfo)> ZIMSubscribedUserStatusListQueriedCallbackParameters
| Name | Type | Description |
|---|---|---|
| userStatusSubscriptionList | const std::vector<ZIMUserStatusSubscription>& | The user status subscription list. |
| errorInfo | const 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
typedef std::function<void(ZIMConversation conversation, const ZIMError& errorInfo)> ZIMConversationQueriedCallbackParameters
| Name | Type | Description |
|---|---|---|
| conversation | ZIMConversation | The queried conversation object. |
| errorInfo | const 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
typedef std::function<void(const std::vector<ZIMConversation>& conversationList, const ZIMError& errorInfo)> ZIMConversationListQueriedCallbackParameters
| Name | Type | Description |
|---|---|---|
| conversationList | const std::vector<ZIMConversation>& | The queried conversation list. |
| errorInfo | const 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
typedef std::function<void(unsigned int unreadMessageCount, const ZIMError& errorInfo)> ZIMConversationTotalUnreadMessageCountQueriedCallbackParameters
| Name | Type | Description |
|---|---|---|
| unreadMessageCount | unsigned int | The total count of unread messages across all conversations. |
| errorInfo | const 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
typedef std::function<void(const std::string& conversationID, ZIMConversationType conversationType, const ZIMError& errorInfo)> ZIMConversationDeletedCallbackParameters
| Name | Type | Description |
|---|---|---|
| conversationID | const std::string& | The ID of the deleted conversation. |
| conversationType | ZIMConversationType | The type of the deleted conversation. |
| errorInfo | const 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
typedef std::function<void(const ZIMError& errorInfo)> ZIMConversationsAllDeletedCallbackParameters
| Name | Type | Description |
|---|---|---|
| errorInfo | const 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
typedef std::function<void(const std::string& conversationID, ZIMConversationType conversationType, const ZIMError& errorInfo)> ZIMConversationUnreadMessageCountClearedCallbackParameters
| Name | Type | Description |
|---|---|---|
| conversationID | const std::string& | The conversation ID whose unread message count was cleared. |
| conversationType | ZIMConversationType | The conversation type whose unread message count was cleared. |
| errorInfo | const 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
typedef std::function<void(const ZIMError& errorInfo)> ZIMConversationTotalUnreadMessageCountClearedCallbackParameters
| Name | Type | Description |
|---|---|---|
| errorInfo | const 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
typedef std::function<void(const std::string& conversationID, ZIMConversationType conversationType, const ZIMError& errorInfo)> ZIMConversationNotificationStatusSetCallbackParameters
| Name | Type | Description |
|---|---|---|
| conversationID | const std::string& | The conversation ID for which the notification status was set. |
| conversationType | ZIMConversationType | The conversation type for which the notification status was set. |
| errorInfo | const 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
typedef std::function<void(const std::string& conversationID, ZIMConversationType conversationType, const ZIMError& errorInfo)> ZIMConversationMessageReceiptReadSentCallbackParameters
| Name | Type | Description |
|---|---|---|
| conversationID | const std::string& | The conversation ID for which the receipt was sent. |
| conversationType | ZIMConversationType | The conversation type for which the receipt was sent. |
| errorInfo | const 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
typedef std::function<void(const std::string& conversationID, ZIMConversationType conversationType, const ZIMError& errorInfo)> ZIMConversationPinnedStateUpdatedCallbackParameters
| Name | Type | Description |
|---|---|---|
| conversationID | const std::string& | The conversation ID whose pinned state was updated. |
| conversationType | ZIMConversationType | The conversation type whose pinned state was updated. |
| errorInfo | const 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
typedef std::function<void(const std::vector<ZIMConversation>& conversationList, const ZIMError& errorInfo)> ZIMConversationPinnedListQueriedCallbackParameters
| Name | Type | Description |
|---|---|---|
| conversationList | const std::vector<ZIMConversation>& | The queried pinned conversation list. |
| errorInfo | const 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
typedef std::function<void(const std::string& conversationID, ZIMConversationType conversationType, const ZIMError& errorInfo)> ZIMConversationDraftSetCallbackParameters
| Name | Type | Description |
|---|---|---|
| conversationID | const std::string& | The conversation ID for which the draft was set. |
| conversationType | ZIMConversationType | The conversation type for which the draft was set. |
| errorInfo | const 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
typedef std::function<void(const std::vector<ZIMConversationBaseInfo>& failedConversationInfos, const ZIMError& errorInfo)> ZIMConversationMarkSetCallbackParameters
| Name | Type | Description |
|---|---|---|
| failedConversationInfos | const std::vector<ZIMConversationBaseInfo>& | The list of conversation info objects that failed to have marks set. |
| errorInfo | const 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
typedef std::function<void(const std::string& conversationID, ZIMConversationType conversationType, const ZIMError& errorInfo)> ZIMConversationMessageDestructDurationSetCallbackParameters
| Name | Type | Description |
|---|---|---|
| conversationID | const std::string& | The ID of the conversation for which the setting was applied. |
| conversationType | ZIMConversationType | The type of the conversation for which the setting was applied. |
| errorInfo | const 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
typedef std::function<void(const std::vector<ZIMConversationSearchInfo>& conversationSearchInfoList, unsigned int nextFlag, const ZIMError& errorInfo)> ZIMConversationsSearchedCallbackParameters
| Name | Type | Description |
|---|---|---|
| conversationSearchInfoList | const std::vector<ZIMConversationSearchInfo>& | The list of searched conversation results. |
| nextFlag | unsigned int | Anchor for the next page query. |
| errorInfo | const 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
typedef std::function<void(ZIMMessage message, const ZIMError& errorInfo)> ZIMMessageSentCallbackParameters
| Name | Type | Description |
|---|---|---|
| message | ZIMMessage | Message object. |
| errorInfo | const 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
typedef std::function<void(const std::string& conversationID, ZIMConversationType conversationType, const std::vector<ZIMMessage>& messageList, const ZIMError& errorInfo)> ZIMMessageQueriedCallbackParameters
| Name | Type | Description |
|---|---|---|
| conversationID | const std::string& | Conversation ID. |
| conversationType | ZIMConversationType | Conversation type. |
| messageList | const std::vector<ZIMMessage>& | Message list. |
| errorInfo | const 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
typedef std::function<void(const std::string& conversationID, ZIMConversationType conversationType, const ZIMError& errorInfo)> ZIMMessageDeletedCallbackParameters
| Name | Type | Description |
|---|---|---|
| conversationID | const std::string& | Conversation ID. |
| conversationType | ZIMConversationType | Conversation type. |
| errorInfo | const 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
typedef std::function<void(const ZIMError& errorInfo)> ZIMConversationMessagesAllDeletedCallbackParameters
| Name | Type | Description |
|---|---|---|
| errorInfo | const 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
typedef std::function<void(ZIMMessage message, const ZIMError& errorInfo)> ZIMMessageRevokedCallbackParameters
| Name | Type | Description |
|---|---|---|
| message | ZIMMessage | Message object. |
| errorInfo | const 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
typedef std::function<void(ZIMMessage message, const ZIMError& errorInfo)> ZIMMessageInsertedCallbackParameters
| Name | Type | Description |
|---|---|---|
| message | ZIMMessage | Message object. |
| errorInfo | const 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
typedef std::function<void(ZIMMessage message, const ZIMError& errorInfo)> ZIMMessageLocalExtendedDataUpdatedCallbackParameters
| Name | Type | Description |
|---|---|---|
| message | ZIMMessage | Message object. |
| errorInfo | const 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
typedef std::function<void(const std::string& conversationID, ZIMConversationType conversationType, const std::vector<long long>& errorMessageIDs, const ZIMError& errorInfo)> ZIMMessageReceiptsReadSentCallbackParameters
| Name | Type | Description |
|---|---|---|
| conversationID | const std::string& | Conversation ID. |
| conversationType | ZIMConversationType | Conversation type. |
| errorMessageIDs | const std::vector<long long>& | Error message ID list. |
| errorInfo | const 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
typedef std::function<void(const std::vector<ZIMMessageReceiptInfo>& infos, const std::vector<long long>& errorMessageIDs, const ZIMError& errorInfo)> ZIMMessageReceiptsInfoQueriedCallbackParameters
| Name | Type | Description |
|---|---|---|
| infos | const std::vector<ZIMMessageReceiptInfo>& | Message receipt information list. |
| errorMessageIDs | const std::vector<long long>& | Error message ID list. |
| errorInfo | const 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
typedef std::function<void(ZIMMessage message, const ZIMError& errorInfo)> ZIMMediaDownloadedCallbackParameters
| Name | Type | Description |
|---|---|---|
| message | ZIMMessage | Message object. |
| errorInfo | const 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
typedef std::function<void(ZIMMessage message, unsigned long long currentFileSize, unsigned long long totalFileSize)> ZIMMediaDownloadingProgressParameters
| Name | Type | Description |
|---|---|---|
| message | ZIMMessage | Message object. |
| currentFileSize | unsigned long long | Current file size. |
| totalFileSize | unsigned long long | Total file size. |
ZIMMessagesSearchedCallback
Methods
onMessagesSearched
typedef std::function<void(const std::string& conversationID, ZIMConversationType conversationType, const std::vector<ZIMMessage>& messageList, ZIMMessage nextMessage, const ZIMError& errorInfo)> ZIMMessagesSearchedCallbackParameters
| Name | Type | Description |
|---|---|---|
| conversationID | const std::string& | Conversation ID. |
| conversationType | ZIMConversationType | Conversation type. |
| messageList | const std::vector<ZIMMessage>& | Message list. |
| nextMessage | ZIMMessage | Next message object. |
| errorInfo | const 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
typedef std::function<void(const std::vector<ZIMMessage>& messageList, ZIMMessage nextMessage, const ZIMError& errorInfo)> ZIMMessagesGlobalSearchedCallbackParameters
| Name | Type | Description |
|---|---|---|
| messageList | const std::vector<ZIMMessage>& | Message list. |
| nextMessage | ZIMMessage | Next message object. |
| errorInfo | const 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
typedef std::function<void(const ZIMMessageReaction& reaction, const ZIMError& errorInfo)> ZIMMessageReactionAddedCallbackParameters
| Name | Type | Description |
|---|---|---|
| reaction | const ZIMMessageReaction& | Message reaction object. |
| errorInfo | const 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
typedef std::function<void(const ZIMMessageReaction& reaction, const ZIMError& errorInfo)> ZIMMessageReactionDeletedCallbackParameters
| Name | Type | Description |
|---|---|---|
| reaction | const ZIMMessageReaction& | Message reaction object. |
| errorInfo | const 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
typedef std::function<void(const ZIMError& errorInfo)> ZIMMessageReactionsAllDeletedCallbackParameters
| Name | Type | Description |
|---|---|---|
| errorInfo | const 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
typedef std::function<void(ZIMMessage message, const std::vector<ZIMMessageReactionUserFullInfo>& userInfoList, const std::string& reactionType, long long nextFlag, unsigned int totalCount, const ZIMError& errorInfo)> ZIMMessageReactionUserListQueriedCallbackParameters
| Name | Type | Description |
|---|---|---|
| message | ZIMMessage | Message object. |
| userInfoList | const std::vector<ZIMMessageReactionUserFullInfo>& | List of user reaction information. |
| reactionType | const std::string& | Message reaction type. |
| nextFlag | long long | List query anchor, used to query the next page. The current value returns 0, which means that the list has been pulled out. |
| totalCount | unsigned int | Total user count. |
| errorInfo | const 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
typedef std::function<void(ZIMCombineMessage message, const ZIMError& errorInfo)> ZIMCombineMessageDetailQueriedCallbackParameters
| Name | Type | Description |
|---|---|---|
| message | ZIMCombineMessage | Combine message object. The messageList in this object already contains the sub-message list of the merged message. |
| errorInfo | const 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
typedef std::function<void(const std::vector<ZIMMessage>& messageList, long long nextFlag, const ZIMMessageRootRepliedInfo& rootRepliedInfo, const ZIMError& errorInfo)> ZIMMessageRepliedListQueriedCallbackParameters
| Name | Type | Description |
|---|---|---|
| messageList | const std::vector<ZIMMessage>& | Message list. |
| nextFlag | long long | List query anchor, used to query the next page. The current value returns 0, which means that the list has been pulled out. |
| rootRepliedInfo | const ZIMMessageRootRepliedInfo& | Root message reply information. |
| errorInfo | const 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
typedef std::function<void(ZIMMessage message, const ZIMError& errorInfo)> ZIMMessageEditedCallbackParameters
| Name | Type | Description |
|---|---|---|
| message | ZIMMessage | Message object. |
| errorInfo | const 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
typedef std::function<void(const ZIMError& errorInfo)> ZIMSendingMessageCancelledCallbackParameters
| Name | Type | Description |
|---|---|---|
| errorInfo | const 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
typedef std::function<void(const ZIMError& errorInfo)> ZIMMessagePinnedCallbackParameters
| Name | Type | Description |
|---|---|---|
| errorInfo | const 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
typedef std::function<void(const std::vector<ZIMMessage>& messageList, const ZIMError& errorInfo)> ZIMPinnedMessageListQueriedCallbackParameters
| Name | Type | Description |
|---|---|---|
| messageList | const std::vector<ZIMMessage>& | Message list. |
| errorInfo | const 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
typedef std::function<void(unsigned long long exportedMessageCount, unsigned long long totalMessageCount)> ZIMMessageExportingProgressParameters
| Name | Type | Description |
|---|---|---|
| exportedMessageCount | unsigned long long | The number of exported messages. |
| totalMessageCount | unsigned long long | The total number of messages. |
ZIMFileCacheQueriedCallback
Methods
onFileCacheQueried
typedef std::function<void(const ZIMFileCacheInfo& fileCacheInfo, const ZIMError& errorInfo)> ZIMFileCacheQueriedCallbackParameters
| Name | Type | Description |
|---|---|---|
| fileCacheInfo | const ZIMFileCacheInfo& | File cache information. |
| errorInfo | const 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
typedef std::function<void(const ZIMError& errorInfo)> ZIMFileCacheClearedCallbackParameters
| Name | Type | Description |
|---|---|---|
| errorInfo | const 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
typedef std::function<void(const ZIMRoomFullInfo& roomInfo, const ZIMError& errorInfo)> ZIMRoomCreatedCallbackParameters
| Name | Type | Description |
|---|---|---|
| roomInfo | const ZIMRoomFullInfo& | Room information. |
| errorInfo | const 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
typedef std::function<void(const ZIMRoomFullInfo& roomInfo, const ZIMError& errorInfo)> ZIMRoomJoinedCallbackParameters
| Name | Type | Description |
|---|---|---|
| roomInfo | const ZIMRoomFullInfo& | Room information. |
| errorInfo | const 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
typedef std::function<void(const ZIMRoomFullInfo& roomInfo, const ZIMError& errorInfo)> ZIMRoomEnteredCallbackParameters
| Name | Type | Description |
|---|---|---|
| roomInfo | const ZIMRoomFullInfo& | Room information. |
| errorInfo | const 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
typedef std::function<void(const ZIMRoomFullInfo& roomInfo, const ZIMError& errorInfo)> ZIMRoomSwitchedCallbackParameters
| Name | Type | Description |
|---|---|---|
| roomInfo | const ZIMRoomFullInfo& | Room information. |
| errorInfo | const 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
typedef std::function<void(const std::string& roomID, const ZIMError& errorInfo)> ZIMRoomLeftCallbackParameters
| Name | Type | Description |
|---|---|---|
| roomID | const std::string& | Room ID. |
| errorInfo | const 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
typedef std::function<void(const std::vector<std::string>& roomIDs, const ZIMError& errorInfo)> ZIMRoomAllLeftCallbackParameters
| Name | Type | Description |
|---|---|---|
| roomIDs | const std::vector<std::string>& | Room ID list. |
| errorInfo | const 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
typedef std::function<void(const std::string& roomID, const std::vector<ZIMUserInfo>& memberList, const std::string& nextFlag, const ZIMError& errorInfo)> ZIMRoomMemberQueriedCallbackParameters
| Name | Type | Description |
|---|---|---|
| roomID | const std::string& | Room ID. |
| memberList | const std::vector<ZIMUserInfo>& | Room member list. |
| nextFlag | const std::string& | Used to query the next page. The current value returns an empty string, which means that the list has been pulled out. |
| errorInfo | const 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
typedef std::function<void(const std::string& roomID, const std::vector<ZIMRoomMemberInfo>& memberList, const std::vector<ZIMErrorUserInfo>& errorUserList, const ZIMError& errorInfo)> ZIMRoomMembersQueriedCallbackParameters
| Name | Type | Description |
|---|---|---|
| roomID | const std::string& | Room ID. |
| memberList | const std::vector<ZIMRoomMemberInfo>& | Room member list. |
| errorUserList | const std::vector<ZIMErrorUserInfo>& | Error member list. |
| errorInfo | const 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
typedef std::function<void(const std::string& roomID, unsigned int count, const ZIMError& errorInfo)> ZIMRoomOnlineMemberCountQueriedCallbackParameters
| Name | Type | Description |
|---|---|---|
| roomID | const std::string& | Room ID. |
| count | unsigned int | Online member count. |
| errorInfo | const 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
typedef std::function<void(const std::string& roomID, const std::vector<std::string>& errorKeys, const ZIMError& errorInfo)> ZIMRoomAttributesOperatedCallbackParameters
| Name | Type | Description |
|---|---|---|
| roomID | const std::string& | Room ID. |
| errorKeys | const std::vector<std::string>& | Error key list. |
| errorInfo | const 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
typedef std::function<void(const std::string& roomID, const ZIMError& errorInfo)> ZIMRoomAttributesBatchOperatedCallbackParameters
| Name | Type | Description |
|---|---|---|
| roomID | const std::string& | Room ID. |
| errorInfo | const 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
typedef std::function<void(const std::string& roomID, const std::unordered_map<std::string, std::string>& roomAttributes, const ZIMError& errorInfo)> ZIMRoomAttributesQueriedCallbackParameters
| Name | Type | Description |
|---|---|---|
| roomID | const std::string& | Room ID. |
| roomAttributes | const std::unordered_map<std::string, std::string>& | Room attributes. |
| errorInfo | const 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
typedef std::function<void(const std::string& roomID, const std::vector<ZIMRoomMemberAttributesOperatedInfo>& infos, const std::vector<std::string>& errorUserList, const ZIMError& errorInfo)> ZIMRoomMembersAttributesOperatedCallbackParameters
| Name | Type | Description |
|---|---|---|
| roomID | const std::string& | Room ID. |
| infos | const std::vector<ZIMRoomMemberAttributesOperatedInfo>& | Room member attribute operation information list. |
| errorUserList | const std::vector<std::string>& | Error member list. |
| errorInfo | const 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
typedef std::function<void(const std::string& roomID, const std::vector<ZIMRoomMemberAttributesInfo>& infos, const ZIMError& errorInfo)> ZIMRoomMembersAttributesQueriedCallbackParameters
| Name | Type | Description |
|---|---|---|
| roomID | const std::string& | Room ID. |
| infos | const std::vector<ZIMRoomMemberAttributesInfo>& | Room member attribute information list. |
| errorInfo | const 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
typedef std::function<void(const std::string& roomID, const std::vector<ZIMRoomMemberAttributesInfo>& infos, const std::string& nextFlag, const ZIMError& errorInfo)> ZIMRoomMemberAttributesListQueriedCallbackParameters
| Name | Type | Description |
|---|---|---|
| roomID | const std::string& | Room ID. |
| infos | const std::vector<ZIMRoomMemberAttributesInfo>& | Room member attribute information list. |
| nextFlag | const std::string& | Used to query the next page. The current value returns 0, which means that the list has been pulled out. |
| errorInfo | const 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
typedef std::function<void(const ZIMGroupFullInfo& groupInfo, const std::vector<ZIMGroupMemberInfo>& userList, const std::vector<ZIMErrorUserInfo>& errorUserList, const ZIMError& errorInfo)> ZIMGroupCreatedCallbackParameters
| Name | Type | Description |
|---|---|---|
| groupInfo | const ZIMGroupFullInfo& | Group information. |
| userList | const std::vector<ZIMGroupMemberInfo>& | Group member information list. |
| errorUserList | const std::vector<ZIMErrorUserInfo>& | Error member list. |
| errorInfo | const 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
typedef std::function<void(const std::string& groupID, const ZIMError& errorInfo)> ZIMGroupDismissedCallbackParameters
| Name | Type | Description |
|---|---|---|
| groupID | const std::string& | Group ID. |
| errorInfo | const 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
typedef std::function<void(const ZIMGroupFullInfo& groupInfo, const ZIMError& errorInfo)> ZIMGroupJoinedCallbackParameters
| Name | Type | Description |
|---|---|---|
| groupInfo | const ZIMGroupFullInfo& | Group information. |
| errorInfo | const 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
typedef std::function<void(const std::string& groupID, const ZIMError& errorInfo)> ZIMGroupLeftCallbackParameters
| Name | Type | Description |
|---|---|---|
| groupID | const std::string& | Group ID. |
| errorInfo | const 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
typedef std::function<void(const std::string& groupID, const std::vector<ZIMGroupMemberInfo>& userList, const std::vector<ZIMErrorUserInfo>& errorUserList, const ZIMError& errorInfo)> ZIMGroupUsersInvitedCallbackParameters
| Name | Type | Description |
|---|---|---|
| groupID | const std::string& | Group ID. |
| userList | const std::vector<ZIMGroupMemberInfo>& | Group member information list. |
| errorUserList | const std::vector<ZIMErrorUserInfo>& | Error member list. |
| errorInfo | const 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
typedef std::function<void(const std::string& groupID, const std::vector<std::string>& kickedUserIDList, const std::vector<ZIMErrorUserInfo>& errorUserList, const ZIMError& errorInfo)> ZIMGroupMemberKickedCallbackParameters
| Name | Type | Description |
|---|---|---|
| groupID | const std::string& | Group ID. |
| kickedUserIDList | const std::vector<std::string>& | List of user IDs kicked out. |
| errorUserList | const std::vector<ZIMErrorUserInfo>& | Error member list. |
| errorInfo | const 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
typedef std::function<void(const std::string& groupID, const std::string& toUserID, const ZIMError& errorInfo)> ZIMGroupOwnerTransferredCallbackParameters
| Name | Type | Description |
|---|---|---|
| groupID | const std::string& | Group ID. |
| toUserID | const std::string& | New group owner user ID. |
| errorInfo | const 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
typedef std::function<void(const std::string& groupID, const std::string& groupName, const ZIMError& errorInfo)> ZIMGroupNameUpdatedCallbackParameters
| Name | Type | Description |
|---|---|---|
| groupID | const std::string& | Group ID. |
| groupName | const std::string& | Group name. |
| errorInfo | const 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
typedef std::function<void(const std::string& groupID, const std::string& groupAvatarUrl, const ZIMError& errorInfo)> ZIMGroupAvatarUrlUpdatedCallbackParameters
| Name | Type | Description |
|---|---|---|
| groupID | const std::string& | Group ID. |
| groupAvatarUrl | const std::string& | Group avatar URL. |
| errorInfo | const 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
typedef std::function<void(const std::string& groupID, const std::string& groupNotice, const ZIMError& errorInfo)> ZIMGroupNoticeUpdatedCallbackParameters
| Name | Type | Description |
|---|---|---|
| groupID | const std::string& | Group ID. |
| groupNotice | const std::string& | Group notice. |
| errorInfo | const 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
typedef std::function<void(const std::string& groupID, const std::string& groupAlias, const ZIMError& errorInfo)> ZIMGroupAliasUpdatedCallbackParameters
| Name | Type | Description |
|---|---|---|
| groupID | const std::string& | Group ID. |
| groupAlias | const std::string& | Group alias. |
| errorInfo | const 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
typedef std::function<void(const ZIMGroupFullInfo& groupInfo, const ZIMError& errorInfo)> ZIMGroupInfoQueriedCallbackParameters
| Name | Type | Description |
|---|---|---|
| groupInfo | const ZIMGroupFullInfo& | Group information. |
| errorInfo | const 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
typedef std::function<void(const std::string& groupID, const std::vector<std::string>& errorKeys, const ZIMError& errorInfo)> ZIMGroupAttributesOperatedCallbackParameters
| Name | Type | Description |
|---|---|---|
| groupID | const std::string& | Group ID. |
| errorKeys | const std::vector<std::string>& | Error keys. |
| errorInfo | const 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
typedef std::function<void(const std::string& groupID, const std::unordered_map<std::string, std::string>& groupAttributes, const ZIMError& errorInfo)> ZIMGroupAttributesQueriedCallbackParameters
| Name | Type | Description |
|---|---|---|
| groupID | const std::string& | Group ID. |
| groupAttributes | const std::unordered_map<std::string, std::string>& | Group attributes. |
| errorInfo | const 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
typedef std::function<void(const std::string& groupID, const std::string& forUserID, ZIMGroupMemberRole role, const ZIMError& errorInfo)> ZIMGroupMemberRoleUpdatedCallbackParameters
| Name | Type | Description |
|---|---|---|
| groupID | const std::string& | Group ID. |
| forUserID | const std::string& | User ID. |
| role | ZIMGroupMemberRole | User role. |
| errorInfo | const 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
typedef std::function<void(const std::string& groupID, const std::string& forUserID, const std::string& nickname, const ZIMError& errorInfo)> ZIMGroupMemberNicknameUpdatedCallbackParameters
| Name | Type | Description |
|---|---|---|
| groupID | const std::string& | Group ID. |
| forUserID | const std::string& | User ID. |
| nickname | const std::string& | User nickname. |
| errorInfo | const 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
typedef std::function<void(const std::string& groupID, const ZIMGroupMemberInfo& userInfo, const ZIMError& errorInfo)> ZIMGroupMemberInfoQueriedCallbackParameters
| Name | Type | Description |
|---|---|---|
| groupID | const std::string& | Group ID. |
| userInfo | const ZIMGroupMemberInfo& | Group member user information. |
| errorInfo | const 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
typedef std::function<void(const std::vector<ZIMGroup>& groupList, long long nextFlag, const ZIMError& errorInfo)> ZIMGroupListQueriedCallbackParameters
| Name | Type | Description |
|---|---|---|
| groupList | const std::vector<ZIMGroup>& | Group list. |
| nextFlag | long long | The 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. |
| errorInfo | const 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
typedef std::function<void(const std::string& groupID, const std::vector<ZIMGroupMemberInfo>& userList, unsigned int nextFlag, const ZIMError& errorInfo)> ZIMGroupMemberListQueriedCallbackParameters
| Name | Type | Description |
|---|---|---|
| groupID | const std::string& | Group ID. |
| userList | const std::vector<ZIMGroupMemberInfo>& | Group member list. |
| nextFlag | unsigned int | Used to query the next page. The current value returns 0, which means that the list has been pulled out. |
| errorInfo | const 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
typedef std::function<void(const std::string& groupID, unsigned int count, const ZIMError& errorInfo)> ZIMGroupMemberCountQueriedCallbackParameters
| Name | Type | Description |
|---|---|---|
| groupID | const std::string& | Group ID. |
| count | unsigned int | Group member count. |
| errorInfo | const 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
typedef std::function<void(const std::string& groupID, const std::vector<ZIMGroupMemberInfo>& userList, unsigned int nextFlag, const ZIMError& errorInfo)> ZIMGroupMessageReceiptMemberListQueriedCallbackParameters
| Name | Type | Description |
|---|---|---|
| groupID | const std::string& | Group ID. |
| userList | const std::vector<ZIMGroupMemberInfo>& | Group member list. |
| nextFlag | unsigned int | Used to query the next page. The current value returns 0, which means that the list has been pulled out. |
| errorInfo | const 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
typedef std::function<void(const std::string& groupID, bool isMute, const ZIMGroupMuteInfo& mutedInfo, const ZIMError& errorInfo)> ZIMGroupMutedCallbackParameters
| Name | Type | Description |
|---|---|---|
| groupID | const std::string& | Group ID. |
| isMute | bool | Whether to mute. |
| mutedInfo | const ZIMGroupMuteInfo& | Group mute information. |
| errorInfo | const 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
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)> ZIMGroupMembersMutedCallbackParameters
| Name | Type | Description |
|---|---|---|
| groupID | const std::string& | Group ID. |
| isMute | bool | Whether to mute. |
| duration | int | Mute duration. |
| mutedUserIDs | const std::vector<std::string>& | List of muted member userIDs. |
| errorUserList | const std::vector<ZIMErrorUserInfo>& | List of user information that failed to be muted. |
| errorInfo | const 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
typedef std::function<void(const std::string& groupID, unsigned long long nextFlag, const std::vector<ZIMGroupMemberInfo>& userList, const ZIMError& errorInfo)> ZIMGroupMemberMutedListQueriedCallbackParameters
| Name | Type | Description |
|---|---|---|
| groupID | const std::string& | Group ID. |
| nextFlag | unsigned long long | Used to query the next page. The current value returns 0, which means that the list has been pulled out. |
| userList | const std::vector<ZIMGroupMemberInfo>& | Group member list. |
| errorInfo | const 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
typedef std::function<void(const std::vector<ZIMGroupSearchInfo>& groupSearchInfoList, unsigned int nextFlag, const ZIMError& errorInfo)> ZIMGroupsSearchedCallbackParameters
| Name | Type | Description |
|---|---|---|
| groupSearchInfoList | const std::vector<ZIMGroupSearchInfo>& | Group search information list. |
| nextFlag | unsigned int | Used to query the next page. The current value returns 0, which means that the list has been pulled out. |
| errorInfo | const 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
typedef std::function<void(const std::string& groupID, const std::vector<ZIMGroupMemberInfo>& userList, unsigned int nextFlag, const ZIMError& errorInfo)> ZIMGroupMembersSearchedCallbackParameters
| Name | Type | Description |
|---|---|---|
| groupID | const std::string& | Group ID. |
| userList | const std::vector<ZIMGroupMemberInfo>& | Group member list. |
| nextFlag | unsigned int | Used to query the next page. The current value returns 0, which means that the list has been pulled out. |
| errorInfo | const 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
typedef std::function<void(const std::string& groupID, ZIMGroupJoinMode mode, const ZIMError& errorInfo)> ZIMGroupJoinModeUpdatedCallbackParameters
| Name | Type | Description |
|---|---|---|
| groupID | const std::string& | Group ID. |
| mode | ZIMGroupJoinMode | Group join mode. |
| errorInfo | const 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
typedef std::function<void(const std::string& groupID, ZIMGroupInviteMode mode, const ZIMError& errorInfo)> ZIMGroupInviteModeUpdatedCallbackParameters
| Name | Type | Description |
|---|---|---|
| groupID | const std::string& | Group ID. |
| mode | ZIMGroupInviteMode | Group invite mode. |
| errorInfo | const 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
typedef std::function<void(const std::string& groupID, ZIMGroupBeInviteMode mode, const ZIMError& errorInfo)> ZIMGroupBeInviteModeUpdatedCallbackParameters
| Name | Type | Description |
|---|---|---|
| groupID | const std::string& | Group ID. |
| mode | ZIMGroupBeInviteMode | Group be invite mode. |
| errorInfo | const 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
typedef std::function<void(const std::string& groupID, const ZIMError& errorInfo)> ZIMGroupJoinApplicationSentCallbackParameters
| Name | Type | Description |
|---|---|---|
| groupID | const std::string& | Group ID. |
| errorInfo | const 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
typedef std::function<void(const std::string& groupID, const std::string& userID, const ZIMError& errorInfo)> ZIMGroupJoinApplicationAcceptedCallbackParameters
| Name | Type | Description |
|---|---|---|
| groupID | const std::string& | Group ID. |
| userID | const std::string& | User ID. |
| errorInfo | const 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
typedef std::function<void(const std::string& groupID, const std::string& userID, const ZIMError& errorInfo)> ZIMGroupJoinApplicationRejectedCallbackParameters
| Name | Type | Description |
|---|---|---|
| groupID | const std::string& | Group ID. |
| userID | const std::string& | User ID. |
| errorInfo | const 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
typedef std::function<void(const std::string& groupID, const std::vector<ZIMErrorUserInfo>& errorUserList, const ZIMError& errorInfo)> ZIMGroupInviteApplicationsSentCallbackParameters
| Name | Type | Description |
|---|---|---|
| groupID | const std::string& | Group ID. |
| errorUserList | const std::vector<ZIMErrorUserInfo>& | Invite failed user information list. |
| errorInfo | const 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
typedef std::function<void(const ZIMGroupFullInfo& groupInfo, const std::string& inviterUserID, const ZIMError& errorInfo)> ZIMGroupInviteApplicationAcceptedCallbackParameters
| Name | Type | Description |
|---|---|---|
| groupInfo | const ZIMGroupFullInfo& | Group information. |
| inviterUserID | const std::string& | Inviter user ID. |
| errorInfo | const 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
typedef std::function<void(const std::string& groupID, const std::string& inviterUserID, const ZIMError& errorInfo)> ZIMGroupInviteApplicationRejectedCallbackParameters
| Name | Type | Description |
|---|---|---|
| groupID | const std::string& | Group information. |
| inviterUserID | const std::string& | Inviter user ID. |
| errorInfo | const 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
typedef std::function<void(const std::vector<ZIMGroupApplicationInfo>& applicationList, unsigned long long nextFlag, const ZIMError& errorInfo)> ZIMGroupApplicationListQueriedCallbackParameters
| Name | Type | Description |
|---|---|---|
| applicationList | const std::vector<ZIMGroupApplicationInfo>& | Group application information list. |
| nextFlag | unsigned long long | Pagination flag, used to get the next page. The current value returns 0, indicating that all data has been pulled out. |
| errorInfo | const 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
typedef std::function<void(const std::string& callID, const ZIMCallInvitationSentInfo& info, const ZIMError& errorInfo)> ZIMCallInvitationSentCallbackParameters
| Name | Type | Description |
|---|---|---|
| callID | const std::string& | Call ID. |
| info | const ZIMCallInvitationSentInfo& | Call invitation information. |
| errorInfo | const 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
typedef std::function<void(const std::string& callID, const ZIMCallingInvitationSentInfo& info, const ZIMError& errorInfo)> ZIMCallingInvitationSentCallbackParameters
| Name | Type | Description |
|---|---|---|
| callID | const std::string& | Call ID. |
| info | const ZIMCallingInvitationSentInfo& | Calling invitation information. |
| errorInfo | const 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
typedef std::function<void(const std::string& callID, const std::vector<std::string>& errorInvitees, const ZIMError& errorInfo)> ZIMCallCancelSentCallbackParameters
| Name | Type | Description |
|---|---|---|
| callID | const std::string& | Call ID. |
| errorInvitees | const std::vector<std::string>& | Call invitation failed user ID list. |
| errorInfo | const 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
typedef std::function<void(const std::string& callID, const ZIMError& errorInfo)> ZIMCallAcceptanceSentCallbackParameters
| Name | Type | Description |
|---|---|---|
| callID | const std::string& | Call ID. |
| errorInfo | const 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
typedef std::function<void(const std::string& callID, const ZIMError& errorInfo)> ZIMCallRejectionSentCallbackParameters
| Name | Type | Description |
|---|---|---|
| callID | const std::string& | Call ID. |
| errorInfo | const 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
typedef std::function<void(const std::string& callID, const ZIMCallJoinSentInfo& info, const ZIMError& errorInfo)> ZIMCallJoinSentCallbackParameters
| Name | Type | Description |
|---|---|---|
| callID | const std::string& | Call ID. |
| info | const ZIMCallJoinSentInfo& | Call join information. |
| errorInfo | const 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
typedef std::function<void(const std::string& callID, const ZIMCallQuitSentInfo& info, const ZIMError& errorInfo)> ZIMCallQuitSentCallbackParameters
| Name | Type | Description |
|---|---|---|
| callID | const std::string& | Call ID. |
| info | const ZIMCallQuitSentInfo& | Call quit information. |
| errorInfo | const 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
typedef std::function<void(const std::string& callID, const ZIMCallEndedSentInfo& info, const ZIMError& errorInfo)> ZIMCallEndSentCallbackParameters
| Name | Type | Description |
|---|---|---|
| callID | const std::string& | Call ID. |
| info | const ZIMCallEndedSentInfo& | Call end information. |
| errorInfo | const 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
typedef std::function<void(const std::vector<ZIMCallInfo>& callList, long long nextFlag, const ZIMError& errorInfo)> ZIMCallInvitationListQueriedCallbackParameters
| Name | Type | Description |
|---|---|---|
| callList | const std::vector<ZIMCallInfo>& | Call information list. |
| nextFlag | long long | Pagination flag, used to get the next page. The current value returns 0, indicating that all data has been pulled out. |
| errorInfo | const 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
typedef std::function<void(const ZIMFriendInfo& friendInfo, const ZIMError& errorInfo)> ZIMFriendAddedCallbackParameters
| Name | Type | Description |
|---|---|---|
| friendInfo | const ZIMFriendInfo& | Friend information. |
| errorInfo | const 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
typedef std::function<void(const std::vector<ZIMErrorUserInfo>& errorUserList, const ZIMError& errorInfo)> ZIMFriendsDeletedCallbackParameters
| Name | Type | Description |
|---|---|---|
| errorUserList | const std::vector<ZIMErrorUserInfo>& | Friend information. |
| errorInfo | const 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
typedef std::function<void(const std::vector<ZIMFriendInfo>& friendList, unsigned int nextFlag, const ZIMError& errorInfo)> ZIMFriendListQueriedCallbackParameters
| Name | Type | Description |
|---|---|---|
| friendList | const std::vector<ZIMFriendInfo>& | Friend information list. |
| nextFlag | unsigned int | Pagination flag, used to get the next page. The current value returns 0, indicating that all data has been pulled out. |
| errorInfo | const 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
typedef std::function<void(const std::vector<ZIMFriendInfo>& friendInfos, const std::vector<ZIMErrorUserInfo>& errorUserList, const ZIMError& errorInfo)> ZIMFriendsInfoQueriedCallbackParameters
| Name | Type | Description |
|---|---|---|
| friendInfos | const std::vector<ZIMFriendInfo>& | Friend information list. |
| errorUserList | const std::vector<ZIMErrorUserInfo>& | Friend information. |
| errorInfo | const 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
typedef std::function<void(const std::vector<ZIMFriendRelationInfo>& relationInfos, const std::vector<ZIMErrorUserInfo>& errorUserList, const ZIMError& errorInfo)> ZIMFriendsRelationCheckedCallbackParameters
| Name | Type | Description |
|---|---|---|
| relationInfos | const std::vector<ZIMFriendRelationInfo>& | Friend relationship information list. |
| errorUserList | const std::vector<ZIMErrorUserInfo>& | Friend information. |
| errorInfo | const 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
typedef std::function<void(const ZIMFriendApplicationInfo& applicationInfo, const ZIMError& errorInfo)> ZIMFriendApplicationSentCallbackParameters
| Name | Type | Description |
|---|---|---|
| applicationInfo | const ZIMFriendApplicationInfo& | Friend application information. |
| errorInfo | const 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
typedef std::function<void(const ZIMFriendInfo& friendInfo, const ZIMError& errorInfo)> ZIMFriendApplicationAcceptedCallbackParameters
| Name | Type | Description |
|---|---|---|
| friendInfo | const ZIMFriendInfo& | Friend information. |
| errorInfo | const 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
typedef std::function<void(const ZIMUserInfo& userInfo, const ZIMError& errorInfo)> ZIMFriendApplicationRejectedCallbackParameters
| Name | Type | Description |
|---|---|---|
| userInfo | const ZIMUserInfo& | User information. |
| errorInfo | const 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
typedef std::function<void(const std::vector<ZIMFriendApplicationInfo>& applicationList, unsigned int nextFlag, const ZIMError& errorInfo)> ZIMFriendApplicationListQueriedCallbackParameters
| Name | Type | Description |
|---|---|---|
| applicationList | const std::vector<ZIMFriendApplicationInfo>& | Friend application information list. |
| nextFlag | unsigned int | Pagination flag, used to get the next page. The current value returns 0, indicating that all data has been pulled out. |
| errorInfo | const 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
typedef std::function<void(const ZIMFriendInfo& friendInfo, const ZIMError& errorInfo)> ZIMFriendAliasUpdatedCallbackParameters
| Name | Type | Description |
|---|---|---|
| friendInfo | const ZIMFriendInfo& | Friend information. |
| errorInfo | const 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
typedef std::function<void(const ZIMFriendInfo& friendInfo, const ZIMError& errorInfo)> ZIMFriendAttributesUpdatedCallbackParameters
| Name | Type | Description |
|---|---|---|
| friendInfo | const ZIMFriendInfo& | Friend information. |
| errorInfo | const 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
typedef std::function<void(const std::vector<ZIMFriendInfo>& friendInfos, unsigned int nextFlag, const ZIMError& errorInfo)> ZIMFriendsSearchedCallbackParameters
| Name | Type | Description |
|---|---|---|
| friendInfos | const std::vector<ZIMFriendInfo>& | Friend information list. |
| nextFlag | unsigned int | Pagination flag, used to get the next page. The current value returns 0, indicating that all data has been pulled out. |
| errorInfo | const 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
typedef std::function<void(const std::vector<ZIMErrorUserInfo>& errorUserList, const ZIMError& errorInfo)> ZIMBlacklistUsersAddedCallbackParameters
| Name | Type | Description |
|---|---|---|
| errorUserList | const std::vector<ZIMErrorUserInfo>& | User information. |
| errorInfo | const 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
typedef std::function<void(const std::vector<ZIMErrorUserInfo>& errorUserList, const ZIMError& errorInfo)> ZIMBlacklistUsersRemovedCallbackParameters
| Name | Type | Description |
|---|---|---|
| errorUserList | const std::vector<ZIMErrorUserInfo>& | User information. |
| errorInfo | const 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
typedef std::function<void(const std::vector<ZIMUserInfo>& blacklist, unsigned int nextFlag, const ZIMError& errorInfo)> ZIMBlacklistQueriedCallbackParameters
| Name | Type | Description |
|---|---|---|
| blacklist | const std::vector<ZIMUserInfo>& | Blacklist user information list. |
| nextFlag | unsigned int | Pagination flag, used to get the next page. The current value returns 0, indicating that all data has been pulled out. |
| errorInfo | const 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
typedef std::function<void(bool isUserInBlacklist, const ZIMError& errorInfo)> ZIMBlacklistCheckedCallbackParameters
| Name | Type | Description |
|---|---|---|
| isUserInBlacklist | bool | Whether in blacklist. |
| errorInfo | const 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
typedef std::function<void(const ZIMCommunityFullInfo& communityInfo, const ZIMError& errorInfo)> ZIMCommunityCreatedCallbackParameters
| Name | Type | Description |
|---|---|---|
| communityInfo | const ZIMCommunityFullInfo& | Community information. |
| errorInfo | const 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
typedef std::function<void(const std::string& communityID, const ZIMError& errorInfo)> ZIMCommunityDismissedCallbackParameters
| Name | Type | Description |
|---|---|---|
| communityID | const std::string& | Community ID. |
| errorInfo | const 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
typedef std::function<void(const ZIMCommunityFullInfo& communityInfo, const ZIMError& errorInfo)> ZIMCommunityJoinedCallbackParameters
| Name | Type | Description |
|---|---|---|
| communityInfo | const ZIMCommunityFullInfo& | Community information. |
| errorInfo | const 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
typedef std::function<void(const std::string& communityID, const ZIMError& errorInfo)> ZIMCommunityLeftCallbackParameters
| Name | Type | Description |
|---|---|---|
| communityID | const std::string& | Community ID. |
| errorInfo | const 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
typedef std::function<void(const std::vector<ZIMCommunity>& communityList, long long nextFlag, const ZIMError& errorInfo)> ZIMCommunityListQueriedCallbackParameters
| Name | Type | Description |
|---|---|---|
| communityList | const std::vector<ZIMCommunity>& | Community list. |
| nextFlag | long long | Next query community list flag. |
| errorInfo | const 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
typedef std::function<void(const std::string& communityID, const std::string& communityName, const ZIMError& errorInfo)> ZIMCommunityNameUpdatedCallbackParameters
| Name | Type | Description |
|---|---|---|
| communityID | const std::string& | Community ID. |
| communityName | const std::string& | Community name. |
| errorInfo | const 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
typedef std::function<void(const std::string& communityID, const std::string& communityAvatarUrl, const ZIMError& errorInfo)> ZIMCommunityAvatarUrlUpdatedCallbackParameters
| Name | Type | Description |
|---|---|---|
| communityID | const std::string& | Community ID. |
| communityAvatarUrl | const std::string& | Community avatar URL. |
| errorInfo | const 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
typedef std::function<void(const std::string& communityID, const std::string& communityNotice, const ZIMError& errorInfo)> ZIMCommunityNoticeUpdatedCallbackParameters
| Name | Type | Description |
|---|---|---|
| communityID | const std::string& | Community ID. |
| communityNotice | const std::string& | Community notice. |
| errorInfo | const 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
typedef std::function<void(const std::string& communityID, const std::vector<std::string>& errorKeys, const ZIMError& errorInfo)> ZIMCommunityAttributesOperatedCallbackParameters
| Name | Type | Description |
|---|---|---|
| communityID | const std::string& | Community ID. |
| errorKeys | const std::vector<std::string>& | Error keys. |
| errorInfo | const 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
typedef std::function<void(const std::string& communityID, const ZIMError& errorInfo)> ZIMCommunityNotificationStatusSetCallbackParameters
| Name | Type | Description |
|---|---|---|
| communityID | const std::string& | Community ID. |
| errorInfo | const 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
typedef std::function<void(const ZIMCommunityFullInfo& communityInfo, const ZIMError& errorInfo)> ZIMCommunityInfoQueriedCallbackParameters
| Name | Type | Description |
|---|---|---|
| communityInfo | const ZIMCommunityFullInfo& | Community information. |
| errorInfo | const 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
typedef std::function<void(const std::string& communityID, const std::vector<ZIMErrorUserInfo>& errorUserList, const ZIMError& errorInfo)> ZIMCommunityUsersInvitedCallbackParameters
| Name | Type | Description |
|---|---|---|
| communityID | const std::string& | Community ID. |
| errorUserList | const std::vector<ZIMErrorUserInfo>& | The error userID list |
| errorInfo | const 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
typedef std::function<void(const std::string& communityID, const std::vector<ZIMErrorUserInfo>& errorUserList, const ZIMError& errorInfo)> ZIMCommunityMembersKickedCallbackParameters
| Name | Type | Description |
|---|---|---|
| communityID | const std::string& | Community ID. |
| errorUserList | const std::vector<ZIMErrorUserInfo>& | The error userID list |
| errorInfo | const 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
typedef std::function<void(const std::string& communityID, const std::string& forUserID, ZIMCommunityMemberRole memberRole, const ZIMError& errorInfo)> ZIMCommunityMemberRoleUpdatedCallbackParameters
| Name | Type | Description |
|---|---|---|
| communityID | const std::string& | Community ID. |
| forUserID | const std::string& | The user ID of the target user. |
| memberRole | ZIMCommunityMemberRole | member role value |
| errorInfo | const 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
typedef std::function<void(const std::string& communityID, const std::string& toUserID, const ZIMError& errorInfo)> ZIMCommunityOwnerTransferredCallbackParameters
| Name | Type | Description |
|---|---|---|
| communityID | const std::string& | Community ID. |
| toUserID | const std::string& | The user ID of the new community owner. |
| errorInfo | const 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
typedef std::function<void(const std::string& communityID, const std::vector<ZIMCommunityMemberInfo>& memberList, long long nextFlag, const ZIMError& errorInfo)> ZIMCommunityMemberListQueriedCallbackParameters
| Name | Type | Description |
|---|---|---|
| communityID | const std::string& | Community ID. |
| memberList | const std::vector<ZIMCommunityMemberInfo>& | Community member list. |
| nextFlag | long long | Anchor for the next community member list query. |
| errorInfo | const 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
typedef std::function<void(const std::string& communityID, const std::vector<ZIMCommunityMemberInfo>& memberList, const std::vector<ZIMErrorUserInfo>& errorUserList, const ZIMError& errorInfo)> ZIMCommunityMembersQueriedCallbackParameters
| Name | Type | Description |
|---|---|---|
| communityID | const std::string& | Community ID. |
| memberList | const std::vector<ZIMCommunityMemberInfo>& | List of queried community members. |
| errorUserList | const std::vector<ZIMErrorUserInfo>& | List of users that failed to be queried. |
| errorInfo | const 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
typedef std::function<void(const ZIMCommunityChannelFullInfo& channelInfo, const ZIMError& errorInfo)> ZIMCommunityChannelCreatedCallbackParameters
| Name | Type | Description |
|---|---|---|
| channelInfo | const ZIMCommunityChannelFullInfo& | Community channel information. |
| errorInfo | const 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
typedef std::function<void(const std::string& communityID, const std::string& channelID, const ZIMError& errorInfo)> ZIMCommunityChannelDismissedCallbackParameters
| Name | Type | Description |
|---|---|---|
| communityID | const std::string& | Community ID. |
| channelID | const std::string& | Community channel ID |
| errorInfo | const 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
typedef std::function<void(const std::string& communityID, const std::string& channelID, const std::string& channelName, const ZIMError& errorInfo)> ZIMCommunityChannelNameUpdatedCallbackParameters
| Name | Type | Description |
|---|---|---|
| communityID | const std::string& | Community ID. |
| channelID | const std::string& | Community channel ID |
| channelName | const std::string& | Community channel name. |
| errorInfo | const 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
typedef std::function<void(const std::string& communityID, const std::string& channelID, const std::string& channelAvatarUrl, const ZIMError& errorInfo)> ZIMCommunityChannelAvatarUrlUpdatedCallbackParameters
| Name | Type | Description |
|---|---|---|
| communityID | const std::string& | Community ID. |
| channelID | const std::string& | Community channel ID |
| channelAvatarUrl | const std::string& | Community avatar URL. |
| errorInfo | const 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
typedef std::function<void(const std::string& communityID, const std::string& channelID, const std::string& channelNotice, const ZIMError& errorInfo)> ZIMCommunityChannelNoticeUpdatedCallbackParameters
| Name | Type | Description |
|---|---|---|
| communityID | const std::string& | Community ID. |
| channelID | const std::string& | Community channel ID |
| channelNotice | const std::string& | Community channel notice. |
| errorInfo | const 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
typedef std::function<void(const std::string& communityID, const std::string& channelID, const std::vector<std::string>& errorKeys, const ZIMError& errorInfo)> ZIMCommunityChannelAttributesOperatedCallbackParameters
| Name | Type | Description |
|---|---|---|
| communityID | const std::string& | Community ID. |
| channelID | const std::string& | Community channel ID. |
| errorKeys | const std::vector<std::string>& | Error keys. |
| errorInfo | const 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
typedef std::function<void(const std::string& communityID, const std::vector<ZIMCommunityChannelFullInfo>& channelInfos, const std::vector<std::string>& errorChannelIDs, const ZIMError& errorInfo)> ZIMCommunityChannelsInfoQueriedCallbackParameters
| Name | Type | Description |
|---|---|---|
| communityID | const std::string& | Community ID. |
| channelInfos | const std::vector<ZIMCommunityChannelFullInfo>& | List of queried community channels. |
| errorChannelIDs | const std::vector<std::string>& | List of channel IDs that failed to be queried. |
| errorInfo | const 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
typedef std::function<void(const std::string& communityID, const std::vector<ZIMCommunityChannel>& channelList, long long nextFlag, const ZIMError& errorInfo)> ZIMCommunityChannelListQueriedCallbackParameters
| Name | Type | Description |
|---|---|---|
| communityID | const std::string& | Community ID. |
| channelList | const std::vector<ZIMCommunityChannel>& | Community channel list. |
| nextFlag | long long | Anchor for the next channel list query. |
| errorInfo | const 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
typedef std::function<void(const std::string& communityID, const std::string& channelID, bool isMute, const std::vector<ZIMErrorUserInfo>& errorUserList, const ZIMError& errorInfo)> ZIMCommunityMembersMutedCallbackParameters
| Name | Type | Description |
|---|---|---|
| communityID | const std::string& | Community ID. |
| channelID | const std::string& | The channel ID. Empty means muted at the community level. |
| isMute | bool | Whether to mute the members. |
| errorUserList | const std::vector<ZIMErrorUserInfo>& | List of users that failed to be muted. |
| errorInfo | const 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
typedef std::function<void(const std::string& communityID, bool isMute, const std::vector<std::string>& errorChannelIDs, const ZIMError& errorInfo)> ZIMCommunityChannelsMutedCallbackParameters
| Name | Type | Description |
|---|---|---|
| communityID | const std::string& | Community ID. |
| isMute | bool | Whether to mute the channels. |
| errorChannelIDs | const std::vector<std::string>& | List of channel IDs that failed to be muted. |
| errorInfo | const 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. |
