In-app Chat

Common Class

ZIMEventHandler

ZPNsManager

All Categories

Class

Protocol

Enum

Class

2026-07-24


ZIMError	ZIMAppConfig
ZIMLogConfig	ZIMCacheConfig
ZIMUserInfo	ZIMUserFullInfo
ZIMUserOfflinePushRule	ZIMUserRule
ZIMUserStatus	ZIMUserStatusSubscription
ZIMSelfUserInfo	ZIMUserStatusSubscribeConfig
ZIMSubscribedUserStatusQueryConfig	ZIMUserCustomStatusUpdateConfig
ZIMErrorUserInfo	ZIMLoginConfig
ZIMUsersInfoQueryConfig	ZIMOfflinePushPrivateMessageTemplate
ZIMVoIPConfig	ZIMPushConfig
ZIMMessageReactionAddConfig	ZIMMessageReactionUserInfo
ZIMMessageReaction	ZIMMessageReactionSimpleInfo
ZIMMessageReactionUserFullInfo	ZIMMessageReactionUserChangeInfo
ZIMMessageLiteInfo	ZIMTextMessageLiteInfo
ZIMCustomMessageLiteInfo	ZIMCombineMessageLiteInfo
ZIMRevokeMessageLiteInfo	ZIMMediaMessageLiteInfo
ZIMImageMessageLiteInfo	ZIMFileMessageLiteInfo
ZIMAudioMessageLiteInfo	ZIMVideoMessageLiteInfo
ZIMMultipleMessageLiteInfo	ZIMMessageRepliedInfo
ZIMMessage	ZIMMediaMessage
ZIMTextMessage	ZIMCustomMessage
ZIMCommandMessage	ZIMBarrageMessage
ZIMImageMessage	ZIMFileMessage
ZIMAudioMessage	ZIMVideoMessage
ZIMRevokeMessage	ZIMCombineMessage
ZIMTipsMessage	ZIMMultipleMessage
ZIMMessageRootRepliedInfo	ZIMMessageRootRepliedCountInfo
ZIMMessageMentionedInfo	ZIMMessageReceivedInfo
ZIMMessageSendConfig	ZIMMessageQueryConfig
ZIMMessageRevokeConfig	ZIMMessageDeleteConfig
ZIMMessageDeletedInfo	ZIMMessageAttachedCallback
ZIMMediaUploadingProgress	ZIMMultipleMediaUploadingProgress
ZIMMessageSendNotification	ZIMMediaMessageSendNotification
ZIMMessageReceiptInfo	ZIMMessageReactionUserQueryConfig
ZIMMessageSentStatusChangeInfo	ZIMMessageSearchConfig
ZIMMessageRepliedListQueryConfig	ZIMMediaDownloadConfig
ZIMMessageEditConfig	ZIMSendingMessageCancelConfig
ZIMMessagePinConfig	ZIMTipsMessageChangeInfo
ZIMTipsMessageGroupChangeInfo	ZIMTipsMessageGroupMemberChangeInfo
ZIMTipsMessagePinStatusChangeInfo	ZIMMessagePinStatusChangeInfo
ZIMFileCacheClearConfig	ZIMFileCacheQueryConfig
ZIMFileCacheInfo	ZIMMessageReactionChangeInfo
ZIMConversation	ZIMConversationBaseInfo
ZIMGroupConversation	ZIMConversationQueryConfig
ZIMConversationFilterOption	ZIMConversationTotalUnreadMessageCountQueryConfig
ZIMConversationDeleteConfig	ZIMConversationsAllDeletedInfo
ZIMConversationChangeInfo	ZIMConversationSearchConfig
ZIMConversationSearchInfo	ZIMRoomInfo
ZIMRoomFullInfo	ZIMRoomMemberInfo
ZIMRoomMemberQueryConfig	ZIMRoomAdvancedConfig
ZIMRoomAttributesSetConfig	ZIMRoomAttributesBatchOperationConfig
ZIMRoomAttributesDeleteConfig	ZIMRoomAttributesUpdateInfo
ZIMRoomMemberAttributesInfo	ZIMRoomMemberAttributesOperatedInfo
ZIMRoomMemberAttributesUpdateInfo	ZIMRoomMemberAttributesSetConfig
ZIMRoomMemberAttributesQueryConfig	ZIMRoomOperatedInfo
ZIMGroupInfo	ZIMGroupMuteInfo
ZIMGroupVerifyInfo	ZIMGroupFullInfo
ZIMGroup	ZIMGroupMemberSimpleInfo
ZIMGroupEnterInfo	ZIMGroupMemberInfo
ZIMGroupOperatedInfo	ZIMGroupMemberQueryConfig
ZIMGroupAdvancedConfig	ZIMGroupAttributesUpdateInfo
ZIMGroupMessageReceiptMemberQueryConfig	ZIMGroupMessageReceiptMemberListQueryConfig
ZIMGroupSearchConfig	ZIMGroupSearchInfo
ZIMGroupMemberSearchConfig	ZIMGroupMuteConfig
ZIMGroupMemberMuteConfig	ZIMGroupMemberMutedListQueryConfig
ZIMGroupApplicationInfo	ZIMGroupJoinApplicationSendConfig
ZIMGroupJoinApplicationAcceptConfig	ZIMGroupJoinApplicationRejectConfig
ZIMGroupInviteApplicationSendConfig	ZIMGroupInviteApplicationAcceptConfig
ZIMGroupInviteApplicationRejectConfig	ZIMGroupApplicationListQueryConfig
ZIMGroupListQueryConfig	ZIMCallUserInfo
ZIMCallInviteConfig	ZIMCallingInviteConfig
ZIMCallJoinConfig	ZIMCallQuitConfig
ZIMCallEndConfig	ZIMCallCancelConfig
ZIMCallAcceptConfig	ZIMCallRejectConfig
ZIMCallInvitationSentInfo	ZIMCallingInvitationSentInfo
ZIMCallJoinSentInfo	ZIMCallQuitSentInfo
ZIMCallEndedSentInfo	ZIMCallInvitationReceivedInfo
ZIMCallInvitationCreatedInfo	ZIMCallInvitationCancelledInfo
ZIMCallInvitationAcceptedInfo	ZIMCallInvitationRejectedInfo
ZIMCallInvitationEndedInfo	ZIMCallInvitationTimeoutInfo
ZIMCallInvitationQueryConfig	ZIMCallInfo
ZIMCallUserStateChangeInfo	ZIMBlacklistQueryConfig
ZIMFriendAddConfig	ZIMFriendDeleteConfig
ZIMFriendListQueryConfig	ZIMFriendSearchConfig
ZIMFriendRelationCheckConfig	ZIMFriendRelationInfo
ZIMFriendInfo	ZIMFriendApplicationSendConfig
ZIMFriendApplicationAcceptConfig	ZIMFriendApplicationRejectConfig
ZIMFriendApplicationListQueryConfig	ZIMFriendApplicationInfo
ZIMCommunityInfo	ZIMCommunity
ZIMCommunityFullInfo	ZIMCommunityCreateConfig
ZIMCommunityListQueryConfig	ZIMCommunityChangeInfo
ZIMCommunityMemberListQueryConfig	ZIMCommunityFullInfoUpdateInfo
ZIMCommunityMemberEnterInfo	ZIMCommunityMemberMuteInfo
ZIMCommunityMemberInfo	ZIMCommunityMemberSimpleInfo
ZIMCommunityMemberStateChangeInfo	ZIMCommunityMemberInfoUpdateInfo
ZIMCommunityChannelInfo	ZIMCommunityChannelMuteInfo
ZIMCommunityChannel	ZIMCommunityChannelFullInfo
ZIMCommunityChannelCreateConfig	ZIMCommunityChannelListQueryConfig
ZIMCommunityChannelChangeInfo	ZIMCommunityChannelFullInfoUpdateInfo
ZIMCommunityChannelMuteConfig	ZIMCommunityMemberMuteConfig
ZIMMessageReactionsChangedEventResult	ZIMMessageReceivedEventResult
ZIMCommunityListChangedEventResult	ZIMCommunityInfoUpdatedEventResult
ZIMCommunityMemberStateChangedEventResult	ZIMCommunityMemberInfoUpdatedEventResult
ZIMCommunityChannelListChangedEventResult	ZIMCommunityChannelInfoUpdatedEventResult
ZIMLogUploadedCallback	ZIMLoggedInCallback
ZIMTokenRenewedCallback	ZIMExperimentalAPICalledCallback
ZIMUserNameUpdatedCallback	ZIMUserAvatarUrlUpdatedCallback
ZIMUserExtendedDataUpdatedCallback	ZIMUserCustomStatusUpdatedCallback
ZIMUserBadgeUpdatedCallback	ZIMUsersInfoQueriedCallback
ZIMUserOfflinePushRuleUpdatedCallback	ZIMSelfUserInfoQueriedCallback
ZIMUsersStatusQueriedCallback	ZIMUsersStatusSubscribedCallback
ZIMUsersStatusUnsubscribedCallback	ZIMSubscribedUserStatusListQueriedCallback
ZIMConversationQueriedCallback	ZIMConversationListQueriedCallback
ZIMConversationTotalUnreadMessageCountQueriedCallback	ZIMConversationDeletedCallback
ZIMConversationsAllDeletedCallback	ZIMConversationUnreadMessageCountClearedCallback
ZIMConversationTotalUnreadMessageCountClearedCallback	ZIMConversationNotificationStatusSetCallback
ZIMConversationMessageReceiptReadSentCallback	ZIMConversationPinnedStateUpdatedCallback
ZIMConversationPinnedListQueriedCallback	ZIMConversationDraftSetCallback
ZIMConversationMarkSetCallback	ZIMConversationMessageDestructDurationSetCallback
ZIMConversationsSearchedCallback	ZIMMessageSentCallback
ZIMMessageQueriedCallback	ZIMMessageDeletedCallback
ZIMConversationMessagesAllDeletedCallback	ZIMMessageRevokedCallback
ZIMMessageInsertedCallback	ZIMMessageLocalExtendedDataUpdatedCallback
ZIMMessageReceiptsReadSentCallback	ZIMMessageReceiptsInfoQueriedCallback
ZIMMediaDownloadedCallback	ZIMMediaDownloadingProgress
ZIMMessagesSearchedCallback	ZIMMessagesGlobalSearchedCallback
ZIMMessageReactionAddedCallback	ZIMMessageReactionDeletedCallback
ZIMMessageReactionsAllDeletedCallback	ZIMMessageReactionUserListQueriedCallback
ZIMCombineMessageDetailQueriedCallback	ZIMMessageRepliedListQueriedCallback
ZIMMessageEditedCallback	ZIMSendingMessageCancelledCallback
ZIMMessagePinnedCallback	ZIMPinnedMessageListQueriedCallback
ZIMMessageExportingProgress	ZIMFileCacheQueriedCallback
ZIMFileCacheClearedCallback	ZIMRoomCreatedCallback
ZIMRoomJoinedCallback	ZIMRoomEnteredCallback
ZIMRoomSwitchedCallback	ZIMRoomLeftCallback
ZIMRoomAllLeftCallback	ZIMRoomMemberQueriedCallback
ZIMRoomMembersQueriedCallback	ZIMRoomOnlineMemberCountQueriedCallback
ZIMRoomAttributesOperatedCallback	ZIMRoomAttributesBatchOperatedCallback
ZIMRoomAttributesQueriedCallback	ZIMRoomMembersAttributesOperatedCallback
ZIMRoomMembersAttributesQueriedCallback	ZIMRoomMemberAttributesListQueriedCallback
ZIMGroupCreatedCallback	ZIMGroupDismissedCallback
ZIMGroupJoinedCallback	ZIMGroupLeftCallback
ZIMGroupUsersInvitedCallback	ZIMGroupMemberKickedCallback
ZIMGroupOwnerTransferredCallback	ZIMGroupNameUpdatedCallback
ZIMGroupAvatarUrlUpdatedCallback	ZIMGroupNoticeUpdatedCallback
ZIMGroupAliasUpdatedCallback	ZIMGroupInfoQueriedCallback
ZIMGroupAttributesOperatedCallback	ZIMGroupAttributesQueriedCallback
ZIMGroupMemberRoleUpdatedCallback	ZIMGroupMemberNicknameUpdatedCallback
ZIMGroupMemberInfoQueriedCallback	ZIMGroupListQueriedCallback
ZIMGroupMemberListQueriedCallback	ZIMGroupMemberCountQueriedCallback
ZIMGroupMessageReceiptMemberListQueriedCallback	ZIMGroupMutedCallback
ZIMGroupMembersMutedCallback	ZIMGroupMemberMutedListQueriedCallback
ZIMGroupsSearchedCallback	ZIMGroupMembersSearchedCallback
ZIMGroupJoinModeUpdatedCallback	ZIMGroupInviteModeUpdatedCallback
ZIMGroupBeInviteModeUpdatedCallback	ZIMGroupJoinApplicationSentCallback
ZIMGroupJoinApplicationAcceptedCallback	ZIMGroupJoinApplicationRejectedCallback
ZIMGroupInviteApplicationsSentCallback	ZIMGroupInviteApplicationAcceptedCallback
ZIMGroupInviteApplicationRejectedCallback	ZIMGroupApplicationListQueriedCallback
ZIMCallInvitationSentCallback	ZIMCallingInvitationSentCallback
ZIMCallCancelSentCallback	ZIMCallAcceptanceSentCallback
ZIMCallRejectionSentCallback	ZIMCallJoinSentCallback
ZIMCallQuitSentCallback	ZIMCallEndSentCallback
ZIMCallInvitationListQueriedCallback	ZIMFriendAddedCallback
ZIMFriendsDeletedCallback	ZIMFriendListQueriedCallback
ZIMFriendsInfoQueriedCallback	ZIMFriendsRelationCheckedCallback
ZIMFriendApplicationSentCallback	ZIMFriendApplicationAcceptedCallback
ZIMFriendApplicationRejectedCallback	ZIMFriendApplicationListQueriedCallback
ZIMFriendAliasUpdatedCallback	ZIMFriendAttributesUpdatedCallback
ZIMFriendsSearchedCallback	ZIMBlacklistUsersAddedCallback
ZIMBlacklistUsersRemovedCallback	ZIMBlacklistQueriedCallback
ZIMBlacklistCheckedCallback	ZIMCommunityCreatedCallback
ZIMCommunityDismissedCallback	ZIMCommunityJoinedCallback
ZIMCommunityLeftCallback	ZIMCommunityListQueriedCallback
ZIMCommunityNameUpdatedCallback	ZIMCommunityAvatarUrlUpdatedCallback
ZIMCommunityNoticeUpdatedCallback	ZIMCommunityAttributesOperatedCallback
ZIMCommunityNotificationStatusSetCallback	ZIMCommunityInfoQueriedCallback
ZIMCommunityUsersInvitedCallback	ZIMCommunityMembersKickedCallback
ZIMCommunityMemberRoleUpdatedCallback	ZIMCommunityOwnerTransferredCallback
ZIMCommunityMemberListQueriedCallback	ZIMCommunityMembersQueriedCallback
ZIMCommunityChannelCreatedCallback	ZIMCommunityChannelDismissedCallback
ZIMCommunityChannelNameUpdatedCallback	ZIMCommunityChannelAvatarUrlUpdatedCallback
ZIMCommunityChannelNoticeUpdatedCallback	ZIMCommunityChannelAttributesOperatedCallback
ZIMCommunityChannelsInfoQueriedCallback	ZIMCommunityChannelListQueriedCallback
ZIMCommunityMembersMutedCallback	ZIMCommunityChannelsMutedCallback

ZIMError

Error infomation

Details

Error infomation.

Declared in ZIMDefines.h

Properties

code

@property ZIMErrorCode code

Description: The storage path of the log files. Refer to the official website document for the default path.

message

@property NSString *message

Description: Error infomation description.

ZIMAppConfig

ZIM application configuration, including AppID and AppSign.

Declared in ZIMDefines.h

Properties

appID

@property unsigned int appID

Description

, please go to the ZEGO official website console to apply for it. Required: Required.

appSign

@property NSString *appSign

Description

, please go to the ZEGO official website console to apply for it. Required: Required.

ZIMLogConfig

Log configuration

Details

Configure the storage path of log files and the maximum log file size.

Declared in ZIMDefines.h

Properties

logPath

@property NSString *logPath

The storage path of the log files. Refer to the official website document for the default path.

logSize

@property unsigned long long logSize

The maximum log file size (Bytes). The default maximum size is 5MB (5 * 1024 * 1024 Bytes)

ZIMCacheConfig

Cache configuration

Details

Configure the storage path of cache files (such as chat records).

Declared in ZIMDefines.h

Properties

cachePath

@property NSString *cachePath

The storage path of the cache files. Refer to the official website document for the default path.

ZIMUserInfo

User information object.

Details

Identifies a unique user.

Declared in ZIMDefines.h

Caution：Note that the userID must be unique under the same appID, otherwise mutual kicks out will occur. It is strongly recommended that userID corresponds to the user ID of the business APP, that is, a userID and a real user are fixed and unique, and should not be passed to the SDK in a random userID. Because the unique and fixed userID allows ZEGO technicians to quickly locate online problems.

Properties

userID

@property NSString *userID

User ID, a string with a maximum length of 32 bytes or less. It is customized by the developer. Only support numbers, English characters and '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'.

userName

@property NSString *userName

Description: User name, defined by you. For version 2.0.0 and onwards, the string has a maximum length of 256 bytes.Required: Not required.Privacy reminder: Please do not provide sensitive personal information, including but not limited to mobile phone numbers, ID card numbers, passport numbers, and real names.

userAvatarUrl

@property NSString *userAvatarUrl

User avatar URL

userExtendedData

@property NSString *userExtendedData

User extended data. This field is currently only available in room related interfaces.

type

@property ZIMUserInfoType type

User Type. This field is used to identify which subclass the current entity belongs to.

ZIMUserFullInfo

User full information object.

Details

Identifies a unique user.

Declared in ZIMDefines.h

Caution：Note that the userID must be unique under the same appID, otherwise mutual kicks out will occur. It is strongly recommended that userID corresponds to the user ID of the business APP, that is, a userID and a real user are fixed and unique, and should not be passed to the SDK in a random userID. Because the unique and fixed userID allows ZEGO technicians to quickly locate online problems.

Properties

baseInfo

@property ZIMUserInfo baseInfo

Description: User basic information.

ZIMUserOfflinePushRule

Data class of the user's offline push rule.

Details

Data class of the user's offline push rule.

Declared in ZIMDefines.h

Properties

onlinePlatforms

@property NSArray<int *> *onlinePlatforms

With the data in the class member variables notToReceiveOfflinePushPlatforms collocation is used. OnlinePlatforms specified platform, online notToReceiveOfflinePushPlatforms specified platform will not receive offline push.

notToReceiveOfflinePushPlatforms

@property NSArray<int *> *notToReceiveOfflinePushPlatforms

With the data in the class member variables onlinePlatforms collocation is used. OnlinePlatforms specified platform, online notToReceiveOfflinePushPlatforms specified platform will not receive offline push.

ZIMUserRule

User rule configuration.

Declared in ZIMDefines.h

Properties

offlinePushRule

@property ZIMUserOfflinePushRule offlinePushRule

The user's current rule information.

ZIMUserStatus

User status data

Details

Contains data about the user's online status.

Declared in ZIMDefines.h

Properties

userID

@property NSString *userID

A unique identifier for a single user.

onlineStatus

@property ZIMUserOnlineStatus onlineStatus

Enumeration that represents the current online status of the user.

onlinePlatforms

@property NSArray<int *> *onlinePlatforms

The list of online platforms of the current user can be used to display the online platforms of the user, such as iPhone online and PC online. Please refer to ZIMPlatform for the meanings of the numbers.

customStatus

@property NSString *customStatus

User-defined status. The default maximum value is 64 bytes. The default expiration time is 1 day. At login, if the field is an empty string (which is the default), the current user's custom state is not modified.

customStatusExpiredTime

@property long long customStatusExpiredTime

Expired timestamp of the custom status.

lastUpdateTime

@property long long lastUpdateTime

Timestamp when user onlineStatus or customStatus was last changed, whichever is the greater.

lastOnlineStatusUpdateTime

@property long long lastOnlineStatusUpdateTime

The timestamp of the last change of the user onlineStatus, which can be used to show that the user was offline/logged in before xxx minutes.

lastCustomStatusUpdateTime

@property long long lastCustomStatusUpdateTime

The timestamp when User customStatus was last changed, which can be used to show when the custom status was last changed.

ZIMUserStatusSubscription

User status subscription information. Contains the user's online status, a list of online platforms, subscription expiration time stamps, and more.

Details

User status subscription information. Contains the user's online status, a list of online platforms, subscription expiration time stamps, and more.

Declared in ZIMDefines.h

Properties

userStatus

@property ZIMUserStatus userStatus

The online status of the user.

subscribeExpiredTime

@property long long subscribeExpiredTime

The timestamp when the user's subscription expired.

ZIMSelfUserInfo

Carry user information and rules of the current user.

Details

Carry user information and rules of the current user.

Declared in ZIMDefines.h

Properties

userFullInfo

@property ZIMUserFullInfo userFullInfo

Personal information of the current user.

userRule

@property ZIMUserRule userRule

Rules for the current user, setting information.

userStatus

@property ZIMUserStatus userStatus

The online status of the user.

ZIMUserStatusSubscribeConfig

subscribeUsersStatus Configuration items of the online status interface for subscribing users in batches.

Details

subscribeUsersStatus Configuration items of the online status interface for subscribing users in batches.

Declared in ZIMDefines.h

Properties

subscriptionDuration

@property unsigned int subscriptionDuration

Subscription duration, in minutes.

ZIMSubscribedUserStatusQueryConfig

QuerySubscribedUserStatusList query subscription list interface configuration items.

Details

QuerySubscribedUserStatusList query subscription list interface configuration items.

Declared in ZIMDefines.h

Properties

userIDs

@property NSArray<NSString *> *userIDs

List of user IDs to query.

ZIMUserCustomStatusUpdateConfig

User custom status update configuration.

Details

Update user custom status parameters.

Declared in ZIMDefines.h

Properties

duration

@property long long duration

Duration of user custom status.

ZIMErrorUserInfo

Error user information class.

Details

Used to show the failed user and the reason for the failure.

Declared in ZIMDefines.h

Properties

userID

@property NSString *userID

reason

@property unsigned int reason

Description Reason for the query failure.

ZIMLoginConfig

Configuration of login-related parameters.

Details

Declared in ZIMDefines.h

Use cases：Used to set different parameters during login.

Properties

userName

@property NSString *userName

Description: User name.Use cases: Used in the scenario where user nickname is modified during login, leave it blank if no change is needed.Required: No.

token

@property NSString *token

Description: Token carried during login.Use cases: Only pass this parameter in the scenario where token is used for authentication.Required: No.

isOfflineLogin

@property BOOL isOfflineLogin

Description: Whether it is offline login.Use cases: Set this parameter to true when performing offline login.Required: No.Default value: false.

customStatus

@property NSString *customStatus

Description: Custom status.Use cases: Only pass this parameter when you need to customize the user status during login.Required: No.

customStatusDuration

@property long long customStatusDuration

Description: Expired duration of the custom status.

ZIMUsersInfoQueryConfig

User information query configuration.

Details

User information query configuration, you can choose to query from the local or from the server. Query the unlimited frequency constraints from the local, and query the limited frequency constraints from the server. You can only query the detailed configuration of 10 users within 10 s.

Declared in ZIMDefines.h

Properties

isQueryFromServer

@property BOOL isQueryFromServer

Detail description: Whether to query user details from the server. Query the unlimited frequency constraints from the local, and query the limited frequency constraints from the server. You can only query the detailed configuration of 10 users within 10 s.Required: not required.Default: false.

ZIMOfflinePushPrivateMessageTemplate

The private message template is currently only applicable to the OPPO manufacturer.

Details

According to OPUSH DMS template check ability to access instructions, OPPO in new message classification on the basis of the new push DMS templates, After you have configured the private message template in the OPPO console, if you need to apply the corresponding template during push notifications, you can assign a value to the privateMessageTemplate in ZIMPushConfig.

Declared in ZIMDefines.h

Properties

templateID

@property NSString *templateID

Description: The private message template ID is currently only applicable to OPPO manufacturers. Please fill in the template ID preset in the OPPO Open Platform console.

titleParameters

@property NSString *titleParameters

Description: To replace the content of the preset title field in the template, a json string needs to be filled in, such as "{"user_name":" Li Hua "}".

contentParameters

@property NSString *contentParameters

Description: To replace the content of the preset fields in the template, a json string needs to be filled in, such as "{"city":" Shenzhen "}".

ZIMVoIPConfig

Provides information about the iOS VoIP offline push.

Details

Provides information about the iOS VoIP offline push.

Declared in ZIMDefines.h

Properties

iOSVoIPHandleType

@property ZIMCXHandleType iOSVoIPHandleType

Description: The type of contact information for the VoIP caller, by default, is generic.

iOSVoIPHandleValue

@property NSString *iOSVoIPHandleValue

Description: The contact information of the VoIP caller. It is related to iOSVoIPHandleType. When iOSVoIPHandleType is PhoneNumber, the Value is a sequence of digits; when iOSVoIPHandleType is EmailAddress, the Value is an email address; when the contact information is of other types, the Value typically follows some domain-specific format, such as a username, numeric ID, or URL.

iOSVoIPHasVideo

@property BOOL iOSVoIPHasVideo

Description: Video call or not. The default value is audio

ZIMPushConfig

Description: Offline push configuration.

Details

Configuration before sending offline push.

Declared in ZIMDefines.h

Properties

title

@property NSString *title

Description: Used to set the push title.Required: Not required.

content

@property NSString *content

Description: Used to set offline push content.Required: Not required.

payload

@property NSString *payload

Description: This parameter is used to set the pass-through field of offline push.Required: Not required.

resourcesID

@property NSString *resourcesID

Description: Offline push advanced configuration for mapping console Settings, with the maximum of 32 characters and defined by yourself.Required: Not required.

threadID

@property NSString *threadID

Description: Used to set the thread ID of offline push.Required: Not required.

enableBadge

@property BOOL enableBadge

Description: Push whether to carry corner information switch.

badgeIncrement

@property int badgeIncrement

Description: The incremental index number carried by the push.

voIPConfig

@property ZIMVoIPConfig voIPConfig

Description: If you use Flutter, RN ZPNs, offline push receiving device has iOS and uses VoIP push type, you can customize some VoIP options with this parameter.

privateMessageTemplate

@property ZIMOfflinePushPrivateMessageTemplate privateMessageTemplate

Description: If you use OPPO Push, you can carry the push template through this field.

ZIMMessageReactionAddConfig

Add configuration for message reactions.

Details

Configuration class for adding message reactions.

Declared in ZIMDefines.h

Properties

increaseCount

@property int increaseCount

Description: When this value is greater than 0, the same user is allowed to react multiple times with the same reaction type, and the counts from those reactions will be accumulated.

ZIMMessageReactionUserInfo

reaction user information.

Details

A class describing reaction user.

Declared in ZIMDefines.h

Properties

userID

@property NSString *userID

Description: user ID

ZIMMessageReaction

message reaction infos

Details

message reaction infos.

Declared in ZIMDefines.h

Properties

reactionType

@property NSString *reactionType

Description: Type of reaction, defined by you, with a maximum length of 32 bytes.

conversationID

@property NSString *conversationID

Description: conversationID.

conversationType

@property ZIMConversationType conversationType

Description: conversation type.

messageID

@property long long messageID

Detail description: reaction message ID.

messageSeq

@property long long messageSeq

Detail description: message sequence.

totalCount

@property unsigned int totalCount

Description: The reaction users number.

isSelfIncluded

@property BOOL isSelfIncluded

Description: The reaciton users if included myself.

userList

@property NSArray<ZIMMessageReactionUserInfo *> *userList

Description: Reaction user info list.

sumCount

@property unsigned int sumCount

Detailed description: The sum count of reaction.

ZIMMessageReactionSimpleInfo

message reaction infos

Details

message reaction infos.

Declared in ZIMDefines.h

Properties

reactionType

@property NSString *reactionType

Description: Type of reaction, defined by you, with a maximum length of 32 bytes.

sumCount

@property unsigned int sumCount

Detailed description: The sum count of reaction.

ZIMMessageReactionUserFullInfo

message reaction user full information.

Details

A class describing reaction user.

Declared in ZIMDefines.h

Properties

userID

@property NSString *userID

Description: user ID

reactions

@property NSArray<ZIMMessageReactionSimpleInfo *> *reactions

Description: A list of summary information for the current user’s reactions under this message.

ZIMMessageReactionUserChangeInfo

User operation change information for message reactions.

Details

A class that describes reaction change information.

Declared in ZIMDefines.h

Properties

userID

@property NSString *userID

user ID.

reactionType

@property NSString *reactionType

Type of reaction, defined by you, with a maximum length of 32 bytes.

action

@property ZIMMessageReactionUserChangeAction action

reaction change action.

sumCount

@property unsigned int sumCount

Description: The sum count for the current reaction type.

ZIMMessageLiteInfo

Base class of message lite info object.

Details

Identifies the basic parameters of a message.

Declared in ZIMDefines.h

Properties

type

@property ZIMMessageType type

Description: Message type.

ZIMTextMessageLiteInfo

Normal text message lite info object.

Declared in ZIMDefines.h

Properties

message

@property NSString *message

Description: Text message content.

ZIMCustomMessageLiteInfo

Custom message lite information.

Declared in ZIMDefines.h

Properties

message

@property NSString *message

Description: Custom message content.

searchedContent

@property NSString *searchedContent

Description: Custom message search content.

subType

@property unsigned int subType

Description: Custom message sub-type.

ZIMCombineMessageLiteInfo

Base class for combine message lite info objects.

Declared in ZIMDefines.h

Properties

title

@property NSString *title

Description: Combine message title.

summary

@property NSString *summary

Description: Combine message summary.

ZIMRevokeMessageLiteInfo

Base class for revoke message lite info objects.

Declared in ZIMDefines.h

ZIMMediaMessageLiteInfo

Base class for media message lite info objects.

Declared in ZIMDefines.h

Properties

fileSize

@property long long fileSize

Description: Media file size.

fileName

@property NSString *fileName

Description: Media file name.

fileLocalPath

@property NSString *fileLocalPath

Description: Media file local path.

fileDownloadUrl

@property NSString *fileDownloadUrl

Description: Media file download address.

ZIMImageMessageLiteInfo

Image message lite information.

Declared in ZIMDefines.h

Properties

largeImageLocalPath

@property NSString *largeImageLocalPath

Description: Large image local path.

largeImageDownloadUrl

@property NSString *largeImageDownloadUrl

Description: Large image download address.

thumbnailLocalPath

@property NSString *thumbnailLocalPath

Description: Thumbnail image local path.

thumbnailDownloadUrl

@property NSString *thumbnailDownloadUrl

Description: Thumbnail image download address.

originalImageSize

@property CGSize originalImageSize

Description: Original image size.

largeImageSize

@property CGSize largeImageSize

Description: Large image size.

thumbnailSize

@property CGSize thumbnailSize

Description: Thumbnail image size.

ZIMFileMessageLiteInfo

File message lite information.

Declared in ZIMDefines.h

ZIMAudioMessageLiteInfo

Audio message lite information.

Declared in ZIMDefines.h

Properties

audioDuration

@property unsigned int audioDuration

Description: Audio duration.

ZIMVideoMessageLiteInfo

Video message lite information.

Declared in ZIMDefines.h

Properties

videoDuration

@property unsigned int videoDuration

Description: Video duration.

videoFirstFrameLocalPath

@property NSString *videoFirstFrameLocalPath

Description: Video first frame local path.

videoFirstFrameDownloadUrl

@property NSString *videoFirstFrameDownloadUrl

Description: Video first frame download address.

videoFirstFrameSize

@property CGSize videoFirstFrameSize

Description: Video first frame size.

ZIMMultipleMessageLiteInfo

Multiple messages lite information.

Declared in ZIMDefines.h

Properties

messageInfoList

@property NSArray<ZIMMessageLiteInfo *> *messageInfoList

Description: Message list.

ZIMMessageRepliedInfo

The reply message refers to the information of the source message.

Declared in ZIMDefines.h

Properties

state

@property ZIMMessageRepliedInfoState state

Description: Message replied state.

messageInfo

@property ZIMMessageLiteInfo messageInfo

Description: Replied message lite information.

senderUserID

@property NSString *senderUserID

Description: Sender user ID of the replied message.

sentTime

@property unsigned long long sentTime

Description: Sent time of the replied message.

messageID

@property long long messageID

Description: ID of the replied message.

messageSeq

@property long long messageSeq

Description: Sequence number of the replied message.

ZIMMessage

Base class of message object

Details

Identifies the basic parameters of a message.

Declared in ZIMDefines.h

Caution：Some of the parameters, such as Message ID, only have values during the callback. Developers do not need to assign values to these parameters when they actively create this object for sending messages.

Properties

type

@property ZIMMessageType type

Identifies the type of this message.

messageID

@property long long messageID

Description: The unique ID that identifies this message.Use cases: Can be used to index other messages.Caution: When the developer actively creates a message, there is no need to modify this parameter.This parameter only has a value during callback.

localMessageID

@property long long localMessageID

Description: SDK locally generated MessageID, developers do not need to pay attention to.

messageSeq

@property long long messageSeq

Description: The sequence number of the message.

senderUserID

@property NSString *senderUserID

Description：Displays the userID of the sender of this message.

conversationID

@property NSString *conversationID

Description: Conversation ID. Ids of the same conversation type are unique.

conversationType

@property ZIMConversationType conversationType

Description: The type of conversation to which the message belongs.

direction

@property ZIMMessageDirection direction

Description: Used to describe whether a message is sent or received.

sentStatus

@property ZIMMessageSentStatus sentStatus

Description: Describes the sending status of a message.

timestamp

@property unsigned long long timestamp

Description: Identifies the sending time of a messageUse cases: Used to present the sending time of a message, and can be used for message sorting.Caution: This is a standard UNIX timestamp, in milliseconds.

orderKey

@property long long orderKey

Description

larger the orderKey, the newer the message, and can be used for ordering messages.

isUserInserted

@property BOOL isUserInserted

Detail description: Describes whether the message is a message inserted by the developer through [insertMessageToLocalDB].Default: false.

receiptStatus

@property ZIMMessageReceiptStatus receiptStatus

Detailed Description: Describe the receipt status of the messageBusiness scenario: used to determine the status of the current message in the receipt message

extendedData

@property NSString *extendedData

Description: message extension field Use cases: You can add extended fields to the message and send it to the peer Required: no Caution

length is 1k, you can contact technical support for configuration Available since: 2.6.0 or higher

localExtendedData

@property NSString *localExtendedData

Description: The expandable message field visible only on this end can store additional information locally, Through [updateMessageLocalExtendedData] change and currently has a length limit of 128K. If you have special requirements, please contact ZEGO technical support for configuration.

reactions

@property NSArray<ZIMMessageReaction *> *reactions

Description: Message statement list, which can carry data strongly related to users such as emoji expressions and voting information.

isBroadcastMessage

@property BOOL isBroadcastMessage

Description: Whether the message is pushed by all employees. Required: Internal assignment.

mentionedUserIDs

@property NSArray<NSString *> *mentionedUserIDs

Description: Whether to mention everyone. It can be presented as "@User". Use cases: For example, it can be used in sending messages. Required: No. Caution: This value does not add the "@User" to the message text. Developers need to implement it themselves. Available since: 2.14.0 or above

isMentionAll

@property BOOL isMentionAll

Description: Whether to mention everyone. It can be presented as "@Everyone". Use cases: For example, it can be used in groups or rooms. Required: No. Default value: false. Recommended value: Set to true if you need to mention everyone. Caution: This value does not add the "@Everyone" to the message text. Developers need to implement it themselves. Available since: 2.14.0 or above

repliedInfo

@property ZIMMessageRepliedInfo repliedInfo

Description: Message reply information.

rootRepliedCount

@property unsigned int rootRepliedCount

Description: Root replied count.

isServerMessage

@property BOOL isServerMessage

Whether the message was sent by the server.

cbInnerID

@property NSString *cbInnerID

The internal callback ID of the message.

editorUserID

@property NSString *editorUserID

Description: The userID of the message editor.

editedTime

@property long long editedTime

Description: The time of message editing.

isGroupTargetedMessage

@property BOOL isGroupTargetedMessage

Indicates whether the message is a group-targeted message.

pinnedUserID

@property NSString *pinnedUserID

Description: The userID of the message pinner.

pinnedTime

@property long long pinnedTime

Description: The time of message pinning.

destructTime

@property long long destructTime

Description: The timestamp at which the message will be destroyed.

ZIMMediaMessage

Base class for media message objects.

Details

Identifies a media message.

Declared in ZIMDefines.h

Caution：This base class is the basis of all media messages and contains the properties required by media messages.

Properties

fileLocalPath

@property NSString *fileLocalPath

Detail description: The local path of the media message. Required: If a local file is sent, this parameter must be set by the sender. Otherwise, the message fails to be sent.

fileDownloadUrl

@property NSString *fileDownloadUrl

Detail description: The external download url of the media message is used for the developer to transparently transmit the media file to other users by filling in this URL when the developer uploads the media file to his own server.Required or not: If an external URL is sent, this parameter is mandatory on the sender end.

fileUID

@property NSString *fileUID

Detail description: The unique ID of the media file. Required or not: The sender does not need to fill in, this value is generated by the SDK.

fileName

@property NSString *fileName

Detail description: The filename of the media file. Required or not: If you are sending an external URL, you need to fill in this value and include the file extension. If a local file is sent, the value is optional.

fileSize

@property long long fileSize

Detail description: The size of the media file. Required or not: The sender does not need to fill in, this value is generated by the SDK.

ZIMTextMessage

Normal text message object.

Details

Identifies the basic parameters of a message.

Declared in ZIMDefines.h

Caution：If the Type parameter of the base class is Text during callback, you can force the base class message object to be of this type.

Properties

message

@property NSString *message

The content of the text message.

ZIMCustomMessage

Custom message object.

Details

Identifies a custom message.

Declared in ZIMDefines.h

Caution：When calling back, if the Type parameter of the base class is Custom, the base class message object can be forcibly converted to this class.

Properties

message

@property NSString *message

The content of the text message.

searchedContent

@property NSString *searchedContent

Description: The search content of the message.

subType

@property unsigned int subType

Description: The subtype of the message, which is used by customers to customize the usage of different custom messages. Required: The sender is required, otherwise the message will fail to be sent.

ZIMCommandMessage

Custom binary message object.

Details

Identifies a binary message.

Declared in ZIMDefines.h

Caution：If the Type parameter of the base class is Custom during callback, you can force the base class message object to be of this type.

Properties

message

@property bytes message

The content of the custom message.

ZIMBarrageMessage

Barrage message class.

Details

The barrage message class does not appear in the session and does not store historical messages.

Declared in ZIMDefines.h

Properties

message

@property NSString *message

Description: The content of the barrage message.

ZIMImageMessage

Image message object.

Details

Identifies the basic parameters of a message.

Declared in ZIMDefines.h

Caution：If the Type parameter of the base class is Image during callback, you can force the base class message object to be of this type.

Properties

thumbnailDownloadUrl

@property NSString *thumbnailDownloadUrl

Detail description: Thumbnail external download URL of the image file. When developers upload thumbnails to their own servers, the SDK can pass through this field to other users. Required or not: optional on the sender side, this field will only take effect when fileDownloadUrl is filled in.

thumbnailLocalPath

@property NSString *thumbnailLocalPath

Detailed description: The thumbnail local path of the image file. Required or not: The sender does not need to fill in it. After calling [downloadMediaFile] to download, the SDK will generate this value.

largeImageDownloadUrl

@property NSString *largeImageDownloadUrl

Detail description: large Image external download URL of the image file. When developers upload large Images to their own servers, the SDK can pass through this field to other users.Required or not: optional on the sender side, this field will only take effect when fileDownloadUrl is filled in.

largeImageLocalPath

@property NSString *largeImageLocalPath

Detailed description: The large image local path of the image file. Required or not: The sender does not need to fill in it. After calling [downloadMediaFile] to download, the SDK will generate this value.

originalImageSize

@property CGSize originalImageSize

Detailed description: The size of the original image.

largeImageSize

@property CGSize largeImageSize

Detailed description: The size of the large image.

thumbnailSize

@property CGSize thumbnailSize

Detailed description: The size of the thumbnail image.

ZIMFileMessage

File message object.

Details

Identifies the basic parameters of a message.

Declared in ZIMDefines.h

Caution：If the Type parameter of the base class is File during callback, you can force the base class message object to be of this type.

ZIMAudioMessage

Audio message object.

Details

Identifies the basic parameters of a message.

Declared in ZIMDefines.h

Caution：If the Type parameter of the base class is Audio during callback, you can force the base class message object to be of this type.

Properties

audioDuration

@property unsigned int audioDuration

Detail description: The duration of the audio file. Required: Required by the sender, if not filled, the audio message will fail to be sent When sending local audio messages.

ZIMVideoMessage

Video message object.

Details

Identifies a video message.

Declared in ZIMDefines.h

Caution：When the Type parameter of the base class in the callback is Video, the base class message object can be cast to this class.

Properties

videoDuration

@property unsigned int videoDuration

Detail description: The duration of the video file. Required: Required by the sender, if not filled, the video message will fail to be sent when sending local video messages.

videoFirstFrameDownloadUrl

@property NSString *videoFirstFrameDownloadUrl

Detail description: Video first frame external download URL of the video file. When developers upload thumbnails to their own servers, the SDK can pass through this field to other users. Required or not: optional on the sender side, this field will only take effect when fileDownloadUrl is filled in.

videoFirstFrameLocalPath

@property NSString *videoFirstFrameLocalPath

Detailed description: The video first frame local path of the video file. Required or not: The sender does not need to fill in it. After calling [downloadMediaFile] to download, the SDK will generate this value.

videoFirstFrameSize

@property CGSize videoFirstFrameSize

Detailed description: The size of the first frame of the video.

ZIMRevokeMessage

Base class for revoke message objects.

Details

Identifies a revoke message.

Declared in ZIMDefines.h

Caution：This base class is the basis of all revoke messages and contains the properties required by revoke messages.

Properties

revokeType

@property ZIMRevokeType revokeType

Detail description: revoke type.

revokeTimestamp

@property unsigned long long revokeTimestamp

Detail description: revoke timestamp.

operatedUserID

@property NSString *operatedUserID

Detail description: operated user ID.

originalMessageType

@property ZIMMessageType originalMessageType

Description: original message type

originalTextMessageContent

@property NSString *originalTextMessageContent

Detail description: original text message content, if the message to be revoked is not a text message, this field is empty.

revokeExtendedData

@property NSString *revokeExtendedData

Detail description: revoke extended data.

revokeStatus

@property ZIMMessageRevokeStatus revokeStatus

Detail description: revoke status.

ZIMCombineMessage

Base class for combine message objects.

Details

Identifies a combine message.

Declared in ZIMDefines.h

Caution：This base class is the basis of all combine messages and contains the properties required by combine messages.

Properties

title

@property NSString *title

Detail description: Combine message title.

summary

@property NSString *summary

Detail description: The summary of combine message.

combineID

@property NSString *combineID

Detail description: Combine ID, internal used

messageList

@property NSArray<ZIMMessage *> *messageList

List of child messages

ZIMTipsMessage

Tips message object.

Details

Identifies a tips info message.

Declared in ZIMDefines.h

Caution：If the Type parameter of the base class is Tips during callback, you can force the base class message object to be of this type.

Properties

event

@property ZIMTipsMessageEvent event

Detail description: Tips event type.

operatedUser

@property ZIMUserInfo operatedUser

Detail description: Operated user information.

targetUserList

@property NSArray<ZIMUserInfo *> *targetUserList

Detail description: Target user list.

changeInfo

@property ZIMTipsMessageChangeInfo changeInfo

Detail description: Change information.

ZIMMultipleMessage

Multiple message object.

Declared in ZIMDefines.h

Properties

messageInfoList

@property NSArray<ZIMMessageLiteInfo *> *messageInfoList

Detail description: List of content in the multiple message.

failedIndexList

@property NSArray<int *> *failedIndexList

Detail description: List of failed index in the multiple message.

ZIMMessageRootRepliedInfo

Reply to the root message of the message tree.

Declared in ZIMDefines.h

Properties

state

@property ZIMMessageRepliedInfoState state

Description: Message replied state.

message

@property ZIMMessage message

Description: Root message.

senderUserID

@property NSString *senderUserID

Description: Sender user ID of the root message.

sentTime

@property long long sentTime

Description: Sent time of the root message.

repliedCount

@property unsigned int repliedCount

Description: Root replied count.

ZIMMessageRootRepliedCountInfo

Information about the number of replies in the reply message tree.

Declared in ZIMDefines.h

Properties

messageID

@property long long messageID

Description: Message ID.

conversationID

@property NSString *conversationID

Description: Conversation ID.

conversationType

@property ZIMConversationType conversationType

Description: Conversation type.

count

@property unsigned int count

Description: Root replied count.

ZIMMessageMentionedInfo

message mention information.

Declared in ZIMDefines.h

message mention information.

Properties

messageID

@property long long messageID

Description: Message ID, used to match the notification information to which message it belongs toRequired or not: Developers do not need to fill in.

messageSeq

@property long long messageSeq

Description: Message sequence number, used to match the notification information to which message it belongs toRequired or not: Developers do not need to fill in.

fromUserID

@property NSString *fromUserID

Description: From which user. Required: Developers do not need to fill in.

type

@property ZIMMessageMentionedType type

Details Description: Type of notification, used to distinguish between reminding oneself and reminding everyone. Required: Developers do not need to fill in.

ZIMMessageReceivedInfo

A structure in which the message receiving event carries relevant information.

Declared in ZIMDefines.h

Properties

conversationID

@property NSString *conversationID

Description: The ID of conversation.

conversationType

@property ZIMConversationType conversationType

Description: The type of conversation.

isOfflineMessage

@property BOOL isOfflineMessage

Description: Whether it is an offline message.

ZIMMessageSendConfig

Configurations related to sending messages.

Details

Configurations related to sending messages.

Declared in ZIMDefines.h

Properties

pushConfig

@property ZIMPushConfig pushConfig

Description: Configures the offline push function, If Android or iOS platform is integrated, it is strongly recommended to configure this. Required: Not mandatory.

priority

@property ZIMMessagePriority priority

Enumeration value used to set message priority. Required: Must mandatory.

hasReceipt

@property BOOL hasReceipt

Detailed description: When sending a message, whether the message has a receipt.Business scenario: use when you need to bring a receipt for a message.Required: not required.Default value: false.

isNotifyMentionedUsers

@property BOOL isNotifyMentionedUsers

Whether to send push notifications to mentioned users.

isRetrySend

@property BOOL isRetrySend

Whether to resend the failed message.

disableUnreadMessageCount

@property BOOL disableUnreadMessageCount

When sending messages that would otherwise affect the other party's unread count, should they no longer be counted as unread by the other party? Whether required: Not required. Default value: false.

isAllowMultipleMessagePartialFailed

@property BOOL isAllowMultipleMessagePartialFailed

Whether to allow some sub-messages to fail to send when sending a multiple message. Whether required: Not required. Default value: false.

ZIMMessageQueryConfig

Example Query message configuration.

Details

Example Query the configurations of messages.

Declared in ZIMDefines.h

Properties

nextMessage

@property ZIMMessage nextMessage

Description: Query the anchor point of the message. Required: This parameter is not required for the first query but is required for subsequent paging queries.

count

@property unsigned int count

Description: Number of query messages. Required: not required.

reverse

@property BOOL reverse

Description: Indicates whether the query is in reverse order. Required: not required. Default value: false.

mode

@property ZIMMessageQueryMode mode

Description: Sets the mode for querying historical messages. Since the SDK can determine whether local data is complete and therefore return historical messages more quickly, it is recommended to use the default value in most cases. Required: No.

ZIMMessageRevokeConfig

Revoke configurations related to messages.

Details

Revoke configurations related to messages.

Declared in ZIMDefines.h

Properties

pushConfig

@property ZIMPushConfig pushConfig

Description: Configures the offline push function, If Android or iOS platform is integrated, it is strongly recommended to configure this. Required: Not required.

revokeExtendedData

@property NSString *revokeExtendedData

Description: revoking additional messages. Required: Not required.

ZIMMessageDeleteConfig

Delete message configuration.

Details

Delete configurations related to messages.

Declared in ZIMDefines.h

Properties

isAlsoDeleteServerMessage

@property BOOL isAlsoDeleteServerMessage

Description: Whether to remove flags for server messages. Required: not required. Default value: false.

ZIMMessageDeletedInfo

Deleted message information.

Details

Information class for deleted messages.

Declared in ZIMDefines.h

Properties

conversationID

@property NSString *conversationID

Description: Conversation ID.

conversationType

@property ZIMConversationType conversationType

Description: Conversation type.

messageDeleteType

@property ZIMMessageDeleteType messageDeleteType

[onMessageDeleted] Indicates the cause of being triggered.

messageList

@property NSArray<ZIMMessage *> *messageList

List of deleted messages. Valid when [ZIMMessageDeleteType] is [ZIMMessageDeleteTypeMessageListDeleted].

ZIMMessageAttachedCallback

The incoming message object is given a localMessgeID and returned.

Declared in ZIMDefines.h

Properties

message

@property ZIMMessage message

Message object.

ZIMMediaUploadingProgress

Progress callback for sending media messages.

Declared in ZIMDefines.h

Properties

message

@property ZIMMediaMessage message

Media message object.

currentFileSize

@property unsigned long long currentFileSize

Current file size.

totalFileSize

@property unsigned long long totalFileSize

Total file size.

ZIMMultipleMediaUploadingProgress

Callback for multiple media files upload progress.

Declared in ZIMDefines.h

Properties

message

@property ZIMMultipleMessage message

Multiple media message object.

currentFileSize

@property unsigned long long currentFileSize

Current file size.

totalFileSize

@property unsigned long long totalFileSize

Total file size.

messageInfoIndex

@property unsigned int messageInfoIndex

Current message index.

currentIndexFileSize

@property unsigned long long currentIndexFileSize

Current index file size.

totalIndexFileSize

@property unsigned long long totalIndexFileSize

Total index file size.

ZIMMessageSendNotification

The notification callback when the message is sent, you can get the relevant information before the message object is sent through this notification

Details

Through this notification, developers can obtain relevant information before the message object is sent, such as localMessageID, etc.

Declared in ZIMDefines.h

Use cases：When developers need to record and cache relevant information before sending a message, they can obtain it by listening to the notification.
Caution：If no monitoring is required, it can be passed [null].

Properties

onMessageAttached

@property ZIMMessageAttachedCallback onMessageAttached

Detail description: After the message falls into the local DB, the notification will be called back before the message is sent to the server. Business scenario: This interface can be used when the developer needs to obtain the relevant information in the message in advance before sending the message. Required: not required. If no monitoring is required, it can be passed empty. Default: empty.

onMediaUploadingProgress

@property ZIMMediaUploadingProgress onMediaUploadingProgress

Description: Media file upload progress.

onMultipleMediaUploadingProgress

@property ZIMMultipleMediaUploadingProgress onMultipleMediaUploadingProgress

Description: Multiple media file upload progress.

ZIMMediaMessageSendNotification

The notification callback when the media message is sent, you can get the relevant information before the message object is sent through this notification

Details

Through this notification, developers can obtain relevant information before the message object is sent, such as localMessageID, etc.

Declared in ZIMDefines.h

Use cases：When developers need to record and cache relevant information before sending a message, they can obtain it by listening to the notification.
Caution：If no monitoring is required, it can be passed [null].

Properties

onMessageAttached

@property ZIMMessageAttachedCallback onMessageAttached

onMediaUploadingProgress

@property ZIMMediaUploadingProgress onMediaUploadingProgress

Callback for media upload progress.

ZIMMessageReceiptInfo

receipt information.

Details

receipt information.

Declared in ZIMDefines.h

Properties

status

@property ZIMMessageReceiptStatus status

Detail description: receipt status.

messageID

@property long long messageID

Detailed Description: Message ID. Business scenario: Developers can match the loaded message list according to this ID. Is it required: No, SDK fills in.

conversationID

@property NSString *conversationID

Session ID.

conversationType

@property ZIMConversationType conversationType

Session type.

readMemberCount

@property unsigned int readMemberCount

Description: Number of read members.

unreadMemberCount

@property unsigned int unreadMemberCount

Description: Number of unread members.

deliveredMemberCount

@property unsigned int deliveredMemberCount

Description: Number of delivered members.

isSelfOperated

@property BOOL isSelfOperated

Description: Whether it is self-operated by multi-terminal.

readTime

@property long long readTime

Description: All the recipients have read the timestamp of that moment.

ZIMMessageReactionUserQueryConfig

Configuration for querying reaction user list

Details

When querying reaction member, you need to configure this object.

Declared in ZIMDefines.h

Properties

nextFlag

@property unsigned long long nextFlag

Description: The flag of the paging query. For the first query, set this field to an empty string. If the "nextFlag" field of the [ZIMMessageReactionUserListQueriedCallback] callback is not an empty string, it needs to be set here to continue the query on the next page.Required: Not required.

count

@property unsigned int count

Description: How many members are retrieved in one query, 100 at most.Caution: To obtain members in pages to reduce overhead, it is recommended to obtain within 20 members at a time. If the value is 0, the SDK will query 100 members by default.Required: Required.

reactionType

@property NSString *reactionType

Description: reaction type, defined by you.

ZIMMessageSentStatusChangeInfo

Notice of Room Message Status Change.

Details

Notice of Room Message Status Change.

Declared in ZIMDefines.h

Properties

status

@property ZIMMessageSentStatus status

message sent status.

message

@property ZIMMessage message

ZIMMessage.

reason

@property NSString *reason

This field stores the reason why a message was rejected by ZEGOCLOUD In-app Chat due to interception by the server-side callback on message not sent yer. If you have enabled the ZEGOCLOUD In-app Chat content moderation service and require this field to capture failure reasons caused by failed content moderation, contact ZEGOCLOUD Technical Support for configuration.

ZIMMessageSearchConfig

Message search configuration.

Details

Message search configuration.

Declared in ZIMDefines.h

Properties

nextMessage

@property ZIMMessage nextMessage

Paging fetch flag, which means fetching messages before or after nextMessage, with 'before' or 'after' determined by the order value. On the first search, nextMessage is null. On subsequent searches, nextMessage needs to pass in the last message in the message list queried last time.

count

@property unsigned int count

count It is recommended to keep the number of items less than 20 to reduce performance overhead.

order

@property ZIMMessageOrder order

When the 'order' is 'DESCENDING' during message search, it means querying messages with sending time earlier than nextMessage. If it's the first message query (i.e. nextMessage is null), then query from the last message stored locally forward. When 'order' is 'ASCENDING', it means querying messages with sending time later than nextMessage. If it's the first message query (i.e. nextMessage is null), then query from the first message stored locally backward. The default is 'DESCENDING'.

keywords

@property NSArray<NSString *> *keywords

Search keywords, up to 5 keywords are supported, otherwise an error will be reported. For example: passing in '1' and '2' will make the search results only show messages that contain both keywords '1' and '2'.

messageTypes

@property NSArray<ZIMMessageType *> *messageTypes

Message types, can be used to specify message types. Support passing in multiple types.

subMessageTypes

@property NSArray<unsigned int *> *subMessageTypes

The subtypes of custom messages have a value range of [0,200]. Developers can use this range to search for specific custom types.

senderUserIDs

@property NSArray<NSString *> *senderUserIDs

The user ID of the message sender, supporting up to 5 IDs. For example, if 'zego2023' is passed in, the search results will only display all the messages sent by the user 'zego2023' in that conversation.

startTime

@property long long startTime

The starting point of the search, in milliseconds, with a default value of 0. The format is UTC timestamp.

endTime

@property long long endTime

The ending point of the search, which must be greater than the startTime, in milliseconds. The default value is 0 and the format is UTC timestamp.

ZIMMessageRepliedListQueryConfig

Configuration for querying reply message list.

Details

Configuration class for querying the replied message list.

Declared in ZIMDefines.h

Properties

nextFlag

@property long long nextFlag

The flag of paginated query. When querying for the first time, set this field to 0. If the 'nextFlag' field of the [queryMessageRepliedList] callback is not 0, it means that the query has not ended yet. You need to set it here to continue querying the next page.

count

@property unsigned int count

The number of queries per query. The upper limit is 100. Exceeding 100 will result in an error.

ZIMMediaDownloadConfig

Configuration for downloading media files.

Details

Configuration class for media file downloads.

Declared in ZIMDefines.h

Properties

messageInfoIndex

@property unsigned int messageInfoIndex

Detailed description: The index of the array where a file in the download multiple message is located.

ZIMMessageEditConfig

(Empty Class) Configurations related to editing messages.

Details

(Empty Class) Configurations related to editing messages.

Declared in ZIMDefines.h

ZIMSendingMessageCancelConfig

(Empty Class) Configurations related to cancel sending messages.

Details

(Empty Class) Configurations related to cancel sending messages.

Declared in ZIMDefines.h

ZIMMessagePinConfig

Pinning message configuration

Details

Pin configurations related to messages.

Declared in ZIMDefines.h

Properties

disableAutoReplace

@property BOOL disableAutoReplace

When the number of pinned messages exceeds the limit, replacing older pinned messages in the pinned list during the next pin operation is not allowed. The default value is [false].

ZIMTipsMessageChangeInfo

Tips message additional information.

Details

Tips message additional information.

Declared in ZIMDefines.h

Properties

type

@property ZIMTipsMessageChangeInfoType type

Tips message additional information type.

ZIMTipsMessageGroupChangeInfo

Tips Additional information about change events related to the message group.

Details

Tips Additional information about change events related to the message group.

Declared in ZIMDefines.h

Properties

groupDataFlag

@property ZIMGroupDataFlag groupDataFlag

If there are multiple changes in the group name, group avatar, and group announcement, you need to know which ones have changed based on the value of this field. Among them, 0b0001 is the group name, 0b0010 is the group notice, and 0b0100 is the group avatar.

groupName

@property NSString *groupName

If the group name is changed, the changed value will be displayed here.

groupNotice

@property NSString *groupNotice

If the group notice is changed, the changed value will be displayed here.

groupAvatarUrl

@property NSString *groupAvatarUrl

If the group avatar url is changed, the changed value will be displayed here.

groupMutedInfo

@property ZIMGroupMuteInfo groupMutedInfo

If the group mute info is changed, the changed value will be displayed here.

ZIMTipsMessageGroupMemberChangeInfo

Tips Additional information about change events related to the message group member.

Details

Tips Additional information about change events related to the message group member.

Declared in ZIMDefines.h

Properties

memberRole

@property int memberRole

If a group member's role changes, the changed role will be displayed here.

muteExpiredTime

@property long long muteExpiredTime

If the group member's muting expired time changes, the new muting expired time will be displayed here.

groupNewOwner

@property ZIMGroupMemberSimpleInfo groupNewOwner

Detailed description: tips message generated when the original group owner leaves the group and causes a change in the group owner. This field is true and indicates a newly created group owner.

ZIMTipsMessagePinStatusChangeInfo

Tips Additional information about change events related to the message pinned or unpined.

Details

Tips Additional information about change events related to the message pinned or unpined.

Declared in ZIMDefines.h

Properties

isPinned

@property BOOL isPinned

Describes whether the current operation is a pin operation or an unpin operation.

ZIMMessagePinStatusChangeInfo

Notification of the message pinned status changed.

Details

When a message in a conversation is successfully pinned or unpinned and a notification is raised, this structure can be used to obtain the operated message and its current pinned status.

Declared in ZIMDefines.h

Properties

pinStatus

@property ZIMMessagePinStatus pinStatus

Message pin status

message

@property ZIMMessage message

The message object whose pin status changed.

ZIMFileCacheClearConfig

Clear cache configuration.

Details

Clear cache configuration.

Declared in ZIMDefines.h

Properties

endTime

@property long long endTime

Expiration stamp of cache cleanup.

ZIMFileCacheQueryConfig

Query cache configuration.

Details

Query cache configuration.

Declared in ZIMDefines.h

Properties

endTime

@property long long endTime

Example Query the expiration timestamp of the cache.

ZIMFileCacheInfo

File cache information.

Details

Detailed description: File cache information.

Declared in ZIMDefines.h

Properties

totalFileSize

@property unsigned long long totalFileSize

Total file size in bytes (B).

ZIMMessageReactionChangeInfo

message reaction change information.

Details

A class that describes reaction change information.

Declared in ZIMDefines.h

Properties

message

@property ZIMMessage message

Description: The message object containing updated reaction information, which can be used to directly replace the old data held by the developer.

userChangeInfoList

@property NSArray<ZIMMessageReactionUserChangeInfo *> *userChangeInfoList

Description: A list of user reaction operation changes under the current message.

ZIMConversation

Session specific content.

Details

The specific content of the session.

Declared in ZIMDefines.h

Properties

conversationID

@property NSString *conversationID

Conversation ID.

type

@property ZIMConversationType type

Conversation type.

conversationName

@property NSString *conversationName

conversationName is the same as the groupName/userName value corresponding to the session.

conversationAvatarUrl

@property NSString *conversationAvatarUrl

Conversation avatar URL. The peer-to-peer conversation avatar URL is the same as the user avatar URL, and the group conversation avatar URL is the same as the group avatar URL.

conversationAlias

@property NSString *conversationAlias

After the friend remarks are set through [updateFriendAlias], this parameter is changed for each chat conversation. After setting a group alias by [updateGroupAlias], the corresponding group chat conversation's parameter will be modified synchronously.

notificationStatus

@property ZIMConversationNotificationStatus notificationStatus

Conversation notification status.

unreadMessageCount

@property unsigned int unreadMessageCount

Unread message count of the conversation.

lastMessage

@property ZIMMessage lastMessage

The last message in the conversation.

orderKey

@property long long orderKey

OrderKey is used to describe the order of messages in the session. The larger orderKey is, the newer it is.

isPinned

@property BOOL isPinned

Whether the conversation is pinned.

pinnedTime

@property long long pinnedTime

Description: The timestamp of conversation pinned.

mentionedInfoList

@property NSArray<ZIMMessageMentionedInfo *> *mentionedInfoList

When reminded in a message or reminded to everyone in a conversation, this array will record the reminders.

draft

@property NSString *draft

Conversation draft, when draft set conversation will carry this parameter.

marks

@property NSArray<int *> *marks

Describes all the existing marks for the conversation.

readMessageSeq

@property long long readMessageSeq

Conversation read message sequence number.

isConversationDisabled

@property BOOL isConversationDisabled

Whether the conversation is unavailable.

selfMutedExpiredTime

@property long long selfMutedExpiredTime

The expiration timestamp of the self-mute for this conversation.

messageDestructDuration

@property int messageDestructDuration

The timed message self-destruction duration for the conversation.

ZIMConversationBaseInfo

Conversation base information

Details

The base content of the session.

Declared in ZIMDefines.h

Properties

conversationID

@property NSString *conversationID

Conversation ID. For single chat, the conversation ID is the other user ID. For group chat, the conversation ID is the group ID.

conversationType

@property ZIMConversationType conversationType

Conversation type

ZIMGroupConversation

Group session object, extend from ZIMGroupConversation.

Details

Group session object, extend from ZIMGroupConversation.

Declared in ZIMDefines.h

Properties

isDisabled

@property BOOL isDisabled

Whether the group session is unavailable.

mutedExpiredTime

@property long long mutedExpiredTime

The expiration date of the group gag.

ZIMConversationQueryConfig

Query the relevant configuration of the session.

Details

Configurable information when querying a session.

Declared in ZIMDefines.h

Properties

nextConversation

@property ZIMConversation nextConversation

Session that needs to be queried.

count

@property unsigned int count

The number of sessions to query.

ZIMConversationFilterOption

Search filters related to the conversation.

Details

Configurable filter options when querying conversation list.

Declared in ZIMDefines.h

Properties

conversationTypes

@property NSArray<ZIMConversationType *> *conversationTypes

Conversation type list

marks

@property NSArray<int *> *marks

Conversation mark list

isOnlyUnreadConversation

@property BOOL isOnlyUnreadConversation

Whether to query only unread conversations

pinnedFilter

@property ZIMConversationPinnedFilter pinnedFilter

Conversation pinned filter

ZIMConversationTotalUnreadMessageCountQueryConfig

Search filters related to the conversation total unread message count.

Details

Configurable filter options when querying conversation total unread message count.

Declared in ZIMDefines.h

Properties

conversationTypes

@property NSArray<ZIMConversationType *> *conversationTypes

Conversation type list

marks

@property NSArray<int *> *marks

Conversation mark list

ZIMConversationDeleteConfig

Conversation delete configuration

Details

Delete the related configuration of the session.

Declared in ZIMDefines.h

Properties

isAlsoDeleteServerConversation

@property BOOL isAlsoDeleteServerConversation

Whether to delete server conversations at the same time

ZIMConversationsAllDeletedInfo

Delete all session notification information.

Details

Delete all session notification information.

Declared in ZIMDefines.h

Properties

count

@property unsigned int count

Number of sessions that were deleted.

ZIMConversationChangeInfo

Conversation change information

Details

Contains information after session changes.

Declared in ZIMDefines.h

Properties

event

@property ZIMConversationEvent event

action

@property ZIMConversationListChangeAction action

Conversation change action

conversation

@property ZIMConversation conversation

Changed conversation

ZIMConversationSearchConfig

Conversation search configuration.

Details

Conversation search configuration.

Declared in ZIMDefines.h

Properties

mode

@property ZIMConversationSearchMode mode

Conversation search mode.

nextFlag

@property unsigned int nextFlag

Pagination token, fill in 0 initially, and then fill in the nextFlag returned from the callback to retrieve data for the next page.

totalConversationCount

@property unsigned int totalConversationCount

The number of messages that can be retrieved in one search. It is recommended to be less than 20 to reduce performance overhead.

keywords

@property NSArray<NSString *> *keywords

Search keywords, supports up to 5. Otherwise, an error will occur. For example, if you pass in '1' and '2', the search results will only display conversations that contain both '1' and '2' keywords in the messages.

conversationMessageCount

@property unsigned int conversationMessageCount

The number of local messages that can be retrieved for a single conversation in one search. It is recommended to be less than 10 to reduce performance overhead.

messageTypes

@property NSArray<ZIMMessageType *> *messageTypes

Message types, can be used to specify message types. Support passing in multiple types.

subMessageTypes

@property NSArray<unsigned int *> *subMessageTypes

The subtypes of custom messages have a value range of [0,200]. Developers can use this range to search for specific custom types.

senderUserIDs

@property NSArray<NSString *> *senderUserIDs

Send user ID, supports up to 5. For example, if you pass in zego2023, the search results will only display conversations where messages have been sent by the user zego2023.

startTime

@property long long startTime

The starting point of the search, in milliseconds, with a default value of 0. The format is UTC timestamp.

endTime

@property long long endTime

The ending point of the search, which must be greater than the startTime, in milliseconds. The default value is 0 and the format is UTC timestamp.

ZIMConversationSearchInfo

Conversation search result

Details

Information class for conversation search results.

Declared in ZIMDefines.h

Properties

conversationID

@property NSString *conversationID

The conversation ID of the local message to be search.

conversationType

@property ZIMConversationType conversationType

conversation type.

conversation

@property ZIMConversation conversation

Conversation object.

totalMessageCount

@property unsigned int totalMessageCount

Total message count.

messageList

@property NSArray<ZIMMessage *> *messageList

Search results of messages.

ZIMRoomInfo

Room information object.

Details

Identifies a unique room.

Declared in ZIMDefines.h

Properties

roomID

@property NSString *roomID

Room ID. a string with a maximum length of 128 bytes. It is customized by the developer and supports only digits, English characters, ~~, and '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~~'.

roomName

@property NSString *roomName

Room name, It is customized by the developer .a string with a maximum length of 64 bytes or less.

ZIMRoomFullInfo

The room details object.

Details

Identifies the detailed information of a room.

Declared in ZIMDefines.h

Properties

baseInfo

@property ZIMRoomInfo baseInfo

Room base information

ZIMRoomMemberInfo

Room user information.

Details

A class describing room user.

Declared in ZIMDefines.h

ZIMRoomMemberQueryConfig

Configuration for querying room member.

Details

When querying member, you need to configure this object.

Declared in ZIMDefines.h

Properties

nextFlag

@property NSString *nextFlag

The flag of the paging query. For the first query, set this field to an empty string. If the 'nextFlag' field of the callback is not an empty string, it needs to be set here to continue the query on the next page.

count

@property unsigned int count

How many messages are retrieved in one query.

ZIMRoomAdvancedConfig

Room advanced configuration

Details

Room‘s advanced config.

Declared in ZIMDefines.h

Properties

roomAttributes

@property NSDictionary<NSString, NSString> *roomAttributes

Room attributes of a room.

roomDestroyDelayTime

@property unsigned int roomDestroyDelayTime

Room destruction time delayed, the unit is seconds. The maximum room destroy delay time is 3 hours.

ZIMRoomAttributesSetConfig

The behavior attribute set by the room attribute.

Details

The behavior attribute set by the room attribute.

Declared in ZIMDefines.h

Properties

isForce

@property BOOL isForce

Whether the operation is mandatory, that is, the property of the room whose owner is another user can be modified.

isDeleteAfterOwnerLeft

@property BOOL isDeleteAfterOwnerLeft

Room attributes are automatically deleted after the owner leaves the room.

isUpdateOwner

@property BOOL isUpdateOwner

Whether to update the owner of the room attribute involved.

ZIMRoomAttributesBatchOperationConfig

The behavior attribute set by the room attribute.

Details

The behavior attribute set by the room attribute.

Declared in ZIMDefines.h

Properties

isForce

@property BOOL isForce

Whether the operation is mandatory, that is, the property of the room whose owner is another user can be modified.

isDeleteAfterOwnerLeft

@property BOOL isDeleteAfterOwnerLeft

Room attributes are automatically deleted after the owner leaves the room.

isUpdateOwner

@property BOOL isUpdateOwner

Whether to update the owner of the room attribute involved.

ZIMRoomAttributesDeleteConfig

The behavior attribute set by the room attribute.

Details

The behavior attribute set by the room attribute.

Declared in ZIMDefines.h

Properties

isForce

@property BOOL isForce

Whether the operation is mandatory, that is, the property of the room whose owner is another user can be deleted.

ZIMRoomAttributesUpdateInfo

Room attribute update information

Details

Notice of Room Attribute Change.

Declared in ZIMDefines.h

Properties

action

@property ZIMRoomAttributesUpdateAction action

Behavioral information of room attribute change notification.

roomAttributes

@property NSDictionary<NSString, NSString> *roomAttributes

Room attributes.

ZIMRoomMemberAttributesInfo

Room user attribute information.

Details

Detail description: A class describing room user attributes, including UserID and its corresponding attributes.

Declared in ZIMDefines.h

Properties

userID

@property NSString *userID

Detail description: User ID.

attributes

@property NSDictionary<NSString, NSString> *attributes

Detailed description: room user attributes.

ZIMRoomMemberAttributesOperatedInfo

Room user attribute operation information.

Details

Detail description: room user attribute operation information, including attributes of successful operation and keys of failure.

Declared in ZIMDefines.h

Properties

attributesInfo

@property ZIMRoomMemberAttributesInfo attributesInfo

Detailed description: room user attribute information.

errorKeys

@property NSArray<NSString *> *errorKeys

Detail description: The key of the room user attribute operation failure.

ZIMRoomMemberAttributesUpdateInfo

Room user attribute update information.

Details

Detailed description: Room user attribute update information.

Declared in ZIMDefines.h

Properties

attributesInfo

@property ZIMRoomMemberAttributesInfo attributesInfo

Detailed description: room user attributes.

ZIMRoomMemberAttributesSetConfig

Room user property settings configuration.

Details

room user attribute setting configuration, including configurable whether to retain user attributes after the user leaves, etc.

Declared in ZIMDefines.h

Use cases：When setting room user attributes, developers can choose to use them according to their actual application scenarios.

Properties

isDeleteAfterOwnerLeft

@property BOOL isDeleteAfterOwnerLeft

Default: true.

ZIMRoomMemberAttributesQueryConfig

Room member attribute query configuration

Details

Detailed description: room user attribute query configuration.

Declared in ZIMDefines.h

Properties

nextFlag

@property NSString *nextFlag

Detail description: Query anchor for room user properties.

count

@property unsigned int count

count.

ZIMRoomOperatedInfo

Room operation information.

Details

Detailed description: Room operation information.

Declared in ZIMDefines.h

Properties

userID

@property NSString *userID

Detail description: UserID of the operator.

ZIMGroupInfo

group information.

Details

group information.

Declared in ZIMDefines.h

Properties

groupID

@property NSString *groupID

groupID.

groupName

@property NSString *groupName

Group name.

groupAvatarUrl

@property NSString *groupAvatarUrl

Use Limit: the maximum number of characters is 500 bytes. There is no limit on special characters.

ZIMGroupMuteInfo

Group mute information.

Details

Group mute information.

Declared in ZIMDefines.h

Properties

mode

@property ZIMGroupMuteMode mode

Group mute mode.

expiredTime

@property long long expiredTime

Group mute expiration time, measured in seconds. When it's 0, there is no mute; when it's -1, it means permanent mute.

roles

@property NSArray<int *> *roles

Detail description: Role list muted in the group.

ZIMGroupVerifyInfo

Verification mode for joining the group.

Details

Group verification information class, describing the group entry verification mode.

Declared in ZIMDefines.h

Properties

joinMode

@property ZIMGroupJoinMode joinMode

Verification mode for joining the group.

inviteMode

@property ZIMGroupInviteMode inviteMode

Verification mode for invite to the group.

beInviteMode

@property ZIMGroupBeInviteMode beInviteMode

Verification mode for being invited to the group.

ZIMGroupFullInfo

complete group information.

Details

complete group information.

Declared in ZIMDefines.h

Properties

baseInfo

@property ZIMGroupInfo baseInfo

basic group information.

groupNotice

@property NSString *groupNotice

Group of announcement.

groupAttributes

@property NSDictionary<NSString, NSString> *groupAttributes

group properties.

groupAlias

@property NSString *groupAlias

the group alias defined by user, which is visible only to that user.

notificationStatus

@property ZIMGroupMessageNotificationStatus notificationStatus

group message notification status.

mutedInfo

@property ZIMGroupMuteInfo mutedInfo

Group mute info.

createTime

@property long long createTime

The timestamp of the server when the group was created.

maxMemberCount

@property unsigned int maxMemberCount

The maximum number of group members.

verifyInfo

@property ZIMGroupVerifyInfo verifyInfo

Verification mode for joining the group.

ZIMGroup

complete group information for group list.

Details

complete group information for group list.

Declared in ZIMDefines.h

Properties

baseInfo

@property ZIMGroupInfo baseInfo

basic group information.

groupAlias

@property NSString *groupAlias

the group alias defined by user, which is visible only to that user.

notificationStatus

@property ZIMGroupMessageNotificationStatus notificationStatus

group message notification status.

ZIMGroupMemberSimpleInfo

Group member simple information.

Details

Simple information class for group members.

Declared in ZIMDefines.h

Properties

memberNickname

@property NSString *memberNickname

Group member nickname.

memberRole

@property ZIMGroupMemberRole memberRole

group role.

ZIMGroupEnterInfo

Information about group members when they join the group.

Details

Information class for a user entering a group.

Declared in ZIMDefines.h

Properties

enterTime

@property long long enterTime

The timestamp of the server when joining the group.

enterType

@property ZIMGroupEnterType enterType

Group entry type.

operatedUser

@property ZIMGroupMemberSimpleInfo operatedUser

Group entry type.

ZIMGroupMemberInfo

Group member information.

Details

Group member information.

Declared in ZIMDefines.h

Properties

memberNickname

@property NSString *memberNickname

Group member nickname.

memberRole

@property ZIMGroupMemberRole memberRole

group role.

muteExpiredTime

@property long long muteExpiredTime

Group member's mute expiration time. When it's 0, it means no mute; when it's -1, it means permanent mute.

groupEnterInfo

@property ZIMGroupEnterInfo groupEnterInfo

Information about group members when they join the group.

ZIMGroupOperatedInfo

The group causes the event to change the operator's information.

Details

The group causes the event to change the operator's information.

Declared in ZIMDefines.h

Properties

userID

@property NSString *userID

The operator's user ID.

userName

@property NSString *userName

The operator's username.

memberNickname

@property NSString *memberNickname

The operator's group member nickname.

memberRole

@property ZIMGroupMemberRole memberRole

The operator's group member role.

ZIMGroupMemberQueryConfig

group member query configuration.

Details

group member query configuration.

Declared in ZIMDefines.h

Properties

nextFlag

@property unsigned int nextFlag

nextFlag.

count

@property unsigned int count

count. Quantity, upper limit is 100, over 100 will be treated as 100.

ZIMGroupAdvancedConfig

Group advanced configuration.

Details

Group advanced configuration.

Declared in ZIMDefines.h

Properties

groupNotice

@property NSString *groupNotice

group notice.

groupAttributes

@property NSDictionary<NSString, NSString> *groupAttributes

Group properties, up to 10 can be configured..

maxMemberCount

@property unsigned int maxMemberCount

The maximum number of group members.

joinMode

@property ZIMGroupJoinMode joinMode

Verification mode for joining the group.

inviteMode

@property ZIMGroupInviteMode inviteMode

Verification mode for invite to the group.

beInviteMode

@property ZIMGroupBeInviteMode beInviteMode

Verification mode for being invited to the group.

ZIMGroupAttributesUpdateInfo

Group attribute update information.

Details

Group attribute update information.

Declared in ZIMDefines.h

Properties

action

@property ZIMGroupAttributesUpdateAction action

Group attribute update action.

groupAttributes

@property NSDictionary<NSString, NSString> *groupAttributes

group properties.

ZIMGroupMessageReceiptMemberQueryConfig

Group message receipt read/unread member query configuration.

Details

Group message receipt read/unread member query configuration.

Declared in ZIMDefines.h

Properties

nextFlag

@property unsigned int nextFlag

The pagination cursor. Set to 0 for the first query, then use the nextFlag from the [ZIMGroupMessageReceiptMemberListQueriedCallback] callback for subsequent pages.

count

@property unsigned int count

The number of group members to query.

ZIMGroupMessageReceiptMemberListQueryConfig

Group message receipt member query configuration.

Declared in ZIMDefines.h

Properties

nextFlag

@property unsigned int nextFlag

The pagination cursor. Set to 0 for the first query, then use the nextFlag from the [ZIMGroupMessageReceiptMemberListQueriedCallback] callback for subsequent pages.

filterType

@property ZIMMessageReceiptFilterType filterType

Filter type for the receipt member list to query.

ZIMGroupSearchConfig

Group search configuration.

Details

Group search configuration.

Declared in ZIMDefines.h

Properties

nextFlag

@property unsigned int nextFlag

The flag used to search groups.

count

@property unsigned int count

count.

keywords

@property NSArray<NSString *> *keywords

Search keywords. For example: passing in '1' and '2' will make the search results only show groups whose group names contain both keywords '1' and '2'.

isAlsoMatchGroupMemberUserName

@property BOOL isAlsoMatchGroupMemberUserName

Whether the search scope includes group member user names. Default is false.

isAlsoMatchGroupMemberNickname

@property BOOL isAlsoMatchGroupMemberNickname

Whether the search scope includes group member user nicknames. Default is false.

ZIMGroupSearchInfo

Group search info.

Details

Group search info.

Declared in ZIMDefines.h

Properties

groupInfo

@property ZIMGroupInfo groupInfo

group info.

userList

@property NSArray<ZIMGroupMemberInfo *> *userList

Group member information.

ZIMGroupMemberSearchConfig

group member search configuration.

Details

group member search configuration.

Declared in ZIMDefines.h

Properties

nextFlag

@property unsigned int nextFlag

The flag for querying, fill in 0 when calling the interface for the first time. When calling the interface again later, fill in the nextFlag returned from the callback to retrieve the remaining data.

count

@property unsigned int count

count.

keywords

@property NSArray<NSString *> *keywords

Search keywords, up to 5 keywords are supported, otherwise an error will be reported. For example: passing in '1' and '2' will make the search results only show group members whose names contain both keywords '1' and '2'.

isAlsoMatchGroupMemberNickname

@property BOOL isAlsoMatchGroupMemberNickname

Whether the search scope includes group member user nickname. Default is false.

ZIMGroupMuteConfig

Group mute configuration.

Details

Group mute configuration.

Declared in ZIMDefines.h

Properties

mode

@property ZIMGroupMuteMode mode

Group mute mode.

duration

@property int duration

Group mute duration, the unit is seconds. The value is -1, which means permanent mute. If you need to implement non-permanent mute, the upper limit is 604800 (7 days). If you need to increase it, please contact ZEGO technical support.

roles

@property NSArray<int *> *roles

Group role list.

ZIMGroupMemberMuteConfig

Group members mute configuration.

Details

Group members mute configuration.

Declared in ZIMDefines.h

Properties

duration

@property int duration

Group members mute duration, the unit is seconds. The value is -1, which means permanent mute. If you need to implement non-permanent mute, the upper limit is 604800 (7 days). If you need to increase it, please contact ZEGO technical support.

ZIMGroupMemberMutedListQueryConfig

Group muted member list query configuration.

Details

Group muted member list query configuration.

Declared in ZIMDefines.h

Properties

nextFlag

@property unsigned long long nextFlag

nextFlag.

count

@property unsigned int count

count.

ZIMGroupApplicationInfo

Group application information.

Details

Group application information class, containing details of join or invite applications.

Declared in ZIMDefines.h

Properties

type

@property ZIMGroupApplicationType type

Group application type.

state

@property ZIMGroupApplicationState state

Group application state.

groupInfo

@property ZIMGroupInfo groupInfo

Group information for applying to join the group.

applyUser

@property ZIMUserInfo applyUser

Detail description: The applicant is the applicant when applying to join, the invitee when applying to invite, and the inviter when applying by invitation.

createTime

@property long long createTime

Group application create time.

updateTime

@property long long updateTime

Group application status update time.

wording

@property NSString *wording

The wording of group application information.

operatedUser

@property ZIMGroupMemberSimpleInfo operatedUser

The operator who agrees to join the group application.

ZIMGroupJoinApplicationSendConfig

The behavior property of the send group join application setting.

Details

Configuration class for sending group join applications.

Declared in ZIMDefines.h

Properties

wording

@property NSString *wording

Postscript to the application operation.

pushConfig

@property ZIMPushConfig pushConfig

Offline push configuration.

ZIMGroupJoinApplicationAcceptConfig

The behavior property of the accept group join application setting.

Details

Configuration class for accepting group join applications.

Declared in ZIMDefines.h

Properties

pushConfig

@property ZIMPushConfig pushConfig

Offline push configuration.

ZIMGroupJoinApplicationRejectConfig

The behavior property of the reject group join application setting.

Details

Configuration class for rejecting group join applications.

Declared in ZIMDefines.h

Properties

pushConfig

@property ZIMPushConfig pushConfig

Offline push configuration.

ZIMGroupInviteApplicationSendConfig

The behavior property of the send group invite application setting.

Details

Configuration class for sending group invite applications.

Declared in ZIMDefines.h

Properties

wording

@property NSString *wording

Postscript to the application operation.

pushConfig

@property ZIMPushConfig pushConfig

Offline push configuration.

ZIMGroupInviteApplicationAcceptConfig

The behavior property of the accept group invite application setting.

Details

Configuration class for accepting group invite applications.

Declared in ZIMDefines.h

Properties

pushConfig

@property ZIMPushConfig pushConfig

Offline push configuration.

ZIMGroupInviteApplicationRejectConfig

The behavior property of the reject group invite application setting.

Details

Configuration class for rejecting group invite applications.

Declared in ZIMDefines.h

Properties

pushConfig

@property ZIMPushConfig pushConfig

Offline push configuration.

ZIMGroupApplicationListQueryConfig

Query the group application configuration.

Details

Through this configuration, you can set the total number of queries and the pagination query.

Declared in ZIMDefines.h

Properties

nextFlag

@property unsigned int nextFlag

nextFlag.

count

@property unsigned int count

count. It is advised to be no more than 30.

ZIMGroupListQueryConfig

Group list query configuration.

Details

Configuration class for querying the group list.

Declared in ZIMDefines.h

Properties

nextFlag

@property long long nextFlag

nextFlag.

userIDs

@property NSArray<NSString *> *userIDs

Specify the list of users.

ZIMCallUserInfo

Call invitation user information.

Details

Call invitation user information.

Declared in ZIMDefines.h

Properties

userID

@property NSString *userID

state

@property ZIMCallUserState state

user status.

extendedData

@property NSString *extendedData

Call the additional information in user information.

ZIMCallInviteConfig

The behavior property of the Send Call Invitation setting.

Details

The behavior property of the Send Call Invitation setting.

Declared in ZIMDefines.h

Properties

timeout

@property unsigned int timeout

The timeout setting of the call invitation, the unit is seconds. The range is [1, 600].

mode

@property ZIMCallInvitationMode mode

Call invitation mode configuration.

extendedData

@property NSString *extendedData

Extended field, through which the inviter can carry information to the invitee.

enableNotReceivedCheck

@property BOOL enableNotReceivedCheck

If the pass value is true, the system checks whether the call invitation is delivered in this call and subsequent calls.

pushConfig

@property ZIMPushConfig pushConfig

Offline push configuration.

ZIMCallingInviteConfig

Behavior property set by quit a call invitation.

Details

Behavior property set by quit a call invitation.

Declared in ZIMDefines.h

Properties

pushConfig

@property ZIMPushConfig pushConfig

Offline push configuration.

ZIMCallJoinConfig

Add the behavior attribute of the call invitation setting.<br/>.

Details

Add the behavior attribute of the call invitation setting.

Declared in ZIMDefines.h

Properties

extendedData

@property NSString *extendedData

Extended field, through which the inviter can carry information to the invitee.

ZIMCallQuitConfig

Behavior property set by quit a call invitation.

Details

Behavior property set by quit a call invitation.

Declared in ZIMDefines.h

Properties

extendedData

@property NSString *extendedData

Extended field, through which the inviter can carry information to the invitee.

pushConfig

@property ZIMPushConfig pushConfig

Offline push configuration.

ZIMCallEndConfig

End the behavior attribute of the call invitation setting.

Details

End the behavior attribute of the call invitation setting.

Declared in ZIMDefines.h

Properties

extendedData

@property NSString *extendedData

Extended field, through which the inviter can carry information to the invitee.

pushConfig

@property ZIMPushConfig pushConfig

Offline push configuration.

ZIMCallCancelConfig

Behavior property that cancels the call invitation setting.

Details

Behavior property that cancels the call invitation setting.

Declared in ZIMDefines.h

Properties

extendedData

@property NSString *extendedData

Extended field, through which the inviter can carry information to the invitee.

pushConfig

@property ZIMPushConfig pushConfig

Offline push configuration.

ZIMCallAcceptConfig

Behavior property set by accepting a call invitation.

Details

Behavior property set by accepting a call invitation.

Declared in ZIMDefines.h

Properties

extendedData

@property NSString *extendedData

Extended field, through which the inviter can carry information to the invitee.

ZIMCallRejectConfig

This parameter is used to set the configuration item of call invitation rejection.

Details

This command is used to customize the call invitation when sending invitation rejection.

Declared in ZIMDefines.h

Use cases：You need to pass the configuration item to the interface when invoking the call rejection invitation.

Properties

extendedData

@property NSString *extendedData

Additional fields for attaching custom content when sending a reject invitation.

ZIMCallInvitationSentInfo

Call invitation sent message.

Details

Call invitation sent message.

Declared in ZIMDefines.h

Properties

timeout

@property unsigned int timeout

The timeout setting of the call invitation, the unit is seconds.

errorUserList

@property NSArray<ZIMErrorUserInfo *> *errorUserList

User id that has not received a call invitation list.

ZIMCallingInvitationSentInfo

Information about callingInvite.

Details

Information about callingInvite

Declared in ZIMDefines.h

Properties

errorUserList

@property NSArray<ZIMErrorUserInfo *> *errorUserList

Error user list.

ZIMCallJoinSentInfo

Result of join the call operation.

Details

Result of join the call operation.

Declared in ZIMDefines.h

Properties

extendedData

@property NSString *extendedData

The pass-through field that comes with invoking the end of the call.

createTime

@property long long createTime

Timestamp of the time when the call invitation was created.

joinTime

@property long long joinTime

Time stamp of the person join the call invitation.

callUserList

@property NSArray<ZIMCallUserInfo *> *callUserList

List of user information in the current call invitation.

ZIMCallQuitSentInfo

Result of quit the call operation.

Details

Result of quit the call operation.

Declared in ZIMDefines.h

Properties

createTime

@property long long createTime

Timestamp of the time when the call invitation was created.

acceptTime

@property long long acceptTime

Time stamp of the person accepting the call invitation.

quitTime

@property long long quitTime

The time stamp for me to exit the call.

ZIMCallEndedSentInfo

Information about ending a call invitation.

Details

Information class for the result of ending a call invitation.

Declared in ZIMDefines.h

Properties

createTime

@property long long createTime

Call invites to create a timestamp.

acceptTime

@property long long acceptTime

Time stamp of the person accepting the call invitation.

endTime

@property long long endTime

Call invitation end time.

ZIMCallInvitationReceivedInfo

Information to accept the call invitation.

Details

Information to accept the call invitation.

Declared in ZIMDefines.h

Properties

mode

@property ZIMCallInvitationMode mode

mode of the call invitation.

timeout

@property unsigned int timeout

The timeout setting of the call invitation, the unit is seconds.

caller

@property NSString *caller

The creator of the call invitation is the same as the userID that calls callInvite.

inviter

@property NSString *inviter

Inviter ID.

createTime

@property long long createTime

The event stamp when the call invitation was created on the server, accurate to milliseconds.

callUserList

@property NSArray<ZIMCallUserInfo *> *callUserList

List of members invited to the call.

extendedData

@property NSString *extendedData

Extended field, through which the inviter can carry information to the invitee.

ZIMCallInvitationCreatedInfo

Information to created the call invitation.

Details

Information to created the call invitation.

Declared in ZIMDefines.h

Properties

mode

@property ZIMCallInvitationMode mode

mode of the call invitation.

caller

@property NSString *caller

The creator of the call invitation is the same as the userID that calls callInvite.

extendedData

@property NSString *extendedData

Extended field, through which the inviter can carry information to the invitee.

timeout

@property unsigned int timeout

The timeout setting of the call invitation, the unit is seconds.

createTime

@property long long createTime

The event stamp when the call invitation was created on the server, accurate to milliseconds.

callUserList

@property NSArray<ZIMCallUserInfo *> *callUserList

List of members invited to the call.

ZIMCallInvitationCancelledInfo

Cancel the call invitation message.

Details

Cancel the call invitation message.

Declared in ZIMDefines.h

Properties

inviter

@property NSString *inviter

The inviter ID of the call invitation.

mode

@property ZIMCallInvitationMode mode

The call invitation mode.

extendedData

@property NSString *extendedData

Extended field, through which the inviter can carry information to the invitee.

ZIMCallInvitationAcceptedInfo

Accept the call invitation message.

Details

Accept the call invitation message.

Declared in ZIMDefines.h

Properties

invitee

@property NSString *invitee

Invitee ID.

extendedData

@property NSString *extendedData

Extended field, through which the inviter can carry information to the invitee.

ZIMCallInvitationRejectedInfo

Reject the call invitation message.

Details

Reject the call invitation message.

Declared in ZIMDefines.h

Properties

invitee

@property NSString *invitee

Invitee ID.

extendedData

@property NSString *extendedData

Extended field, through which the inviter can carry information to the invitee.

ZIMCallInvitationEndedInfo

End the call operation information.

Details

End the call operation information.

Declared in ZIMDefines.h

Properties

caller

@property NSString *caller

The calling party of the current call.

operatedUserID

@property NSString *operatedUserID

End the call operator.

extendedData

@property NSString *extendedData

The pass-through field that comes with invoking the end of the call.

mode

@property ZIMCallInvitationMode mode

The mode of the call invitation.

endTime

@property long long endTime

Time stamp of the end of the call, in milliseconds. The format is UTC time stamp.

ZIMCallInvitationTimeoutInfo

Information class about timeout notifications.

Details

Information class about timeout notifications.

Declared in ZIMDefines.h

Properties

mode

@property ZIMCallInvitationMode mode

Call invitation type.

ZIMCallInvitationQueryConfig

Inquiry the setting attribute of the call invitation list.

Details

Inquiry the setting attribute of the call invitation list

Declared in ZIMDefines.h

Properties

count

@property unsigned int count

The query number is limited to up to 100.

nextFlag

@property long long nextFlag

The flag of the query list.No padding is required for the first query. After the query, callback will return a nextFlag, which can be filled in the next query to continue the query based on the last query.

ZIMCallInfo

Call invitation information.

Details

Call invitation information.

Declared in ZIMDefines.h

Properties

callID

@property NSString *callID

Call invite ID.

caller

@property NSString *caller

Call invitation initiator ID.

inviter

@property NSString *inviter

The inviter ID of the call invitation.

createTime

@property long long createTime

Call invites to create a timestamp.

endTime

@property long long endTime

Call invitation end time.

state

@property ZIMCallState state

Call invitation status.

mode

@property ZIMCallInvitationMode mode

Call invitation mode.

extendedData

@property NSString *extendedData

Create a call invitation additional information.

callUserList

@property NSArray<ZIMCallUserInfo *> *callUserList

The list of call member.

ZIMCallUserStateChangeInfo

Call member status change information.

Details

Call member status change information.

Declared in ZIMDefines.h

Properties

callUserList

@property NSArray<ZIMCallUserInfo *> *callUserList

List of call members whose status changes.

ZIMBlacklistQueryConfig

Query the blacklist configuration.

Details

Through this configuration, you can set the total number of queries and the pagination query.

Declared in ZIMDefines.h

Properties

nextFlag

@property unsigned int nextFlag

nextFlag.

count

@property unsigned int count

count.

ZIMFriendAddConfig

The behavior property of the Add Friend setting.

Details

The behavior property of the Add Friend setting.

Declared in ZIMDefines.h

Properties

friendAlias

@property NSString *friendAlias

Alias of friend.

friendAttributes

@property NSDictionary<NSString, NSString> *friendAttributes

Friend attributes. Up to 5 can be set. The key of the attribute can only be selected from k0 to k4.

wording

@property NSString *wording

Add a friend postscript.

ZIMFriendDeleteConfig

The behavior property of the Delete Friend setting.

Details

The behavior property of the Delete Friend setting.

Declared in ZIMDefines.h

Properties

type

@property ZIMFriendDeleteType type

Delete type.

ZIMFriendListQueryConfig

Query the configuration of the friend list.

Details

Query the configuration of the friend list.

Declared in ZIMDefines.h

Properties

nextFlag

@property unsigned int nextFlag

The index of the current query anchor point.

count

@property unsigned int count

Total number of current queries.

ZIMFriendSearchConfig

Friend search configuration.

Details

Configuration class for searching friends.

Declared in ZIMDefines.h

Properties

nextFlag

@property unsigned int nextFlag

nextFlag.

count

@property unsigned int count

count.

keywords

@property NSArray<NSString *> *keywords

isAlsoMatchFriendAlias

@property BOOL isAlsoMatchFriendAlias

Whether to match friend aliases.

ZIMFriendRelationCheckConfig

Check the behavior properties of friend relationships.

Details

Check the behavior properties of friend relationships.

Declared in ZIMDefines.h

Properties

type

@property ZIMFriendRelationCheckType type

Check type.

ZIMFriendRelationInfo

Friend relationship information.

Details

Detailed description: Friend relationship information.

Declared in ZIMDefines.h

Properties

type

@property ZIMUserRelationType type

Friend relationship type.

userID

@property NSString *userID

user ID.

ZIMFriendInfo

Friend information.

Details

Detailed description: Friend information.

Declared in ZIMDefines.h

Properties

friendAlias

@property NSString *friendAlias

The alias of friend.

friendAttributes

@property NSDictionary<NSString, NSString> *friendAttributes

Friend attributes. Up to 5 can be set. The key of the attribute can only be selected from k0 to k4.

createTime

@property long long createTime

Friend add time.

wording

@property NSString *wording

Add a friend postscript.

ZIMFriendApplicationSendConfig

The behavior property of the Send Friend Application setting.

Details

The behavior property of the Send Friend Application setting.

Declared in ZIMDefines.h

Properties

wording

@property NSString *wording

Add a friend postscript.

friendAlias

@property NSString *friendAlias

Alias of friend.

friendAttributes

@property NSDictionary<NSString, NSString> *friendAttributes

Friend attributes. Up to 5 can be set. The key of the attribute can only be selected from k0 to k4.

pushConfig

@property ZIMPushConfig pushConfig

Offline push configuration.

ZIMFriendApplicationAcceptConfig

Behavior attributes for accepting friend requests.

Details

Behavior attributes for accepting friend requests.

Declared in ZIMDefines.h

Properties

friendAlias

@property NSString *friendAlias

friend alias.

friendAttributes

@property NSDictionary<NSString, NSString> *friendAttributes

friend attributes.

pushConfig

@property ZIMPushConfig pushConfig

Offline push configuration.

ZIMFriendApplicationRejectConfig

Behavior attributes for rejecting friend application.

Details

Behavior attributes for rejecting friend application.

Declared in ZIMDefines.h

Properties

pushConfig

@property ZIMPushConfig pushConfig

Offline push configuration.

ZIMFriendApplicationListQueryConfig

Query the configuration of the friend application list.

Details

Query the configuration of the friend application list.

Declared in ZIMDefines.h

Properties

nextFlag

@property unsigned int nextFlag

The index of the current query anchor point.

count

@property unsigned int count

Total number of current queries.

ZIMFriendApplicationInfo

Friend application information.

Details

Detailed description: Friend application information.

Declared in ZIMDefines.h

Properties

type

@property ZIMFriendApplicationType type

Friend application type.

state

@property ZIMFriendApplicationState state

Friend application state.

applyUser

@property ZIMUserInfo applyUser

Detail description: If you are the applicant, here is the respondent information; if you are the respondent, here is the applicant information;.

wording

@property NSString *wording

The wording of friend application information.

createTime

@property long long createTime

Friend add time.

updateTime

@property long long updateTime

Friend application status update time.

ZIMCommunityInfo

Basic community information.

Details

Community basic information class.

Declared in ZIMDefines.h

Properties

communityID

@property NSString *communityID

The community ID.

communityName

@property NSString *communityName

The community name.

communityAvatarUrl

@property NSString *communityAvatarUrl

The URL of the community avatar.

ZIMCommunity

Community object.

Details

Community information class, containing basic attributes of a community.

Declared in ZIMDefines.h

Properties

baseInfo

@property ZIMCommunityInfo baseInfo

The basic information of the community.

totalUnreadMessageCount

@property unsigned int totalUnreadMessageCount

The total unread message count across all channels.

ZIMCommunityFullInfo

Full community information.

Details

Community full information class, containing all attributes of a community.

Declared in ZIMDefines.h

Properties

baseInfo

@property ZIMCommunityInfo baseInfo

The basic information of the community.

communityNotice

@property NSString *communityNotice

The community notice.

communityAttributes

@property NSDictionary<NSString, NSString> *communityAttributes

The community attributes.

createTime

@property long long createTime

The time when the community was created.

creatorUserID

@property NSString *creatorUserID

The user ID of the community creator.

currentMemberCount

@property unsigned int currentMemberCount

The current number of community members.

notificationStatus

@property ZIMCommunityMessageNotificationStatus notificationStatus

The notification status of the community.

ZIMCommunityCreateConfig

Configuration for creating a community.

Details

Configuration class for creating a community.

Declared in ZIMDefines.h

Properties

communityNotice

@property NSString *communityNotice

The community notice to set when creating the community.

communityAttributes

@property NSDictionary<NSString, NSString> *communityAttributes

The community attributes to set when creating the community.

ZIMCommunityListQueryConfig

Configuration for querying the community list.

Details

Configuration class for querying the community list.

Declared in ZIMDefines.h

Properties

nextFlag

@property long long nextFlag

The pagination flag for querying the next page.

ZIMCommunityChangeInfo

Community change information

Details

Community change information class, describing changes to community attributes.

Declared in ZIMDefines.h

Properties

action

@property ZIMCommunityListChangeAction action

Conmmunity change event

community

@property ZIMCommunity community

Changed community

ZIMCommunityMemberListQueryConfig

Community member list query configuration

Details

Configuration class for querying the community member list.

Declared in ZIMDefines.h

Properties

nextFlag

@property long long nextFlag

The pagination flag for querying the next page.

channelID

@property NSString *channelID

The channel ID to query members from.

isMutedMember

@property BOOL isMutedMember

Whether to query only muted members.

ZIMCommunityFullInfoUpdateInfo

Community full info update information

Details

Community full information update notification class.

Declared in ZIMDefines.h

Properties

communityInfo

@property ZIMCommunityFullInfo communityInfo

Changed community full info

ZIMCommunityMemberEnterInfo

Community member enter information

Details

Information class for a member entering a community.

Declared in ZIMDefines.h

Properties

enterTime

@property long long enterTime

The time when the member entered the community.

enterType

@property ZIMCommunityMemberEnterType enterType

The type of how the member entered the community.

operatedUserID

@property NSString *operatedUserID

The user ID of the operator (e.g., the inviter).

ZIMCommunityMemberMuteInfo

Community member mute info

Details

Community member mute status information class.

Declared in ZIMDefines.h

Properties

muteType

@property ZIMCommunityMemberMuteType muteType

The mute type indicating which level the member is muted at.

channelID

@property NSString *channelID

The channel ID of the mute. Empty means muted at the community level.

muteExpiredTime

@property long long muteExpiredTime

The expiration time of the member's mute.

ZIMCommunityMemberInfo

Community member information

Details

Community member information class.

Declared in ZIMDefines.h

Properties

memberRole

@property ZIMCommunityMemberRole memberRole

The role of the community member.

enterInfo

@property ZIMCommunityMemberEnterInfo enterInfo

The information about how the member entered the community.

muteInfo

@property ZIMCommunityMemberMuteInfo muteInfo

The mute information of the community member.

ZIMCommunityMemberSimpleInfo

Community member simple information

Details

Simple community member information class.

Declared in ZIMDefines.h

Properties

memberRole

@property ZIMCommunityMemberRole memberRole

The role of the community member.

ZIMCommunityMemberStateChangeInfo

Community member state info change information

Details

Community member state change information class.

Declared in ZIMDefines.h

Properties

state

@property ZIMCommunityMemberChangeState state

The current state of the community member.

action

@property ZIMCommunityMemberChangeAction action

The action type of the member state change.

memberInfo

@property ZIMCommunityMemberSimpleInfo memberInfo

Changed community member simple info

ZIMCommunityMemberInfoUpdateInfo

Community member full info update information

Details

Community member information update notification class.

Declared in ZIMDefines.h

Properties

memberInfo

@property ZIMCommunityMemberInfo memberInfo

Changed community member info

ZIMCommunityChannelInfo

Basic community channel information.

Details

Community channel basic information class.

Declared in ZIMDefines.h

Properties

channelID

@property NSString *channelID

The channel ID.

channelType

@property ZIMCommunityChannelType channelType

The type of the community channel.

channelName

@property NSString *channelName

The channel name.

channelAvatarUrl

@property NSString *channelAvatarUrl

The URL of the channel avatar.

communityID

@property NSString *communityID

The ID of the community that the channel belongs to.

ZIMCommunityChannelMuteInfo

Community channel mute info

Details

Community channel mute status information class.

Declared in ZIMDefines.h

Properties

mode

@property ZIMCommunityChannelMuteMode mode

The mute mode of the community channel.

expiredTime

@property long long expiredTime

The expiration time of the channel mute.

roles

@property NSArray<int *> *roles

The muted roles in the community channel.

ZIMCommunityChannel

Community channel object.

Details

Community channel information class, containing basic attributes of a channel.

Declared in ZIMDefines.h

Properties

baseInfo

@property ZIMCommunityChannelInfo baseInfo

The basic information of the community channel.

conversationID

@property NSString *conversationID

The conversation ID of the community channel.

channelAttributes

@property NSDictionary<NSString, NSString> *channelAttributes

The community channel attributes.

notificationStatus

@property ZIMConversationNotificationStatus notificationStatus

The notification status of the community channel.

unreadMessageCount

@property unsigned int unreadMessageCount

The number of unread messages in the community channel.

lastMessage

@property ZIMMessage lastMessage

The last message in the community channel.

mentionedInfoList

@property NSArray<ZIMMessageMentionedInfo *> *mentionedInfoList

The list of mention information in the community channel.

selfMutedExpiredTime

@property long long selfMutedExpiredTime

The expiration time of the local user's mute in the channel.

draft

@property NSString *draft

The draft message of the community channel.

ZIMCommunityChannelFullInfo

Full community channel information.

Details

Community channel full information class, containing all attributes of a channel.

Declared in ZIMDefines.h

Properties

baseInfo

@property ZIMCommunityChannelInfo baseInfo

The basic information of the community channel.

createTime

@property long long createTime

The time when the channel was created.

creatorUserID

@property NSString *creatorUserID

The user ID of the channel creator.

channelNotice

@property NSString *channelNotice

The community channel notice.

channelAttributes

@property NSDictionary<NSString, NSString> *channelAttributes

The community channel attributes.

currentMemberCount

@property unsigned int currentMemberCount

The current number of channel members.

muteInfo

@property ZIMCommunityChannelMuteInfo muteInfo

The mute information of the community channel.

ZIMCommunityChannelCreateConfig

Configuration for creating a community channel.

Details

Configuration class for creating a community channel.

Declared in ZIMDefines.h

Properties

channelNotice

@property NSString *channelNotice

The channel notice to set when creating the channel.

channelAttributes

@property NSDictionary<NSString, NSString> *channelAttributes

The channel attributes to set when creating the channel.

ZIMCommunityChannelListQueryConfig

Configuration for querying the community channel list.

Details

Configuration class for querying the community channel list.

Declared in ZIMDefines.h

Properties

nextFlag

@property long long nextFlag

The pagination flag for querying the next page.

ZIMCommunityChannelChangeInfo

Community channel change information.

Details

Community channel change information class, describing changes to channel attributes.

Declared in ZIMDefines.h

Properties

action

@property ZIMCommunityChannelListChangeAction action

The action type of the channel list change.

channel

@property ZIMCommunityChannel channel

The changed community channel information.

ZIMCommunityChannelFullInfoUpdateInfo

Community channel full info update information

Details

Community channel full information update notification class.

Declared in ZIMDefines.h

Properties

channelInfo

@property ZIMCommunityChannelFullInfo channelInfo

Changed community channel full info

ZIMCommunityChannelMuteConfig

Community channel mute configuration

Details

Configuration class for muting a community channel.

Declared in ZIMDefines.h

Properties

mode

@property ZIMCommunityChannelMuteMode mode

The mute mode for the community channel.

roles

@property NSArray<int *> *roles

The roles to mute. Empty means muting all roles.

duration

@property int duration

The mute duration in seconds. 0 means unmute.

ZIMCommunityMemberMuteConfig

Community channel mute configuration

Details

Configuration class for muting community members.

Declared in ZIMDefines.h

Properties

duration

@property int duration

The mute duration in seconds. 0 means unmute.

channelID

@property NSString *channelID

The channel ID. Leave empty to mute at the community level.

ZIMMessageReactionsChangedEventResult

The callback of the reactions change.

Declared in ZIMDefines.h

Properties

reactions

@property NSArray<ZIMMessageReaction *> *reactions

Message reaction change info list

changeInfoList

@property NSArray<ZIMMessageReactionChangeInfo *> *changeInfoList

Message reaction change info list

ZIMMessageReceivedEventResult

Triggered when messages are received.

Declared in ZIMDefines.h

Properties

messageList

@property NSArray<ZIMMessage *> *messageList

message list

receivedInfo

@property ZIMMessageReceivedInfo receivedInfo

Message received info

ZIMCommunityListChangedEventResult

Triggered when the community list changes.

Declared in ZIMDefines.h

Properties

changeInfoList

@property NSArray<ZIMCommunityChangeInfo *> *changeInfoList

List of community change information.

ZIMCommunityInfoUpdatedEventResult

Triggered when community information is updated.

Declared in ZIMDefines.h

Properties

updateInfoList

@property NSArray<ZIMCommunityFullInfoUpdateInfo *> *updateInfoList

List of community information updates.

ZIMCommunityMemberStateChangedEventResult

Triggered when a community member's state changes.

Declared in ZIMDefines.h

Properties

communityID

@property NSString *communityID

Community ID.

changeInfoList

@property NSArray<ZIMCommunityMemberStateChangeInfo *> *changeInfoList

List of community member state changes.

ZIMCommunityMemberInfoUpdatedEventResult

Triggered when community member information is updated.

Declared in ZIMDefines.h

Properties

communityID

@property NSString *communityID

Community ID.

updateInfoList

@property NSArray<ZIMCommunityMemberInfoUpdateInfo *> *updateInfoList

List of community member information updates.

ZIMCommunityChannelListChangedEventResult

Triggered when the community channel list changes.

Declared in ZIMDefines.h

Properties

communityID

@property NSString *communityID

Community ID.

changeInfoList

@property NSArray<ZIMCommunityChannelChangeInfo *> *changeInfoList

List of community channel changes.

ZIMCommunityChannelInfoUpdatedEventResult

Triggered when community channel information is updated.

Declared in ZIMDefines.h

Properties

communityID

@property NSString *communityID

Community ID.

updateInfoList

@property NSArray<ZIMCommunityChannelFullInfoUpdateInfo *> *updateInfoList

List of community channel information updates.

ZIMLogUploadedCallback

Methods

onLogUploaded

void(^ZIMLogUploadedCallback)((ZIMError) errorInfo);

Callback of the log upload result.

Parameters

Name	Type	Description
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMLoggedInCallback)((ZIMError) errorInfo);

Callback of the login result.

Parameters

Name	Type	Description
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMTokenRenewedCallback)((NSString *) token, (ZIMError) errorInfo);

Callback of the result of renewing the token.

Parameters

Name	Type	Description
token	NSString *	The renewed token.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMExperimentalAPICalledCallback)((NSString *) result, (ZIMError) errorInfo);

The result of called the experimental API.

Parameters

Name	Type	Description
result	NSString *	The result returned by calling the experimental API in JSON string format. For details, please consult ZEGO technical support.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMUserNameUpdatedCallback)((NSString *) userName, (ZIMError) errorInfo);

Update the user name callback.

Parameters

Name	Type	Description
userName	NSString *	The updated user name.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMUserAvatarUrlUpdatedCallback)((NSString *) userAvatarUrl, (ZIMError) errorInfo);

Callback for updating the user avatar URL.

Parameters

Name	Type	Description
userAvatarUrl	NSString *	The updated user avatar URL.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMUserExtendedDataUpdatedCallback)((NSString *) extendedData, (ZIMError) errorInfo);

Update the user extended data callback.

Parameters

Name	Type	Description
extendedData	NSString *	The updated user extended data.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMUserCustomStatusUpdatedCallback)((NSString *) customStatus, (ZIMError) errorInfo);

The callback of the custom status update.

Parameters

Name	Type	Description
customStatus	NSString *	The updated user custom status.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMUserBadgeUpdatedCallback)((ZIMError) errorInfo);

Update the user badge callback.

Parameters

Name	Type	Description
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMUsersInfoQueriedCallback)((NSArray<ZIMUserFullInfo *> *) userList, (NSArray<ZIMErrorUserInfo *> *) errorUserList, (ZIMError) errorInfo);

Query the userInfo callback.

Parameters

Name	Type	Description
userList	NSArray<ZIMUserFullInfo >	The queried user information list.
errorUserList	NSArray<ZIMErrorUserInfo >	The list of user IDs that failed to be queried.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMUserOfflinePushRuleUpdatedCallback)((ZIMUserOfflinePushRule) offlinePushRule, (ZIMError) errorInfo);

Update the result callback of the user offline push rule.

Parameters

Name	Type	Description
offlinePushRule	ZIMUserOfflinePushRule	The updated user offline push rule.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMSelfUserInfoQueriedCallback)((ZIMSelfUserInfo) selfUserInfo, (ZIMError) errorInfo);

Callback result of querying personal user information and rules.

Parameters

Name	Type	Description
selfUserInfo	ZIMSelfUserInfo	The current user information and rules.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMUsersStatusQueriedCallback)((NSArray<ZIMUserStatus *> *) userStatusList, (NSArray<ZIMErrorUserInfo *> *) errorUserList, (ZIMError) errorInfo);

Result callback of the queryUsersStatus interface for batch querying user online status.

Parameters

Name	Type	Description
userStatusList	NSArray<ZIMUserStatus >	The queried user status list.
errorUserList	NSArray<ZIMErrorUserInfo >	The list of user IDs that failed to be queried.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMUsersStatusSubscribedCallback)((NSArray<ZIMErrorUserInfo *> *) errorUserList, (ZIMError) errorInfo);

Callback for the operation results of the batch subscription interface.

Parameters

Name	Type	Description
errorUserList	NSArray<ZIMErrorUserInfo >	The list of user IDs that failed to subscribe.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMUsersStatusUnsubscribedCallback)((NSArray<ZIMErrorUserInfo *> *) errorUserList, (ZIMError) errorInfo);

Callback for canceling the operations of subscribing interfaces in a batch.

Parameters

Name	Type	Description
errorUserList	NSArray<ZIMErrorUserInfo >	The list of user IDs that failed to unsubscribe.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMSubscribedUserStatusListQueriedCallback)((NSArray<ZIMUserStatusSubscription *> *) userStatusSubscriptionList, (ZIMError) errorInfo);

Query for the current user subscription list operation results callback.

Parameters

Name	Type	Description
userStatusSubscriptionList	NSArray<ZIMUserStatusSubscription >	The user status subscription list.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMConversationQueriedCallback)((ZIMConversation) conversation, (ZIMError) errorInfo);

Conversation query callback.

Parameters

Name	Type	Description
conversation	ZIMConversation	The queried conversation object.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMConversationListQueriedCallback)((NSArray<ZIMConversation *> *) conversationList, (ZIMError) errorInfo);

Session list query callback.

Parameters

Name	Type	Description
conversationList	NSArray<ZIMConversation >	The queried conversation list.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMConversationTotalUnreadMessageCountQueriedCallback)((unsigned int) unreadMessageCount, (ZIMError) errorInfo);

Query conversation unread total count callback.

Parameters

Name	Type	Description
unreadMessageCount	unsigned int	The total count of unread messages across all conversations.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMConversationDeletedCallback)((NSString *) conversationID, (ZIMConversationType) conversationType, (ZIMError) errorInfo);

Callback for conversation deletion.

Parameters

Name	Type	Description
conversationID	NSString *	The ID of the deleted conversation.
conversationType	ZIMConversationType	The type of the deleted conversation.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMConversationsAllDeletedCallback)((ZIMError) errorInfo);

Callback for conversations deletion.

Parameters

Name	Type	Description
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMConversationUnreadMessageCountClearedCallback)((NSString *) conversationID, (ZIMConversationType) conversationType, (ZIMError) errorInfo);

Callback for session unread clearing.

Parameters

Name	Type	Description
conversationID	NSString *	The conversation ID whose unread message count was cleared.
conversationType	ZIMConversationType	The conversation type whose unread message count was cleared.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMConversationTotalUnreadMessageCountClearedCallback)((ZIMError) errorInfo);

Callback for sessions unread clearing.

Parameters

Name	Type	Description
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMConversationNotificationStatusSetCallback)((NSString *) conversationID, (ZIMConversationType) conversationType, (ZIMError) errorInfo);

Callback for conversation notification state settings.

Parameters

Name	Type	Description
conversationID	NSString *	The conversation ID for which the notification status was set.
conversationType	ZIMConversationType	The conversation type for which the notification status was set.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMConversationMessageReceiptReadSentCallback)((NSString *) conversationID, (ZIMConversationType) conversationType, (ZIMError) errorInfo);

Callback interface for setting the read receipt conversation.

Parameters

Name	Type	Description
conversationID	NSString *	The conversation ID for which the receipt was sent.
conversationType	ZIMConversationType	The conversation type for which the receipt was sent.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMConversationPinnedStateUpdatedCallback)((NSString *) conversationID, (ZIMConversationType) conversationType, (ZIMError) errorInfo);

Callback for conversation pinned state updated.

Parameters

Name	Type	Description
conversationID	NSString *	The conversation ID whose pinned state was updated.
conversationType	ZIMConversationType	The conversation type whose pinned state was updated.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMConversationPinnedListQueriedCallback)((NSArray<ZIMConversation *> *) conversationList, (ZIMError) errorInfo);

Callback for querying the pinned conversation list.

Parameters

Name	Type	Description
conversationList	NSArray<ZIMConversation >	The queried pinned conversation list.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMConversationDraftSetCallback)((NSString *) conversationID, (ZIMConversationType) conversationType, (ZIMError) errorInfo);

Sets the callback for the session draft.

Parameters

Name	Type	Description
conversationID	NSString *	The conversation ID for which the draft was set.
conversationType	ZIMConversationType	The conversation type for which the draft was set.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMConversationMarkSetCallback)((NSArray<ZIMConversationBaseInfo *> *) failedConversationInfos, (ZIMError) errorInfo);

Callback for conversation mark set.

Parameters

Name	Type	Description
failedConversationInfos	NSArray<ZIMConversationBaseInfo >	The list of conversation info objects that failed to have marks set.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMConversationMessageDestructDurationSetCallback)((NSString *) conversationID, (ZIMConversationType) conversationType, (ZIMError) errorInfo);

Callback for the result of setting the message self-destruction duration in a conversation.

Parameters

Name	Type	Description
conversationID	NSString *	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	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMConversationsSearchedCallback)((NSArray<ZIMConversationSearchInfo *> *) conversationSearchInfoList, (unsigned int) nextFlag, (ZIMError) errorInfo);

Search for the return of local conversations results based on local messages.

Parameters

Name	Type	Description
conversationSearchInfoList	NSArray<ZIMConversationSearchInfo >	The list of searched conversation results.
nextFlag	unsigned int	Anchor for the next page query.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMMessageSentCallback)((ZIMMessage) message, (ZIMError) errorInfo);

Callback of the result of sending the message.

Parameters

Name	Type	Description
message	ZIMMessage	Message object.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMMessageQueriedCallback)((NSString *) conversationID, (ZIMConversationType) conversationType, (NSArray<ZIMMessage *> *) messageList, (ZIMError) errorInfo);

The developer uses this callback to get a list of queried messages, which can be used to display historical messages.

Parameters

Name	Type	Description
conversationID	NSString *	Conversation ID.
conversationType	ZIMConversationType	Conversation type.
messageList	NSArray<ZIMMessage >	Message list.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMMessageDeletedCallback)((NSString *) conversationID, (ZIMConversationType) conversationType, (ZIMError) errorInfo);

A callback to delete a message.

Parameters

Name	Type	Description
conversationID	NSString *	Conversation ID.
conversationType	ZIMConversationType	Conversation type.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMConversationMessagesAllDeletedCallback)((ZIMError) errorInfo);

Deletes callbacks of all messages for all sessions.

Parameters

Name	Type	Description
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMMessageRevokedCallback)((ZIMMessage) message, (ZIMError) errorInfo);

Retracted news consequential reconciliation.

Parameters

Name	Type	Description
message	ZIMMessage	Message object.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMMessageInsertedCallback)((ZIMMessage) message, (ZIMError) errorInfo);

Callback of the result of inserting the message.

Parameters

Name	Type	Description
message	ZIMMessage	Message object.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMMessageLocalExtendedDataUpdatedCallback)((ZIMMessage) message, (ZIMError) errorInfo);

Callback for updating message local extension fields.

Parameters

Name	Type	Description
message	ZIMMessage	Message object.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMMessageReceiptsReadSentCallback)((NSString *) conversationID, (ZIMConversationType) conversationType, (NSArray<long long *> *) errorMessageIDs, (ZIMError) errorInfo);

Callback interface for setting the read receipt message.

Parameters

Name	Type	Description
conversationID	NSString *	Conversation ID.
conversationType	ZIMConversationType	Conversation type.
errorMessageIDs	NSArray<long long >	Error message ID list.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMMessageReceiptsInfoQueriedCallback)((NSArray<ZIMMessageReceiptInfo *> *) infos, (NSArray<NSString *> *) errorMessageIDs, (ZIMError) errorInfo);

Callback interface for query receipt message read.

Parameters

Name	Type	Description
infos	NSArray<ZIMMessageReceiptInfo >	Message receipt information list.
errorMessageIDs	NSArray<NSString >	Error message ID list.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMMediaDownloadedCallback)((ZIMMessage) message, (ZIMError) errorInfo);

The result callback of the download completion of the media message.

Parameters

Name	Type	Description
message	ZIMMessage	Message object.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMMediaDownloadingProgress)((ZIMMessage) message, (unsigned long long) currentFileSize, (unsigned long long) totalFileSize);

Progress callback for downloading media messages.

Parameters

Name	Type	Description
message	ZIMMessage	Message object.
currentFileSize	unsigned long long	Current file size.
totalFileSize	unsigned long long	Total file size.

ZIMMessagesSearchedCallback

Methods

onMessagesSearched

void(^ZIMMessagesSearchedCallback)((NSString *) conversationID, (ZIMConversationType) conversationType, (NSArray<ZIMMessage *> *) messageList, (ZIMMessage) nextMessage, (ZIMError) errorInfo);

Return of local message search results.

Parameters

Name	Type	Description
conversationID	NSString *	Conversation ID.
conversationType	ZIMConversationType	Conversation type.
messageList	NSArray<ZIMMessage >	Message list.
nextMessage	ZIMMessage	Next message object.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMMessagesGlobalSearchedCallback)((NSArray<ZIMMessage *> *) messageList, (ZIMMessage) nextMessage, (ZIMError) errorInfo);

Return of local message search results.

Parameters

Name	Type	Description
messageList	NSArray<ZIMMessage >	Message list.
nextMessage	ZIMMessage	Next message object.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMMessageReactionAddedCallback)((ZIMMessageReaction) reaction, (ZIMError) errorInfo);

The addition of return for message reactions.

Parameters

Name	Type	Description
reaction	ZIMMessageReaction	Message reaction object.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMMessageReactionDeletedCallback)((ZIMMessageReaction) reaction, (ZIMError) errorInfo);

The delete of return for message reactions.

Parameters

Name	Type	Description
reaction	ZIMMessageReaction	Message reaction object.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMMessageReactionsAllDeletedCallback)((ZIMError) errorInfo);

The delete of return for message reactions.

Parameters

Name	Type	Description
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMMessageReactionUserListQueriedCallback)((ZIMMessage) message, (NSArray<ZIMMessageReactionUserFullInfo *> *) userInfoList, (NSString *) reactionType, (long long) nextFlag, (unsigned int) totalCount, (ZIMError) errorInfo);

The return of the query for the details of the reaction.

Parameters

Name	Type	Description
message	ZIMMessage	Message object.
userInfoList	NSArray<ZIMMessageReactionUserFullInfo >	List of user reaction information.
reactionType	NSString *	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	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMCombineMessageDetailQueriedCallback)((ZIMCombineMessage) message, (ZIMError) errorInfo);

Result callback for querying merge message details.

Parameters

Name	Type	Description
message	ZIMCombineMessage	Combine message object. The messageList in this object already contains the sub-message list of the merged message.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMMessageRepliedListQueriedCallback)((NSArray<ZIMMessage *> *) messageList, (long long) nextFlag, (ZIMMessageRootRepliedInfo) rootRepliedInfo, (ZIMError) errorInfo);

The callback for querying the reply message list result.

Parameters

Name	Type	Description
messageList	NSArray<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	ZIMMessageRootRepliedInfo	Root message reply information.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMMessageEditedCallback)((ZIMMessage) message, (ZIMError) errorInfo);

Callback of the result of editing the message.

Parameters

Name	Type	Description
message	ZIMMessage	Message object.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMSendingMessageCancelledCallback)((ZIMError) errorInfo);

Callback of the result of cancel sending the message.

Parameters

Name	Type	Description
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMMessagePinnedCallback)((ZIMError) errorInfo);

Callback of the result of the message to be pinned or unpinned.

Parameters

Name	Type	Description
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMPinnedMessageListQueriedCallback)((NSArray<ZIMMessage *> *) messageList, (ZIMError) errorInfo);

The developer uses this callback to get a list of queried pinned messages, which can be used to display pinned messages.

Parameters

Name	Type	Description
messageList	NSArray<ZIMMessage >	Message list.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMMessageExportingProgress)((unsigned long long) exportedMessageCount, (unsigned long long) totalMessageCount);

Progress callback of the exported message.

Parameters

Name	Type	Description
exportedMessageCount	unsigned long long	The number of exported messages.
totalMessageCount	unsigned long long	The total number of messages.

ZIMFileCacheQueriedCallback

Methods

onFileCacheQueried

void(^ZIMFileCacheQueriedCallback)((ZIMFileCacheInfo) fileCacheInfo, (ZIMError) errorInfo);

Callback for querying the results of the local cache.

Parameters

Name	Type	Description
fileCacheInfo	ZIMFileCacheInfo	File cache information.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMFileCacheClearedCallback)((ZIMError) errorInfo);

Clears the callback of the local cache result.

Parameters

Name	Type	Description
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMRoomCreatedCallback)((ZIMRoomFullInfo) roomInfo, (ZIMError) errorInfo);

Callback of the result of creating the room.

Parameters

Name	Type	Description
roomInfo	ZIMRoomFullInfo	Room information.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMRoomJoinedCallback)((ZIMRoomFullInfo) roomInfo, (ZIMError) errorInfo);

Callback of the result of joining the room.

Parameters

Name	Type	Description
roomInfo	ZIMRoomFullInfo	Room information.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMRoomEnteredCallback)((ZIMRoomFullInfo) roomInfo, (ZIMError) errorInfo);

Callback of the result of entering the room.

Parameters

Name	Type	Description
roomInfo	ZIMRoomFullInfo	Room information.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMRoomSwitchedCallback)((ZIMRoomFullInfo) roomInfo, (ZIMError) errorInfo);

Callback of the result of switched rooms.

Parameters

Name	Type	Description
roomInfo	ZIMRoomFullInfo	Room information.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMRoomLeftCallback)((NSString *) roomID, (ZIMError) errorInfo);

Callback of the result of leaving the room.

Parameters

Name	Type	Description
roomID	NSString *	Room ID.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMRoomAllLeftCallback)((NSArray<NSString *> *) roomIDs, (ZIMError) errorInfo);

Callback for the results of leaving all rooms.

Parameters

Name	Type	Description
roomIDs	NSArray<NSString >	Room ID list.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMRoomMemberQueriedCallback)((NSString *) roomID, (NSArray<ZIMUserInfo *> *) memberList, (NSString *) nextFlag, (ZIMError) errorInfo);

Callback of the result of querying the room members list.

Parameters

Name	Type	Description
roomID	NSString *	Room ID.
memberList	NSArray<ZIMUserInfo >	Room member list.
nextFlag	NSString *	Used to query the next page. The current value returns an empty string, which means that the list has been pulled out.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMRoomMembersQueriedCallback)((NSString *) roomID, (NSArray<ZIMRoomMemberInfo *> *) memberList, (NSArray<ZIMErrorUserInfo *> *) errorUserList, (ZIMError) errorInfo);

Callback for the result of querying the specified member of the room.

Parameters

Name	Type	Description
roomID	NSString *	Room ID.
memberList	NSArray<ZIMRoomMemberInfo >	Room member list.
errorUserList	NSArray<ZIMErrorUserInfo >	Error member list.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMRoomOnlineMemberCountQueriedCallback)((NSString *) roomID, (unsigned int) count, (ZIMError) errorInfo);

Callback of the result of querying the online members count in the room.

Parameters

Name	Type	Description
roomID	NSString *	Room ID.
count	unsigned int	Online member count.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMRoomAttributesOperatedCallback)((NSString *) roomID, (NSArray<NSString *> *) errorKeys, (ZIMError) errorInfo);

The return of the operation result of the room attribute.

Parameters

Name	Type	Description
roomID	NSString *	Room ID.
errorKeys	NSArray<NSString >	Error key list.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMRoomAttributesBatchOperatedCallback)((NSString *) roomID, (ZIMError) errorInfo);

The return of the result of the room attribute combination operation.

Parameters

Name	Type	Description
roomID	NSString *	Room ID.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMRoomAttributesQueriedCallback)((NSString *) roomID, (NSDictionary<NSString, NSString> *) roomAttributes, (ZIMError) errorInfo);

Return of room attribute query results.

Parameters

Name	Type	Description
roomID	NSString *	Room ID.
roomAttributes	NSDictionary<NSString, NSString> *	Room attributes.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMRoomMembersAttributesOperatedCallback)((NSString *) roomID, (NSArray<ZIMRoomMemberAttributesOperatedInfo *> *) infos, (NSArray<NSString *> *) errorUserList, (ZIMError) errorInfo);

Callback of the result of setting room member attributes.

Parameters

Name	Type	Description
roomID	NSString *	Room ID.
infos	NSArray<ZIMRoomMemberAttributesOperatedInfo >	Room member attribute operation information list.
errorUserList	NSArray<NSString >	Error member list.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMRoomMembersAttributesQueriedCallback)((NSString *) roomID, (NSArray<ZIMRoomMemberAttributesInfo *> *) infos, (ZIMError) errorInfo);

Returns the results of batch query of room user attributes.

Parameters

Name	Type	Description
roomID	NSString *	Room ID.
infos	NSArray<ZIMRoomMemberAttributesInfo >	Room member attribute information list.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMRoomMemberAttributesListQueriedCallback)((NSString *) roomID, (NSArray<ZIMRoomMemberAttributesInfo *> *) infos, (NSString *) nextFlag, (ZIMError) errorInfo);

Returns the query result of the user attribute list in the room.

Parameters

Name	Type	Description
roomID	NSString *	Room ID.
infos	NSArray<ZIMRoomMemberAttributesInfo >	Room member attribute information list.
nextFlag	NSString *	Used to query the next page. The current value returns 0, which means that the list has been pulled out.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMGroupCreatedCallback)((ZIMGroupFullInfo) groupInfo, (NSArray<ZIMGroupMemberInfo *> *) userList, (NSArray<ZIMErrorUserInfo *> *) errorUserList, (ZIMError) errorInfo);

Returns the result of creating a group.

Parameters

Name	Type	Description
groupInfo	ZIMGroupFullInfo	Group information.
userList	NSArray<ZIMGroupMemberInfo >	Group member information list.
errorUserList	NSArray<ZIMErrorUserInfo >	Error member list.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMGroupDismissedCallback)((NSString *) groupID, (ZIMError) errorInfo);

Returns the result of dismissing the group.

Parameters

Name	Type	Description
groupID	NSString *	Group ID.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMGroupJoinedCallback)((ZIMGroupFullInfo) groupInfo, (ZIMError) errorInfo);

Returns the result of joining the group.

Parameters

Name	Type	Description
groupInfo	ZIMGroupFullInfo	Group information.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMGroupLeftCallback)((NSString *) groupID, (ZIMError) errorInfo);

Return of the result of leaving the group.

Parameters

Name	Type	Description
groupID	NSString *	Group ID.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMGroupUsersInvitedCallback)((NSString *) groupID, (NSArray<ZIMGroupMemberInfo *> *) userList, (NSArray<ZIMErrorUserInfo *> *) errorUserList, (ZIMError) errorInfo);

The result of the user being invited to the group is returned.

Parameters

Name	Type	Description
groupID	NSString *	Group ID.
userList	NSArray<ZIMGroupMemberInfo >	Group member information list.
errorUserList	NSArray<ZIMErrorUserInfo >	Error member list.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMGroupMemberKickedCallback)((NSString *) groupID, (NSArray<NSString *> *) kickedUserIDList, (NSArray<ZIMErrorUserInfo *> *) errorUserList, (ZIMError) errorInfo);

Returns the result of kicking out a group member.

Parameters

Name	Type	Description
groupID	NSString *	Group ID.
kickedUserIDList	NSArray<NSString >	List of user IDs kicked out.
errorUserList	NSArray<ZIMErrorUserInfo >	Error member list.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMGroupOwnerTransferredCallback)((NSString *) groupID, (NSString *) toUserID, (ZIMError) errorInfo);

Returns the result of the group owner assignment.

Parameters

Name	Type	Description
groupID	NSString *	Group ID.
toUserID	NSString *	New group owner user ID.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMGroupNameUpdatedCallback)((NSString *) groupID, (NSString *) groupName, (ZIMError) errorInfo);

Returns the result of the group name update.

Parameters

Name	Type	Description
groupID	NSString *	Group ID.
groupName	NSString *	Group name.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMGroupAvatarUrlUpdatedCallback)((NSString *) groupID, (NSString *) groupAvatarUrl, (ZIMError) errorInfo);

Returns the result of the group avatar URL update.

Parameters

Name	Type	Description
groupID	NSString *	Group ID.
groupAvatarUrl	NSString *	Group avatar URL.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMGroupNoticeUpdatedCallback)((NSString *) groupID, (NSString *) groupNotice, (ZIMError) errorInfo);

The return of the results of the group announcement update.

Parameters

Name	Type	Description
groupID	NSString *	Group ID.
groupNotice	NSString *	Group notice.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMGroupAliasUpdatedCallback)((NSString *) groupID, (NSString *) groupAlias, (ZIMError) errorInfo);

Returns the result of the group alias update.

Parameters

Name	Type	Description
groupID	NSString *	Group ID.
groupAlias	NSString *	Group alias.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMGroupInfoQueriedCallback)((ZIMGroupFullInfo) groupInfo, (ZIMError) errorInfo);

Returns the result of querying group information.

Parameters

Name	Type	Description
groupInfo	ZIMGroupFullInfo	Group information.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMGroupAttributesOperatedCallback)((NSString *) groupID, (NSArray<NSString *> *) errorKeys, (ZIMError) errorInfo);

Returns the result of a group attribute operation.

Parameters

Name	Type	Description
groupID	NSString *	Group ID.
errorKeys	NSArray<NSString >	Error keys.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMGroupAttributesQueriedCallback)((NSString *) groupID, (NSDictionary<NSString, NSString> *) groupAttributes, (ZIMError) errorInfo);

The return of query group attribute results.

Parameters

Name	Type	Description
groupID	NSString *	Group ID.
groupAttributes	NSDictionary<NSString, NSString> *	Group attributes.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMGroupMemberRoleUpdatedCallback)((NSString *) groupID, (NSString *) forUserID, (ZIMGroupMemberRole) role, (ZIMError) errorInfo);

Returns the result of the member role update.

Parameters

Name	Type	Description
groupID	NSString *	Group ID.
forUserID	NSString *	User ID.
role	ZIMGroupMemberRole	User role.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMGroupMemberNicknameUpdatedCallback)((NSString *) groupID, (NSString *) forUserID, (NSString *) nickname, (ZIMError) errorInfo);

Returns the result of the group member's nickname update.

Parameters

Name	Type	Description
groupID	NSString *	Group ID.
forUserID	NSString *	User ID.
nickname	NSString *	User nickname.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMGroupMemberInfoQueriedCallback)((NSString *) groupID, (ZIMGroupMemberInfo) userInfo, (ZIMError) errorInfo);

Returns the result of the group member query.

Parameters

Name	Type	Description
groupID	NSString *	Group ID.
userInfo	ZIMGroupMemberInfo	Group member user information.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMGroupListQueriedCallback)((NSArray<ZIMGroup *> *) groupList, (long long) nextFlag, (ZIMError) errorInfo);

Returns the results of the query group list.

Parameters

Name	Type	Description
groupList	NSArray<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	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMGroupMemberListQueriedCallback)((NSString *) groupID, (NSArray<ZIMGroupMemberInfo *> *) userList, (unsigned int) nextFlag, (ZIMError) errorInfo);

Returns the result of querying the group member list.

Parameters

Name	Type	Description
groupID	NSString *	Group ID.
userList	NSArray<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	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMGroupMemberCountQueriedCallback)((NSString *) groupID, (unsigned int) count, (ZIMError) errorInfo);

Returns the result of querying the group member count.

Parameters

Name	Type	Description
groupID	NSString *	Group ID.
count	unsigned int	Group member count.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMGroupMessageReceiptMemberListQueriedCallback)((NSString *) groupID, (NSArray<ZIMGroupMemberInfo *> *) userList, (unsigned int) nextFlag, (ZIMError) errorInfo);

Callback interface for querying the specific read/unread member list of group receipt messages.

Parameters

Name	Type	Description
groupID	NSString *	Group ID.
userList	NSArray<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	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMGroupMutedCallback)((NSString *) groupID, (BOOL) isMute, (ZIMGroupMuteInfo) mutedInfo, (ZIMError) errorInfo);

Returns the result of the group mute info update.

Parameters

Name	Type	Description
groupID	NSString *	Group ID.
isMute	BOOL	Whether to mute.
mutedInfo	ZIMGroupMuteInfo	Group mute information.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMGroupMembersMutedCallback)((NSString *) groupID, (BOOL) isMute, (int) duration, (NSArray<NSString *> *) mutedUserIDs, (NSArray<ZIMErrorUserInfo *> *) errorUserList, (ZIMError) errorInfo);

Returns the result of the group members mute info update.

Parameters

Name	Type	Description
groupID	NSString *	Group ID.
isMute	BOOL	Whether to mute.
duration	int	Mute duration.
mutedUserIDs	NSArray<NSString >	List of muted member userIDs.
errorUserList	NSArray<ZIMErrorUserInfo >	List of user information that failed to be muted.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMGroupMemberMutedListQueriedCallback)((NSString *) groupID, (unsigned long long) nextFlag, (NSArray<ZIMGroupMemberInfo *> *) userList, (ZIMError) errorInfo);

Returns the result of querying the group muted member list.

Parameters

Name	Type	Description
groupID	NSString *	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	NSArray<ZIMGroupMemberInfo >	Group member list.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMGroupsSearchedCallback)((NSArray<ZIMGroupSearchInfo *> *) groupSearchInfoList, (unsigned int) nextFlag, (ZIMError) errorInfo);

Returns the result of search a group.

Parameters

Name	Type	Description
groupSearchInfoList	NSArray<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	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMGroupMembersSearchedCallback)((NSString *) groupID, (NSArray<ZIMGroupMemberInfo *> *) userList, (unsigned int) nextFlag, (ZIMError) errorInfo);

Returns the result of search a group members.

Parameters

Name	Type	Description
groupID	NSString *	Group ID.
userList	NSArray<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	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMGroupJoinModeUpdatedCallback)((NSString *) groupID, (ZIMGroupJoinMode) mode, (ZIMError) errorInfo);

The return of the results of the group verification mode update.

Parameters

Name	Type	Description
groupID	NSString *	Group ID.
mode	ZIMGroupJoinMode	Group join mode.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMGroupInviteModeUpdatedCallback)((NSString *) groupID, (ZIMGroupInviteMode) mode, (ZIMError) errorInfo);

The return of the results of the group verification mode update.

Parameters

Name	Type	Description
groupID	NSString *	Group ID.
mode	ZIMGroupInviteMode	Group invite mode.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMGroupBeInviteModeUpdatedCallback)((NSString *) groupID, (ZIMGroupBeInviteMode) mode, (ZIMError) errorInfo);

The return of the results of the group verification mode update.

Parameters

Name	Type	Description
groupID	NSString *	Group ID.
mode	ZIMGroupBeInviteMode	Group be invite mode.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMGroupJoinApplicationSentCallback)((NSString *) groupID, (ZIMError) errorInfo);

The return of the results of the group join application sent.

Parameters

Name	Type	Description
groupID	NSString *	Group ID.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMGroupJoinApplicationAcceptedCallback)((NSString *) groupID, (NSString *) userID, (ZIMError) errorInfo);

The return of the results of the group join application accept.

Parameters

Name	Type	Description
groupID	NSString *	Group ID.
userID	NSString *	User ID.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMGroupJoinApplicationRejectedCallback)((NSString *) groupID, (NSString *) userID, (ZIMError) errorInfo);

The return of the results of the group join application reject.

Parameters

Name	Type	Description
groupID	NSString *	Group ID.
userID	NSString *	User ID.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMGroupInviteApplicationsSentCallback)((NSString *) groupID, (NSArray<ZIMErrorUserInfo *> *) errorUserList, (ZIMError) errorInfo);

The return of the results of the group invite application sent.

Parameters

Name	Type	Description
groupID	NSString *	Group ID.
errorUserList	NSArray<ZIMErrorUserInfo >	Invite failed user information list.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMGroupInviteApplicationAcceptedCallback)((ZIMGroupFullInfo) groupInfo, (NSString *) inviterUserID, (ZIMError) errorInfo);

The return of the results of the group invite application accept.

Parameters

Name	Type	Description
groupInfo	ZIMGroupFullInfo	Group information.
inviterUserID	NSString *	Inviter user ID.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMGroupInviteApplicationRejectedCallback)((NSString *) groupID, (NSString *) inviterUserID, (ZIMError) errorInfo);

The return of the results of the group invite application accept.

Parameters

Name	Type	Description
groupID	NSString *	Group information.
inviterUserID	NSString *	Inviter user ID.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMGroupApplicationListQueriedCallback)((NSArray<ZIMGroupApplicationInfo *> *) applicationList, (unsigned long long) nextFlag, (ZIMError) errorInfo);

Query the callback of group application list.

Parameters

Name	Type	Description
applicationList	NSArray<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	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMCallInvitationSentCallback)((NSString *) callID, (ZIMCallInvitationSentInfo) info, (ZIMError) errorInfo);

Action callback for sending a call invitation.

Parameters

Name	Type	Description
callID	NSString *	Call ID.
info	ZIMCallInvitationSentInfo	Call invitation information.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMCallingInvitationSentCallback)((NSString *) callID, (ZIMCallingInvitationSentInfo) info, (ZIMError) errorInfo);

Callback result of inviting the current call.

Parameters

Name	Type	Description
callID	NSString *	Call ID.
info	ZIMCallingInvitationSentInfo	Calling invitation information.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMCallCancelSentCallback)((NSString *) callID, (NSArray<NSString *> *) errorInvitees, (ZIMError) errorInfo);

Callback for the action to cancel the call invitation.

Parameters

Name	Type	Description
callID	NSString *	Call ID.
errorInvitees	NSArray<NSString >	Call invitation failed user ID list.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMCallAcceptanceSentCallback)((NSString *) callID, (ZIMError) errorInfo);

Action callback for accepting call invitations.

Parameters

Name	Type	Description
callID	NSString *	Call ID.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMCallRejectionSentCallback)((NSString *) callID, (ZIMError) errorInfo);

Action callback for rejecting a call invitation.

Parameters

Name	Type	Description
callID	NSString *	Call ID.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMCallJoinSentCallback)((NSString *) callID, (ZIMCallJoinSentInfo) info, (ZIMError) errorInfo);

Result callback of joining the call invitation.

Parameters

Name	Type	Description
callID	NSString *	Call ID.
info	ZIMCallJoinSentInfo	Call join information.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMCallQuitSentCallback)((NSString *) callID, (ZIMCallQuitSentInfo) info, (ZIMError) errorInfo);

Quit the callback closure of the call invitation operation.

Parameters

Name	Type	Description
callID	NSString *	Call ID.
info	ZIMCallQuitSentInfo	Call quit information.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMCallEndSentCallback)((NSString *) callID, (ZIMCallEndedSentInfo) info, (ZIMError) errorInfo);

Result callback of ending the call invitation.

Parameters

Name	Type	Description
callID	NSString *	Call ID.
info	ZIMCallEndedSentInfo	Call end information.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMCallInvitationListQueriedCallback)((NSArray<ZIMCallInfo *> *) callList, (long long) nextFlag, (ZIMError) errorInfo);

Result Callback of querying the call list.

Parameters

Name	Type	Description
callList	NSArray<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	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMFriendAddedCallback)((ZIMFriendInfo) friendInfo, (ZIMError) errorInfo);

Add a friend result callback.

Parameters

Name	Type	Description
friendInfo	ZIMFriendInfo	Friend information.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMFriendsDeletedCallback)((NSArray<ZIMErrorUserInfo *> *) errorUserList, (ZIMError) errorInfo);

Return results of deleting friends.

Parameters

Name	Type	Description
errorUserList	NSArray<ZIMErrorUserInfo >	Friend information.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMFriendListQueriedCallback)((NSArray<ZIMFriendInfo *> *) friendList, (unsigned int) nextFlag, (ZIMError) errorInfo);

The returned result of querying the friends list.

Parameters

Name	Type	Description
friendList	NSArray<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	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMFriendsInfoQueriedCallback)((NSArray<ZIMFriendInfo *> *) friendInfos, (NSArray<ZIMErrorUserInfo *> *) errorUserList, (ZIMError) errorInfo);

Return results of querying friend information in batches.

Parameters

Name	Type	Description
friendInfos	NSArray<ZIMFriendInfo >	Friend information list.
errorUserList	NSArray<ZIMErrorUserInfo >	Friend information.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMFriendsRelationCheckedCallback)((NSArray<ZIMFriendRelationInfo *> *) relationInfos, (NSArray<ZIMErrorUserInfo *> *) errorUserList, (ZIMError) errorInfo);

Check the friend relationship result.

Parameters

Name	Type	Description
relationInfos	NSArray<ZIMFriendRelationInfo >	Friend relationship information list.
errorUserList	NSArray<ZIMErrorUserInfo >	Friend information.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMFriendApplicationSentCallback)((ZIMFriendApplicationInfo) applicationInfo, (ZIMError) errorInfo);

The result of sending a friend application.

Parameters

Name	Type	Description
applicationInfo	ZIMFriendApplicationInfo	Friend application information.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMFriendApplicationAcceptedCallback)((ZIMFriendInfo) friendInfo, (ZIMError) errorInfo);

Accept the returned result of friend application.

Parameters

Name	Type	Description
friendInfo	ZIMFriendInfo	Friend information.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMFriendApplicationRejectedCallback)((ZIMUserInfo) userInfo, (ZIMError) errorInfo);

Accept the returned result of friend application.

Parameters

Name	Type	Description
userInfo	ZIMUserInfo	User information.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMFriendApplicationListQueriedCallback)((NSArray<ZIMFriendApplicationInfo *> *) applicationList, (unsigned int) nextFlag, (ZIMError) errorInfo);

The result of sending a friend application.

Parameters

Name	Type	Description
applicationList	NSArray<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	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMFriendAliasUpdatedCallback)((ZIMFriendInfo) friendInfo, (ZIMError) errorInfo);

Return results of updating friend alias.

Parameters

Name	Type	Description
friendInfo	ZIMFriendInfo	Friend information.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMFriendAttributesUpdatedCallback)((ZIMFriendInfo) friendInfo, (ZIMError) errorInfo);

Return results of updating friend attributes.

Parameters

Name	Type	Description
friendInfo	ZIMFriendInfo	Friend information.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMFriendsSearchedCallback)((NSArray<ZIMFriendInfo *> *) friendInfos, (unsigned int) nextFlag, (ZIMError) errorInfo);

Search results returned by local friends.

Parameters

Name	Type	Description
friendInfos	NSArray<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	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMBlacklistUsersAddedCallback)((NSArray<ZIMErrorUserInfo *> *) errorUserList, (ZIMError) errorInfo);

Callback for operation results of adding users to the blacklist.

Parameters

Name	Type	Description
errorUserList	NSArray<ZIMErrorUserInfo >	User information.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMBlacklistUsersRemovedCallback)((NSArray<ZIMErrorUserInfo *> *) errorUserList, (ZIMError) errorInfo);

The callback result of the operation to remove the user from the blacklist.

Parameters

Name	Type	Description
errorUserList	NSArray<ZIMErrorUserInfo >	User information.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMBlacklistQueriedCallback)((NSArray<ZIMUserInfo *> *) blacklist, (unsigned int) nextFlag, (ZIMError) errorInfo);

Query the blacklist result callback.

Parameters

Name	Type	Description
blacklist	NSArray<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	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMBlacklistCheckedCallback)((BOOL) isUserInBlacklist, (ZIMError) errorInfo);

Blacklist check result callback.

Parameters

Name	Type	Description
isUserInBlacklist	BOOL	Whether in blacklist.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMCommunityCreatedCallback)((ZIMCommunityFullInfo) communityInfo, (ZIMError) errorInfo);

Callback of the result of creating a community.

Parameters

Name	Type	Description
communityInfo	ZIMCommunityFullInfo	Community information.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMCommunityDismissedCallback)((NSString *) communityID, (ZIMError) errorInfo);

Callback of the result of dismissing a community.

Parameters

Name	Type	Description
communityID	NSString *	Community ID.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMCommunityJoinedCallback)((ZIMCommunityFullInfo) communityInfo, (ZIMError) errorInfo);

Callback of the result of joining a community.

Parameters

Name	Type	Description
communityInfo	ZIMCommunityFullInfo	Community information.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMCommunityLeftCallback)((NSString *) communityID, (ZIMError) errorInfo);

Callback of the result of leaving a community.

Parameters

Name	Type	Description
communityID	NSString *	Community ID.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMCommunityListQueriedCallback)((NSArray<ZIMCommunity *> *) communityList, (long long) nextFlag, (ZIMError) errorInfo);

Callback of the result of querying the community list.

Parameters

Name	Type	Description
communityList	NSArray<ZIMCommunity >	Community list.
nextFlag	long long	Next query community list flag.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMCommunityNameUpdatedCallback)((NSString *) communityID, (NSString *) communityName, (ZIMError) errorInfo);

Callback of the result of updating the community name.

Parameters

Name	Type	Description
communityID	NSString *	Community ID.
communityName	NSString *	Community name.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMCommunityAvatarUrlUpdatedCallback)((NSString *) communityID, (NSString *) communityAvatarUrl, (ZIMError) errorInfo);

Callback of the result of updating the community avatar URL.

Parameters

Name	Type	Description
communityID	NSString *	Community ID.
communityAvatarUrl	NSString *	Community avatar URL.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMCommunityNoticeUpdatedCallback)((NSString *) communityID, (NSString *) communityNotice, (ZIMError) errorInfo);

Callback of the result of updating the community notice.

Parameters

Name	Type	Description
communityID	NSString *	Community ID.
communityNotice	NSString *	Community notice.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMCommunityAttributesOperatedCallback)((NSString *) communityID, (NSArray<NSString *> *) errorKeys, (ZIMError) errorInfo);

Callback of the result of operating community attributes.

Parameters

Name	Type	Description
communityID	NSString *	Community ID.
errorKeys	NSArray<NSString >	Error keys.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMCommunityNotificationStatusSetCallback)((NSString *) communityID, (ZIMError) errorInfo);

Callback of the result of setting the community notification status.

Parameters

Name	Type	Description
communityID	NSString *	Community ID.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMCommunityInfoQueriedCallback)((ZIMCommunityFullInfo) communityInfo, (ZIMError) errorInfo);

Callback of the result of querying community information.

Parameters

Name	Type	Description
communityInfo	ZIMCommunityFullInfo	Community information.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMCommunityUsersInvitedCallback)((NSString *) communityID, (NSArray<ZIMErrorUserInfo *> *) errorUserList, (ZIMError) errorInfo);

Callback of the result of inviting users into the community.

Parameters

Name	Type	Description
communityID	NSString *	Community ID.
errorUserList	NSArray<ZIMErrorUserInfo >	The error userID list
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMCommunityMembersKickedCallback)((NSString *) communityID, (NSArray<ZIMErrorUserInfo *> *) errorUserList, (ZIMError) errorInfo);

Callback of the result of kicking members from the community.

Parameters

Name	Type	Description
communityID	NSString *	Community ID.
errorUserList	NSArray<ZIMErrorUserInfo >	The error userID list
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMCommunityMemberRoleUpdatedCallback)((NSString *) communityID, (NSString *) forUserID, (ZIMCommunityMemberRole) memberRole, (ZIMError) errorInfo);

Callback of the result of updating a community member's role.

Parameters

Name	Type	Description
communityID	NSString *	Community ID.
forUserID	NSString *	The user ID of the target user.
memberRole	ZIMCommunityMemberRole	member role value
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMCommunityOwnerTransferredCallback)((NSString *) communityID, (NSString *) toUserID, (ZIMError) errorInfo);

Callback of the result of transferring the community owner.

Parameters

Name	Type	Description
communityID	NSString *	Community ID.
toUserID	NSString *	The user ID of the new community owner.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMCommunityMemberListQueriedCallback)((NSString *) communityID, (NSArray<ZIMCommunityMemberInfo *> *) memberList, (long long) nextFlag, (ZIMError) errorInfo);

Callback of the result of querying the community member list.

Parameters

Name	Type	Description
communityID	NSString *	Community ID.
memberList	NSArray<ZIMCommunityMemberInfo >	Community member list.
nextFlag	long long	Anchor for the next community member list query.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMCommunityMembersQueriedCallback)((NSString *) communityID, (NSArray<ZIMCommunityMemberInfo *> *) memberList, (NSArray<ZIMErrorUserInfo *> *) errorUserList, (ZIMError) errorInfo);

Callback of the result of querying specific community members.

Parameters

Name	Type	Description
communityID	NSString *	Community ID.
memberList	NSArray<ZIMCommunityMemberInfo >	List of queried community members.
errorUserList	NSArray<ZIMErrorUserInfo >	List of users that failed to be queried.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMCommunityChannelCreatedCallback)((ZIMCommunityChannelFullInfo) channelInfo, (ZIMError) errorInfo);

Callback of the result of creating a community channel.

Parameters

Name	Type	Description
channelInfo	ZIMCommunityChannelFullInfo	Community channel information.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMCommunityChannelDismissedCallback)((NSString *) communityID, (NSString *) channelID, (ZIMError) errorInfo);

Callback of the result of dismissing a community channel.

Parameters

Name	Type	Description
communityID	NSString *	Community ID.
channelID	NSString *	Community channel ID
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMCommunityChannelNameUpdatedCallback)((NSString *) communityID, (NSString *) channelID, (NSString *) channelName, (ZIMError) errorInfo);

Callback of the result of updating the community channel name.

Parameters

Name	Type	Description
communityID	NSString *	Community ID.
channelID	NSString *	Community channel ID
channelName	NSString *	Community channel name.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMCommunityChannelAvatarUrlUpdatedCallback)((NSString *) communityID, (NSString *) channelID, (NSString *) channelAvatarUrl, (ZIMError) errorInfo);

Callback of the result of updating the community channel avatar URL.

Parameters

Name	Type	Description
communityID	NSString *	Community ID.
channelID	NSString *	Community channel ID
channelAvatarUrl	NSString *	Community avatar URL.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMCommunityChannelNoticeUpdatedCallback)((NSString *) communityID, (NSString *) channelID, (NSString *) channelNotice, (ZIMError) errorInfo);

Callback of the result of updating the community channel notice.

Parameters

Name	Type	Description
communityID	NSString *	Community ID.
channelID	NSString *	Community channel ID
channelNotice	NSString *	Community channel notice.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMCommunityChannelAttributesOperatedCallback)((NSString *) communityID, (NSString *) channelID, (NSArray<NSString *> *) errorKeys, (ZIMError) errorInfo);

Callback of the result of operating community channel attributes.

Parameters

Name	Type	Description
communityID	NSString *	Community ID.
channelID	NSString *	Community channel ID.
errorKeys	NSArray<NSString >	Error keys.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMCommunityChannelsInfoQueriedCallback)((NSString *) communityID, (NSArray<ZIMCommunityChannelFullInfo *> *) channelInfos, (NSArray<NSString *> *) errorChannelIDs, (ZIMError) errorInfo);

Callback of the result of querying community channel information.

Parameters

Name	Type	Description
communityID	NSString *	Community ID.
channelInfos	NSArray<ZIMCommunityChannelFullInfo >	List of queried community channels.
errorChannelIDs	NSArray<NSString >	List of channel IDs that failed to be queried.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMCommunityChannelListQueriedCallback)((NSString *) communityID, (NSArray<ZIMCommunityChannel *> *) channelList, (long long) nextFlag, (ZIMError) errorInfo);

Callback of the result of querying the community channel list.

Parameters

Name	Type	Description
communityID	NSString *	Community ID.
channelList	NSArray<ZIMCommunityChannel >	Community channel list.
nextFlag	long long	Anchor for the next channel list query.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMCommunityMembersMutedCallback)((NSString *) communityID, (NSString *) channelID, (BOOL) isMute, (NSArray<ZIMErrorUserInfo *> *) errorUserList, (ZIMError) errorInfo);

Callback of the result of muting community members.

Parameters

Name	Type	Description
communityID	NSString *	Community ID.
channelID	NSString *	The channel ID. Empty means muted at the community level.
isMute	BOOL	Whether to mute the members.
errorUserList	NSArray<ZIMErrorUserInfo >	List of users that failed to be muted.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for 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

void(^ZIMCommunityChannelsMutedCallback)((NSString *) communityID, (BOOL) isMute, (NSArray<NSString *> *) errorChannelIDs, (ZIMError) errorInfo);

Callback of the result of muting community channels.

Parameters

Name	Type	Description
communityID	NSString *	Community ID.
isMute	BOOL	Whether to mute the channels.
errorChannelIDs	NSArray<NSString >	List of channel IDs that failed to be muted.
errorInfo	ZIMError	Error code information, used to obtain the result of the interface call. code is 0 for success, and non-0 for failure. When an interface call fails, developers should check the error code documentation on the official website for solutions.