Class

2026-01-21


ZIMAppConfig	ZIMAudio
ZIMAudioANSParam	ZIMAudioError
ZIMAudioEventHandler	ZIMAudioFrameParam
ZIMAudioMessage	ZIMAudioMessageLiteInfo
ZIMAudioPlayConfig	ZIMAudioRecordConfig
ZIMBarrageMessage	ZIMBlacklistQueryConfig
ZIMCacheConfig	ZIMCallAcceptConfig
ZIMCallCancelConfig	ZIMCallEndConfig
ZIMCallInfo	ZIMCallingInvitationSentInfo
ZIMCallingInviteConfig	ZIMCallInvitationAcceptedInfo
ZIMCallInvitationCancelledInfo	ZIMCallInvitationCreatedInfo
ZIMCallInvitationEndedInfo	ZIMCallInvitationQueryConfig
ZIMCallInvitationReceivedInfo	ZIMCallInvitationRejectedInfo
ZIMCallInvitationSentInfo	ZIMCallInvitationTimeoutInfo
ZIMCallInviteConfig	ZIMCallJoinConfig
ZIMCallJoinSentInfo	ZIMCallQuitConfig
ZIMCallQuitSentInfo	ZIMCallRejectConfig
ZIMCallUserInfo	ZIMCallUserStateChangeInfo
ZIMCombineMessage	ZIMCombineMessageLiteInfo
ZIMCommandMessage	ZIMConversation
ZIMConversationBaseInfo	ZIMConversationChangeInfo
ZIMConversationDeleteConfig	ZIMConversationFilterOption
ZIMConversationQueryConfig	ZIMConversationsAllDeletedInfo
ZIMConversationSearchConfig	ZIMConversationSearchInfo
ZIMConversationTotalUnreadMessageCountQueryConfig	ZIMCustomMessage
ZIMCustomMessageLiteInfo	ZIMDefines
ZIMError	ZIMErrorUserInfo
ZIMFileCacheClearConfig	ZIMFileCacheInfo
ZIMFileCacheQueryConfig	ZIMFileMessage
ZIMFileMessageLiteInfo	ZIMFriendAddConfig
ZIMFriendApplicationAcceptConfig	ZIMFriendApplicationInfo
ZIMFriendApplicationListQueryConfig	ZIMFriendApplicationRejectConfig
ZIMFriendApplicationSendConfig	ZIMFriendDeleteConfig
ZIMFriendInfo	ZIMFriendListQueryConfig
ZIMFriendRelationCheckConfig	ZIMFriendRelationInfo
ZIMFriendsSearchConfig	ZIMGroup
ZIMGroupAdvancedConfig	ZIMGroupApplicationInfo
ZIMGroupApplicationListQueryConfig	ZIMGroupAttributesUpdateInfo
ZIMGroupConversation	ZIMGroupEnterInfo
ZIMGroupFullInfo	ZIMGroupInfo
ZIMGroupInviteApplicationAcceptConfig	ZIMGroupInviteApplicationRejectConfig
ZIMGroupInviteApplicationSendConfig	ZIMGroupJoinApplicationAcceptConfig
ZIMGroupJoinApplicationRejectConfig	ZIMGroupJoinApplicationSendConfig
ZIMGroupMemberInfo	ZIMGroupMemberMuteConfig
ZIMGroupMemberMutedListQueryConfig	ZIMGroupMemberQueryConfig
ZIMGroupMemberSearchConfig	ZIMGroupMemberSimpleInfo
ZIMGroupMessageReceiptMemberQueryConfig	ZIMGroupMuteConfig
ZIMGroupMuteInfo	ZIMGroupOperatedInfo
ZIMGroupSearchConfig	ZIMGroupSearchInfo
ZIMGroupVerifyInfo	ZIMImageMessage
ZIMImageMessageLiteInfo	ZIMLogConfig
ZIMLoginConfig	ZIMMediaDownloadConfig
ZIMMediaMessage	ZIMMediaMessageLiteInfo
ZIMMessage	ZIMMessageDeleteConfig
ZIMMessageDeletedInfo	ZIMMessageEditConfig
ZIMMessageExportConfig	ZIMMessageImportConfig
ZIMMessageLiteInfo	ZIMMessageMentionedInfo
ZIMMessagePinStatusChangeInfo	ZIMMessageQueryConfig
ZIMMessageReaction	ZIMMessageReactionUserInfo
ZIMMessageReactionUserQueryConfig	ZIMMessageReceiptInfo
ZIMMessageReceivedInfo	ZIMMessageRepliedInfo
ZIMMessageRepliedListQueryConfig	ZIMMessageRevokeConfig
ZIMMessageRootRepliedCountInfo	ZIMMessageRootRepliedInfo
ZIMMessageSearchConfig	ZIMMessageSendConfig
ZIMMessageSendNotification	ZIMMessageSentStatusChangeInfo
ZIMMultipleMessage	ZIMMultipleMessageLiteInfo
ZIMOfflinePushPrivateMessageTemplate	ZIMPushConfig
ZIMRevokeMessage	ZIMRevokeMessageLiteInfo
ZIMRoomAdvancedConfig	ZIMRoomAttributesBatchOperationConfig
ZIMRoomAttributesDeleteConfig	ZIMRoomAttributesSetConfig
ZIMRoomAttributesUpdateInfo	ZIMRoomFullInfo
ZIMRoomInfo	ZIMRoomMemberAttributesInfo
ZIMRoomMemberAttributesOperatedInfo	ZIMRoomMemberAttributesQueryConfig
ZIMRoomMemberAttributesSetConfig	ZIMRoomMemberAttributesUpdateInfo
ZIMRoomMemberInfo	ZIMRoomMemberQueryConfig
ZIMRoomOperatedInfo	ZIMSelfUserInfo
ZIMSelfUserRule	ZIMSendingMessageCancelConfig
ZIMSubscribedUserStatusQueryConfig	ZIMTextMessage
ZIMTextMessageLiteInfo	ZIMTipsMessage
ZIMTipsMessageChangeInfo	ZIMTipsMessageGroupChangeInfo
ZIMTipsMessageGroupMemberChangeInfo	ZIMTipsMessagePinStatusChangeInfo
ZIMUserFullInfo	ZIMUserInfo
ZIMUserOfflinePushRule	ZIMUsersInfoQueryConfig
ZIMUserStatus	ZIMUserStatusSubscribeConfig
ZIMUserStatusSubscription	ZIMVideoMessage
ZIMVideoMessageLiteInfo	ZIMVoIPConfig
ZPNsConfig	ZPNsManager

ZIMAppConfig

ZIM 应用配置，包含 AppID 和 AppSign。

Declared in ZIMDefines.h

属性

appID

public unsigned int appID

是否必填：必填。

appSign

public NSString * appSign

是否必填：必填。

ZIMAudio

方法

getVersion

static

getVersion

+ (NSString *)getVersion;

获取 ZIM Audio SDK 版本号

如果在 SDK 运行过程中遇到异常情况，您可以通过该接口将问题、日志等信息提交给 ZEGO 技术人员进行定位和排查。开发者也可以通过此 API 收集当前 SDK 的版本信息，方便进行应用程序运行统计和相关问题处理。

调用时机：任何时候。

支持版本：ZIM Audio SDK 1.0.0

SDK 当前版本号。

setAdvancedConfigWithKey:key:value:

static

setAdvancedConfigWithKey:key:value:

+ (void)setAdvancedConfigWithKey:(NSString *) key value:(NSString *) value;

实现高级配置

参数

名称	类型	描述
key	NSString *	进阶配置的 key。
value	NSString *	进阶配置的 value。

详情

当 SDK 的默认行为无法满足开发者的使用场景时，可以调用此 API 实现开发者定义的高级配置。

调用时机：必须在 [init] 之前调用，否则将在下一次 [init] 后生效。

支持版本：ZIM Audio SDK1.0.0
使用限制：无。
注意事项：使用前请先联系 ZEGO 技术支持。

sharedInstance

static

sharedInstance

+ (ZIMAudio) sharedInstance;

获取单例对象。

在使用 ZIMAudio SDK 时，开发者应直接调用此 API 获取内部的单例对象，而不需要自行创建和维护该对象。

调用时机：任何时候。

支持版本：ZIM Audio SDK 1.0.0

initWithLicense:license:

- (void)initWithLicense:(NSString *) license;

初始化 ZIM Audio SDK

参数

名称	类型	描述
license	NSString *	鉴权文件。如果仅实现录制和播放音频，此字段可传空。当需要使用音量增益和噪声等进阶功能时，需要传入此字段。如何获取鉴权文件，请参考在线鉴权。

详情

在使用 ZIMAudio SDK 的其他功能接口时，必须首先调用此 API 进行初始化。

调用时机：在调用其他 API 之前调用。

支持版本：ZIM Audio SDK 1.0.0
使用限制：当没有传递认证信息或认证信息不正确时，SDK 的初始化可以正常进行，但对于一些需要认证的后续功能的使用将会受到限制。

uninit

- (void)uninit;

反初始化 ZIM Audio SDK

当您不再需要使用 ZIMAudio SDK 时，可以调用此 API 进行反初始化并释放内存资源。

支持版本：ZIM Audio SDK 1.0.0

setEventHandler:eventHandler:

- (void)setEventHandler:(nullable id<ZIMAudioEventHandler>) eventHandler;

设置 ZIM Audio SDK 事件通知回调

参数

名称	类型	描述
eventHandler	nullable id<ZIMAudioEventHandler>	事件通知回调。开发者应根据自身业务场景，重写回调的相关方法以关注特定的通知。

详情

设置事件通知回调，以监控录音机和播放器生命周期等回调事件。

调用时机：在 [init] 之后调用。

支持版本：ZIM Audio SDK 1.0.0
注意事项：当多次调用该 API 并传入不同的 eventHandler 对象时，最后一个对象将覆盖先前设置的对象；当 API 传入的 eventHandler 对象为空时，将取消事件回调通知。

enableANS:enable:

- (void)enableANS:(BOOL) enable;

开启噪声控制功能

参数

名称	类型	描述
enable	BOOL	是否开启此功能。

详情

开启此功能后，可以使人声更清晰。该功能较好地抑制持续性噪音（如雨声等白噪音）。

使用场景：当需要噪音抑制以改善录制音频的音质和用户体验时，可以开启此功能。

调用时机：在 [init] 后且 [startPlay] 期间调用。

支持版本：ZIM Audio SDK 1.0.0
注意事项：只有在认证处于合法使用期内，或者认证信息中允许使用时，才能正常调用此 API；否则，将报告认证已过期或不支持该功能的错误消息。

enableAGC:enable:

- (void)enableAGC:(BOOL) enable;

开启音量增益功能

参数

名称	类型	描述
enable	BOOL	是否开启此功能。

详情

开启此功能后，SDK 可以自动调节麦克风音量，以适应远近拾音并保持音量稳定。

使用场景：当需要确保音量稳定以改善录制音频的音质和用户体验时，可以开启此功能。

调用时机：在 [init] 后且 [startPlay] 期间调用。

支持版本：ZIM Audio SDK 1.0.0
注意事项：只有在认证处于合法使用期内，或者认证信息中允许使用时，才能正常调用此 API；否则，将报告认证已过期或不支持该功能的错误消息。

setANSParam:param:

- (void)setANSParam:(ZIMAudioANSParam) param;

设置 ANS 参数

参数

名称	类型	描述
param	ZIMAudioANSParam	ANS 参数

详情

当使用 [enableANS] 开启噪音抑制时，您可以使用此函数在不同的噪音抑制模式之间切换，以控制噪音抑制的程度。

使用场景：当默认的噪音抑制效果不符合期望时，您可以使用此函数来调整噪音抑制模式。

默认值：当未调用此函数时，默认的噪音抑制模式为 [Medium]。
调用时机：在 [init] 后的任何时候调用。

支持版本：ZIM Audio SDK 1.0.0
使用限制：无。
注意事项：只有在 License 鉴权文件处于合法使用期内，或者认证信息中允许使用时，才能正常调用此 API；否则，将报告认证已过期或不支持该功能的错误消息。

startRecordWithConfig:config:

- (void)startRecordWithConfig:(ZIMAudioRecordConfig) config;

开始录制音频文件。

参数

名称	类型	描述
config	ZIMAudioRecordConfig	音频录制配置。

详情

开始录制音频文件。SDK 将向系统申请使用麦克风设备收集音频并将其写入本地文件。使用场景：在用户需要发送语音消息之前，他们可以调用此 API 收集并生成发送所需的语音文件。录制文件最终将保存到本地设置的路径中。

调用时机：在 [init] 后调用。
相关接口：当调用此 API 开始录制时，SDK 将抛出 [onRecorderStarted] 通知。只有在收到此回调通知后，开发者才能认为录制已正式开始并更新 UI 显示；之后，SDK 将通过 [onRecorderProgress] 回调录制进度；在异常情况下，SDK 还可能抛出 [onRecorderFailed] 通知，请开发者根据需要监控并警告用户发生异常。

支持版本：ZIM Audio SDK 1.0.0
使用限制：不能同时使用与录制相关的 API 和与播放相关的 API。同时，SDK 内部只能执行录制或播放之一。因此，在需要开始录制之前，开发者需要主动停止播放功能，否则在 SDK 开始录制之前也会停止播放相关功能。
注意事项：开发者在使用此 API 前请确保已获得应用程序的音频收集权限；当 SDK 开始录制时，它将独占使用音频设备，因此会中断其他第三方应用程序的播放和其他行为。

completeRecord

- (void)completeRecord;

完成录制音频文件。

完成录制音频文件。调用此 API 后，录制文件将在传递给 [startRecord] 的文件路径中生成并保存。

使用场景：完成录制后，开发者可以将录制文件作为即时消息发送。例如，将其传递给 ZIM 的 AudioMessage 以发送语音消息。

调用时机：[startRecord] 录制生效时。
相关接口：当调用此 API 并成功完成录制时，SDK 将抛出 [onRecorderCompleted] 通知。开发者必须在发送语音消息之前接收此回调通知。

支持版本：ZIM Audio SDK 1.0.0
使用限制：不能同时使用与录制相关的 API 和与播放相关的 API。同时，SDK 内部只能执行录制或播放之一。
注意事项：如果开发者在 [startRecord] 生效时不调用此 API 结束录制，则当达到 [startRecord] 的最大录制持续时间时，录制仍将完成并保存文件。完成录制后，SDK 将释放对音频设备的占用。

cancelRecord

- (void)cancelRecord;

中断录制音频

中断录制音频文件。调用此 API 后，录制将停止，并且 SDK 将在内部删除本地文件。

使用场景：在录制过程中需要提前停止录制且不需要发送语音消息时，可以调用此 API 取消录制。

调用时机：[startRecord] 录制生效时。
相关接口：当调用此 API 取消录制时，SDK 将抛出 [onRecorderCancelled] 通知。开发者可以根据此通知清理相关资源并更新 UI 显示。

支持版本：ZIM Audio SDK 1.0.0
使用限制：不能同时使用与录制相关的 API 和与播放相关的 API。同时，SDK 内部只能执行录制或播放之一。
注意事项：取消录制后，SDK 将释放音频设备的占用。

isRecording

- (BOOL)isRecording;

获取 ZIM Audio SDK 是否正在录制音频

获取当前时刻 SDK 是否正在录制。

使用场景：当开发者需要在某一时刻获取和检测录制状态时，可以调用此 API 获取录制状态。

调用时机：在 [init] 后的任何时候调用。

支持版本：ZIM Audio SDK 1.0.0

setAudioRouteType:routeType:

- (void)setAudioRouteType:(ZIMAudioRouteType) routeType;

设置音频路由类型

参数

名称	类型	描述
routeType	ZIMAudioRouteType	路由类型。

详情

设置音频路由类型，选择是使用扬声器还是耳机听取音频。

使用场景：当开发者需要为用户提供选择音频播放位置的选项时，可以调用此 API 更改当前正在播放的音频路由类型。

调用时机：在 [init] 后的任何时候调用。

支持版本：ZIM Audio SDK 1.0.0
使用限制：无。
注意事项：当用户当前使用耳机进行音频播放时，此 API 的设置将不会生效。

startPlayWithConfig:config:

- (void)startPlayWithConfig:(ZIMAudioPlayConfig) config;

开始播放音频文件

参数

名称	类型	描述
config	ZIMAudioPlayConfig	音频播放配置。

详情

开始播放音频文件。SDK 将读取指定路径中的音频文件并进行播放。

使用场景：用户接收到语音消息后，可以调用此 API 播放已在本地下载并保存的音频文件。

调用时机：在 [init] 后调用。
相关接口：当调用此 API 开始播放时，SDK 将抛出 [onPlayerStarted] 通知。只有在收到此回调通知后，开发者才能认为播放已正式开始并更新 UI 显示；之后，SDK 将通过 [onPlayerProgress] 回调播放进度；在异常情况下，SDK 还可能抛出 [onPlayerFailed] 通知，请开发者根据需要监控并警告用户发生异常。

支持版本：ZIM Audio SDK 1.0.0
使用限制：不能同时使用与播放相关的 API 和与录制相关的 API。同时，SDK 内部只能执行录制或播放之一。因此，在需要启用播放之前，开发者必须首先确保此时没有使用录制功能，否则播放将失败。
注意事项：当 SDK 开始播放时，它将独占使用音频设备，因此会中断其他第三方应用程序的播放，并且不会与其他应用程序的音频输出混合。

stopPlay

- (void)stopPlay;

停止音频播放

停止 SDK 当前正在播放的音频。

使用场景：在播放过程中需要提前停止音频播放时，可以调用此 API 停止播放。如果用户需要立即播放下一段音频，则需要停止前一段音频的播放；或者当用户即将离开播放页面时，也应该停止当前的播放。

调用时机：在 [startPlay] 播放期间调用。
相关接口：当调用此 API 停止播放时，SDK 将抛出 [onPlayerStopped] 通知。开发者可以根据此回调通知更新 UI 显示。

支持版本：ZIM Audio SDK1.0.0
使用限制：不能同时使用与播放相关的 API 和与录制相关的 API。同时，SDK 内部只能执行录制或播放之一。因此，在需要启用播放之前，开发者必须首先确保此时没有使用录制功能，否则播放将失败。
注意事项：停止播放或完成播放后，SDK 将释放音频设备的占用。

isPlaying

- (BOOL)isPlaying;

获取 ZIM Audio SDK 是否正在播放音频

获取 ZIM Audio SDK 是否正在播放音频。使用场景：当开发者需要在某一时刻获取和检测播放状态时，可以调用此 API 获取播放状态。

调用时机：在 [init] 后的任何时候调用。

支持版本：ZIM Audio SDK 1.0.0

ZIMAudioANSParam

噪声抑制参数

详情

包括噪声抑制模式。

Declared in ZIMAudioDefines.h

属性

mode

public ZIMAudioANSMode mode

噪声抑制模式（ANS）。

ZIMAudioError

详情

可用于记录 SDK 生成的错误类型和错误信息，查阅 ZEGO 官方网站上的错误代码表，并寻求 ZEGO 技术支持的帮助。

Declared in ZIMAudioDefines.h

属性

code

public ZIMAudioErrorCode code

错误码，请参考 ZIM Audio 错误码文档获取解决建议。

message

public NSString * message

可用于记录 SDK 生成的错误类型和错误信息，查阅 ZEGO 官方网站上的错误代码表，并寻求 ZEGO 技术支持的帮助。

ZIMAudioEventHandler

方法

onError:errorInfo:

- (void)onError:(ZIMAudioError) errorInfo;

异常回调

参数

名称	类型	描述
errorInfo	ZIMAudioError	错误信息。

详情

当 SDK 内部检测到异常时，将通过此回调抛出通知。

使用场景：用于方便开发者收集 SDK 问题并对其进行故障排除。建议监控回调并进行适当的日志打印或事件报告。

支持版本：ZIM Audio SDK1.0.0
注意事项：不建议开发者在收到此回调后执行逻辑。仅建议用于收集和排查问题。

onRecorderStarted

- (void)onRecorderStarted;

录音开始回调

当开发者调用 [startRecord] 并且 SDK 已经内部准备好音频设备并即将开始录制时，将回调此通知。

使用场景：由开发者用于更新 UI。

相关接口：在调用 [startRecord] 后将回调此通知。

支持版本：ZIM Audio SDK 1.0.0
注意事项：无。

onRecorderCompleted:totalDuration:

- (void)onRecorderCompleted:(int) totalDuration;

录音完成回调

参数

名称	类型	描述
totalDuration	int	音频时长（以毫秒为单位）。

详情

当开发者调用 [completeRecord] 并且 SDK 完成录制并保存录音文件时，将回调此通知。

使用场景：由开发者用于更新 UI 和发送后续语音消息。

相关接口：在调用 [completeRecord] 后将回调此通知。

支持版本：ZIM Audio SDK 1.0.0
注意事项：开发者必须在发送语音消息之前收到此回调通知。

onRecorderCancelled

- (void)onRecorderCancelled;

录音取消回调

当开发者调用 [cancelRecord] 并且 SDK 停止录制并不保留已录制数据时，将回调此通知。

使用场景：由开发者用于更新 UI。

相关接口：在调用 [cancelRecord] 后将回调此通知。

支持版本：1.0.0
注意事项：无。

onRecorderProgress:currentDuration:

- (void)onRecorderProgress:(int) currentDuration;

录制进度通知回调

参数

名称	类型	描述
currentDuration	int	当前记录持续时间（以毫秒为单位）。

详情

录制进度通知。当录制已经开始时，SDK 每 500 毫秒会回调进度通知。用例：用于开发者更新用户界面。

支持版本：ZIM Audio SDK 1.0.0
注意事项：无。

onRecorderFailed:errorCode:

- (void)onRecorderFailed:(ZIMAudioErrorCode) errorCode;

音频录制失败回调

参数

名称	类型	描述
errorCode	ZIMAudioErrorCode	错误码，请参考 ZIM Audio 错误码文档获取解决建议。

详情

当录制开始或录制过程中发生异常导致录制失败时，将使用此回调通知您。

使用场景：由开发者用于更新 UI。建议开发者监听此回调并向用户提供必要的提示。

支持版本：ZIM Audio SDK 1.0.0
注意事项：无。

onPlayerStarted:totalDuration:

- (void)onPlayerStarted:(int) totalDuration;

音频播放开始回调

参数

名称	类型	描述
totalDuration	int	总播放时间（以毫秒为单位）。

详情

当开发者调用 [startPlay] 并且 SDK 已经内部准备好音频设备并即将开始播放时，将回调此通知。

使用场景：由开发者用于更新 UI。

相关接口：在调用 [startPlay] 后将回调此通知。

支持版本：ZIM Audio SDK 1.0.0
注意事项：无。

onPlayerEnded

- (void)onPlayerEnded;

音频播放完成回调

当音频文件播放完成时，将回调此通知。

使用场景：由开发者用于更新 UI。

支持版本：ZIM Audio SDK 1.0.0
注意事项：无。

onPlayerStopped

- (void)onPlayerStopped;

音频播放停止回调

当开发者调用 [stopPlay] 时，SDK 将立即停止当前正在播放的音频并回调此通知。

使用场景：由开发者用于更新 UI。

相关接口：在调用 [stopPlay] 后将回调此通知。

支持版本：ZIM Audio SDK 1.0.0
注意事项：无。

onPlayerProgress:currentDuration:

- (void)onPlayerProgress:(int) currentDuration;

音频播放进度回调

参数

名称	类型	描述
currentDuration	int	当前播放时间，以毫秒为单位。

详情

当播放已经开始时，SDK 将每 500 毫秒调用进度通知回调。

使用场景：由开发者用于更新 UI。

支持版本：ZIM Audio SDK 1.0.0
注意事项：无。

onPlayerInterrupted

- (void)onPlayerInterrupted;

音频播放中断回调

当播放被其他操作中断时，SDK 将调用此通知。例如，在播放过程中开始录制，播放过程中收到系统的来电事件，播放过程中音频设备被其他应用程序抢占等。

使用场景：由开发者用于更新 UI。

支持版本：ZIM Audio SDK 1.0.0
注意事项：无。

onPlayerFailed:errorCode:

- (void)onPlayerFailed:(ZIMAudioErrorCode) errorCode;

音频播放失败回调

参数

名称	类型	描述
errorCode	ZIMAudioErrorCode	错误码，请参考 ZIM Audio 错误码文档获取解决建议。

详情

当播放开始或播放过程中发生异常导致播放失败时，将使用此回调通知您。

使用场景：由开发者用于更新 UI。建议开发者监听此回调并向用户提供必要的提示。

支持版本：ZIM Audio SDK 1.0.0
注意事项：无。

ZIMAudioFrameParam

详情

音频帧属性参数。

Declared in ZIMAudioDefines.h

属性

sampleRate

public Number sampleRate

音频采样率。

channels

public Number channels

音频通道数。

ZIMAudioMessage

音频消息对象。

详情

标识一条音频消息。

注意事项：回调时若基类的 Type 参数为 Audio，可将基类消息对象强转为此类。

Declared in ZIMDefines.h

属性

audioDuration

public unsigned long long audioDuration

音频文件的时长。

是否必填：发送本地音频消息时，发送端必填，不填会导致音频消息发送失败。

fileLocalPath

public NSString * fileLocalPath

媒体消息的文件的本地绝对路径。

是否必填：如果发送本地文件，则发送端必填，否则消息会发送失败。

fileDownloadUrl

public NSString * fileDownloadUrl

媒体消息的外部下载 URL，用于开发者将媒体文件上传到自己的服务器中时，通过填入该 URL 让 SDK 透传到其他用户中。

是否必填：如果发送的是外部 URL，发送端必填。

fileUID

public NSString * fileUID

媒体文件的唯一 ID。

是否必填：发送端不需要填，该值由 SDK 生成。

fileName

public NSString * fileName

媒体文件的文件名。

是否必填：如果发送的是外部 URL，则需要填写该值，且需要包含文件扩展名。如果发送的是本地文件，该值选填。

fileSize

public unsigned long long fileSize

媒体文件的大小。

是否必填：发送端不需要填，该值由 SDK 生成。

type

public ZIMMessageType type

消息类型。

messageID

public long long messageID

标识这条消息的唯一 ID。

业务场景：可用于索引其他消息。

注意事项：开发者主动创建一条消息时，不需要修改这个参数，此参数仅在回调时有值。

timestamp

public unsigned long long timestamp

标识一条消息的发送时间。

业务场景：用于呈现一条消息的发送时间，并可用于消息排序。

注意事项：此为标准 UNIX 时间戳，单位为毫秒。

senderUserID

public NSString * senderUserID

展示本条消息发送者的 userID。

conversationID

public NSString * conversationID

会话的 ID，相同会话类型下的 ID 是唯一的。

direction

public ZIMMessageDirection direction

用于描述消息的方向是发送还是接收。

sentStatus

public ZIMMessageSentStatus sentStatus

描述消息的发送状态。

conversationType

public ZIMConversationType conversationType

该消息所属会话的类型。

conversationSeq

public unsigned long long conversationSeq

表示该消息在会话中的序号。

orderKey

public long long orderKey

orderKey 越大消息越新，可用于消息排序。

localMessageID

public long long localMessageID

SDK 本地生成的 MessageID,开发者无需关注。

isUserInserted

public BOOL isUserInserted

该消息是否是开发者通过 [insertMessageToLocalDB] 接口插入的消息。

默认值：false。

receiptStatus

public ZIMMessageReceiptStatus receiptStatus

描述该消息的回执状态。

业务场景：用于在回执消息中，判断当前消息是处于什么状态。

extendedData

public NSString extendedData

消息拓展字段。

业务场景：可为消息附加拓展字段，然后发送给对端。
是否必填：否。

支持版本：2.6.0 及以上。
注意事项：长度为1k，可联系技术支持进行配置。

localExtendedData

public NSString * localExtendedData

仅本端可见的消息拓展字段，可附带额外的信息存储到本地，可通过 [updateMessageLocalExtendedData] 修改，目前长度的限制是 128K。如有特殊需求，可联系 ZEGO 技术支持进行配置。

isBroadcastMessage

public BOOL isBroadcastMessage

该消息是否是全员推送消息。

是否必填：SDK内部赋值。

isMentionAll

public BOOL isMentionAll

是否需要提醒所有人。业务表现可为“@所有人”。

业务场景：例如在群或者房间可使用。
是否必填：否。
默认值：false。
建议值：如果需要提醒所有人，可以设置为 true。

注意事项：该值并不会在消息文本上增加 @所有人的字样，需要开发者自行实现。

支持版本 : 2.14.0 及以上。

mentionedUserIDs

public NSArray\<NSString *> * mentionedUserIDs

提醒一批相关的用户。业务表现可为“@某用户”。

业务场景：发消息时可以带上
是否必填：否。

注意事项：该值并不会在消息文本上增加 @某用户的字样，需要开发者自行实现。

支持版本 : 2.14.0 及以上。

messageSeq

public unsigned long long messageSeq

表示该消息在会话中的序号。

rootRepliedCount

public unsigned int rootRepliedCount

回复消息树对应的根消息的回复消息数量。

repliedInfo

public ZIMMessageRepliedInfo repliedInfo

回复消息引用的源消息的信息。

editorUserID

public NSString * editorUserID

本条消息最新的编辑者的 userID。

editedTime

public unsigned long long editedTime

本条消息最新的编辑时间戳。

isGroupTargetedMessage

public BOOL isGroupTargetedMessage

标识该消息是否为群定向消息。

pinnedUserID

public NSString * pinnedUserID

该消息的最后一次置顶的置顶者。

业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。

pinnedTime

public long long pinnedTime

该消息最后一次置顶的置顶时间。

业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。

ZIMAudioMessageLiteInfo

音频消息的简要信息对象。

详情

标识一条音频消息。

Declared in ZIMDefines.h

属性

audioDuration

public unsigned long long audioDuration

音频文件的时长。

是否必填：发送本地音频消息时，发送端必填，不填会导致音频消息发送失败。

fileLocalPath

public NSString * fileLocalPath

媒体消息的文件的本地绝对路径。

是否必填：如果发送本地文件，则发送端必填，否则消息会发送失败。

fileDownloadUrl

public NSString * fileDownloadUrl

媒体消息的外部下载 URL，用于开发者将媒体文件上传到自己的服务器中时，通过填入该 URL 让 SDK 透传到其他用户中。

是否必填：如果发送的是外部 URL，发送端必填。

fileName

public NSString * fileName

媒体文件的文件名。

是否必填：如果发送的是外部 URL，则需要填写该值，且需要包含文件扩展名。如果发送的是本地文件，该值选填。

fileSize

public unsigned long long fileSize

媒体文件的大小。

是否必填：发送端不需要填，该值由 SDK 生成。

type

public ZIMMessageType type

消息类型。

messageID

public long long messageID

标识这条消息的唯一 ID。

业务场景：可用于索引其他消息。

注意事项：开发者主动创建一条消息时，不需要修改这个参数，此参数仅在回调时有值。

timestamp

public unsigned long long timestamp

标识一条消息的发送时间。

业务场景：用于呈现一条消息的发送时间，并可用于消息排序。

注意事项：此为标准 UNIX 时间戳，单位为毫秒。

senderUserID

public NSString * senderUserID

展示本条消息发送者的 userID。

conversationID

public NSString * conversationID

会话的 ID，相同会话类型下的 ID 是唯一的。

direction

public ZIMMessageDirection direction

用于描述消息的方向是发送还是接收。

sentStatus

public ZIMMessageSentStatus sentStatus

描述消息的发送状态。

conversationType

public ZIMConversationType conversationType

该消息所属会话的类型。

conversationSeq

public unsigned long long conversationSeq

表示该消息在会话中的序号。

orderKey

public long long orderKey

orderKey 越大消息越新，可用于消息排序。

localMessageID

public long long localMessageID

SDK 本地生成的 MessageID,开发者无需关注。

isUserInserted

public BOOL isUserInserted

该消息是否是开发者通过 [insertMessageToLocalDB] 接口插入的消息。

默认值：false。

receiptStatus

public ZIMMessageReceiptStatus receiptStatus

描述该消息的回执状态。

业务场景：用于在回执消息中，判断当前消息是处于什么状态。

extendedData

public NSString extendedData

消息拓展字段。

业务场景：可为消息附加拓展字段，然后发送给对端。
是否必填：否。

支持版本：2.6.0 及以上。
注意事项：长度为1k，可联系技术支持进行配置。

localExtendedData

public NSString * localExtendedData

isBroadcastMessage

public BOOL isBroadcastMessage

该消息是否是全员推送消息。

是否必填：SDK内部赋值。

isMentionAll

public BOOL isMentionAll

是否需要提醒所有人。业务表现可为“@所有人”。

业务场景：例如在群或者房间可使用。
是否必填：否。
默认值：false。
建议值：如果需要提醒所有人，可以设置为 true。

注意事项：该值并不会在消息文本上增加 @所有人的字样，需要开发者自行实现。

支持版本 : 2.14.0 及以上。

mentionedUserIDs

public NSArray\<NSString *> * mentionedUserIDs

提醒一批相关的用户。业务表现可为“@某用户”。

业务场景：发消息时可以带上
是否必填：否。

注意事项：该值并不会在消息文本上增加 @某用户的字样，需要开发者自行实现。

支持版本 : 2.14.0 及以上。

messageSeq

public unsigned long long messageSeq

表示该消息在会话中的序号。

rootRepliedCount

public unsigned int rootRepliedCount

回复消息树对应的根消息的回复消息数量。

repliedInfo

public ZIMMessageRepliedInfo repliedInfo

回复消息引用的源消息的信息。

editorUserID

public NSString * editorUserID

本条消息最新的编辑者的 userID。

editedTime

public unsigned long long editedTime

本条消息最新的编辑时间戳。

isGroupTargetedMessage

public BOOL isGroupTargetedMessage

标识该消息是否为群定向消息。

pinnedUserID

public NSString * pinnedUserID

该消息的最后一次置顶的置顶者。

业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。

pinnedTime

public long long pinnedTime

该消息最后一次置顶的置顶时间。

业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。

ZIMBlacklistQueryConfig

黑名单查询配置。

详情

通过该配置可以设置查询总条数以及分页查询

Declared in ZIMDefines.h

属性

count

public unsigned int count

数量。

是否必填：必填。

nextFlag

public unsigned int nextFlag

下一个标志。

是否必填：非必填，首次默认为 0，表示从头开始查询。

ZIMCacheConfig

缓存配置。

详情

配置缓存文件（例如聊天记录）的存储路径。

Declared in ZIMDefines.h

属性

cachePath

public NSString * cachePath

缓存文件的存储路径。

是否必填：非必填。
默认值：Android：/storage/Android/data/[packageName]/files/ZIMCaches iOS：~~/Library/Caches/ZIMCaches macOS：（沙箱）~~/Library/Containers/[Bundle ID]/Data/Library/Caches/ZIMCaches / （非沙箱）~/Library/Caches/ZIMCaches Windows：C:\Users[Your UserName]\AppData[App Name]ZEGO.SDK\ZIMCaches
建议值：建议使用默认值。

注意事项：请注意设置的目录是否有读写权限，否则会导致 SDK 无法正确执行。

ZIMCallAcceptConfig

接受呼叫邀请设置的行为属性。

详情

接受呼叫邀请设置的行为属性。

Declared in ZIMDefines.h

属性

extendedData

public NSString * extendedData

扩展字段，邀请者可通过该字段携带信息给被邀请者。

是否必填：必填。

ZIMCallCancelConfig

取消呼叫邀请设置的行为属性。

详情

取消呼叫邀请设置的行为属性。

Declared in ZIMDefines.h

属性

extendedData

public NSString * extendedData

扩展字段，邀请者可通过该字段携带信息给被邀请者。

是否必填：非必填。
默认值：""。

pushConfig

public ZIMPushConfig pushConfig

离线推送配置。

是否必填：非必填。

ZIMCallEndConfig

结束呼叫邀请设置的行为属性。

详情

结束呼叫邀请设置的行为属性。

Declared in ZIMDefines.h

属性

extendedData

public NSString * extendedData

扩展字段，邀请者可通过该字段携带信息给被邀请者。

是否必填：非必填。

pushConfig

public ZIMPushConfig pushConfig

离线推送配置。

是否必填：非必填。

ZIMCallInfo

呼叫邀请信息。

详情

呼叫邀请信息。

Declared in ZIMDefines.h

属性

callID

public NSString * callID

呼叫邀请 ID。

caller

public NSString * caller

呼叫邀请发起者 ID。

mode

public ZIMCallInvitationMode mode

呼叫邀请模式。

state

public ZIMCallState state

呼叫邀请状态。

extendedData

public NSString * extendedData

创建呼叫邀请附加信息。

createTime

public number createTime

呼叫邀请创建时间戳。

endTime

public number endTime

呼叫邀请结束时间。

callUserList

public ZIMCallUserInfo[] callUserList

呼叫邀请成员列表。

ZIMCallInvitationAcceptedInfo

接受呼叫邀请信息。

详情

接受呼叫邀请信息。

public ZIMCallInvitationMode mode

当次呼叫邀请的模式。

endTime

public long long endTime

结束呼叫的时间戳，单位毫秒，格式: UTC 时间戳。

ZIMCallInvitationQueryConfig

查询呼叫邀请列表的设置属性。

详情

查询呼叫邀请列表的设置属性。

Declared in ZIMDefines.h

属性

count

public unsigned int count

查询条数，最多限制 100 条。传入数值超过 100，按照 100 处理。

是否必填：必填。

nextFlag

public long long nextFlag

查询列表的标志位。首次查询时无需填充，查询后 callback 会返回一个 nextFlag,下次查询时填入可以在上一次的基础上继续往后查询。

是否必填：非必填。

ZIMCallInvitationReceivedInfo

接受呼叫邀请的信息。

详情

接受呼叫邀请的信息。

Declared in ZIMDefines.h

属性

timeout

public int timeout

详细描述：呼叫邀请的超时时间设置，单位为秒。

inviter

public NSString * inviter

邀请者ID。

extendedData

public NSString * extendedData

扩展字段，邀请者可通过该字段携带信息给被邀请者。

mode

public ZIMCallInvitationMode mode

本次呼叫邀请的模式。

caller

public NSString * caller

本次呼叫邀请的创建者，与调用 callInvite 的 userID 相同。

createTime

public long long createTime

本次呼叫邀请在服务端创建时的事件戳，精确到毫秒。

callUserList

public NSArray<ZIMCallUserInfo *> * callUserList

本次呼叫邀请的成员列表。

ZIMCallInvitationRejectedInfo

拒绝呼叫邀请信息。

详情

拒绝呼叫邀请信息。

Declared in ZIMDefines.h

属性

invitee

public NSString * invitee

被邀请者ID。

extendedData

public NSString * extendedData

扩展字段，邀请者可通过该字段携带信息给被邀请者。

ZIMCallInvitationSentInfo

呼叫邀请已发送信息。

详情

呼叫邀请已发送信息。

Declared in ZIMDefines.h

属性

timeout

public int timeout

详细描述：呼叫邀请的超时时间设置，单位为秒。

errorInvitees

deprecated

public NSArray< ZIMCallUserInfo *> errorInvitees

未收到呼叫邀请的用户id。

已废弃

该字段已在 2.9.0 版本废弃，请使用 errorUserList 代替。

errorUserList

public NSArray<ZIMErrorUserInfo *> errorUserList

未收到呼叫邀请的用户id 列表。

ZIMCallInvitationTimeoutInfo

有关超时通知的信息类。

详情

有关超时通知的信息类。

Declared in ZIMDefines.h

属性

mode

public ZIMCallInvitationMode mode

呼叫邀请的类型。

ZIMCallInviteConfig

发送呼叫邀请设置的行为属性。

详情

发送呼叫邀请设置的行为属性。

Declared in ZIMDefines.h

属性

timeout

public unsigned int timeout

是否必填：非必填。
默认值：90。

extendedData

public NSString * extendedData

扩展字段，邀请者可通过该字段携带信息给被邀请者。

pushConfig

public ZIMPushConfig pushConfig

离线推送配置。

是否必填：非必填。

mode

public ZIMCallInvitationMode mode

呼叫邀请模式配置。

是否必填：非必填。
默认值：GENERAL

支持版本：2.9.0 及以后版本。

enableNotReceivedCheck

public BOOL enableNotReceivedCheck

通过值为 true 的情况下，本次呼叫邀请以及后续呼叫中邀请将会检测邀请是否送达。

业务场景：主叫发起呼叫邀请后，如果被叫在 5 秒内（可提单给技术支持配置为 3 秒或 4 秒）因断网、未上线等原因没有接收到本次邀请，该用户状态将会变为 notYetReceived 暂未送达状态。您可使用该状态流转向用户提示该用户可能不在线。当被叫后续在呼叫超时前上线，此状态会流转为 received 已送达状态。
是否必填：非必填。
默认值：false。

注意事项：该属性在 2.15.0 及后续版本生效，新版本发送给老版本开启了送达检测的呼叫邀请，老版本将继续展示 inviting 状态而非 notYetReceived。

ZIMCallJoinConfig

加入呼叫邀请设置的行为属性。

详情

加入呼叫邀请设置的行为属性。

Declared in ZIMDefines.h

属性

extendedData

public NSString * extendedData

扩展字段，邀请者可通过该字段携带信息给被邀请者。

ZIMCallJoinSentInfo

加入呼叫操作的结果信息。

详情

加入呼叫操作的结果信息。

Declared in ZIMDefines.h

属性

createTime

public long long createTime

当次呼叫邀请的创建时间的时间戳。

joinTime

public long long joinTime

本人加入呼叫邀请的时间戳。

extendedData

public NSString * extendedData

调用结束呼叫时附带的透传字段。

callUserList

public NSArray<ZIMCallUserInfo> * callUserList

当前呼叫邀请中的用户信息列表。

ZIMCallQuitConfig

退出呼叫邀请设置的行为属性。

详情

退出呼叫邀请设置的行为属性。

Declared in ZIMDefines.h

属性

extendedData

public NSString * extendedData

扩展字段，邀请者可通过该字段携带信息给被邀请者。

是否必填：必填。

pushConfig

public ZIMPushConfig pushConfig

离线推送配置。

是否必填：非必填。

ZIMCallQuitSentInfo

退出呼叫操作的结果信息。

详情

退出呼叫操作的结果信息。

Declared in ZIMDefines.h

属性

createTime

public long long createTime

当次呼叫邀请的创建时间的时间戳。

acceptTime

public long long acceptTime

本人接受呼叫邀请的时间戳。

quitTime

public long long quitTime

本人退出呼叫的时间戳。

ZIMCallRejectConfig

用于设置拒绝呼叫邀请的配置项。

详情

用于发送拒绝邀请时自定义呼叫邀请的配置。

业务场景：用户需要在调用拒绝呼叫邀请时将配置项传入接口。

Declared in ZIMDefines.h

属性

extendedData

public NSString extendedData

用于发送拒绝邀请时附加自定义内容的额外字段。

业务场景：用户需要再拒绝时给邀请方传一些自定义内容时使用。
是否必填：必填。
默认值：""。

ZIMCallUserInfo

呼叫邀请用户信息。

详情

呼叫邀请用户信息。

Declared in ZIMDefines.h

属性

userID

public NSString * userID

用户ID。

取值范围：最大 32 字节的字符串。仅支持数字，英文字符和 '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'。

state

Declared in ZIMDefines.h

属性

pushConfig

public ZIMPushConfig pushConfig

离线推送配置。

是否必填：非必填。

ZIMCombineMessage

合并消息对象基类。

详情

标识一条合并消息。

支持版本：2.14.0 及以上。

Declared in ZIMDefines.h

属性

title

public NSString * title

合并消息标题。

summary

public NSString * summary

合并消息的概要

combineID

public NSString * combineID

合并消息 ID，SDK 内部使用

messageList

public NSArray<ZIMMessage*>* messageList

合并消息的子消息列表

type

public ZIMMessageType type

消息类型。

messageID

public long long messageID

标识这条消息的唯一 ID。

业务场景：可用于索引其他消息。

注意事项：开发者主动创建一条消息时，不需要修改这个参数，此参数仅在回调时有值。

timestamp

public unsigned long long timestamp

标识一条消息的发送时间。

业务场景：用于呈现一条消息的发送时间，并可用于消息排序。

注意事项：此为标准 UNIX 时间戳，单位为毫秒。

senderUserID

public NSString * senderUserID

展示本条消息发送者的 userID。

conversationID

public NSString * conversationID

会话的 ID，相同会话类型下的 ID 是唯一的。

direction

public ZIMMessageDirection direction

用于描述消息的方向是发送还是接收。

sentStatus

public ZIMMessageSentStatus sentStatus

描述消息的发送状态。

conversationType

public ZIMConversationType conversationType

该消息所属会话的类型。

conversationSeq

public unsigned long long conversationSeq

表示该消息在会话中的序号。

orderKey

public long long orderKey

orderKey 越大消息越新，可用于消息排序。

localMessageID

public long long localMessageID

SDK 本地生成的 MessageID,开发者无需关注。

isUserInserted

public BOOL isUserInserted

该消息是否是开发者通过 [insertMessageToLocalDB] 接口插入的消息。

默认值：false。

receiptStatus

public ZIMMessageReceiptStatus receiptStatus

描述该消息的回执状态。

业务场景：用于在回执消息中，判断当前消息是处于什么状态。

extendedData

public NSString extendedData

消息拓展字段。

业务场景：可为消息附加拓展字段，然后发送给对端。
是否必填：否。

支持版本：2.6.0 及以上。
注意事项：长度为1k，可联系技术支持进行配置。

localExtendedData

public NSString * localExtendedData

isBroadcastMessage

public BOOL isBroadcastMessage

该消息是否是全员推送消息。

是否必填：SDK内部赋值。

isMentionAll

public BOOL isMentionAll

是否需要提醒所有人。业务表现可为“@所有人”。

业务场景：例如在群或者房间可使用。
是否必填：否。
默认值：false。
建议值：如果需要提醒所有人，可以设置为 true。

注意事项：该值并不会在消息文本上增加 @所有人的字样，需要开发者自行实现。

支持版本 : 2.14.0 及以上。

mentionedUserIDs

public NSArray\<NSString *> * mentionedUserIDs

提醒一批相关的用户。业务表现可为“@某用户”。

业务场景：发消息时可以带上
是否必填：否。

注意事项：该值并不会在消息文本上增加 @某用户的字样，需要开发者自行实现。

支持版本 : 2.14.0 及以上。

messageSeq

public unsigned long long messageSeq

表示该消息在会话中的序号。

rootRepliedCount

public unsigned int rootRepliedCount

回复消息树对应的根消息的回复消息数量。

repliedInfo

public ZIMMessageRepliedInfo repliedInfo

回复消息引用的源消息的信息。

editorUserID

public NSString * editorUserID

本条消息最新的编辑者的 userID。

editedTime

public unsigned long long editedTime

本条消息最新的编辑时间戳。

isGroupTargetedMessage

public BOOL isGroupTargetedMessage

标识该消息是否为群定向消息。

pinnedUserID

public NSString * pinnedUserID

该消息的最后一次置顶的置顶者。

业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。

pinnedTime

public long long pinnedTime

该消息最后一次置顶的置顶时间。

业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。

ZIMCombineMessageLiteInfo

合并消息的简要信息对象。

详情

标识一条合并消息。

Declared in ZIMDefines.h

属性

title

public NSString * title

合并消息标题。

summary

public NSString * summary

合并消息的概要

type

public ZIMMessageType type

消息类型。

ZIMCommandMessage

自定义二进制消息对象。

详情

标识一条二进制消息。

注意事项：回调时若基类的 Type 参数为 command，可将基类消息对象强转为此类。

Declared in ZIMDefines.h

属性

message

public NSData * message

消息的内容，支持任意数据。

是否必填：发送端必填，否则消息会发送失败。

type

public ZIMMessageType type

消息类型。

messageID

public long long messageID

标识这条消息的唯一 ID。

业务场景：可用于索引其他消息。

注意事项：开发者主动创建一条消息时，不需要修改这个参数，此参数仅在回调时有值。

timestamp

public unsigned long long timestamp

标识一条消息的发送时间。

业务场景：用于呈现一条消息的发送时间，并可用于消息排序。

注意事项：此为标准 UNIX 时间戳，单位为毫秒。

senderUserID

public NSString * senderUserID

展示本条消息发送者的 userID。

conversationID

public NSString * conversationID

会话的 ID，相同会话类型下的 ID 是唯一的。

direction

public ZIMMessageDirection direction

用于描述消息的方向是发送还是接收。

sentStatus

public ZIMMessageSentStatus sentStatus

描述消息的发送状态。

conversationType

public ZIMConversationType conversationType

该消息所属会话的类型。

conversationSeq

public unsigned long long conversationSeq

表示该消息在会话中的序号。

orderKey

public long long orderKey

orderKey 越大消息越新，可用于消息排序。

localMessageID

public long long localMessageID

SDK 本地生成的 MessageID,开发者无需关注。

isUserInserted

public BOOL isUserInserted

该消息是否是开发者通过 [insertMessageToLocalDB] 接口插入的消息。

默认值：false。

receiptStatus

public ZIMMessageReceiptStatus receiptStatus

描述该消息的回执状态。

业务场景：用于在回执消息中，判断当前消息是处于什么状态。

extendedData

public NSString extendedData

消息拓展字段。

业务场景：可为消息附加拓展字段，然后发送给对端。
是否必填：否。

支持版本：2.6.0 及以上。
注意事项：长度为1k，可联系技术支持进行配置。

localExtendedData

public NSString * localExtendedData

isBroadcastMessage

public BOOL isBroadcastMessage

该消息是否是全员推送消息。

是否必填：SDK内部赋值。

isMentionAll

public BOOL isMentionAll

是否需要提醒所有人。业务表现可为“@所有人”。

业务场景：例如在群或者房间可使用。
是否必填：否。
默认值：false。
建议值：如果需要提醒所有人，可以设置为 true。

注意事项：该值并不会在消息文本上增加 @所有人的字样，需要开发者自行实现。

支持版本 : 2.14.0 及以上。

mentionedUserIDs

public NSArray\<NSString *> * mentionedUserIDs

提醒一批相关的用户。业务表现可为“@某用户”。

业务场景：发消息时可以带上
是否必填：否。

注意事项：该值并不会在消息文本上增加 @某用户的字样，需要开发者自行实现。

支持版本 : 2.14.0 及以上。

messageSeq

public unsigned long long messageSeq

表示该消息在会话中的序号。

rootRepliedCount

public unsigned int rootRepliedCount

回复消息树对应的根消息的回复消息数量。

repliedInfo

public ZIMMessageRepliedInfo repliedInfo

回复消息引用的源消息的信息。

editorUserID

public NSString * editorUserID

本条消息最新的编辑者的 userID。

editedTime

public unsigned long long editedTime

本条消息最新的编辑时间戳。

isGroupTargetedMessage

public BOOL isGroupTargetedMessage

标识该消息是否为群定向消息。

pinnedUserID

public NSString * pinnedUserID

该消息的最后一次置顶的置顶者。

业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。

pinnedTime

public long long pinnedTime

该消息最后一次置顶的置顶时间。

业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。

方法

ZIMCommandMessage

- (void)ZIMCommandMessage;

Declared in ZIMDefines.h

ZIMConversation

会话具体内容。

详情

会话的具体内容。

Declared in ZIMDefines.h

属性

conversationID

public NSString * conversationID

会话ID。

conversationName

public NSString * conversationName

conversationName,与会话对应的 groupName/userName 值相同。

type

public ZIMConversationType type

会话类型。

unreadMessageCount

public int unreadMessageCount

会话未读数。

lastMessage

public ZIMMessage lastMessage

最后一条消息。

orderKey

public long orderKey

用于描述消息在会话中的顺序，orderKey 越大越新。

notificationStatus

public ZIMConversationNotificationStatus notificationStatus

会话通知状态。

conversationAvatarUrl

public NSString * conversationAvatarUrl

会话头像 URL。单聊会话头像 URL 与用户头像 URL 相同，群聊会话头像 URL 与群头像 URL 相同。

使用限制：最大 500 字节，无特殊字符限制。

isPinned

public BOOL isPinned

会话是否置顶。

支持版本：2.8.0。

mentionedInfoList

public NSArray<ZIMMessageMentionedInfo *>* mentionedInfoList

当在会话的消息中被提醒到或者被提醒所有人时，该数组会有记录。

业务场景：比如可以在会话列表根据该数组显示当前会话有多少个提醒，还可以显示是哪个用户的提醒。

conversationAlias

public NSString * conversationAlias

会话别名，通过 [updateFriendAlias] 设置好友备注后，对应的单聊会话该参数会同步修改。通过 [updateGroupAlias] 设置群备注后，对应的群聊会话该参数会同步修改。

业务场景：为好友或群组设置备注后，渲染会话页时，对应的会话优先选择展示 alias 别名，而不是 conversation name（好友的用户名或群组名）。

marks

public NSArray<NSNumber *> * marks

描述了该会话现有的所有标记。

业务场景：业务层可以按照不同会话拥有的不同标记做分组逻辑等。

是否必填：非必填。
默认值：true。

ZIMConversationFilterOption

查询会话的相关过滤项。

详情

查询会话时可配置的过滤项。

Declared in ZIMDefines.h

属性

marks

public NSArray<NSNumber *> * marks

会话标记列表，只支持 [1, 20] 的整数。若列表包含 -1，查询结果为所有已标记会话；若列表包含 0，查询结果为所有无标记的会话；若传入多个标记，查询结果为所有传入标记的并集；若列表为空，则查询结果为所有会话。

业务场景：需要查询包含指定的会话标记时可使用该过滤项。

conversationTypes

public NSArray<NSNumber *> * conversationTypes

会话类型。仅支持单聊和群聊。

业务场景：需要按照会话类型查询时可使用该过滤项。

isOnlyUnreadConversation

public BOOL isOnlyUnreadConversation

是否仅查询存在未读数的会话。传 true 时，则仅查询存在未读数的会话。传 false 时，则查询时将不考虑会话是否存在未读数。

业务场景：需要查询出仅存在消息未读数的会话。

ZIMConversationQueryConfig

查询会话的相关配置。

详情

查询会话时可配置的信息。

Declared in ZIMDefines.h

属性

nextConversation

public ZIMConversation nextConversation

需要查询的会话。

是否必填：非必填。

count

public unsigned int count

需要查询的会话数量。

是否必填：必填。

ZIMConversationSearchConfig

会话搜索配置。

详情

会话搜索配置。

Declared in ZIMDefines.h

属性

nextFlag

unsigned int nextFlag

分页拉取表示，初始时填 0，后续填从 callback 里返回的 nextFlag，以获取下一分页的数据。

totalConversationCount

unsigned int totalConversationCount

搜索一次可获取的消息数量。建议小于 20，以降低性能开销。

是否必填：必填。

conversationMessageCount

unsigned int conversationMessageCount

搜索一次，可获取单个会话的本地消息数量，建议小于 10，以降低性能开销。

keywords

NSArray<NSString *> * keywords

搜索关键字，最多支持 5 个，否则会报错。例如：传入 "1" 和 "2"，则搜索结果只会展示消息同时包含 "1" 和 "2" 这两个关键字的会话。

messageTypes

NSArray<NSNumber *> messageTypes

消息类型，可用于指定消息类型。支持传入多个类型。详情请参考 ZIMMessageType。

subMessageTypes

NSArray<NSNumber *> subMessageTypes

自定义消息的子类型，取值范围为 [0,200]。开发者可基于此搜索具体的自定义类型。

senderUserIDs

NSArray<NSString *> senderUserIDs

发送用户 ID，最多支持 5 个。例如，传入 "zego2023"，则搜索结果只会展示 "zego2023" 用户发过消息的会话。

startTime

long long startTime

搜索的起始时间点，单位：毫秒，默认为 0，格式：UTC 时间戳。

endTime

long long endTime

搜索的结束时间点，必须大于 startTime，单位：毫秒，默认为 0，格式：UTC 时间戳。

ZIMConversationSearchInfo

会话搜索信息。

Declared in ZIMDefines.h

属性

conversationID

public NSString * conversationID

要搜索的本地消息的会话 ID。

conversationType

public ZIMConversationType conversationType

会话类型。

totalMessageCount

public unsigned int totalMessageCount

总消息条数。

messageList

public NSArray<ZIMMessage *> * messageList

搜索到的消息列表

ZIMConversationTotalUnreadMessageCountQueryConfig

查询会话未读消息总数的相关配置项。

详情

查询会话未读消息总数时可配置的过滤项。

Declared in ZIMDefines.h

属性

marks

public NSArray<NSNumber *> * marks

业务场景：需要查询包含指定的会话标记时可使用该过滤项。

conversationTypes

public NSArray<NSNumber *> * conversationTypes

会话类型。仅支持单聊和群聊。

业务场景：需要按照会话类型查询时可使用该过滤项。

ZIMConversationsAllDeletedInfo

删除全部会话通知的信息。

详情

删除全部会话通知的信息。

Declared in ZIMDefine.h

属性

count

public unsigned int count

会话被删除的数目。

ZIMCustomMessage

自定义消息对象。

详情

标识一条自定义消息。

支持版本：2.8.0 及以上。
注意事项：回调时若基类的 Type 参数为 Custom，可将基类消息对象强转为此类。

Declared in ZIMDefines.h

属性

message

public NSString * message

消息的文本内容，应为标准 UTF-8 字符串。

是否必填：发送端必填，否则消息会发送失败。

subType

public unsigned int subType

消息的子类型，用于客户自定义不同自定义消息的用法。取值范围为 [0, 200]。

是否必填：发送端必填，否则消息会发送失败。

searchedContent

public NSString * searchedContent

自定义消息的检索字段。由于无法通过直接搜索 message 字段来搜索自定义消息，您可把该自定义消息中希望被搜索的内容（如投票的标题等）拼接后放到此参数（长度上限默认为 64 字节），以便后续搜索。

type

public ZIMMessageType type

消息类型。

messageID

public long long messageID

标识这条消息的唯一 ID。

业务场景：可用于索引其他消息。

注意事项：开发者主动创建一条消息时，不需要修改这个参数，此参数仅在回调时有值。

timestamp

public unsigned long long timestamp

标识一条消息的发送时间。

业务场景：用于呈现一条消息的发送时间，并可用于消息排序。

注意事项：此为标准 UNIX 时间戳，单位为毫秒。

senderUserID

public NSString * senderUserID

展示本条消息发送者的 userID。

conversationID

public NSString * conversationID

会话的 ID，相同会话类型下的 ID 是唯一的。

direction

public ZIMMessageDirection direction

用于描述消息的方向是发送还是接收。

sentStatus

public ZIMMessageSentStatus sentStatus

描述消息的发送状态。

conversationType

public ZIMConversationType conversationType

该消息所属会话的类型。

conversationSeq

public unsigned long long conversationSeq

表示该消息在会话中的序号。

orderKey

public long long orderKey

orderKey 越大消息越新，可用于消息排序。

localMessageID

public long long localMessageID

SDK 本地生成的 MessageID,开发者无需关注。

isUserInserted

public BOOL isUserInserted

该消息是否是开发者通过 [insertMessageToLocalDB] 接口插入的消息。

默认值：false。

receiptStatus

public ZIMMessageReceiptStatus receiptStatus

描述该消息的回执状态。

业务场景：用于在回执消息中，判断当前消息是处于什么状态。

extendedData

public NSString extendedData

消息拓展字段。

业务场景：可为消息附加拓展字段，然后发送给对端。
是否必填：否。

支持版本：2.6.0 及以上。
注意事项：长度为1k，可联系技术支持进行配置。

localExtendedData

public NSString * localExtendedData

isBroadcastMessage

public BOOL isBroadcastMessage

该消息是否是全员推送消息。

是否必填：SDK内部赋值。

isMentionAll

public BOOL isMentionAll

是否需要提醒所有人。业务表现可为“@所有人”。

业务场景：例如在群或者房间可使用。
是否必填：否。
默认值：false。
建议值：如果需要提醒所有人，可以设置为 true。

注意事项：该值并不会在消息文本上增加 @所有人的字样，需要开发者自行实现。

支持版本 : 2.14.0 及以上。

mentionedUserIDs

public NSArray\<NSString *> * mentionedUserIDs

提醒一批相关的用户。业务表现可为“@某用户”。

业务场景：发消息时可以带上
是否必填：否。

注意事项：该值并不会在消息文本上增加 @某用户的字样，需要开发者自行实现。

支持版本 : 2.14.0 及以上。

messageSeq

public unsigned long long messageSeq

表示该消息在会话中的序号。

rootRepliedCount

public unsigned int rootRepliedCount

回复消息树对应的根消息的回复消息数量。

repliedInfo

public ZIMMessageRepliedInfo repliedInfo

回复消息引用的源消息的信息。

editorUserID

public NSString * editorUserID

本条消息最新的编辑者的 userID。

editedTime

public unsigned long long editedTime

本条消息最新的编辑时间戳。

isGroupTargetedMessage

public BOOL isGroupTargetedMessage

标识该消息是否为群定向消息。

pinnedUserID

public NSString * pinnedUserID

该消息的最后一次置顶的置顶者。

业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。

pinnedTime

public long long pinnedTime

该消息最后一次置顶的置顶时间。

业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。

ZIMCustomMessageLiteInfo

自定义消息的简要对象。

详情

标识一条自定义消息。

Declared in ZIMDefines.h

属性

message

public NSString * message

消息的文本内容，为标准 UTF-8 字符串。

是否必填：发送端必填，否则消息会发送失败。

subType

public unsigned int subType

消息的子类型，用于客户自定义不同自定义消息的用法。取值范围为 [0, 200]。

是否必填：发送端必填，否则消息会发送失败。

searchedContent

public NSString * searchedContent

type

public ZIMMessageType type

消息类型。

ZIMDefines

方法

ZIMBlacklistUsersAddedCallback

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

添加用户到黑名单的操作结果回调。

参数

名称	类型	描述
errorUserList	NSArray<ZIMErrorUserInfo >	拉黑失败的 userInfo 列表。
errorInfo	ZIMError *	添加用户到黑名单返回的错误码。0 代表成功，非 0 为失败。若出现失败时，开发者应查看官网错误码文档查询解决方案。

详情

添加用户到黑名单的操作结果回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否添加到黑名单成功。
通知时机：当开发者调用 [addUsersToBlacklistWithUserIDs] 接口时，会触发该回调。
相关接口：通过 [addUsersToBlacklistWithUserIDs] 添加黑名单。

支持版本：2.13.0 及以上。

ZIMFriendAddedCallback

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

添加好友结果回调。

参数

名称	类型	描述
friendInfo	ZIMFriendInfo	好友信息。
errorInfo	ZIMError *	添加好友返回的错误码。0 代表成功，非 0 为失败。若出现失败时，开发者应查看官网错误码文档查询解决方案。

详情

添加好友的结果的返回。

业务场景：进行确添加好友操作后，成功与否可以通过该回调得知。
相关接口：[addFriendByUserID]，添加好友。

支持版本：2.13.0 及以上。

ZIMFriendAliasUpdatedCallback

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

更新好友备注的返回结果。

参数

名称	类型	描述
friendInfo	ZIMFriendInfo	好友信息。
errorInfo	ZIMError *	更新好友备注的错误码。0 代表成功，非 0 为失败。若出现失败时，开发者应查看官网错误码文档查询解决方案。

详情

更新好友备注的返回结果。

业务场景：进行更新好友备注操作后，成功与否可以通过该回调得知。
相关接口：[updateFriendAlias]，更新好友备注。

ZIMFriendApplicationAcceptedCallback

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

接受好友申请的返回结果。

参数

名称	类型	描述
friendInfo	ZIMFriendInfo	好友信息。
errorInfo	ZIMError *	同意好友申请的错误码。0 代表成功，非 0 为失败。若出现失败时，开发者应查看官网错误码文档查询解决方案。

详情

接受好友申请的返回结果。

业务场景：进行接受好友申请操作后，成功与否可以通过该回调得知。
相关接口：[acceptFriendApplicationFromUserID]，接受好友申请。

ZIMFriendApplicationListQueriedCallback

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

发起好友申请的返回结果。

参数

名称	类型	描述
applicationList	NSArray<ZIMFriendApplicationInfo >	好友申请信息列表。
nextFlag	int	当前查询锚点下标。
errorInfo	ZIMError *	查询好友申请列表错误码。0 代表成功，非 0 为失败。若出现失败时，开发者应查看官网错误码文档查询解决方案。

详情

发起好友申请的返回结果。

业务场景：进行发起好友申请操作后，成功与否可以通过该回调得知。
相关接口：[sendFriendApplicationToUserID]，发起好友申请。

支持版本：2.14.0 及以上。

ZIMFriendApplicationRejectedCallback

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

拒绝好友申请的返回结果。

参数

名称	类型	描述
userInfo	ZIMUserInfo	申请人用户信息。
errorInfo	ZIMError *	同意好友申请的错误码。0 代表成功，非 0 为失败。若出现失败时，开发者应查看官网错误码文档查询解决方案。

详情

拒绝好友申请的返回结果。

业务场景：进行拒绝好友申请操作后，成功与否可以通过该回调得知。
相关接口：[rejectFriendApplicationFromUserID]，拒绝好友申请。

ZIMFriendApplicationSentCallback

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

发起好友申请的返回结果。

参数

名称	类型	描述
applicationInfo	ZIMFriendApplicationInfo	好友申请信息。
errorInfo	ZIMError *	发起好友申请的错误码。0 代表成功，非 0 为失败。若出现失败时，开发者应查看官网错误码文档查询解决方案。

详情

发起好友申请的返回结果。

业务场景：进行发起好友申请操作后，成功与否可以通过该回调得知。
相关接口：[sendFriendApplicationToUserID]，发起好友申请。

支持版本：2.14.0 及以上。

ZIMFriendAttributesUpdatedCallback

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

更新好友属性的返回结果。

参数

名称	类型	描述
friendInfo	ZIMFriendInfo	好友信息。
errorInfo	ZIMError *	更新好友属性错误码。0 代表成功，非 0 为失败。若出现失败时，开发者应查看官网错误码文档查询解决方案。

详情

更新好友属性的返回结果。

业务场景：进行更新好友属性操作后，成功与否可以通过该回调得知。
相关接口：[updateFriendAttributes]，更新好友属性。

ZIMFriendListQueriedCallback

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

查询好友列表的返回结果。

参数

名称	类型	描述
friendList	NSArray<ZIMFriendInfo >	查询好友列表的返回结果。
nextFlag	int	当前查询锚点下标。
errorInfo	ZIMError *	查询好友列表返回的错误码。0 代表成功，非 0 为失败。若出现失败时，开发者应查看官网错误码文档查询解决方案。

详情

查询好友列表的返回结果。

业务场景：进行查询好友列表操作后，成功与否可以通过该回调得知。
相关接口：[queryFriendListWithConfig]，查询好友列表。

ZIMFriendsDeletedCallback

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

删除好友的返回结果。

参数

名称	类型	描述
errorUserList	NSArray<ZIMErrorUserInfo >	删除失败的用户id及原因列表。
errorInfo	ZIMError *	添加用户到黑名单返回的错误码。0 代表成功，非 0 为失败。若出现失败时，开发者应查看官网错误码文档查询解决方案。

详情

删除好友的返回结果。

业务场景：进行删除好友操作后，成功与否可以通过该回调得知。
相关接口：[deleteFriendsByUserIDs]，批量删除好友。

支持版本：2.14.0 及以上。

ZIMFriendsInfoQueriedCallback

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

批量查询好友信息的返回结果。

参数

名称	类型	描述
friendInfos	NSArray<ZIMFriendInfo >	好友信息。
errorUserList	NSArray<ZIMErrorUserInfo >	查询失败的用户id及原因。
errorInfo	ZIMError *	发起好友申请的错误码。0 代表成功，非 0 为失败。若出现失败时，开发者应查看官网错误码文档查询解决方案。

详情

批量查询好友信息的返回结果。

业务场景：进行批量查询好友信息操作后，成功与否可以通过该回调得知。
相关接口：[queryFriendsInfoByUserIDs]，批量查询好友信息。

ZIMFriendsSearchedCallback

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

搜索本地好友的返回结果。

参数

名称	类型	描述
friendInfos	NSArray<ZIMFriendInfo >	好友信息列表。
nextFlag	int	当前查询锚点下标。
errorInfo	ZIMError *	查询好友列表返回的错误码。0 代表成功，非 0 为失败。若出现失败时，开发者应查看官网错误码文档查询解决方案。

详情

搜索本地好友的返回结果。

业务场景：进行本地好友搜索操作后，成功与否可以通过该回调得知。
相关接口：[searchLocalFriendsWithConfig]，搜索本地好友。

ZIMBlacklistUsersRemovedCallback

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

移除用户出黑名单的操作结果回调。

参数

名称	类型	描述
errorUserList	NSArray<ZIMErrorUserInfo >	移除失败的 userInfo 列表。
errorInfo	ZIMError *	黑名单删除的错误码。0 代表成功，非 0 为失败。若出现失败时，开发者应查看官网错误码文档查询解决方案。

详情

移除用户出黑名单的操作结果回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否添加到黑名单成功。
通知时机：当开发者调用 [removeUsersFromBlacklistWithUserIDs] 接口时，会触发该回调。
相关接口：通过 [removeUsersFromBlacklistWithUserIDs] 将用户移除出黑名单。

支持版本：2.13.0 及以上。

ZIMBlacklistQueriedCallback

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

查询黑名单结果回调。

参数

名称	类型	描述
blacklist	NSArray<ZIMUserInfo >	SDK 本地存储的黑名单数据。
nextFlag	unsigned int	详情描述：下一个标志。为 0 表示黑名单查询完毕。不为 0 时表示黑名单查询未完成，再次调用查询接口，传入此 nextFlag 即可继续查询。
errorInfo	ZIMError *	查询的错误码。0 代表成功，非 0 为失败。若出现查询失败时，开发者应查看官网错误码文档查询解决方案。

详情

查询黑名单结果回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否查询成功。
通知时机：当开发者调用 [queryBlacklistWithConfig] 接口时，会触发该回调。
相关接口：通过 [queryBlacklistWithConfig] 查询黑名单列表。

支持版本：2.13.0 及以上。

ZIMFriendsRelationCheckedCallback

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

检查好友关系的返回结果。

参数

名称	类型	描述
errorUserList	NSArray<ZIMErrorUserInfo >	检查好友关系失败的用户id及原因列表。
relationInfos	NSArray<ZIMFriendRelationInfo >	好友关系信息列表。
errorInfo	ZIMError *	查询的错误码。0 代表成功，非 0 为失败。若出现查询失败时，开发者应查看官网错误码文档查询解决方案。

详情

发起好友申请的返回结果。

业务场景：进行检查好友关系操作后，成功与否可以通过该回调得知。
相关接口：[checkFriendsRelationByUserIDs]，检查好友关系。

支持版本：2.14.0 及以上。

ZIMBlacklistCheckedCallback

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

黑名单检查结果回调。

参数

名称	类型	描述
isUserInBlacklist	BOOL	该用户是否在黑名单
errorInfo	ZIMError *	黑名单检查返回的错误码。0 代表检查成功，非 0 为失败。若出现失败时，开发者应查看官网错误码文档查询解决方案。

详情

黑名单检查结果回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否检查成功。
通知时机：当开发者调用 [checkUserIsInBlackListByUserID] 接口时，会触发该回调。
相关接口：通过 [checkUserIsInBlackListByUserID] 检查用户是否在黑名单。

支持版本：2.13.0 及以上。

ZIMSubscribedUserStatusListQueriedCallback

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

querySubscribedUserStatusList 查询当前用户订阅列表操作的结果回调。

参数

名称	类型	描述
userStatusSubscriptionList	NSArray< ZIMUserStatusSubscription >	订阅列表中用户的订阅信息。

详情

querySubscribedUserStatusList 查询当前用户订阅列表操作的结果回调。

ZIMUserCustomStatusUpdatedCallback

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

更新自定义状态的回调。

参数

名称	类型	描述
errorInfo	ZIMError	更新自定义状态的错误信息。
customStatus	NSString *	自定义状态。

详情

更新自定义状态的回调。

ZIMUsersStatusQueriedCallback

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

批量查询用户在线状态接口 queryUsersStatus 的结果回调。

参数

名称	类型	描述
userStatusList	NSArray<ZIMUserStatus >	被查询用户的在线状态信息列表。
errorUserList	NSArray< ZIMErrorUserInfo >	查询失败的用户列表。
errorInfo	ZIMError *	查询操作的结果，包含错误码与错误信息。

详情

批量查询用户在线状态接口 queryUsersStatus 的结果回调。

ZIMUsersStatusSubscribedCallback

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

subscribeUsersStatus 批量订阅接口的操作结果回调。

参数

名称	类型	描述
errorUserList	NSArray<ZIMErrorUserInfo > _Nonnull	订阅失败的用户列表。
errorInfo	ZIMError *_Nonnull	操作结果，包含错误码与错误信息。

详情

subscribeUsersStatus 批量订阅接口的操作结果回调。

ZIMUsersStatusUnsubscribedCallback

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

unsubscribeUsersStatus 批量取消订阅接口的操作回调。

参数

名称	类型	描述
errorUserList	NSArray<ZIMErrorUserInfo > _Nonnull	取消失败的用户列表。
errorInfo	ZIMError *	批量取消操作的结果，包含错误信息与错误码。

详情

unsubscribeUsersStatus 批量取消订阅接口的操作回调。

ZIMTokenRenewedCallback

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

更新 Token 的结果的回调。

参数

名称	类型	描述
token	NSString *	需要更新的鉴权 Token。
errorInfo	ZIMError	错误信息。错误码值为 0 时更新成功，非 0 时更新失败。若出现返回非 0 错误码的时候，开发者应到官网错误码文档中查询解决方案。

详情

开发者更新 Token 后，执行结果的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否更新 Token 成功。
通知时机：当开发者调用 [renewToken] 接口时，会触发该回调。
相关接口：通过 [renewToken] 更新 Token，更新 Token 的成功与否会通过本回调通知。

支持版本：1.1.0 及以上。

ZIMUsersInfoQueriedCallback

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

查询 userInfo 的回调。

参数

名称	类型	描述
userList	NSArray<ZIMUserFullInfo >	查询到的 userInfo 列表。
errorUserList	NSArray<ZIMErrorUserInfo>	查询失败的 userInfo 列表。
errorInfo	ZIMError *	查询的错误码。0 代表登录成功，非 0 为登录失败。若出现查询失败时，开发者应查看官网错误码文档查询解决方案。

详情

开发者查询用户信息后的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否登录成功。
通知时机：当开发者调用 [queryUsersInfo] 接口时，会触发该回调。
相关接口：通过 [queryUsersInfo] 查询。

支持版本：2.2.0 及以上。

ZIMUserNameUpdatedCallback

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

更新 user name 的回调。

参数

名称	类型	描述
userName	NSString *	更新后的 user name。
errorInfo	ZIMError	查询的错误码。0 代表登录成功，非 0 为登录失败。若出现查询失败时，开发者应查看官网错误码文档查询解决方案。

详情

开发者更新用户名称后的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否操作成功。
通知时机：当开发者调用 [updateUserName] 接口时，会触发该回调。
相关接口：[updateUserName]。

支持版本：2.2.0 及以上。

ZIMUserAvatarUrlUpdatedCallback

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

更新 user avatar URL 的回调。

参数

名称	类型	描述
userAvatarUrl	NSString *	更新后的 user avatar URL。
errorInfo	ZIMError	查询的错误码。0 代表登录成功，非 0 为登录失败。若出现查询失败时，开发者应查看官网错误码文档查询解决方案。

详情

开发者更新用户头像 URL 后的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否操作成功。
通知时机：当开发者调用 [updateUserAvatarUrl] 接口时，会触发该回调。
相关接口：[updateUserAvatarUrl] 。

支持版本：2.3.0 及以上。

ZIMUserExtendedDataUpdatedCallback

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

更新 user extended data 的回调。

参数

名称	类型	描述
extendedData	NSString *	更新后的 user extended data。
errorInfo	ZIMError	查询的错误码。0 代表登录成功，非 0 为登录失败。若出现查询失败时，开发者应查看官网错误码文档查询解决方案。

详情

开发者修改用户扩展信息后的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否操作成功。
通知时机：当开发者调用 [updateUserExtendedData] 接口时，会触发该回调。
相关接口：通过 [updateUserExtendedData] 查询。

支持版本：2.2.0 及以上。

ZIMLoggedInCallback

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

登录结果的回调。

参数

名称	类型	描述
errorInfo	ZIMError	日志上传结果的错误信息。信息中的错误码值 0 代表成功，非 0 为失败。若出现上传失败时，开发者应查看官网错误码文档查询解决方案。

详情

开发者登录结果的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否登录成功。
通知时机：当开发者调用 [login] 接口时，会触发该回调。

支持版本：1.2.0 及以上。

ZIMLogUploadedCallback

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

日志上传结果的回调。

参数

名称	类型	描述
errorInfo	ZIMError	日志上传结果的错误信息。信息中的错误码值 0 代表成功，非 0 为失败。若出现上传失败时，开发者应查看官网错误码文档查询解决方案。

详情

开发者进行上传日志后，执行结果的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否上传成功。
通知时机：当开发者调用 [uploadLog] 接口时，会触发该回调。
相关接口：通过 [uploadLog] 调用日志上传，成功与否会通过本回调通知。

支持版本：1.2.0 及以上。

ZIMSelfUserInfoQueriedCallback

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

查询个人用户信息、规则的结果回调。

参数

名称	类型	描述
selfUserInfo	ZIMSelfUserInfo	自身用户信息、规则数据类。
errorInfo	ZIMError	包含错误码，错误信息。

详情

查询个人用户信息、规则的结果回调。

ZIMUserOfflinePushRuleUpdatedCallback

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

更新用户离线推送规则的结果回调。

参数

名称	类型	描述
offlinePushRule	ZIMUserOfflinePushRule	更新后的离线推送规则。
errorInfo	ZIMError	包含错误码与详细信息。

详情

更新用户离线推送规则的结果回调。

ZIMCallInvitationListQueriedCallback

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

查询呼叫列表的结果回调。

参数

名称	类型	描述
callList	NSArray<ZIMCallInfo >	查询返回的呼叫信息列表
nextFlag	long long	分页查询返回的锚点，下次查询时传入可在上次查询的基础上继续查询。
errorInfo	ZIMError *	查询返回的错误信息。

详情

查询呼叫列表的结果回调。

ZIMCallingInvitationSentCallback

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

邀请加入当前呼叫的结果回调。

参数

名称	类型	描述
callID	NSString *	当前呼叫邀请的 callID。
info	ZIMCallingInvitationSentInfo *	呼叫中邀请已发送信息。
errorInfo	ZIMError *	错误信息，详情请参考常见错误码文档。

详情

邀请加入当前呼叫的结果回调。

ZIMCallQuitSentCallback

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

退出呼叫操作的回调闭包。

参数

名称	类型	描述
callID	NSString *	退出的 callID。
info	ZIMCallQuitSentInfo *	退出的信息。
errorInfo	ZIMError *	错误信息。

详情

退出呼叫操作的回调闭包。

ZIMCallEndSentCallback

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

结束呼叫的结果回调。

参数

名称	类型	描述
callID	NSString *	呼叫的 callID。
info	ZIMCallInvitationEndedInfo *	结束呼叫返回的信息。
errorInfo	ZIMError *	结束呼叫返回的错误信息。

详情

结束呼叫的结果回调。

ZIMCallJoinSentCallback

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

加入呼叫的结果回调。

名称	类型	描述
callID	NSString *	呼叫的 callID。
info	ZIMCallJoinSentInfo *	加入呼叫返回的信息。
errorInfo	ZIMError *	加入呼叫返回的错误信息。

ZIMCallInvitationSentCallback

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

发送呼叫邀请的操作回调。

参数

名称	类型	描述
callID	NSString *	已创建的呼叫邀请ID。
info	ZIMCallInvitationSentInfo *	发送呼叫邀请信息。
errorInfo	ZIMError *	发送呼叫邀请的错误码。0 代表发送呼叫邀请成功，非 0 为发送呼叫邀请失败。若出现发送呼叫邀请失败时，开发者应查看官网错误码文档查询解决方案。

详情

发送呼叫邀请的操作回调。

业务场景：进行发送呼叫邀请操作后，成功与否可以通过该回调得知。
通知时机：发送呼叫邀请操作结束后的结果返回。
相关接口：[callInvite]，发送呼叫邀请。

支持版本：2.0.0。

ZIMCallCancelSentCallback

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

取消呼叫邀请的操作回调。

参数

名称	类型	描述
callID	NSString *	呼叫邀请唯一 ID
errorInvitees	NSArray<NSString *>	取消呼叫邀请失败的用户。
errorInfo	ZIMError	取消呼叫邀请的错误码。0 代表取消呼叫邀请成功，非 0 为取消呼叫邀请失败。若出现取消呼叫邀请失败时，开发者应查看官网错误码文档查询解决方案。

详情

取消呼叫邀请的操作回调。

业务场景：进行取消呼叫邀请操作后，成功与否可以通过该回调得知。
通知时机：取消呼叫邀请操作结束后的结果返回。
相关接口：[callCancel]，取消呼叫邀请。

支持版本：2.0.0。

ZIMCallAcceptanceSentCallback

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

接受呼叫邀请的操作回调。

参数

名称	类型	描述
callID	NSString *	呼叫邀请唯一ID
errorInfo	ZIMError	接受呼叫邀请的错误码。0 代表接受呼叫邀请成功，非 0 为接受呼叫邀请失败。若出现接受呼叫邀请失败时，开发者应查看官网错误码文档查询解决方案。

详情

接受呼叫邀请的操作回调。

业务场景：进行接受呼叫邀请操作后，成功与否可以通过该回调得知。
通知时机：接受呼叫邀请操作结束后的结果返回。
相关接口：[callAccept]，接受呼叫邀请。

支持版本：2.0.0。

ZIMCallRejectionSentCallback

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

拒绝呼叫邀请的操作回调。

参数

名称	类型	描述
callID	NSString *	呼叫邀请唯一ID
errorInfo	ZIMError	拒绝呼叫邀请的错误码。0 代表拒绝呼叫邀请成功，非 0 为拒绝呼叫邀请失败。若出现拒绝呼叫邀请失败时，开发者应查看官网错误码文档查询解决方案。

详情

拒绝呼叫邀请的操作回调。

业务场景：进行拒绝呼叫邀请操作后，成功与否可以通过该回调得知。
通知时机：拒绝呼叫邀请操作结束后的结果返回。
相关接口：[callReject]，拒绝呼叫邀请。

支持版本：2.0.0。

ZIMGroupCreatedCallback

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

创建群的结果的返回。

参数

名称	类型	描述
groupInfo	ZIMGroupFullInfo *	群组信息。
userList	NSArray<ZIMGroupMemberInfo *>	用户列表。
errorUserList	NSArray<ZIMErrorUserInfo *>	错误用户列表。
errorInfo	ZIMError *	创建群组的错误码。0 代表创建群组成功，非 0 为创建群组失败。若出现创建群组失败时，开发者应查看官网错误码文档查询解决方案。

详情

群创建操作结果的返回。

业务场景：进行群创建操作后，成功与否可以通过该回调得知。
通知时机：群创建操作结束后的结果返回。
相关接口：[createGroup]，创建群组。

ZIMGroupsSearchedCallback

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

搜索群的结果的返回。

参数

名称	类型	描述
groupSearchInfoList	NSArray<ZIMGroupSearchInfo *>	群组信息。
nextFlag	unsigned int	分页拉取标志，搜索下一页的锚点。
errorInfo	ZIMError *	搜索群组的错误码。0 代表搜索群组成功，非 0 为搜索群组失败。若出现搜索群组失败时，开发者应查看官网错误码文档查询解决方案。

详情

搜索群操作结果的返回。

业务场景：进行群搜索操作后，成功与否可以通过该回调得知。
相关接口：[searchLocalGroupsWithConfig]，搜索群组。

ZIMGroupMembersSearchedCallback

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

搜索群成员的结果的返回。

参数

名称	类型	描述
groupID	NSString *	群 ID。
userList	NSArray<ZIMGroupMemberInfo *>	符合搜索条件的群成员列表。
nextFlag	unsigned int	分页拉取标志，搜索下一页的锚点。
errorInfo	ZIMError *	搜索群成员的错误码。0 代表搜索群成员成功，非 0 为搜索群成员失败。若出现搜索群成员失败时，开发者应查看官网错误码文档查询解决方案。

详情

搜索群成员的结果的返回。

业务场景：进行群成员搜索操作后，成功与否可以通过该回调得知。
相关接口：[searchLocalGroupMembersByGroupID]，搜索群成员。

ZIMGroupJoinedCallback

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

加入群的结果的返回。

参数

名称	类型	描述
groupInfo	ZIMGroupFullInfo	群信息。
errorInfo	ZIMError	加入群组的错误码。0 代表加入群组成功，非 0 为加入群组失败。若出现加入群组失败时，开发者应查看官网错误码文档查询解决方案。

详情

群加入操作结果的返回。

业务场景：进行群加入操作后，成功与否可以通过该回调得知。
通知时机：群加入操作结束后的结果返回。
相关接口：[joinGroup]，加入群组。[leaveGroup]，离开群组。

ZIMGroupLeftCallback

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

离开群的结果的返回。

参数

名称	类型	描述
groupID	NSString *	群组 ID。
errorInfo	ZIMError	离开群组的错误码。0 代表离开群组成功，非 0 为离开群组失败。若出现离开群组失败时，开发者应查看官网错误码文档查询解决方案。

详情

群离开操作结果的返回。

业务场景：进行群离开操作后，成功与否可以通过该回调得知。
通知时机：群离开操作结束后的结果返回。
相关接口：[leaveGroup]，离开群组。[joinGroup]，进入群组。

ZIMGroupDismissedCallback

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

解散群的结果的返回。

参数

名称	类型	描述
groupID	NSString *	群组 ID。
errorInfo	ZIMError	解散群组的错误码。0 代表解散群组成功，非 0 为解散群组失败。若出现解散群组失败时，开发者应查看官网错误码文档查询解决方案。

详情

群解散操作结果的返回。

业务场景：进行群解散操作后，成功与否可以通过该回调得知。
通知时机：群解散操作结束后的结果返回。
相关接口：[createGroup]，创建群组。[dismissGroup]，解散群租。

ZIMGroupUsersInvitedCallback

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

用户被邀请进群的结果的返回。

参数

名称	类型	描述
groupID	NSString *	群组 ID。
userList	NSArray<ZIMGroupMemberInfo *>	用户列表。
errorUserList	NSArray<ZIMErrorUserInfo *>	邀请失败的用户列表。
errorInfo	ZIMError	邀请用户入群的错误码。0 代表邀请用户入群，非 0为邀请用户入群失败。若出现邀请用户入群失败时，开发者应查看官网错误码文档查询解决方案。

详情

邀请用户进群操作结果的返回。

业务场景：用户被邀请进群后，成功与否可以通过该回调得知。
通知时机：用户被邀请进群后的结果返回。
相关接口：[inviteUsersIntoGroup]，邀请用户进群。

ZIMGroupMemberKickedCallback

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

踢出群成员的结果的返回。

参数

名称	类型	描述
kickedUserIDList	NSArray<NSString *>	被踢出的成员列表。
errorUserList	NSArray<ZIMErrorUserInfo *>	错误的用户列表。
errorInfo	ZIMError *	踢出群成员的错误码。0 代表踢出群成员成功，非 0 为踢出群成员失败。若出现踢出群成员时，开发者应查看官网错误码文档查询解决方案。

详情

踢出群成员操作结果的返回。

业务场景：进行踢出群成员操作后，成功与否可以通过该回调得知。
通知时机：踢出群成员操作结束后的结果返回。
相关接口：[kickGroupMembers]，踢出群成员。

ZIMGroupOwnerTransferredCallback

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

群主转让的结果的返回。

参数

名称	类型	描述
groupID	NSString *	群组ID。
toUserID	NSString *	用户ID。
errorInfo	ZIMError	转让群主的错误码。0 代表转让群主成功，非 0为转让群主失败。若出现转让群主失败时，开发者应查看官网错误码文档查询解决方案。

详情

群主转让操作结果的返回。

业务场景：进行群主转让操作后，成功与否可以通过该回调得知。
通知时机：群主转让操作结束后的结果返回。
相关接口：[transferGroupOwner]，群主转让。

ZIMGroupAliasUpdatedCallback

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

群备注更新的结果回调。

参数

名称	类型	描述
groupID	NSString *	群组 ID。
groupAlias	NSString *	群备注。
errorInfo	ZIMError	更新群备注的错误码。0 代表更新成功，非 0为更新失败。若出现更新失败时，请查看官网错误码文档查询解决方案。

详情

群备注更新操作结果的返回。

业务场景：进行群备注更新操作后，成功与否可以通过该回调得知。
通知时机：群备注更新操作结束后的结果返回。
相关接口：[updateGroupAlias]，更新群备注。

ZIMGroupNameUpdatedCallback

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

群名称更新的结果的返回。

参数

名称	类型	描述
groupID	NSString *	群组ID。
groupName	NSString *	群名称。
errorInfo	ZIMError	更新群名称的错误码。0 代表更新群名称成功，非 0为更新群名称失败。若出现更新群名称失败时，开发者应查看官网错误码文档查询解决方案。

详情

群名称更新操作结果的返回。

业务场景：进行群名称更新操作后，成功与否可以通过该回调得知。
通知时机：群名称更新操作结束后的结果返回。
相关接口：[updateGroupName]，群名称更新。

ZIMGroupMutedCallback

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

群禁言更新的结果的返回。

参数

名称	类型	描述
groupID	NSString *	群组ID。
isMute	BOOL	群禁言或解除群禁言。
mutedInfo	ZIMGroupMuteInfo	群禁言信息。
errorInfo	ZIMError	更新群禁言信息的错误码。0 代表更新群禁言信息成功，非 0为更新群禁言信息失败。若出现更新群禁言信息失败时，开发者应查看官网错误码文档查询解决方案。

详情

群禁言信息更新操作结果的返回。

业务场景：进行群禁言信息更新操作后，成功与否可以通过该回调得知。
通知时机：群禁言信息更新操作结束后的结果返回。
相关接口：[muteGroup]，群禁言。

ZIMGroupMembersMutedCallback

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

群成员禁言更新的结果的返回。

参数

名称	类型	描述
groupID	NSString *	群组ID。
isMute	BOOL	群成员禁言或解除群成员禁言。
duration	int	群成员禁言时长，单位为秒。
mutedUserIDs	NSArray<NSString >	成功被修改禁言状态的群成员 ID 列表。
errorUserList	NSArray<ZIMErrorUserInfo >	修改禁言状态失败的群成员列表。
errorInfo	ZIMError	更新群成员禁言信息的错误码。0 代表更新群成员禁言信息成功，非 0为更新群成员禁言信息失败。若出现更新群成员禁言信息失败时，开发者应查看官网错误码文档查询解决方案。

详情

群成员禁言信息更新操作结果的返回。

业务场景：进行群成员禁言信息更新操作后，成功与否可以通过该回调得知。
通知时机：群成员禁言信息更新操作结束后的结果返回。
相关接口：[muteGroupMembers]，群禁言。

ZIMGroupAvatarUrlUpdatedCallback

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

群头像 URL 更新的结果的返回。

参数

名称	类型	描述
groupID	NSString *	群组ID。
groupAvatarUrl	NSString *	群头像 URL。
errorInfo	ZIMError	更新群头像 URL 的错误码。0 代表更新成功，非 0为更新群名称失败。若出现失败时，开发者应查看官网错误码文档查询解决方案。

详情

群头像 URL 更新操作结果的返回。

业务场景：进行群头像 URL 更新操作后，成功与否可以通过该回调得知。
通知时机：群头像 URL 更新操作结束后的结果返回。
相关接口：[updateGroupAvatarUrl]。

ZIMGroupNoticeUpdatedCallback

void(^ZIMGroupNoticeUpdatedCallback)((const :string &) groupNotice, (ZIMError) errorInfo);

群公告更新的结果的返回。

参数

名称	类型	描述
groupNotice	const std::string &	群公告。
errorInfo	ZIMError	更新群公告的错误码。0 代表更新群公告成功，非 0为更新群公告失败。若出现更新群公告失败时，开发者应查看官网错误码文档查询解决方案。

详情

群公告更新操作结果的返回。

业务场景：进行群公告更新操作后，成功与否可以通过该回调得知。
通知时机：群公告更新操作结束后的结果返回。
相关接口：[updateGroupNotice]，群公告更新。

ZIMGroupJoinModeUpdatedCallback

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

加群验证模式更新的回调。

参数

名称	类型	描述
groupID	NSString *	群组ID。
mode	ZIMGroupJoinMode	加群验证模式。
errorInfo	ZIMError	更新操作的错误码。0 代表更新成功，非 0为更新失败。

详情

加群验证模式更新操作结果的返回。

业务场景：进行加群验证模式更新操作后，成功与否可以通过该回调得知。
通知时机：加群验证模式更新操作结束后的结果返回。
相关接口：[updateGroupJoinMode]，加群验证模式更新。

ZIMGroupInviteModeUpdatedCallback

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

邀请入群验证模式更新的回调。

参数

名称	类型	描述
groupID	NSString *	群组ID。
mode	ZIMGroupInviteMode	邀请入群验证模式。
errorInfo	ZIMError	更新操作的错误码。0 代表更新成功，非 0为更新失败。

详情

邀请入群证模式更新操作结果的返回。

业务场景：进行邀请入群验证模式更新操作后，成功与否可以通过该回调得知。
通知时机：邀请入群验证模式更新操作结束后的结果返回。
相关接口：[updateGroupInviteMode]，邀请入群验证模式更新。

ZIMGroupBeInviteModeUpdatedCallback

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

被邀请入群验证模式更新的回调。

参数

名称	类型	描述
groupID	NSString *	群组ID。
mode	ZIMGroupBeInviteMode	被邀请入群验证模式。
errorInfo	ZIMError	更新操作的错误码。0 代表更新成功，非 0为更新失败。

详情

被邀请入群证模式更新操作结果的返回。

业务场景：进行被邀请入群验证模式更新操作后，成功与否可以通过该回调得知。
通知时机：被邀请入群验证模式更新操作结束后的结果返回。
相关接口：[updateGroupBeInviteMode]，被邀请入群验证模式更新。

ZIMGroupJoinApplicationSentCallback

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

发送加群申请的回调。

参数

名称	类型	描述
groupID	NSString *	群组ID。
errorInfo	ZIMError	更新操作的错误码。0 代表更新成功，非 0为更新失败。

详情

发送加群申请的操作结果的返回。

业务场景：发送加群申请的操作后，成功与否可以通过该回调得知。
相关接口：[sendGroupJoinApplication]，发送加群申请。

ZIMGroupJoinApplicationAcceptedCallback

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

接受加群申请的回调。

参数

名称	类型	描述
groupID	NSString *	群组ID。
userID	NSString *	申请人ID。
errorInfo	ZIMError	更新操作的错误码。0 代表更新成功，非 0为更新失败。

详情

接受加群申请的操作结果的返回。

业务场景：接受加群申请的操作后，成功与否可以通过该回调得知。
相关接口：[acceptGroupJoinApplication]，接受加群申请。

ZIMGroupJoinApplicationRejectedCallback

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

拒绝加群申请的回调。

参数

名称	类型	描述
groupID	NSString *	群组ID。
userID	NSString *	申请人ID。
errorInfo	ZIMError	更新操作的错误码。0 代表更新成功，非 0为更新失败。

详情

拒绝加群申请的操作结果的返回。

业务场景：拒绝加群申请的操作后，成功与否可以通过该回调得知。
相关接口：[rejectGroupJoinApplication]，拒绝加群申请。

ZIMGroupInviteApplicationsSentCallback

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

发送邀请入群申请的回调。

参数

名称	类型	描述
groupID	NSString *	群组ID。
errorUserList	NSArray<ZIMErrorUserInfo> *	邀请失败的用户列表。
errorInfo	ZIMError	更新操作的错误码。0 代表更新成功，非 0为更新失败。

详情

发送邀请入群申请的操作结果的返回。

业务场景：发送邀请入群申请的操作后，成功与否可以通过该回调得知。
相关接口：[sendGroupInviteApplications]，发送邀请入群申请。

ZIMGroupInviteApplicationAcceptedCallback

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

接受邀请入群申请的回调。

参数

名称	类型	描述
groupID	NSString *	群组ID。
inviterUserID	NSString *	邀请人ID。
errorInfo	ZIMError	更新操作的错误码。0 代表更新成功，非 0为更新失败。

详情

接受邀请入群申请的操作结果的返回。

业务场景：接受邀请入群申请的操作后，成功与否可以通过该回调得知。
相关接口：[acceptGroupInviteApplication]，接受邀请入群申请。

ZIMGroupApplicationListQueriedCallback

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

查询入群申请列表的回调。

参数

名称	类型	描述
applicationList	NSArray<ZIMGroupApplicationInfo> *	入群申请列表。
nextFlag	unsigned int	下一个标志。
errorInfo	ZIMError	更新操作的错误码。0 代表更新成功，非 0为更新失败。

详情

入群申请列表查询结果的返回。

业务场景：进行入群申请列表查询后，成功与否可以通过该回调得知。
相关接口：[queryGroupApplicationList]，查询入群申请列表。

ZIMGroupInviteApplicationRejectedCallback

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

拒绝邀请入群申请的回调。

参数

名称	类型	描述
groupID	NSString *	群组ID。
inviterUserID	NSString *	邀请人ID。
errorInfo	ZIMError	更新操作的错误码。0 代表更新成功，非 0为更新失败。

详情

拒绝邀请入群申请的操作结果的返回。

业务场景：拒绝邀请入群申请的操作后，成功与否可以通过该回调得知。
相关接口：[rejectGroupInviteApplication]，拒绝邀请入群申请。

ZIMGroupInfoQueriedCallback

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

查询群信息的结果的返回。

参数

名称	类型	描述
groupInfo	ZIMGroupFullInfo	群信息。
errorInfo	ZIMError	查询群组信息的错误码。0 代表查询群组信息成功，非 0 为查询群组信息失败。若出现查询群组信息失败时，开发者应查看官网错误码文档查询解决方案。

详情

群信息查询结果的返回。

业务场景：进行群信息查询后，成功与否可以通过该回调得知。
通知时机：群信息查询结束后的结果返回。
相关接口：[queryGroupInfo]，群信息查询。

ZIMGroupListQueriedCallback

void(^ZIMGroupListQueriedCallback)((NSArray<ZIMGroupInfo *>) groupList, (ZIMError) errorInfo);

查询群列表的结果的返回。

参数

名称	类型	描述
groupList	NSArray<ZIMGroupInfo *>	群列表。
errorInfo	ZIMError	查询群组列表的错误码。0 代表查询群组列表成功，非 0 为查询群组列表失败。若出现查询群组列表失败时，开发者应查看官网错误码文档查询解决方案。

详情

群列表查询结果的返回。

业务场景：进行群列表查询后，成功与否可以通过该回调得知。
通知时机：群列表查询结束后的结果返回。
相关接口：[queryGroupList]，查询群组列表。

ZIMGroupAttributesOperatedCallback

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

群属性操作结果的返回。

参数

名称	类型	描述
groupID	NSString *	群组ID。
errorKeys	NSArray<String *>	错误的键。
errorInfo	ZIMError	设置群组属性的错误码。0 代表设置群组属性成功，非 0 为设置群组属性失败。若出现设置群组属性失败时，开发者应查看官网错误码文档查询解决方案。

详情

群属性操作结果的返回。

业务场景：进行自定义属性操作后，成功与否可以通过该回调得知。
通知时机：群属性操作结束后的结果返回。
相关接口：[setGroupAttributes]，设置房间属性。[deleteGroupAttributes]，删除房间属性。

ZIMGroupAttributesQueriedCallback

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

查询群属性结果的返回。

参数

名称	类型	描述
groupID	NSString *	群组 ID。
groupAttributes	NSDictionary<NSString,NSString>	群属性。
errorInfo	ZIMError *	查询群组属性的错误码。0 代表查询群组属性成功，非 0 为查询群组属性失败。若出现查询群组属性失败时，开发者应查看官网错误码文档查询解决方案。

详情

群属性查询结果的返回。

业务场景：进行自定义属性查询后，成功与否可以通过该回调得知。
通知时机：群属性查询后的结果返回。
相关接口：[queryGroupAttributes]，查询房间属性。

ZIMGroupMemberRoleUpdatedCallback

void(^ZIMGroupMemberRoleUpdatedCallback)((NSString *) groupID, (const :string) forUserID, (int) role, (ZIMError) errorInfo);

成员角色更新的结果的返回。

参数

名称	类型	描述
groupID	NSString *	群组 ID。
forUserID	const std::string	用户ID。
role	int	角色。
errorInfo	ZIMError	群成员角色更新的错误码。0 代表群成员角色更新成功，非 0为群成员角色更新失败。若出现群成员角色更新失败时，开发者应查看官网错误码文档查询解决方案。

详情

成员角色更新操作结果的返回。

业务场景：进行成员角色更新操作后，成功与否可以通过该回调得知。
通知时机：成员角色更新操作结束后的结果返回。
相关接口：[setGroupMemberRole]，成员角色更新。

ZIMGroupMemberNicknameUpdatedCallback

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

群成员昵称更新的结果的返回。

参数

名称	类型	描述
groupID	NSString *	群组 ID。
forUserID	NSString *	用户ID。
nickname	NSString *	用户昵称。
errorInfo	ZIMError *	设置群成员昵称的错误码。0 代表设置群成员昵称成功，非 0 为设置群成员昵称失败。若出现设置群成员昵称失败时，开发者应查看官网错误码文档查询解决方案。

详情

群成员昵称更新操作结果的返回。

业务场景：进行群成员昵称更新操作后，成功与否可以通过该回调得知。
通知时机：群成员昵称更新操作结束后的结果返回。
相关接口：[setGroupMemberNickname]，群成员昵称更新。

ZIMGroupMemberInfoQueriedCallback

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

群成员查询的结果的返回。

参数

名称	类型	描述
groupID	NSString *	群组 ID。
userInfo	ZIMGroupMemberInfo	群成员信息。
errorInfo	ZIMError	查询群组成员的错误码。0 代表查询群组成员成功，非 0 为查询群组成员失败。若出现查询群组成员失败时，开发者应查看官网错误码文档查询解决方案。

详情

群成员查询结果的返回。

业务场景：进行群成员查询后，成功与否可以通过该回调得知。
通知时机：群成员查询后的结果返回。
相关接口：[queryGroupMemberInfo]，群成员查询。

ZIMGroupMemberListQueriedCallback

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

查询群成员列表的结果的返回。

参数

名称	类型	描述
userList	NSArray<ZIMGroupMemberInfo *>	成员列表。
nextFlag	int	下一个标志。
errorInfo	ZIMError *	查询群成员列表的错误码。0 代表查询群成员列表成功，非 0 为查询群成员列表失败。若出现查询群成员列表失败时，开发者应查看官网错误码文档查询解决方案。

详情

查询群成员列表操作结果的返回。

业务场景：进行查询群成员列表操作后，成功与否可以通过该回调得知。
通知时机：查询群成员列表操作结束后的结果返回。
相关接口：[queryGroupMemberList]，查询群成员列表。

ZIMGroupMemberMutedListQueriedCallback

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

查询群禁言成员列表的结果的返回。

参数

名称	类型	描述
groupID	NSString *	修改群成员禁言状态的群 ID。
nextFlag	unsigned long long	下一个标志。
userList	NSArray<ZIMGroupMemberInfo *>	成员列表。
errorInfo	ZIMError *	查询群禁言成员列表的错误码。0 代表查询群禁言成员列表成功，非 0 为查询群禁言成员列表失败。若出现查询群禁言成员列表失败时，开发者应查看官网错误码文档查询解决方案。

详情

查询群成员禁言列表操作结果的返回。

业务场景：进行查询群禁言成员列表操作后，成功与否可以通过该回调得知。
通知时机：查询群禁言成员列表操作结束后的结果返回。
相关接口：[queryGroupMemberMutedListByGroupID]，查询群禁言成员列表。

ZIMGroupMemberCountQueriedCallback

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

查询群成员数量的结果的返回。

参数

名称	类型	描述
groupID	NSString *	成员数量。
count	int	下一个标志。
errorInfo	ZIMError	查询群成员数量的错误码。0 代表查询群成员数量成功，非 0 为查询群成员数量失败。若出现查询群成员数量失败时，开发者应查看官网错误码文档查询解决方案。

详情

查询群成员数量操作结果的返回。

业务场景：进行查询群成员数量操作后，成功与否可以通过该回调得知。
通知时机：查询群成员数量操作结束后的结果返回。
相关接口：[queryGroupMemberCount]，查询群成员数量。

ZIMConversationPinnedListQueriedCallback

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

置顶会话列表查询回调。

参数

名称	类型	描述
conversationList	NSArray<ZIMConversation >	置顶会话列表。
errorInfo	ZIMError *	查询置顶会话列表的错误信息。0 代表查询置顶会话列表成功，非 0 为查询置顶会话列表失败。若出现查询置顶会话列表失败时，开发者应查看官网错误码文档查询解决方案。

详情

查询置顶会话列表后通过该回调返回查询结果。

业务场景：可在该回调内做置顶会话列表查询后的逻辑。
通知时机：查询置顶会话列表后触发。

支持版本：2.8.0 及以上。

ZIMConversationPinnedStateUpdatedCallback

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

会话置顶状态变更回调。

参数

名称	类型	描述
conversationID	NSString *	会话 ID。
conversationType	ZIMConversationType	会话类型。
errorInfo	ZIMError *	更新会话置顶状态的错误码。0 代表更新会话置顶状态成功，非 0为更新会话置顶状态失败。若出现更新会话置顶状态失败时，开发者应查看官网错误码文档查询解决方案。

详情

更新会话置顶状态后通过该回调返回结果。

业务场景：可在该回调内做更新会话置顶状态后的逻辑。
通知时机：调用 [updateConversationPinnedState] 接口更新会话置顶状态后触发。

支持版本：2.8.0 及以上。

ZIMConversationQueriedCallback

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

会话查询回调。

参数

名称	类型	描述
conversation	ZIMConversation *	会话对象。
errorInfo	ZIMError *	查询会话的错误码。0 代表查询会话成功，非 0 为查询会话失败。若出现查询会话失败时，开发者应查看官网错误码文档查询解决方案。

详情

查询会话后通过该回调返回查询结果。

业务场景：可在该回调内做会话查询后的逻辑。
通知时机：调用 [queryConversation] 接口查询会话后触发。

支持版本：2.8.0 及以上。

ZIMConversationListQueriedCallback

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

会话列表查询回调。

参数

名称	类型	描述
conversationList	ArrayList<ZIMConversation>	会话列表。
errorInfo	ZIMError	查询回话列表的错误码。0 代表查询回话列表成功，非 0 为查询回话列表失败。若出现查询回话列表失败时，开发者应查看官网错误码文档查询解决方案。

详情

查询会话列表后通过该回调返回查询结果。

业务场景：可在该回调内做会话列表查询后的逻辑。
通知时机：查询会话列表后触发。
相关接口：[queryConversationList]

支持版本：2.0.0 及以上。

ZIMConversationDeletedCallback

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

会话删除的回调。

参数

名称	类型	描述
conversationID	NSString *	会话 ID。
conversationType	ZIMConversationType	会话类型。
errorInfo	ZIMError	删除回话的错误码。0 代表删除回话成功，非 0为删除回话失败。若出现删除回话失败时，开发者应查看官网错误码文档查询解决方案。

详情

删除会话后通过该回调返回删除结果。

业务场景：可在该回调内做会话删除后的逻辑。
通知时机：删除会话后触发。
相关接口：[deleteConversation]。

支持版本：2.0.0 及以上。

ZIMConversationDraftSetCallback

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

设置会话草稿的回调。

参数

名称	类型	描述
conversationID	NSString *	会话 ID。
conversationType	ZIMConversationType	会话类型。
errorInfo	ZIMError *	设置会话草稿的错误码。0 代表设置会话草稿成功，非 0为设置会话草稿失败。若出现设置会话草稿失败时，开发者应查看官网错误码文档查询解决方案。

详情

设置会话草稿后，通过该回调返回操作结果。

业务场景：可在该回调内做设置会话草稿后的逻辑。
通知时机：设置会话草稿后触发。
相关接口：[setConversationDraft]。

支持版本：2.14.0 及以上。

ZIMConversationTotalUnreadMessageCountQueriedCallback

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

查询会话未读消息总数的回调。

参数

名称	类型	描述
unreadMessageCount	unsigned int	会话未读消息总数。
errorInfo	ZIMError *	查询操作的错误码。

通知时机：查询会话未读消息总数触发。

支持版本：2.17.0 及以上。

ZIMConversationsAllDeletedCallback

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

全部会话删除的回调。

参数

名称	类型	描述
errorInfo	ZIMError	删除全部会话的错误码。0 代表删除全部会话成功，非 0为删除全部会话失败。若出现删除全部会话失败时，开发者应查看官网错误码文档查询解决方案。

详情

删除全部会话后通过该回调返回删除结果。

业务场景：可在该回调内做全部会话删除后的逻辑。
通知时机：删除全部会话后触发。
相关接口：[deleteAllConversations]。

支持版本：2.12.0 及以上。

ZIMConversationTotalUnreadMessageCountClearedCallback

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

全部会话未读数清除的回调。

参数

名称	类型	描述
errorInfo	ZIMError	清除全部会话未读数数量的错误码。0 代表清除全部会话未读数数量成功，非 0为清除全部会话未读数数量失败。若出现清除全部会话未读数数量失败时，开发者应查看官网错误码文档查询解决方案。

详情

清除全部会话未读数后通过该回调返回清除会话的结果。

业务场景：可在该回调内做清除全部未读数后的逻辑。
通知时机：清除全部会话未读数后触发。
相关接口：[clearConversationTotalUnreadMessageCount]

支持版本：2.12.0 及以上。

ZIMConversationUnreadMessageCountClearedCallback

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

会话未读数清除的回调。

参数

名称	类型	描述
conversationID	NSString *	会话 ID。
conversationType	ZIMConversationType	会话类型。
errorInfo	ZIMError	清除回话未读数数量的错误码。0 代表清除回话未读数数量成功，非 0为清除回话未读数数量失败。若出现清除回话未读数数量失败时，开发者应查看官网错误码文档查询解决方案。

详情

清除会话未读数后通过该回调返回清除会话的结果。

业务场景：可在该回调内做清除未读数后的逻辑。
通知时机：清除会话未读数后触发。
相关接口：[clearConversationUnreadMessageCount]

支持版本：2.0.0 及以上。

ZIMConversationMarkSetCallback

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

会话标记设置的回调。

参数

名称	类型	描述
failedConversationInfos	NSArray<ZIMConversationBaseInfo >	设置失败的会话简要信息。
errorInfo	ZIMError	会话标记操作的错误码。0 代表会话标记操作成功，非 0 为会话标记操作失败。若出现会话标记操作失败时，开发者应查看官网错误码文档查询解决方案。

详情

设置会话标记的结果。

通知时机：设置会话标记后触发。
相关接口：[setConversationMark]。

支持版本：2.17.0 及以上。

ZIMConversationNotificationStatusSetCallback

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

会话通知状态设置的回调。

参数

名称	类型	描述
conversationID	NSString *	会话ID。
conversationType	ZIMConversationType	会话类型。
errorInfo	ZIMError	设置回话通知状态的错误码。0 代表设置回话通知状态成功，非 0为设置回话通知状态失败。若出现设置回话通知状态失败时，开发者应查看官网错误码文档查询解决方案。

详情

设置群通知状态后通过该回调返回群通知的结果。

业务场景：可在该回调内做设置群通知状态后的逻辑。
通知时机：设置群通知状态后触发。
相关接口：[setConversationNotificationStatus]。

支持版本：2.0.0 及以上。

ZIMMessageInsertedCallback

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

插入本地消息的结果的回调。

参数

名称	类型	描述
message	ZIMMessage	消息对象。
errorInfo	ZIMError	插入本地消息的错误码。0 代表插入消息成功，非 0 为插入消息失败。若出现插入消息失败时，开发者应查看 https://doc-zh.zego.im/article/11606 查询解决方案。

详情

插入本地消息的结果的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否插入成功。
通知时机：当开发者调用 [insertMessageToLocalDB] 接口时，会触发该回调。
相关接口：通过 [insertMessageToLocalDB] 插入本地消息，成功与否会通过本回调通知。

支持版本：2.4.0 及以上。

ZIMMessageImportedCallback

void(^ZIMMessageImportedCallback)((ZIMError) errorInfo);

导入消息的结果的回调。

参数

名称	类型	描述
errorInfo	ZIMError	导入消息的错误码。0 代表导入消息成功，非 0 为导入消息失败。

详情

导入消息的结果的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否导入成功。
通知时机：当开发者调用 [importLocalMessages] 接口时，会触发该回调。
相关接口：通过 [importLocalMessages] 导入消息，成功与否会通过本回调通知。

支持版本：2.15.0 及以上。

ZIMMessageExportedCallback

void(^ZIMMessageExportedCallback)((ZIMError) errorInfo);

导出消息的结果的回调。

参数

名称	类型	描述
errorInfo	ZIMError	导出消息的错误码。0 代表导出消息成功，非 0 为导出消息失败。

详情

导出消息的结果的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否导出成功。
通知时机：当开发者调用 [exportLocalMessages] 接口时，会触发该回调。
相关接口：通过 [exportLocalMessages] 导出消息，成功与否会通过本回调通知。

支持版本：2.15.0 及以上。

ZIMFileCacheClearedCallback

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

清除本地缓存结果的回调。

参数

名称	类型	描述
errorInfo	ZIMError	清理缓存的错误码。0 代表清理缓存成功，非 0 为清理缓存失败。

详情

清除本地缓存结果的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否清理成功。
通知时机：当开发者调用 [clearLocalFileCache] 接口时，会触发该回调。
相关接口：通过 [clearLocalFileCache] 插入本地消息，成功与否会通过本回调通知。

支持版本：2.15.0 及以上。

ZIMFileCacheQueriedCallback

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

查询本地缓存的结果的回调。

参数

名称	类型	描述
fileCacheInfo	ZIMFileCacheInfo	缓存信息。
errorInfo	ZIMError	查询缓存的错误码。0 代表查询缓存成功，非 0 为查询缓存失败。

详情

查询本地缓存的结果的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否查询成功。
通知时机：当开发者调用 [queryLocalFileCache] 接口时，会触发该回调。
相关接口：通过 [queryLocalFileCache]查询本地缓存，成功与否会通过本回调通知。

支持版本：2.15.0 及以上。

ZIMMessageReactionAddedCallback

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

消息表态新增的返回。

参数

名称	类型	描述
reaction	ZIMMessageReaction *	表态数据。
errorInfo	ZIMError *	添加消息表态的错误码，0 代表操作成功，非 0 代表操作失败，请参考官网文档（https://doc-zh.zego.im/article/11605）获取解决方案。

详情

消息表态新增操作的结果。

通知时机：对消息进行表态后。
相关接口：[addMessageReaction]

支持版本：2.10.0 及以上。

ZIMMessageReactionDeletedCallback

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

消息表态删除的返回。

参数

名称	类型	描述
reaction	ZIMMessageReaction *	表态数据。
errorInfo	ZIMError *	删除消息表态的错误码，0 代表操作成功，非 0 代表操作失败，请参考官网文档（https://doc-zh.zego.im/article/11605）获取解决方案。

详情

消息表态删除操作的结果。

通知时机：删除消息表态后。
相关接口：[deleteMessageReaction]

支持版本：2.10.0 及以上。

ZIMMessageReactionUserListQueriedCallback

void(^ZIMMessageReactionUserListQueriedCallback)((ZIMMessage *) message, (NSArray<ZIMMessageReactionUserInfo> *) userList, (NSString *) reactionType, (long long) nextFlag, (int) totalCount, (ZIMError *) error);

消息表态详情查询的返回。

参数

名称	类型	描述
message	ZIMMessage *	表态相关的消息。
userList	NSArray<ZIMMessageReactionUserInfo> *	查询出来的表态用户详情列表。
reactionType	NSString *	表态的类型。
nextFlag	long long	查询锚点，用于下一次分页传给 [ZIMMessageReactionUserQueryConfig] 查询使用。
totalCount	int	表态的用户总数。
error	ZIMError *	错误信息。

详情

消息表态用户信息查询操作的结果。

通知时机：查询消息表态的用户信息后。
相关接口：[queryMessageReactionUserListByMessage]

支持版本：2.10.0 及以上。

ZIMMessageRepliedListQueriedCallback

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

查询回复消息列表的结果的回调。

名称	类型	描述
messageList	NSArray<ZIMMessage> *	查询出来的消息列表。
nextFlag	long long	查询锚点，用于下一次分页传给 [ZIMMessageRepliedListQueryConfig] 查询使用。
rootRepliedInfo	ZIMMessageRootRepliedInfo	根消息的回复信息。
error	ZIMError *	错误信息。

ZIMMessageEditedCallback

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

编辑消息的结果的回调。

参数

名称	类型	描述
message	ZIMMessage	编辑的消息对象，可从中获取 editedTime、editorUserID 等参数。
errorInfo	ZIMError	编辑消息的错误码。

详情

编辑消息的结果的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否编辑成功。
通知时机：当开发者调用 [editMessage] 接口时，会触发该回调。

支持版本：2.20.0 及以上。

ZIMMessagePinnedCallback

void(^ZIMMessagePinnedCallback)((ZIMError) errorInfo, (zim_sequence) sequence);

置顶或取消置顶消息的结果的回调。

参数

名称	类型	描述
errorInfo	ZIMError	置顶或取消消息的错误码。
sequence	zim_sequence	上下文，用于标识本次回调是哪一次调用触发的。

详情

置顶或取消置顶消息的结果的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否编辑成功。
通知时机：当开发者调用 [pinMessage] 接口时，会触发该回调。

支持版本：2.25.0 及以上。

ZIMMessageSentCallback

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

发送消息的结果的回调。

参数

名称	类型	描述
message	ZIMMessage	发送的消息对象，可从中获取 messageID 等参数。若发送失败则其中的 messageID 参数将为空字符串。
errorInfo	ZIMError	发送消息的错误码。0 代表发送消息成功，非 0为发送消息失败。若出现发送消息失败时，开发者应查看官网错误码文档查询解决方案。

详情

发送消息的结果的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否发送成功。
通知时机：当开发者调用 [sendPeerMessage] 与 [sendRoomMessage] 接口时，会触发该回调。
相关接口：通过 [sendPeerMessage] 与 [sendRoomMessage] 发送消息，发送消息的成功与否会通过本回调通知。

支持版本：1.1.0 及以上。

ZIMSendingMessageCancelledCallback

void(^ZIMSendingMessageCancelledCallback)();

取消发送消息的结果的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否取消发送成功。
通知时机：当开发者调用 [cancelSendingMessage] 接口时，会触发该回调。

支持版本：2.22.0 及以上。

ZIMConversationMessageReceiptReadSentCallback

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

设置回执会话已读的回调接口。

参数

名称	类型	描述
conversationID	NSString *	会话 ID。
conversationType	ZIMConversationType	会话类型。
errorInfo	ZIMError	设置回执会话已读的错误码。0 代表设置成功，非 0为设置失败。若出现设置失败时，开发者应查看官网错误码文档查询解决方案。

详情

设置回执会话已读的回调接口。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否设置成功。
通知时机：当开发者调用 [sendConversationMessageReceiptRead] 接口时，会触发该回调。
相关接口：通过 [sendConversationMessageReceiptRead] 设置回执的会话已读的结果成功与否会通过本回调通知。

支持版本：2.5.0 及以上。

ZIMMessageReceiptsReadSentCallback

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

设置回执消息已读的回调接口。

参数

名称	类型	描述
conversationID	NSString *	会话 ID。
conversationType	ZIMConversationType	会话类型。
errorMessageIDs	NSArray<NSNumber >	设置消息回执失败对应的消息ID。
errorInfo	ZIMError	设置回执消息已读的错误码。0 代表设置成功，非 0为设置失败。若出现设置失败时，开发者应查看官网错误码文档查询解决方案。

详情

设置回执消息已读的回调接口。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否设置成功。
通知时机：当开发者调用 [sendMessageReceiptsRead] 接口时，会触发该回调。
相关接口：通过 [sendMessageReceiptsRead] 设置回执的消息已读的结果成功与否会通过本回调通知。

支持版本：2.5.0 及以上。

ZIMMessageReceiptsInfoQueriedCallback

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

查询回执消息信息的回调接口。

参数

名称	类型	描述
infos	NSArray<ZIMMessageReceiptInfo >	查询出来的回执信息。
errorMessageIDs	NSArray<NSString >	查询消息回执信息错误的消息ID。
errorInfo	ZIMError	查询消息回执的错误码。0 代表查询成功，非 0 为查询失败。若出现查询失败时，开发者应查看官网错误码文档查询解决方案。

详情

查询回执消息信息的回调接口。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否发送成功。
通知时机：当开发者调用 [queryMessageReceiptsInfo] 接口时，会触发该回调。
相关接口：通过 [queryMessageReceiptsInfo] 查询回执的信息的结果成功与否会通过本回调通知。

支持版本：2.5.0 及以上。

ZIMGroupMessageReceiptMemberListQueriedCallback

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

查询群回执消息具体已读/未读成员列表的回调接口。

参数

名称	类型	描述
groupID	NSString *	群组 ID。
userList	NSArray<ZIMGroupMemberInfo *>	查询成功的群用户列表。
nextFlag	unsigned int	查询下一页对应的 flag，用于给 [ZIMGroupMessageReceiptMemberQueryConfig] 的 nextFlag 参数使用。
errorInfo	ZIMError	设置查询群成员列表返回的错误码。0 代表查询成功，非 0为查询失败。若出现查询失败时，开发者应查看官网错误码文档查询解决方案。

详情

查询群回执消息具体已读/未读成员列表的回调接口。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否发送成功。
通知时机：当开发者调用 [queryGroupMessageReceiptReadMemberList] / [queryGroupMessageReceiptUnreadMemberList] 接口时，会触发该回调。

支持版本：2.5.0 及以上。

ZIMMessageRevokedCallback

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

撤回消息的结果的回调。

参数

名称	类型	描述
message	ZIMMessage	消息对象。
errorInfo	ZIMError	撤回消息的错误码。0 代表撤回成功，非 0为撤回失败。若出现撤回失败时，开发者应查看官网错误码文档查询解决方案。

详情

撤回消息的结果的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否发送成功。
通知时机：当开发者调用 [revokeMessage] 接口时，会触发该回调。
相关接口：通过 [revokeMessage] 撤回消息，发送消息的成功与否会通过本回调通知。

支持版本：2.5.0 及以上。

ZIMMessageQueriedCallback

void(^ZIMMessageQueriedCallback)((NSString *) conversationID, (ZIMConversationType) conversationType, (null) messageList, (ZIMError) errorInfo);

开发者通过该回调获取查询到的消息列表，可以做历史消息显示。

参数

名称	类型	描述
conversationID	NSString *	会话 ID。
conversationType	ZIMConversationType	会话类型。
messageList	null	查询结果的消息列表。
errorInfo	ZIMError	查询消息的错误码。0 代表查询消息成功，非 0为查询消息失败。若出现查询消息失败时，开发者应查看官网错误码文档查询解决方案。

详情

查询消息列表的结果回调。

业务场景：开发者通过该回调获取查询到的消息列表，可以做历史消息显示。
通知时机：调用查询历史消息接口 [queryHistoryMessage] 后，查询到的消息列表会通过本回调通知。
相关接口：通过 [queryHistoryMessage] 查询历史消息，查询到的消息列表会通过本回调通知。

支持版本：2.0.0 及以上。

ZIMPinnedMessageListQueriedCallback

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

开发者通过该回调获取查询到的置顶消息列表，可以做置顶消息显示。

参数

名称	类型	描述
messageList	NSArray<ZIMMessage >	查询结果的消息列表。
errorInfo	ZIMError	查询消息的错误码。0 代表查询消息成功，非 0为查询消息失败。若出现查询消息失败时，开发者应查看官网错误码文档查询解决方案。

详情

查询置顶消息列表的结果回调。

业务场景：开发者通过该回调获取查询到的置顶消息列表，可以做置顶消息显示。
通知时机：调用查询置顶消息接口 [queryPinnedMessageList] 后，查询到的置顶消息列表会通过本回调通知。
相关接口：通过 [queryPinnedMessageList] 查询历史消息，查询到的消息列表会通过本回调通知。

支持版本：2.25.0 及以上。

ZIMConversationMessagesAllDeletedCallback

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

删除全部会话的全部消息的回调。

参数

名称	类型	描述
errorInfo	ZIMError *	删除消息的错误码。0 代表删除消息成功，非 0为删除消息失败。若出现删除消息失败时，开发者应查看官网错误码文档查询解决方案。

详情

删除全部会话的全部消息后通过该回调返回消息删除的结果。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否删除成功。
通知时机：调用删除消息接口 [deleteAllConversationMessages] 后触发。
相关接口：[deleteAllConversationMessages]。

支持版本：2.14.0 及以上。

ZIMMessageDeletedCallback

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

删除消息的回调。

参数

名称	类型	描述
conversationID	NSString *	会话 ID
conversationType	ZIMConversationType	会话类型
errorInfo	ZIMError	删除消息的错误码。0 代表删除消息成功，非 0为删除消息失败。若出现删除消息失败时，开发者应查看官网错误码文档查询解决方案。

详情

删除消息后通过该回调返回消息删除的结果。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否删除成功。
通知时机：调用删除消息接口 [deleteMessage] 后触发。
相关接口：[deleteMessage]。

支持版本：2.0.0 及以上。

ZIMMediaDownloadedCallback

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

下载媒体消息的结果回调。

参数

名称	类型	描述
message	ZIMMessage	发送的消息对象，可从中获取 messageID 等参数。若发送失败则其中的 messageID 参数将为空字符串。
errorInfo	ZIMError	发送消息的错误码。0 代表发送消息成功，非 0为发送消息失败。若出现发送消息失败时，开发者应查看官网错误码文档查询解决方案。

详情

媒体消息下载的结果回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否下载成功。
通知时机：当开发者调用 [downloadMediaFile] 接口时，会触发该回调。
相关接口：通过 [downloadMediaFile] 下载媒体消息，成功与否会通过本回调通知。

支持版本：2.1.0 及以上。

ZIMMediaUploadingProgress:message:currentFileSize:totalFileSize:

- (void)ZIMMediaUploadingProgress:(ZIMMediaMessage *) message currentFileSize:(unsigned long long) currentFileSize totalFileSize:(unsigned long long) totalFileSize;

发送媒体消息的进度回调。

参数

名称	类型	描述
message	ZIMMediaMessage *	当前文件上传的消息对象。
currentFileSize	unsigned long long	当前进度，即当前文件上传的实时大小。
totalFileSize	unsigned long long	总进度，即当前文件的总大小。

详情

发送媒体消息的进度回调。

业务场景：开发者可以通过该回调获得媒体消息的发送进度。
通知时机：当开发者调用 [sendMediaMessage] 接口时，会触发该回调，且在发送的过程中将会多次触发。
相关接口：通过 [sendMediaMessage]，发送进度情况会通过本回调通知。

支持版本：2.1.0 及以上。

ZIMMessageExportingProgress:exportedMessageCount:totalMessageCount:

- (void)ZIMMessageExportingProgress:(unsigned long long) exportedMessageCount totalMessageCount:(unsigned long long) totalMessageCount;

导出消息的进度回调。

参数

名称	类型	描述
exportedMessageCount	unsigned long long	当前进度，即当前导出的消息数。
totalMessageCount	unsigned long long	总进度，即导出消息的总数目。

详情

导出消息的进度回调。

业务场景：开发者可以通过该回调获得导出消息的进度。
通知时机：当开发者调用 [exportLocalMessages] 接口时，会触发该回调，且在导出的过程中将会多次触发。
相关接口：通过 [exportLocalMessages]，导出进度情况会通过本回调通知。

支持版本：2.15.0 及以上。

ZIMMessageImportingProgress:importedMessageCount:totalMessageCount:

- (void)ZIMMessageImportingProgress:(unsigned long long) importedMessageCount totalMessageCount:(unsigned long long) totalMessageCount;

导入消息的进度回调。

参数

名称	类型	描述
importedMessageCount	unsigned long long	当前进度，即当前导入的消息数。
totalMessageCount	unsigned long long	总进度，即导入消息的总数目。

详情

导入消息的进度回调。

业务场景：开发者可以通过该回调获得导入消息的进度。
通知时机：当开发者调用 [importLocalMessages] 接口时，会触发该回调，且在导入的过程中将会多次触发。
相关接口：通过 [importLocalMessages]，导入进度情况会通过本回调通知。

支持版本：2.15.0 及以上。

ZIMMediaDownloadingProgress:message:currentFileSize:totalFileSize:

- (void)ZIMMediaDownloadingProgress:(ZIMMessage *) message currentFileSize:(unsigned long long) currentFileSize totalFileSize:(unsigned long long) totalFileSize;

下载媒体文件的进度回调。

参数

名称	类型	描述
message	ZIMMessage *	当前文件下载的消息对象。
currentFileSize	unsigned long long	当前进度，即当前文件下载的实时大小。
totalFileSize	unsigned long long	总进度，即当前文件的总大小。

详情

下载媒体消息的进度回调。

业务场景：开发者可以通过该回调获得媒体消息的下载进度。
通知时机：当开发者调用 [downloadMediaFile] 接口时，会触发该回调，且在下载的过程中将会多次触发。
相关接口：通过 [downloadMediaFile]，下载进度情况会通过本回调通知。

支持版本：2.1.0 及以上。

ZIMMessageLocalExtendedDataUpdatedCallback

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

更新消息本地拓展字段的回调。

参数

名称	类型	描述
message	ZIMMessage *	更新后消息对象。
errorInfo	ZIMError *	查询的错误码。0 代表登录成功，非 0 为登录失败。若出现查询失败时，开发者应查看官网错误码文档查询解决方案。

详情

开发者修改消息本地扩展信息后的回调。

业务场景：开发者可以通过该回调中的 [errorCode] 判断是否操作成功。
通知时机：当开发者调用 [updateMessageLocalExtendedData] 接口时，会触发该回调。

支持版本：2.9.0 及以上。

ZIMMessagesSearchedCallback

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

搜索本地消息结果的返回。

参数

名称	类型	描述
conversationID	NSString *	会话 ID，单聊时，conversationID 即是对方的 userID。群组时，conversationID 即是群组的 groupID。
conversationType	ZIMConversationType	会话类型。0：单聊 1：房间 2：群组，注意：“房间”场景下，默认不支持缓存和搜索离线消息。
messageList	NSArray<ZIMMessage *>	搜索到的消息列表。
nextMessage	ZIMMessage *_Nullable	分页拉取标志，搜索下一页的消息锚点。
errorInfo	ZIMError *	搜索本地消息的错误码。0 代表搜索本地消息成功，非 0 为搜索本地消息失败。若出现搜索本地消息失败时，开发者应查看官网错误码文档查询解决方案。

详情

搜索本地消息结果的返回。

业务场景：进行本地消息搜索操作后，成功与否可以通过该回调得知。
相关接口：[searchLocalMessagesByConversationID]，搜索本地消息。

ZIMMessagesGlobalSearchedCallback

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

全局搜索本地消息结果的返回。

参数

名称	类型	描述
messageList	NSArray<ZIMMessage >	全局搜索到的消息列表。
nextMessage	NSArray<ZIMMessage >	分页拉取标志，搜索下一页的消息锚点。
errorInfo	ZIMError *	全局搜索本地消息的错误码。0 代表全局搜索本地消息成功，非 0 为全局搜索本地消息失败。若出现全局搜索本地消息失败时，开发者应查看官网错误码文档查询解决方案。

详情

全局搜索本地消息结果的返回。

业务场景：进行全局本地消息搜索操作后，成功与否可以通过该回调得知。
相关接口：[searchGlobalLocalMessagesWithConfig]，全局搜索本地消息。

ZIMConversationsSearchedCallback

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

基于本地消息搜索本地会话结果的返回。

参数

名称	类型	描述
conversationSearchInfoList	NSArray<ZIMConversationSearchInfo> *	搜索到的会话消息列表。
nextFlag	unsigned int	分页拉取标志，搜索下一页的锚点。
errorInfo	ZIMError *	搜索结果的错误码。0 代表搜索成功，非 0 为搜索失败。若出现搜索失败时，开发者应查看官网错误码文档查询解决方案。

详情

基于本地消息搜索本地会话结果的返回。

业务场景：进行本地会话消息搜索操作后，成功与否可以通过该回调得知。
相关接口：[searchLocalConversations]，基于本地消息搜索本地会话。

ZIMRoomMembersQueriedCallback

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

查询房间指定成员的结果回调。

参数

名称	类型	描述
roomID	NSString *	房间 ID。
memberList	NSArray<ZIMRoomMemberInfo >	查询成功的用户信息列表。
errorUserList	NSArray<ZIMErrorUserInfo >	查询失败的用户列表。
errorInfo	ZIMError *	错误信息。

详情

查询房间用户信息后通过该回调返回查询结果。

业务场景：可在该回调内做查询房间用户信息后的逻辑。
通知时机：调用 [queryRoomMembersByUserIDs] 接口查询房间用户信息后触发。

支持版本：2.8.0 及以上。

ZIMRoomMembersAttributesQueriedCallback

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

房间用户属性批量查询结果的返回。

参数

名称	类型	描述
roomID	NSString *	房间 ID。
infos	NSArray<ZIMRoomMemberAttributesInfo >	房间用户属性列表。
errorInfo	ZIMError *	查询房间用户属性的错误码。0 代表查询房间用户属性成功，非 0 为查询房间用户属性失败。若出现查询房间用户属性失败时，开发者应查看 https://doc-zh.zego.im/article/11606 查询解决方案。

详情

根据 UserID 列表，房间用户属性批量查询结果的返回。

业务场景：进行房间用户属性查询后，成功与否以及查询结果可以通过该回调得知。
通知时机：房间用户属性查询结束后的结果返回。
相关接口：[queryRoomMembersAttributes]，查询房间用户属性。

支持版本：2.4.0 及以上。

ZIMRoomMemberAttributesListQueriedCallback

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

房间内用户属性列表查询结果的返回。

参数

名称	类型	描述
roomID	NSString *	房间 ID。
infos	NSArray<ZIMRoomMemberAttributesInfo >	房间用户属性列表。
nextFlag	NSString *	下一个分页查询的锚点，为空则代表已经查询完毕。
errorInfo	ZIMError *	查询房间用户属性的错误码。0 代表查询房间用户属性成功，非 0 为查询房间用户属性失败。若出现查询房间用户属性失败时，开发者应查看 https://doc-zh.zego.im/article/11606 查询解决方案。

详情

分页查询房间内所有用户属性列表结果的返回。

业务场景：进行房间用户属性查询后，成功与否以及查询结果可以通过该回调得知。
通知时机：房间用户属性查询结束后的结果返回。
相关接口：[queryRoomMemberAttributesList]，查询房间用户属性。

支持版本：2.4.0 及以上。

ZIMRoomCreatedCallback

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

创建房间的结果的回调。

参数

名称	类型	描述
roomInfo	ZIMRoomFullInfo	创建出来的房间的详细信息。若创建失败则其中的 roomID 参数将为空字符串。
errorInfo	ZIMError	错误信息。

详情

创建房间的结果回调。

业务场景：当开发者创建房间时可以通过该回调来判断是否创建成功，并执行相应的业务逻辑。
通知时机：当调用 [createRoom] 创建房间后结果会触发本回调通知。
相关接口：通过 [createRoom] 创建房间，创建结果会通过本回调通知。

支持版本：1.1.0 及以上。

ZIMRoomEnteredCallback

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

进入房间的结果的回调。

参数

名称	类型	描述
roomInfo	ZIMRoomFullInfo	创建出来的房间的详细信息。若创建失败则其中的 roomID 参数将为空字符串。
errorInfo	ZIMError	错误信息。

详情

进入房间的结果回调。

业务场景：当开发者进入房间时可以通过该回调来判断是否进入成功，并执行相应的业务逻辑。
通知时机：当调用 [enterRoom] 进入房间后结果会触发本回调通知。
相关接口：通过 [enterRoom] 创建房间，进入结果会通过本回调通知。

支持版本：2.1.0 及以上。

ZIMRoomSwitchedCallback

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

切换房间的结果的回调。

参数

名称	类型	描述
roomInfo	ZIMRoomFullInfo	切换后的房间的详细信息。
errorInfo	ZIMError	错误信息。

详情

切换房间的结果回调。

业务场景：当开发者切换房间时可以通过该回调来判断是否切换成功，并执行相应的业务逻辑。
通知时机：当调用 [switchRoom] 切换房间后结果会触发本回调通知。
相关接口：通过 [switchRoom] 切换房间，切换结果会通过本回调通知。

支持版本：2.18.0 及以上。

ZIMRoomJoinedCallback

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

加入房间的结果的回调。

参数

名称	类型	描述
roomInfo	ZIMRoomFullInfo	加入的房间的详细信息。若加入失败则其中的 roomID 参数将为空字符串。
errorInfo	ZIMError	加入房间的错误码。0 代表加入房间成功，非 0 为加入房间失败。若出现加入房间失败时，开发者应查看官网错误码文档查询解决方案。

详情

加入房间的结果的回调。

业务场景：当开发者加入房间时，开发者可以通过该回调判断是否加入成功。
通知时机：当有人加入房间时，会通过该回调通知。
相关接口：通过 [joinRoom] 加入房间，加入结果会通过本回调通知。

支持版本：1.1.0 及以上。

ZIMRoomAllLeftCallback

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

离开所有房间的结果的回调。

参数

名称	类型	描述
roomIDs	NSArray<NSString >	房间 ID 列表。

通知时机：当用户调用 [leaveAllRoom]，则会触发该回调返回结果。

支持版本：1.15 及以上。

ZIMRoomLeftCallback

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

离开房间的结果的回调。

参数

名称	类型	描述
roomID	NSString *	房间 ID
errorInfo	ZIMError	离开房间的错误码。0 代表离开房间成功，非 0 为离开房间失败。若出现离开房间失败时，开发者应查看官网错误码文档查询解决方案。

详情

离开房间的结果的回调。

业务场景：当用户本人需要离开房间时，开发者可以在该回调里进行业务逻辑处理。
通知时机：当用户调用 [leaveRoom]，则会触发该回调返回结果。
相关接口：通过 [leaveRoom] 离开房间，离开结果会通过本回调通知。

支持版本：1.1.0 及以上。

ZIMRoomMemberQueriedCallback

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

查询房间成员列表的结果回调。

参数

名称	类型	描述
roomID	NSString *	房间 ID
memberList	NSArray<ZIMUserInfo *>	房间的成员列表。
nextFlag	NSString *	分页查询的标识位，如果此字段为空字符串，说明已查询完毕。否则需要将此值设置到 ZIMQueryMemberConfig 的 "nextFlag" 字段中以进行下一页查询。
errorInfo	ZIMError	查询房间成员的错误码。0 代表查询房间成员成功，非 0 为查询房间成员失败。若出现查询房间成员失败时，开发者应查看官网错误码文档查询解决方案。

详情

查询房间成员列表的结果回调。

通知时机：当调用 [queryRoomMember] 接口进行房间成员查询时候，会触发该回调。
相关接口：通过 [queryRoomMember] 查询房间成员列表，查询结果会通过本回调通知。

支持版本：1.1.0 及以上。

ZIMRoomOnlineMemberCountQueriedCallback

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

查询房间在线成员数量回调。

参数

名称	类型	描述
roomID	NSString *	房间 ID
count	unsigned int	房间的在线成员数量。
errorInfo	ZIMError	查询房间在线成员的错误码。0 代表查询房间在线成员成功，非 0 为查询房间在线成员失败。若出现查询房间在线成员失败时，开发者应查看官网错误码文档查询解决方案。

详情

进行查询房间在线成员数量操作后，执行所获得的人数回调。

通知时机：当调用 [queryRoomOnlineMemberCount] 接口进行查询房间成员人数时，会触发该回调。
相关接口：可通过 [queryRoomOnlineMemberCount] 查询房间在线人数。

支持版本：1.1.0 及以上。

ZIMRoomAttributesQueriedCallback

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

房间属性查询结果的返回。

参数

名称	类型	描述
roomID	NSString *	房间 ID
roomAttributes	NSDictionary<NSString,NSString > *	房间内的房间属性。
errorInfo	ZIMError	查询房间全部属性的错误码。0 代表查询房间全部属性成功，非 0 为查询房间全部属性失败。若出现查询房间全部属性失败时，开发者应查看官网错误码文档查询解决方案。

详情

房间属性查询结果的返回。

业务场景：进行自定义属性查询后，成功与否以及查询结果可以通过该回调得知。
通知时机：房间属性查询结束后的结果返回。
相关接口：[queryRoomAllAttributes]，查询房间属性。

支持版本：1.3.0。

ZIMRoomAttributesOperatedCallback

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

房间属性操作结果的返回。

参数

名称	类型	描述
roomID	NSString *	房间 ID。
errorKeys	NSArray<NSString *>	操作失败的 keys。
errorInfo	ZIMError	房间属性操作的错误码。0 代表房间属性操作成功，非 0 为房间属性操作失败。若出现房间属性操作失败时，开发者应查看官网错误码文档查询解决方案。

详情

房间属性操作结果的返回。

业务场景：进行自定义属性操作后，成功与否可以通过该回调得知。
通知时机：房间属性操作结束后的结果返回。
相关接口：[setRoomAttributes]，设置房间属性。[deleteRoomAttributes]，删除房间属性。

支持版本：1.3.0。

ZIMRoomAttributesBatchOperatedCallback

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

房间属性组合操作结果的返回。

参数

名称	类型	描述
roomID	NSString *	房间 ID
errorInfo	ZIMError	房间属性批处理操作的错误码。0 代表房间属性批处理操作成功，非 0 为房间属性批处理操作失败。若出现房间属性批处理操作失败时，开发者应查看官网错误码文档查询解决方案。

详情

房间属性组合操作结果的返回。

业务场景：进行自定义属性组合操作后，成功与否可以通过该回调得知。
通知时机：房间属性组合操作结束后的结果返回。
相关接口：[beginRoomAttributesBatchOperation]，开始房间属性组合操作。[endRoomAttributesBatchOperation]，完成房间属性组合操作。

支持版本：1.3.0。

ZIMError

错误信息

详情

错误信息。

Declared in ZIMDefines.h

属性

code

public ZIMErrorCode code

错误码枚举值。

message

public NSString * message

错误信息描述。

ZIMErrorUserInfo

失败用户信息类。

详情

用于展示失败的用户以及失败的原因。

Declared in ZIMDefines.h

属性

userID

public NSString * userID

userID。

取值范围：最大 32 字节的字符串。仅支持数字，英文字符和 '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'。

reason

public unsigned int reason

描述查询失败原因的 reason。

ZIMFileCacheClearConfig

清理缓存配置。

详情

清理缓存配置。

Declared in ZIMDefines.h

属性

endTime

public unsigned long long endTime

缓存清理的截至时间戳。

是否必填：非必填。

ZIMFileCacheInfo

文件缓存信息。

详情

文件缓存信息。

Declared in ZIMDefines.h

属性

totalFileSize

public unsigned long long totalFileSize

总的文件大小，单位为字节（B）。

ZIMFileCacheQueryConfig

查询缓存配置。

详情

查询缓存配置。

Declared in ZIMDefines.h

属性

endTime

public unsigned long long endTime

查询缓存的截至时间戳。

是否必填：非必填。

ZIMFileMessage

文件消息对象。

详情

标识一条文件消息。

注意事项：回调时若基类的 Type 参数为 File，可将基类消息对象强转为此类。

Declared in ZIMDefines.h

属性

fileLocalPath

public NSString * fileLocalPath

媒体消息的文件的本地绝对路径。

是否必填：如果发送本地文件，则发送端必填，否则消息会发送失败。

fileDownloadUrl

public NSString * fileDownloadUrl

媒体消息的外部下载 URL，用于开发者将媒体文件上传到自己的服务器中时，通过填入该 URL 让 SDK 透传到其他用户中。

是否必填：如果发送的是外部 URL，发送端必填。

fileUID

public NSString * fileUID

媒体文件的唯一 ID。

是否必填：发送端不需要填，该值由 SDK 生成。

fileName

public NSString * fileName

媒体文件的文件名。

是否必填：如果发送的是外部 URL，则需要填写该值，且需要包含文件扩展名。如果发送的是本地文件，该值选填。

fileSize

public unsigned long long fileSize

媒体文件的大小。

是否必填：发送端不需要填，该值由 SDK 生成。

type

public ZIMMessageType type

消息类型。

messageID

public long long messageID

标识这条消息的唯一 ID。

业务场景：可用于索引其他消息。

注意事项：开发者主动创建一条消息时，不需要修改这个参数，此参数仅在回调时有值。

timestamp

public unsigned long long timestamp

标识一条消息的发送时间。

业务场景：用于呈现一条消息的发送时间，并可用于消息排序。

注意事项：此为标准 UNIX 时间戳，单位为毫秒。

senderUserID

public NSString * senderUserID

展示本条消息发送者的 userID。

conversationID

public NSString * conversationID

会话的 ID，相同会话类型下的 ID 是唯一的。

direction

public ZIMMessageDirection direction

用于描述消息的方向是发送还是接收。

sentStatus

public ZIMMessageSentStatus sentStatus

描述消息的发送状态。

conversationType

public ZIMConversationType conversationType

该消息所属会话的类型。

conversationSeq

public unsigned long long conversationSeq

表示该消息在会话中的序号。

orderKey

public long long orderKey

orderKey 越大消息越新，可用于消息排序。

localMessageID

public long long localMessageID

SDK 本地生成的 MessageID,开发者无需关注。

isUserInserted

public BOOL isUserInserted

该消息是否是开发者通过 [insertMessageToLocalDB] 接口插入的消息。

默认值：false。

receiptStatus

public ZIMMessageReceiptStatus receiptStatus

描述该消息的回执状态。

业务场景：用于在回执消息中，判断当前消息是处于什么状态。

extendedData

public NSString extendedData

消息拓展字段。

业务场景：可为消息附加拓展字段，然后发送给对端。
是否必填：否。

支持版本：2.6.0 及以上。
注意事项：长度为1k，可联系技术支持进行配置。

localExtendedData

public NSString * localExtendedData

isBroadcastMessage

public BOOL isBroadcastMessage

该消息是否是全员推送消息。

是否必填：SDK内部赋值。

isMentionAll

public BOOL isMentionAll

是否需要提醒所有人。业务表现可为“@所有人”。

业务场景：例如在群或者房间可使用。
是否必填：否。
默认值：false。
建议值：如果需要提醒所有人，可以设置为 true。

注意事项：该值并不会在消息文本上增加 @所有人的字样，需要开发者自行实现。

支持版本 : 2.14.0 及以上。

mentionedUserIDs

public NSArray\<NSString *> * mentionedUserIDs

提醒一批相关的用户。业务表现可为“@某用户”。

业务场景：发消息时可以带上
是否必填：否。

注意事项：该值并不会在消息文本上增加 @某用户的字样，需要开发者自行实现。

支持版本 : 2.14.0 及以上。

messageSeq

public unsigned long long messageSeq

表示该消息在会话中的序号。

rootRepliedCount

public unsigned int rootRepliedCount

回复消息树对应的根消息的回复消息数量。

repliedInfo

public ZIMMessageRepliedInfo repliedInfo

回复消息引用的源消息的信息。

editorUserID

public NSString * editorUserID

本条消息最新的编辑者的 userID。

editedTime

public unsigned long long editedTime

本条消息最新的编辑时间戳。

isGroupTargetedMessage

public BOOL isGroupTargetedMessage

标识该消息是否为群定向消息。

pinnedUserID

public NSString * pinnedUserID

该消息的最后一次置顶的置顶者。

业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。

pinnedTime

public long long pinnedTime

该消息最后一次置顶的置顶时间。

业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。

ZIMFileMessageLiteInfo

文件消息的简要信息对象。

详情

标识一条文件消息。

Declared in ZIMDefines.h

属性

fileLocalPath

public NSString * fileLocalPath

媒体消息的文件的本地绝对路径。

是否必填：如果发送本地文件，则发送端必填，否则消息会发送失败。

fileDownloadUrl

public NSString * fileDownloadUrl

媒体消息的外部下载 URL，用于开发者将媒体文件上传到自己的服务器中时，通过填入该 URL 让 SDK 透传到其他用户中。

是否必填：如果发送的是外部 URL，发送端必填。

fileName

public NSString * fileName

媒体文件的文件名。

是否必填：如果发送的是外部 URL，则需要填写该值，且需要包含文件扩展名。如果发送的是本地文件，该值选填。

fileSize

public unsigned long long fileSize

媒体文件的大小。

是否必填：发送端不需要填，该值由 SDK 生成。

type

public ZIMMessageType type

消息类型。

ZIMFriendAddConfig

添加好友设置的行为属性。

详情

添加好友设置的行为属性。

Declared in ZIMDefines.h

属性

wording

public NSString * wording

添加好友附言。

friendAlias

public NSString * friendAlias

好友备注。

friendAttributes

public NSDictionary<NSString *, NSString *> * friendAttributes

好友属性。最多设置 5 个。属性的 key 仅支持从 k0 ～ k4 取值。

ZIMFriendApplicationAcceptConfig

接受好友申请的行为属性。

详情

接受好友申请的行为属性。

Declared in ZIMDefines.h

属性

friendAlias

public NSString * friendAlias

好友别名。

friendAttributes

public NSDictionary<NSString *, NSString *> * friendAttributes

好友属信

pushConfig

public ZIMPushConfig pushConfig

离线推送配置

ZIMFriendApplicationInfo

好友申请信息。

详情

好友申请信息。

Declared in ZIMDefines.h

属性

applyUser

public ZIMUserInfo applyUser

如果自己是申请人，则这里是被申请人信息；如果自己是被申请人，则这里是申请人信息；

wording

public NSString * wording

好友申请附言。

createTime

public int createTime

好友添加时间。

updateTime

public int updateTime

好友申请状态更新时间。

type

public ZIMFriendApplicationType type

好友申请类型。

state

public ZIMFriendApplicationState state

好友申请状态。

ZIMFriendApplicationListQueryConfig

查询好友申请列表配置。

详情

查询好友申请列表配置。

Declared in ZIMDefines.h

属性

count

public int count

当前查询总数。

nextFlag

public int nextFlag

当前查询锚点下标。

ZIMFriendApplicationRejectConfig

拒绝好友申请的行为属性。

详情

拒绝好友申请的行为属性。

public NSDictionary<NSString *, NSString *> * friendAttributes

好友属性。最多设置 5 个。属性的 key 仅支持从 k0 ～ k4 取值。

createTime

public int createTime

好友添加时间。

userName

public NSString * userName

用户 name，由开发者自定义生成。

是否必填：非必填。
取值范围：2.0.0 及以后版本，支持最大 256 字节的字符串。
隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。

userAvatarUrl

public NSString * userAvatarUrl

用户头像，由开发者自定义生成。

是否必填：非必填。
取值范围：特殊字符不受限制，最大长度为500字节。
隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。

支持版本：2.13.0 及以上。
注意事项：房间成员列表需要在 2.18.0 版本后才会返回该值。

userExtendedData

public NSString * userExtendedData

用户的扩展字段信息。

注意事项：仅房间用户时，该属性有值。

ZIMFriendListQueryConfig

查询好友列表配置。

详情

查询好友列表配置。

Declared in ZIMDefines.h

属性

count

public int count

当前查询总数。

nextFlag

public int nextFlag

当前查询锚点下标。

ZIMFriendRelationCheckConfig

检查好友关系的行为属性。

详情

检查好友关系的行为属性。

Declared in ZIMDefines.h

属性

type

public ZIMFriendRelationCheckType type

检查类型。

ZIMFriendRelationInfo

好友关系信息。

详情

好友关系信息。

Declared in ZIMDefines.h

属性

userID

public NSString * userID

用户ID。

type

public ZIMUserRelationType type

好友关系类型。

ZIMFriendsSearchConfig

搜索本地好友配置。

详情

搜索本地好友配置。

Declared in ZIMDefines.h

属性

keywords

public NSArray<NSString *> * keywords

搜索关键词列表。

isAlsoMatchFriendAlias

public BOOL isAlsoMatchFriendAlias

是否匹配好友别名。

count

public int count

当前搜索总数。

nextFlag

public int nextFlag

当前搜索起止下标。

ZIMGroup

群组列表的完整的信息。

详情

群组列表的完整的信息。

Declared in ZIMDefines.h

属性

baseInfo

public ZIMGroupInfo baseInfo

基本群组信息。

notificationStatus

public ZIMGroupMessageNotificationStatus notificationStatus

群组消息通知状态。

groupAlias

public NSString * groupAlias

用户自定的仅该用户可见的群备注。

ZIMGroupAdvancedConfig

群组高级配置。

详情

群组高级配置。

是否必填：是。

Declared in ZIMDefines.h

属性

groupAttributes

public HashMap<String, String> groupAttributes

群组属性，最多可配置 10 个。

是否必填：否。

groupNotice

public NSString * groupNotice

群公告。

是否必填：否。

maxMemberCount

public unsigned int maxMemberCount

群成员最大数量。

业务场景：当需要限制群成员数量时使用。
是否必填：否。
默认值：0。
取值范围：[0, 套餐默认的最大群成员数量]。

注意事项：支持版本 2.15 及以上。

joinMode

public ZIMGroupJoinMode joinMode

入群模式。

是否必填：否。

注意事项：支持版本 2.15 及以上。

inviteMode

public ZIMGroupInviteMode inviteMode

邀请模式。

是否必填：否。

注意事项：支持版本 2.15 及以上。

beInviteMode

public ZIMGroupBeInviteMode beInviteMode

邀请目标验证模式。

是否必填：否。

注意事项：支持版本 2.15 及以上。

ZIMGroupApplicationInfo

入群申请信息。

Declared in ZIMDefines.h

属性

applyUser

public ZIMUserInfo applyUser

类型为加入申请时是申请人，类型为邀请申请时是被邀请人，类型为被邀请申请时是邀请人。

wording

public NSString * wording

入群申请附言。

createTime

public unsigned long long createTime

入群申请创建时间戳，单位为毫秒。

updateTime

public unsigned long long updateTime

入群申请状态更新时间，单位为毫秒。

type

public ZIMGroupApplicationType type

入群申请类型。

state

public ZIMGroupApplicationState state

入群申请状态。

groupInfo

public ZIMGroupInfo groupInfo

申请入群的群信息。

operatedUser

public ZIMGroupMemberSimpleInfo operatedUser

同意外部用户加群申请的操作人。

ZIMGroupApplicationListQueryConfig

入群申请查询配置。

详情

通过该配置可以设置查询总条数以及分页查询

Declared in ZIMDefines.h

属性

count

public unsigned int count

数量，建议不超过 30。

是否必填：必填。

nextFlag

public unsigned int nextFlag

下一个标志。

是否必填：非必填，首次默认为 0，表示从头开始查询。

ZIMGroupAttributesUpdateInfo

群属性更新信息。

详情

群属性更新信息。

Declared in ZIMDefines.h

属性

action

public ZIMGroupAttributesUpdateAction action

群属性更新行为。

groupAttributes

public HashMap<String, String> groupAttributes

群属性。

ZIMGroupConversation

群会话对象，继承自ZIMGroupConversation。

详情

群会话对象，继承自ZIMGroupConversation。

Declared in ZIMDefines.h

属性

mutedExpiredTime

public long long mutedExpiredTime

群禁言的过期时间。

isDisabled

public BOOL isDisabled

这个群会话是否为不可用的状态。

conversationID

public NSString * conversationID

会话ID。

conversationName

public NSString * conversationName

conversationName,与会话对应的 groupName/userName 值相同。

type

public ZIMConversationType type

会话类型。

unreadMessageCount

public int unreadMessageCount

会话未读数。

lastMessage

public ZIMMessage lastMessage

最后一条消息。

orderKey

public long orderKey

用于描述消息在会话中的顺序，orderKey 越大越新。

notificationStatus

public ZIMConversationNotificationStatus notificationStatus

会话通知状态。

conversationAvatarUrl

public NSString * conversationAvatarUrl

会话头像 URL。单聊会话头像 URL 与用户头像 URL 相同，群聊会话头像 URL 与群头像 URL 相同。

使用限制：最大 500 字节，无特殊字符限制。

isPinned

public BOOL isPinned

会话是否置顶。

支持版本：2.8.0。

mentionedInfoList

public NSArray<ZIMMessageMentionedInfo *>* mentionedInfoList

当在会话的消息中被提醒到或者被提醒所有人时，该数组会有记录。

业务场景：比如可以在会话列表根据该数组显示当前会话有多少个提醒，还可以显示是哪个用户的提醒。

conversationAlias

public NSString * conversationAlias

业务场景：为好友或群组设置备注后，渲染会话页时，对应的会话优先选择展示 alias 别名，而不是 conversation name（好友的用户名或群组名）。

marks

public NSArray<NSNumber *> * marks

描述了该会话现有的所有标记。

业务场景：业务层可以按照不同会话拥有的不同标记做分组逻辑等。

draft

public NSString * draft

会话草稿，当设置会话草稿后，会话中会带有该字段。

ZIMGroupEnterInfo

群成员入群时的信息。

Declared in ZIMDefines.h

属性

enterType

public ZIMGroupEnterType enterType

入群类型。

enterTime

public unsigned long long enterTime

入群时服务端的时间戳。

operatedUser

public ZIMGroupMemberSimpleInfo operatedUser

同意加群申请的操作人或者邀请入群申请的邀请人。

ZIMGroupFullInfo

群组完整的信息。

详情

群组完整的信息。

Declared in ZIMDefines.h

属性

baseInfo

public ZIMGroupInfo baseInfo

基本群组信息。

groupAttributes

public HashMap<String, String> groupAttributes

群组属性。

groupNotice

public NSString* groupNotice

群公告。

notificationStatus

public ZIMGroupMessageNotificationStatus notificationStatus

群组消息通知状态。

mutedInfo

public ZIMGroupMuteInfo mutedInfo

群禁言信息。

createTime

public unsigned long long createTime

群创建时的服务端的时间戳。

注意事项：支持版本 2.15 及以上。

maxMemberCount

public unsigned int maxMemberCount

群成员最大数量。

注意事项：支持版本 2.15 及以上。

verifyInfo

public ZIMGroupVerifyInfo verifyInfo

入群的验证模式。

注意事项：支持版本 2.15 及以上。

groupAlias

public NSString * groupAlias

用户自定的仅该用户可见的群备注。

ZIMGroupInfo

群组信息。

详情

群组信息。

Declared in ZIMDefines.h

属性

groupID

public NSString * groupID

群组ID。

是否必填：非必填,若 groupID 为空后台会自动生成。
取值范围：最大 32 字节的字符串。仅支持数字，英文字符和 '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'。且不能以 ’#‘ 开头

groupName

public NSString * groupName

群名称。

是否必填：非必填。
取值范围：最大 50 字节的字符串。

groupAvatarUrl

public NSString * groupAvatarUrl

群头像 URL。

是否必填：非必填。

使用限制：最大 500 字节，无特殊字符限制。

群组成员信息。

详情

群组成员信息。

Declared in ZIMDefines.h

属性

memberNickname

public NSString * memberNickname

群组成员昵称。

memberRole

public int memberRole

群角色，1：群主，2：管理员，3：群成员。

memberAvatarUrl

deprecated

public NSString * memberAvatarUrl

群成员头像 URL。

使用限制：最大 500 字节，无特殊字符限制。

已废弃

废弃于 2.13.0 版本。如需获取群成员头像 URL，请查看 userAvatarUrl。

muteExpiredTime

public unsigned long long muteExpiredTime

群成员禁言过期时间。为 0 时即不禁言，为 -1 时即永久禁言。

groupEnterInfo

public ZIMGroupEnterInfo groupEnterInfo

群成员入群时的信息。

注意事项：支持版本 2.15 及以上。

userID

public NSString * userID

用户 ID，由开发者自定义生成。

是否必填：必填。
取值范围：最大 32 字节的字符串。仅支持数字，英文字符和 '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'。
隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。

注意事项：注意 userID 在同一个 appID 下需唯一，否则会出现互踢的情况。强烈建议 userID 与业务 APP 的用户 ID 一一对应，即一个 userID 与一个真实用户是固定且唯一的，而不应该是以随机的 userID 的方式传给 SDK 的方式。因为唯一且固定的 userID 可以让 ZEGO 技术人员快速定位线上问题。

userName

public NSString * userName

用户 name，由开发者自定义生成。

是否必填：非必填。
取值范围：2.0.0 及以后版本，支持最大 256 字节的字符串。
隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。

userAvatarUrl

public NSString * userAvatarUrl

用户头像，由开发者自定义生成。

是否必填：非必填。
取值范围：特殊字符不受限制，最大长度为500字节。
隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。

支持版本：2.13.0 及以上。
注意事项：房间成员列表需要在 2.18.0 版本后才会返回该值。

userExtendedData

public NSString * userExtendedData

用户的扩展字段信息。

注意事项：仅房间用户时，该属性有值。

ZIMGroupMemberMuteConfig

群组成员禁言配置。

详情

群组成员禁言配置。

是否必填：是。

Declared in ZIMDefines.h

属性

duration

public int duration

群组成员禁言时长，单位是秒。取值为 -1，即永久禁言。如需实现非永久禁言，取值上限为 604800（即 7 天）。如需上调，请联系 ZEGO 技术支持。

是否必填：必填。

ZIMGroupMemberMutedListQueryConfig

群禁言成员列表查询配置。

详情

群禁言成员列表查询配置。

Declared in ZIMDefines.h

属性

count

public int count

数量。

是否必填：必填。

nextFlag

public unsigned long long nextFlag

下一个标志。

是否必填：非必填，首次默认为空，表示从头开始查询。

ZIMGroupMemberQueryConfig

群成员查询配置。

详情

群成员查询配置。

Declared in ZIMDefines.h

属性

count

public int count

数量，上限为 100，超过 100 则按照 100 处理。

是否必填：必填。

nextFlag

public int nextFlag

下一个标志。

是否必填：非必填，首次默认为空，表示从头开始查询。

ZIMGroupMemberSearchConfig

群成员搜索配置。

详情

群成员搜索配置。

Declared in ZIMDefines.h

属性

count

unsigned int count

结果的数量。

是否必填：必填。

nextFlag

unsigned int nextFlag

查询的 flag ，第一次调用接口时填 0。后续再次调用接口时填从 callback 里返回的 nextFlag，以便获取剩余数据。

是否必填：非必填

keywords

NSArray<NSString *> * keywords

搜索关键字，最多支持 5 个，否则会报错。例如：传入 "1" 和 "2"，则搜索结果只会展示名称同时包含 "1" 和 "2" 这两个关键字的群成员。

是否必填：否

注意事项：最多支持填写 5 个，否则会报错。

isAlsoMatchGroupMemberNickname

BOOL isAlsoMatchGroupMemberNickname

搜索范围是否包括群成员用户昵称，默认为 false。

是否必填：否。
默认值：false。

ZIMGroupMemberSimpleInfo

群成员简要信息。

Declared in ZIMDefines.h

属性

memberNickname

public NSString * memberNickname

群组成员昵称。

memberRole

public int memberRole

群角色，1：群主，2：管理员，3：群成员。

userID

public NSString * userID

用户 ID，由开发者自定义生成。

是否必填：必填。
取值范围：最大 32 字节的字符串。仅支持数字，英文字符和 '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'。
隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。

注意事项：注意 userID 在同一个 appID 下需唯一，否则会出现互踢的情况。强烈建议 userID 与业务 APP 的用户 ID 一一对应，即一个 userID 与一个真实用户是固定且唯一的，而不应该是以随机的 userID 的方式传给 SDK 的方式。因为唯一且固定的 userID 可以让 ZEGO 技术人员快速定位线上问题。

userName

public NSString * userName

用户 name，由开发者自定义生成。

是否必填：非必填。
取值范围：2.0.0 及以后版本，支持最大 256 字节的字符串。
隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。

userAvatarUrl

public NSString * userAvatarUrl

用户头像，由开发者自定义生成。

是否必填：非必填。
取值范围：特殊字符不受限制，最大长度为500字节。
隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。

支持版本：2.13.0 及以上。
注意事项：房间成员列表需要在 2.18.0 版本后才会返回该值。

userExtendedData

public NSString * userExtendedData

用户的扩展字段信息。

注意事项：仅房间用户时，该属性有值。

ZIMGroupMessageReceiptMemberQueryConfig

详情

群消息回执已读/未读成员查询配置。

Declared in ZIMDefines.h

属性

count

public int count

需要查询的群成员数量。

是否必填：必填。

nextFlag

public int nextFlag

下一个标志。初始填 0，后续从 [ZIMGroupMessageReceiptMemberListQueriedCallback] 回调拿到下一个的 nextFlag。

ZIMGroupMuteConfig

群组禁言配置。

详情

群组禁言配置。

是否必填：是。

Declared in ZIMDefines.h

属性

mode

public ZIMGroupMuteMode mode

群组禁言模式。

默认值：All，全体禁言。
是否必填：是。

duration

public int duration

群组禁言时长，单位是秒。取值为 -1，即永久禁言。如需实现非永久禁言，取值上限为 604800（即 7 天）。如需上调，请联系 ZEGO 技术支持。

是否必填：必填。

roles

public NSArray<NSNumber *> * roles

群角色列表。

是否必填：仅当 ZIMGroupMuteMode 为 Custom 时，此字段才有意义。

注意事项：当列表中有 3（普通用户）时，必须同时存在其他角色，且不能为 1、2、4。如果仅需要禁言普通用户时，ZIMGroupMuteMode 需为 Normal。

ZIMGroupMuteInfo

群组禁言信息。

详情

群组禁言信息。

Declared in ZIMDefines.h

属性

mode

public ZIMGroupMuteMode mode

群组禁言模式。

expiredTime

public long long expiredTime

群组禁言过期时间，单位为秒。为 0 时为不禁言，为 -1 时为永久禁言。

roles

public NSArray\<NSNumber *> * roles

群被禁言角色列表。

ZIMGroupOperatedInfo

群组引发事件变化操作者的信息。

详情

群组引发事件变化操作者的信息。

Declared in ZIMDefines.h

属性

operatedUserInfo

deprecated

public ZIMGroupMemberInfo operatedUserInfo

群成员信息。

已废弃

自 2.3.0 版本已废弃，请使用该类的其他属性。同时，该属性类无法获取到群成员的头像 URL 信息。

userID

public NSString * userID

操作者的用户 ID。

userName

public NSString * userName

操作者的用户名。

memberNickname

public NSString * memberNickname

操作者的群成员昵称。

memberRole

public int memberRole

操作者的群成员角色。

ZIMGroupSearchConfig

群搜索配置。

详情

群搜索配置。

Declared in ZIMDefines.h

属性

count

public unsigned int count

搜索一次，可获取的群组数量。建议小于 20，以降低性能开销。

是否必填：必填。

nextFlag

public unsigned int nextFlag

查询的 flag 。

是否必填：首次查询时填 0。后续再次调用接口时，填从 Callback 回调里返回的 nextFlag，以便获取下一分页数据。

keywords

public NSArray<NSString *> * keywords

搜索关键字。例如：传入 "1" 和 "2"，则搜索结果只会展示群名称同时包含 "1" 和 "2" 这两个关键字的群组。

是否必填：否

注意事项：最多支持填写 5 个，否则会报错。

isAlsoMatchGroupMemberNickname

public BOOL isAlsoMatchGroupMemberNickname

搜索范围是否包括群成员用户昵称，默认为 false。

是否必填：否。
默认值：false。

isAlsoMatchGroupMemberUserName

public BOOL isAlsoMatchGroupMemberUserName

搜索范围是否包括群成员用户名称，默认为 false。

是否必填：否。
默认值：false。

ZIMGroupSearchInfo

群搜索信息。

详情

群组搜索信息。

Declared in ZIMDefines.h

属性

groupInfo

public ZIMGroupInfo * groupInfo

群信息

userList

public NSArray<ZIMGroupMemberInfo *> * userList

群成员信息。

ZIMGroupVerifyInfo

入群的验证模式。

Declared in ZIMDefines.h

属性

joinMode

public ZIMGroupJoinMode joinMode

加入群的验证模式。

inviteMode

public ZIMGroupInviteMode inviteMode

邀请入群的验证模式。

beInviteMode

public ZIMGroupBeInviteMode beInviteMode

被邀请入群的验证模式。

ZIMImageMessage

图片消息对象。

详情

标识一条图片消息。

注意事项：回调时若基类的 Type 参数为 Image，可将基类消息对象强转为此类。

Declared in ZIMDefines.h

属性

thumbnailLocalPath

public NSString * thumbnailLocalPath

图片文件的缩略图本地路径。

是否必填：发送端不需要填，当调用 [downloadMediaFile] 下载之后， SDK 会生成该值。

thumbnailDownloadUrl

public NSString * thumbnailDownloadUrl

图片文件的缩略图外部下载 URL。当开发者将缩略图上传到自己的服务器上时，可以通过该字段让 SDK 透传到其他用户中。

是否必填：发送端选填，当 fileDownloadUrl 填入后，该字段才生效。

largeImageLocalPath

public NSString * largeImageLocalPath

图片文件的大图本地路径。

是否必填：发送端不需要填，当调用 [downloadMediaFile] 下载之后， SDK 会生成该值。

largeImageDownloadUrl

public NSString * largeImageDownloadUrl

图片文件的大图外部下载 URL。当开发者将大图上传到自己的服务器上时，可以通过该字段让 SDK 透传到其他用户中。

是否必填：发送端选填，当 fileDownloadUrl 填入后，该字段才生效。

originalImageSize

public CGSize originalImageSize

原图宽高。在 2.19.0 版本后对于透传图片消息（即该 URL 由客户自行传入的情况）支持传入，ZIM 会做透传处理；对于本地图片消息如果传入，ZIM 会在发送时检查是否正确，如果不正确将会自动纠正。

业务场景：用户需要绘出图片 UI 时，用于确定原图宽高的参数。

largeImageSize

public CGSize largeImageSize

大图宽高。在 2.19.0 版本后对于透传图片消息（即该 URL 由客户自行传入的情况）支持传入，ZIM 会做透传处理；对于本地图片消息如果传入，ZIM 会在发送时检查是否正确，如果不正确将会自动纠正。

业务场景：用户需要绘出图片 UI 时，用于确定大图宽高的参数。

thumbnailSize

public CGSize thumbnailSize

缩略图宽高。在 2.19.0 版本后对于透传图片消息（即该 URL 由客户自行传入的情况）支持传入，ZIM 会做透传处理；对于本地图片消息如果传入，ZIM 会在发送时检查是否正确，如果不正确将会自动纠正。

业务场景：用户需要绘出图片 UI 时，用于确定缩略图宽高的参数。

fileLocalPath

public NSString * fileLocalPath

媒体消息的文件的本地绝对路径。

是否必填：如果发送本地文件，则发送端必填，否则消息会发送失败。

fileDownloadUrl

public NSString * fileDownloadUrl

媒体消息的外部下载 URL，用于开发者将媒体文件上传到自己的服务器中时，通过填入该 URL 让 SDK 透传到其他用户中。

是否必填：如果发送的是外部 URL，发送端必填。

fileUID

public NSString * fileUID

媒体文件的唯一 ID。

是否必填：发送端不需要填，该值由 SDK 生成。

fileName

public NSString * fileName

媒体文件的文件名。

是否必填：如果发送的是外部 URL，则需要填写该值，且需要包含文件扩展名。如果发送的是本地文件，该值选填。

fileSize

public unsigned long long fileSize

媒体文件的大小。

是否必填：发送端不需要填，该值由 SDK 生成。

type

public ZIMMessageType type

消息类型。

messageID

public long long messageID

标识这条消息的唯一 ID。

业务场景：可用于索引其他消息。

注意事项：开发者主动创建一条消息时，不需要修改这个参数，此参数仅在回调时有值。

timestamp

public unsigned long long timestamp

标识一条消息的发送时间。

业务场景：用于呈现一条消息的发送时间，并可用于消息排序。

注意事项：此为标准 UNIX 时间戳，单位为毫秒。

senderUserID

public NSString * senderUserID

展示本条消息发送者的 userID。

conversationID

public NSString * conversationID

会话的 ID，相同会话类型下的 ID 是唯一的。

direction

public ZIMMessageDirection direction

用于描述消息的方向是发送还是接收。

sentStatus

public ZIMMessageSentStatus sentStatus

描述消息的发送状态。

conversationType

public ZIMConversationType conversationType

该消息所属会话的类型。

conversationSeq

public unsigned long long conversationSeq

表示该消息在会话中的序号。

orderKey

public long long orderKey

orderKey 越大消息越新，可用于消息排序。

localMessageID

public long long localMessageID

SDK 本地生成的 MessageID,开发者无需关注。

isUserInserted

public BOOL isUserInserted

该消息是否是开发者通过 [insertMessageToLocalDB] 接口插入的消息。

默认值：false。

receiptStatus

public ZIMMessageReceiptStatus receiptStatus

描述该消息的回执状态。

业务场景：用于在回执消息中，判断当前消息是处于什么状态。

extendedData

public NSString extendedData

消息拓展字段。

业务场景：可为消息附加拓展字段，然后发送给对端。
是否必填：否。

支持版本：2.6.0 及以上。
注意事项：长度为1k，可联系技术支持进行配置。

localExtendedData

public NSString * localExtendedData

isBroadcastMessage

public BOOL isBroadcastMessage

该消息是否是全员推送消息。

是否必填：SDK内部赋值。

isMentionAll

public BOOL isMentionAll

是否需要提醒所有人。业务表现可为“@所有人”。

业务场景：例如在群或者房间可使用。
是否必填：否。
默认值：false。
建议值：如果需要提醒所有人，可以设置为 true。

注意事项：该值并不会在消息文本上增加 @所有人的字样，需要开发者自行实现。

支持版本 : 2.14.0 及以上。

mentionedUserIDs

public NSArray\<NSString *> * mentionedUserIDs

提醒一批相关的用户。业务表现可为“@某用户”。

业务场景：发消息时可以带上
是否必填：否。

注意事项：该值并不会在消息文本上增加 @某用户的字样，需要开发者自行实现。

支持版本 : 2.14.0 及以上。

messageSeq

public unsigned long long messageSeq

表示该消息在会话中的序号。

rootRepliedCount

public unsigned int rootRepliedCount

回复消息树对应的根消息的回复消息数量。

repliedInfo

public ZIMMessageRepliedInfo repliedInfo

回复消息引用的源消息的信息。

editorUserID

public NSString * editorUserID

本条消息最新的编辑者的 userID。

editedTime

public unsigned long long editedTime

本条消息最新的编辑时间戳。

isGroupTargetedMessage

public BOOL isGroupTargetedMessage

标识该消息是否为群定向消息。

pinnedUserID

public NSString * pinnedUserID

该消息的最后一次置顶的置顶者。

业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。

pinnedTime

public long long pinnedTime

该消息最后一次置顶的置顶时间。

业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。

ZIMImageMessageLiteInfo

图片消息的简要信息对象。

详情

标识一条图片消息。

Declared in ZIMDefines.h

属性

thumbnailLocalPath

public NSString * thumbnailLocalPath

图片文件的缩略图本地路径。

是否必填：发送端不需要填，当调用 [downloadMediaFile] 下载之后， SDK 会生成该值。

thumbnailDownloadUrl

public NSString * thumbnailDownloadUrl

图片文件的缩略图外部下载 URL。当开发者将缩略图上传到自己的服务器上时，可以通过该字段让 SDK 透传到其他用户中。

是否必填：发送端选填，当 fileDownloadUrl 填入后，该字段才生效。

largeImageLocalPath

public NSString * largeImageLocalPath

图片文件的大图本地路径。

是否必填：发送端不需要填，当调用 [downloadMediaFile] 下载之后， SDK 会生成该值。

largeImageDownloadUrl

public NSString * largeImageDownloadUrl

图片文件的大图外部下载 URL。当开发者将大图上传到自己的服务器上时，可以通过该字段让 SDK 透传到其他用户中。

是否必填：发送端选填，当 fileDownloadUrl 填入后，该字段才生效。

fileLocalPath

public NSString * fileLocalPath

媒体消息的文件的本地绝对路径。

是否必填：如果发送本地文件，则发送端必填，否则消息会发送失败。

fileDownloadUrl

public NSString * fileDownloadUrl

媒体消息的外部下载 URL，用于开发者将媒体文件上传到自己的服务器中时，通过填入该 URL 让 SDK 透传到其他用户中。

是否必填：如果发送的是外部 URL，发送端必填。

fileName

public NSString * fileName

媒体文件的文件名。

是否必填：如果发送的是外部 URL，则需要填写该值，且需要包含文件扩展名。如果发送的是本地文件，该值选填。

fileSize

public unsigned long long fileSize

媒体文件的大小。

是否必填：发送端不需要填，该值由 SDK 生成。

type

public ZIMMessageType type

消息类型。

ZIMLogConfig

日志配置。

详情

配置日志文件保存路径和日志文件大小上限。

Declared in ZIMDefines.h

属性

logPath

public NSString * logPath

日志文件的存储路径，默认路径参考官网文档。

是否必填：非必填。
默认值：Android：/storage/Android/data/[packageName]/files/ZIMLogs iOS：~~/Library/Caches/ZIMLogs macOS：（沙箱）~~/Library/Containers/[Bundle ID]/Data/Library/Caches/ZIMLogs / ；（非沙箱）~/Library/Caches/ZIMLogs Windows：C:\Users[Your UserName]\AppData[App Name]ZEGO.SDK\ZIMLogs
建议值：建议使用默认值。

注意事项：请注意设置的目录是否有读写权限，否则会导致 SDK 无法正确执行。

logSize

public unsigned long long logSize

日志文件大小上限 (Bytes)。

是否必填：非必填。
默认值：默认大小 5MB (5 * 1024 * 1024 Bytes)。
建议值：建议使用默认大小，太大会导致磁盘占用过多，太小会导致日志记录不全。

ZIMLoginConfig

登录相关参数配置。

详情

登录相关参数。

业务场景：用于登录时设置不同的参数。

支持版本：2.13.0 及以上。

Declared in ZIMDefines.h

属性

userName

public NSString * userName

用户昵称。

业务场景：用于登录同时修改用户昵称的场景，无需变更时传空。
是否必填：否。

token

public NSString * token

登录时携带的 token。

业务场景：仅在使用 token 鉴权的场景中传入。
是否必填：否。

isOfflineLogin

public BOOL isOfflineLogin

是否是离线登录。

业务场景：在离线登录时需要传入 true。
是否必填：否。
默认值：false。

customStatus

public NSString * customStatus

用户自定义状态，默认最大值为 64 字节，默认过期时间为 1 天，过期后重置为空字符串。登录时，如果该字段为空字符串（默认为空字符串），那么不会修改当前用户的自定义状态。

支持版本：2.20.0

ZIMMediaDownloadConfig

下载媒体文件的配置。

Declared in ZIMDefines.h

属性

messageInfoIndex

public int messageInfoIndex

下载组合消息里的某个文件所在数组的索引。

是否必填：下载组合消息的文件时必填。

ZIMMediaMessage

媒体消息对象基类。

详情

标识一条媒体消息。

注意事项：该基类是所有媒体消息的基础，包含媒体消息所需要的属性。

Declared in ZIMDefines.h

属性

fileLocalPath

public NSString * fileLocalPath

媒体消息的文件的本地绝对路径。

是否必填：如果发送本地文件，则发送端必填，否则消息会发送失败。

fileDownloadUrl

public NSString * fileDownloadUrl

媒体消息的外部下载 URL，用于开发者将媒体文件上传到自己的服务器中时，通过填入该 URL 让 SDK 透传到其他用户中。

是否必填：如果发送的是外部 URL，发送端必填。

fileUID

public NSString * fileUID

媒体文件的唯一 ID。

是否必填：发送端不需要填，该值由 SDK 生成。

fileName

public NSString * fileName

媒体文件的文件名。

是否必填：如果发送的是外部 URL，则需要填写该值，且需要包含文件扩展名。如果发送的是本地文件，该值选填。

fileSize

public unsigned long long fileSize

媒体文件的大小。

是否必填：发送端不需要填，该值由 SDK 生成。

type

public ZIMMessageType type

消息类型。

messageID

public long long messageID

标识这条消息的唯一 ID。

业务场景：可用于索引其他消息。

注意事项：开发者主动创建一条消息时，不需要修改这个参数，此参数仅在回调时有值。

timestamp

public unsigned long long timestamp

标识一条消息的发送时间。

业务场景：用于呈现一条消息的发送时间，并可用于消息排序。

注意事项：此为标准 UNIX 时间戳，单位为毫秒。

senderUserID

public NSString * senderUserID

展示本条消息发送者的 userID。

conversationID

public NSString * conversationID

会话的 ID，相同会话类型下的 ID 是唯一的。

direction

public ZIMMessageDirection direction

用于描述消息的方向是发送还是接收。

sentStatus

public ZIMMessageSentStatus sentStatus

描述消息的发送状态。

conversationType

public ZIMConversationType conversationType

该消息所属会话的类型。

conversationSeq

public unsigned long long conversationSeq

表示该消息在会话中的序号。

orderKey

public long long orderKey

orderKey 越大消息越新，可用于消息排序。

localMessageID

public long long localMessageID

SDK 本地生成的 MessageID,开发者无需关注。

isUserInserted

public BOOL isUserInserted

该消息是否是开发者通过 [insertMessageToLocalDB] 接口插入的消息。

默认值：false。

receiptStatus

public ZIMMessageReceiptStatus receiptStatus

描述该消息的回执状态。

业务场景：用于在回执消息中，判断当前消息是处于什么状态。

extendedData

public NSString extendedData

消息拓展字段。

业务场景：可为消息附加拓展字段，然后发送给对端。
是否必填：否。

支持版本：2.6.0 及以上。
注意事项：长度为1k，可联系技术支持进行配置。

localExtendedData

public NSString * localExtendedData

isBroadcastMessage

public BOOL isBroadcastMessage

该消息是否是全员推送消息。

是否必填：SDK内部赋值。

isMentionAll

public BOOL isMentionAll

是否需要提醒所有人。业务表现可为“@所有人”。

业务场景：例如在群或者房间可使用。
是否必填：否。
默认值：false。
建议值：如果需要提醒所有人，可以设置为 true。

注意事项：该值并不会在消息文本上增加 @所有人的字样，需要开发者自行实现。

支持版本 : 2.14.0 及以上。

mentionedUserIDs

public NSArray\<NSString *> * mentionedUserIDs

提醒一批相关的用户。业务表现可为“@某用户”。

业务场景：发消息时可以带上
是否必填：否。

注意事项：该值并不会在消息文本上增加 @某用户的字样，需要开发者自行实现。

支持版本 : 2.14.0 及以上。

messageSeq

public unsigned long long messageSeq

表示该消息在会话中的序号。

rootRepliedCount

public unsigned int rootRepliedCount

回复消息树对应的根消息的回复消息数量。

repliedInfo

public ZIMMessageRepliedInfo repliedInfo

回复消息引用的源消息的信息。

editorUserID

public NSString * editorUserID

本条消息最新的编辑者的 userID。

editedTime

public unsigned long long editedTime

本条消息最新的编辑时间戳。

isGroupTargetedMessage

public BOOL isGroupTargetedMessage

标识该消息是否为群定向消息。

pinnedUserID

public NSString * pinnedUserID

该消息的最后一次置顶的置顶者。

业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。

pinnedTime

public long long pinnedTime

该消息最后一次置顶的置顶时间。

业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。

ZIMMediaMessageLiteInfo

媒体消息简要信息对象基类。

详情

标识一条媒体消息。

注意事项：该基类是所有媒体消息简要信息的基础，包含媒体消息简要信息所需要的属性。

Declared in ZIMDefines.h

属性

fileLocalPath

public NSString * fileLocalPath

媒体消息的文件的本地绝对路径。

是否必填：如果发送本地文件，则发送端必填，否则消息会发送失败。

fileDownloadUrl

public NSString * fileDownloadUrl

媒体消息的外部下载 URL，用于开发者将媒体文件上传到自己的服务器中时，通过填入该 URL 让 SDK 透传到其他用户中。

是否必填：如果发送的是外部 URL，发送端必填。

fileName

public NSString * fileName

媒体文件的文件名。

是否必填：如果发送的是外部 URL，则需要填写该值，且需要包含文件扩展名。如果发送的是本地文件，该值选填。

fileSize

public unsigned long long fileSize

媒体文件的大小。

是否必填：发送端不需要填，该值由 SDK 生成。

type

public ZIMMessageType type

消息类型。

ZIMMessage

消息对象的基类。

详情

标识一条消息的基本参数。

注意事项：其中的部分参数如 Message ID 仅在回调时有值。开发者主动创建此对象用于发送消息时不需要给这些参数赋值。

Declared in ZIMDefines.h

属性

type

public ZIMMessageType type

消息类型。

messageID

public long long messageID

标识这条消息的唯一 ID。

业务场景：可用于索引其他消息。

注意事项：开发者主动创建一条消息时，不需要修改这个参数，此参数仅在回调时有值。

timestamp

public unsigned long long timestamp

标识一条消息的发送时间。

业务场景：用于呈现一条消息的发送时间，并可用于消息排序。

注意事项：此为标准 UNIX 时间戳，单位为毫秒。

senderUserID

public NSString * senderUserID

展示本条消息发送者的 userID。

conversationID

public NSString * conversationID

会话的 ID，相同会话类型下的 ID 是唯一的。

direction

public ZIMMessageDirection direction

用于描述消息的方向是发送还是接收。

sentStatus

public ZIMMessageSentStatus sentStatus

描述消息的发送状态。

conversationType

public ZIMConversationType conversationType

该消息所属会话的类型。

conversationSeq

public unsigned long long conversationSeq

表示该消息在会话中的序号。

orderKey

public long long orderKey

orderKey 越大消息越新，可用于消息排序。

localMessageID

public long long localMessageID

SDK 本地生成的 MessageID,开发者无需关注。

isUserInserted

public BOOL isUserInserted

该消息是否是开发者通过 [insertMessageToLocalDB] 接口插入的消息。

默认值：false。

receiptStatus

public ZIMMessageReceiptStatus receiptStatus

描述该消息的回执状态。

业务场景：用于在回执消息中，判断当前消息是处于什么状态。

extendedData

public NSString extendedData

消息拓展字段。

业务场景：可为消息附加拓展字段，然后发送给对端。
是否必填：否。

支持版本：2.6.0 及以上。
注意事项：长度为1k，可联系技术支持进行配置。

localExtendedData

public NSString * localExtendedData

isBroadcastMessage

public BOOL isBroadcastMessage

该消息是否是全员推送消息。

是否必填：SDK内部赋值。

isMentionAll

public BOOL isMentionAll

是否需要提醒所有人。业务表现可为“@所有人”。

业务场景：例如在群或者房间可使用。
是否必填：否。
默认值：false。
建议值：如果需要提醒所有人，可以设置为 true。

注意事项：该值并不会在消息文本上增加 @所有人的字样，需要开发者自行实现。

支持版本 : 2.14.0 及以上。

mentionedUserIDs

public NSArray\<NSString *> * mentionedUserIDs

提醒一批相关的用户。业务表现可为“@某用户”。

业务场景：发消息时可以带上
是否必填：否。

注意事项：该值并不会在消息文本上增加 @某用户的字样，需要开发者自行实现。

支持版本 : 2.14.0 及以上。

messageSeq

public unsigned long long messageSeq

表示该消息在会话中的序号。

rootRepliedCount

public unsigned int rootRepliedCount

回复消息树对应的根消息的回复消息数量。

repliedInfo

public ZIMMessageRepliedInfo repliedInfo

回复消息引用的源消息的信息。

editorUserID

public NSString * editorUserID

本条消息最新的编辑者的 userID。

editedTime

public unsigned long long editedTime

本条消息最新的编辑时间戳。

isGroupTargetedMessage

public BOOL isGroupTargetedMessage

标识该消息是否为群定向消息。

pinnedUserID

public NSString * pinnedUserID

该消息的最后一次置顶的置顶者。

业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。

pinnedTime

public long long pinnedTime

该消息最后一次置顶的置顶时间。

业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。

ZIMMessageDeleteConfig

删除消息配置。

详情

删除消息的相关配置。

Declared in ZIMDefines.h

属性

isAlsoDeleteServerMessage

public BOOL isAlsoDeleteServerMessage

是否删除服务器消息的标志。

是否必填：非必填。
默认值：false。

ZIMMessageDeletedInfo

被删除的消息信息。

Declared in ZIMDefines.h

属性

conversationID

public NSString * conversationID

会话 ID。

conversationType

public ZIMConversationType conversationType

会话类型。

messageList

public NSArray<ZIMMessage> * messageList

删除的消息列表。

isDeleteConversationAllMessage

deprecated

public BOOL isDeleteConversationAllMessage

是否删除会话当前所有消息。

已废弃

该字段在 2.14.0 版本被废弃。

messageDeleteType

public ZIMMessageDeleteType messageDeleteType

[onMessageDeleted] 被触发的原因。

ZIMMessageEditConfig

详情

（空类）编辑消息的相关配置。

Declared in ZIMDefines.h

ZIMMessageExportConfig

详情

导出消息的相关配置。该 Config 目前为预留参数。

Declared in ZIMDefines.h

ZIMMessageImportConfig

详情

导入消息的相关配置。该 Config 目前为预留参数。

Declared in ZIMDefines.h

ZIMMessageLiteInfo

消息简要信息对象的基类。

详情

标识一条消息的基本参数。

Declared in ZIMDefines.h

属性

type

public ZIMMessageType type

消息类型。

ZIMMessageMentionedInfo

消息提醒信息。

详情

消息提醒信息。

Declared in ZIMDefines.h

属性

messageID

public long messageID

消息ID，用于匹配该提醒信息是属于哪一条消息

是否必填：不需要开发者填写

fromUserID

public NSString * fromUserID

来自哪个用户。

是否必填：不需要开发者填写。

type

public ZIMMessageMentionedType type

消息提醒的类型，用于区分是提醒自己的还是提醒全部人的

是否必填：不需要开发者填写

messageSeq

public unsigned long long messageSeq

消息 seq。

ZIMMessagePinStatusChangeInfo

消息置顶状态变更通知。

详情

当会话内一条消息被成功置顶或取消置顶并触发通知时，可以通过该结构获取被操作的消息与当前置顶状态。

Declared in ZIMDefines.h

属性

pinStatus

public ZIMMessagePinStatus pinStatus

消息置顶状态。

message

public ZIMMessage message

根消息对象。

ZIMMessageQueryConfig

查询消息配置。

详情

查询消息的相关配置。

Declared in ZIMDefines.h

属性

nextMessage

public ZIMMessage nextMessage

查询消息的锚点。

是否必填：首次查询时不必填，后续分页查询时，需要填此参数。

count

public unsigned int count

查询消息的条数。

是否必填：必填。

reverse

public Boolean reverse

是否反序查询的标志。

是否必填：非必填。
默认值：false。

ZIMMessageReaction

表态具体内容。

详情

表态具体内容。

Declared in ZIMDefines.h

属性

conversationID

public NSString * conversationID

会话 ID。

conversationType

public ZIMConversationType conversationType

会话类型。

messageID

public long long messageID

表态的消息 ID。

reactionType

public NSString * reactionType

表态类型，由您定义，长度上限为 32 字节。

isSelfIncluded

public BOOL isSelfIncluded

已表态用户中是否包含自己。

totalCount

public unsigned int totalCount

表态的用户总数。

userList

public NSArray<ZIMMessageReactionUserInfo*> * userList

表态的用户列表。

ZIMMessageReactionUserInfo

表态用户信息。

详情

描述表态用户的类。

Declared in ZIMDefines.h

属性

userID

public NSString * userID

用户 ID

ZIMMessageReactionUserQueryConfig

用于查询表态详情成员的配置。

详情

查询表态成员时，需要配置此对象。

Declared in ZIMDefines.h

属性

nextFlag

public unsigned long long nextFlag

分页查询的标识位，首次查询时，将此字段设为空字符串。若 [ZIMMessageReactionUserListQueriedCallback] 回调的 "nextFlag" 字段不是空字符串，说明还没结束，需要将其设置到此处以继续下一页的查询。

业务场景：开发者可根据该字段进行分页查询成员列表，第一次查询传空。
是否必填：非必填。
默认值：空。

count

public unsigned int count

一次获取多少表态的成员。上限为 100，超出 100 会导致错误。

业务场景：开发者可以根据该参数来决定一次需要查询多少房间成员。
是否必填：必填。

注意事项：分页获取表态成员以降低开销，建议单次获取 20 人以内。若该处填写值为 0，SDK 会默认查询 100 人。

reactionType

public NSString * reactionType

表态类型，由您自行定义。

ZIMMessageReceiptInfo

回执信息。

详情

回执信息。

Declared in ZIMDefines.h

属性

status

public ZIMMessageReceiptStatus status

回执的状态。

messageID

public long long messageID

消息ID。

业务场景：开发者可根据这个ID 匹配已经加载过的消息列表。
是否必填：否，SDK填充。

conversationID

public NSString * conversationID

会话ID。

业务场景：用于表示这是属于哪个会话的回执信息。
是否必填：否，SDK填充。

conversationType

public ZIMConversationType conversationType

会话类型。

业务场景：用于表示这个会话所属类型。
是否必填：否，SDK填充。

readMemberCount

public unsigned int readMemberCount

表示该回执的已读人数。

业务场景：用于查询回执的信息时，可显示该消息已被多少人已读。
是否必填：否。
默认值：0。

注意事项：该值表示有多少人已读过该消息，仅适用于消息已读；如果是非自己发送的消息，该值为0。

unreadMemberCount

public unsigned int unreadMemberCount

表示该回执的未读人数。

业务场景：用于查询回执的信息时，可显示该消息已被多少人未读。
是否必填：否。
默认值：0。

注意事项：该值表示有多少人还没读过该消息，仅适用于消息已读；如果是非自己发送的消息，该值为0。

isSelfOperated

public BOOL isSelfOperated

多端登录场景时，A 设备设置消息回执已读后，其他在线多端设备用于区分是否自己设置的消息回执已读。

readTime

public unsigned long long readTime

消息回执已读时的服务端时间戳。

默认值：0。

注意事项：对应消息发送者，其值为会话成员全部已读时的时间戳，对于消息接收者，其值为设置消息回执已读时的时间戳。

ZIMMessageReceivedInfo

消息接收事件携带相关信息的结构体。

详情

消息接收事件携带相关信息的结构体。

支持版本：2.18.0 及以上版本。

Declared in ZIMDefines.h

属性

isOfflineMessage

public BOOL isOfflineMessage

消息是否为当前用户离线、短暂断网、登出期间发送，是的话为 true。

ZIMMessageRepliedInfo

回复消息引用的源消息的描述信息。

Declared in ZIMDefines.h

属性

state

public ZIMMessageRepliedInfoState state

源消息状态。

sentTime

public unsigned long long sentTime

源消息的发送服务端时间戳（UTC）。

senderUserID

public NSString * senderUserID

源消息的发送者用户 ID。

messageSeq

public unsigned long long messageSeq

源消息的seq。

messageInfo

public ZIMMessageLiteInfo messageInfo

源消息的简要信息。

messageID

public unsigned long long messageID

源消息 ID。

ZIMMessageRepliedListQueryConfig

用于查询回复消息列表的配置。

Declared in ZIMDefines.h

属性

nextFlag

public unsigned long long nextFlag

分页查询的标识位，首次查询时，将此字段设为0。若 [queryMessageRepliedList] 回调的 "nextFlag" 字段不为0，说明还没结束，需要将其设置到此处以继续下一页的查询。

count

public unsigned int count

单次查询的数量。上限为 100，超出 100 会导致错误。

是否必填：必填。

ZIMMessageRevokeConfig

详情

撤回消息的相关配置。

Declared in ZIMDefines.h

属性

revokeExtendedData

public NSString * revokeExtendedData

撤回附加消息。

是否必填：非必填。

pushConfig

public ZIMPushConfig pushConfig

发送离线推送的相关配置，如果集成了 Android 或 iOS 平台，强烈建议配置该项。

是否必填：非必填。

ZIMMessageRootRepliedCountInfo

回复消息树的回复数量的信息。

Declared in ZIMDefines.h

属性

conversationID

public NSString * conversationID

会话 ID。

conversationType

public ZIMConversationType conversationType

会话类型。

messageID

public unsigned long long messageID

根消息 ID。

count

public unsigned int count

回复消息树的回复数量。

ZIMMessageRootRepliedInfo

回复消息树的根消息的描述信息。

Declared in ZIMDefines.h

属性

state

public ZIMMessageRepliedInfoState state

根消息状态。

sentTime

public unsigned long long sentTime

根消息的发送时间戳。

senderUserID

public NSString * senderUserID

根消息的发送者用户 ID。

repliedCount

public unsigned int repliedCount

回复消息树的回复数量。

message

public ZIMMessage message

根消息对象。

ZIMMessageSearchConfig

消息搜索配置。

详情

消息搜索配置。

Declared in ZIMDefines.h

属性

nextMessage

ZIMMessage * nextMessage

分页拉取标志，即指拉取 nextMessage 之后或之前的消息，“之后”或“之前”由 order 值决定。第一次搜索时，nextMessage 为 null。之后搜索时，nextMessage 需传入上次查询到的消息列表的最后一条消息。

是否必填：否。

count

unsigned int count

数量。建议小于 20 条，以降低性能开销。

是否必填：必填。

order

ZIMMessageOrder order

搜索消息时 "order" 为 "DESCENDING" 时，表示对发送时间比 nextMessage 早的消息进行查询。若是首次查询消息时（即 nextMessage 为 null），则从本地存储的最后一条消息向前查询。"order" 为 "ASCENDING" 时，表示对发送时间比 nextMessage 晚的消息进行查询。若是首次查询消息时（即 nextMessage 为 null），则从本地存储的第一条消息向后查询。默认为 "DESCENDING"。

keywords

NSArray<NSString *> * keywords

搜索关键字，最多支持 5 个，否则会报错。例如：传入 "1" 和 "2"，则搜索结果只会展示同时包含 "1" 和 "2" 这两个关键字的消息。

是否必填：否。

messageTypes

NSArray<NSNumber *> messageTypes

消息类型，可用于指定消息类型。支持传入多个类型。

是否必填：否。

subMessageTypes

NSArray<NSNumber *> subMessageTypes

自定义消息的子类型，取值范围为 [0,200]。开发者可基于此搜索具体的自定义类型。

是否必填：否。

senderUserIDs

NSArray<NSString *> senderUserIDs

消息发送用户 ID，最多支持 5 个。例如，传入 "zego2023"，则搜索结果只会展示 "zego2023" 用户在该会话中发送的所有消息。

是否必填：否。

startTime

long long startTime

搜索的起始时间点，单位：毫秒，默认为 0，格式：UTC 时间戳。

是否必填：否。

endTime

long long endTime

搜索的结束时间点，必须大于 startTime，单位：毫秒，默认为 0，格式：UTC 时间戳。

是否必填：否。

ZIMMessageSendConfig

详情

发送消息的相关配置。

Declared in ZIMDefines.h

属性

pushConfig

public ZIMPushConfig pushConfig

发送离线推送的相关配置，如果集成了 Android 或 iOS 平台，强烈建议配置该项。

是否必填：非必填。

priority

public ZIMMessagePriority priority

用于设置消息优先级的枚举值。

是否必填：必填。

hasReceipt

public BOOL hasReceipt

发送消息时候，该消息是否带回执。

业务场景：需要为一条消息带上回执时使用。
是否必填：非必填。
默认值：false。

isNotifyMentionedUsers

public BOOL isNotifyMentionedUsers

发送消息时候，是否离线推送通知该消息提及到的用户。

是否必填：非必填。
默认值：true。

isRetrySend

public BOOL isRetrySend

是否重发发送失败的消息。

是否必填：否。

disableUnreadMessageCount

public BOOL disableUnreadMessageCount

标识本次发送的消息是否不计入未读消息数。

业务场景：需要发送一条不计入未读消息数的消息时，需要将该参数置为 true。
是否必填：否。
默认值：false。

ZIMMessageSendNotification

消息发送时的通知回调，可以通过此通知获取消息对象发送前的相关信息

详情

通过该通知，开发者可以获取到消息对象发送前的相关信息，如 localMessageID 等。

业务场景：当开发者需要记录和缓存消息发送前的相关信息，可以通过监听该通知获取。

注意事项：若无需监听，可传空。

Declared in ZIMDefines.h

属性

onMessageAttached

public ZIMMessageAttachedCallback onMessageAttached

消息在落入本地 DB 后，将要向服务端发送消息之前，会回调该通知。

业务场景：用于开发者需要在发送消息之前，提前获取消息里的相关信息时，可以使用此接口。
是否必填：非必填。若无需监听的情况下，可传空。
默认值：空。

onMediaUploadingProgress

public ZIMMediaUploadingProgress onMediaUploadingProgress

通过该通知，开发者可以获取到媒体消息上传时的进度回调。

业务场景：开发者可用于展示发送媒体消息时的进度条，提升 UI 交互体验。
是否必填：非必填。若无需监听的情况下，可传空。

onMultipleMediaUploadingProgress

public ZIMMultipleMediaUploadingProgress onMultipleMediaUploadingProgress

通过该通知，开发者可以获取到组合消息里的媒体文件上传时的进度回调。

业务场景：开发者可用于展示各媒体文件的上传进度及总的上传进度，提升 UI 交互体验。
是否必填：非必填。

支持版本：2.19.0 及以上。

ZIMMessageSentStatusChangeInfo

消息状态变更通知。

详情

消息状态变更通知。

Declared in ZIMDefines.h

属性

message

public ZIMMessage message

消息详情。

status

public ZIMMessageSentStatus status

消息发送的状态。

reason

public NSString * reason

此字段记录服务端发送前回调拦截消息导致 ZIM 拒绝发送的原因。若您开通了 ZIM 内容审核服务，并需在此字段中获取审核未通过导致的失败原因，请联系 ZEGO 技术支持进行配置。

ZIMMultipleMessage

组合消息对象。

详情

标识一条组合消息。

注意事项：仅支持文本、图片、文件、音频、视频、自定义消息的组合，且数量不超过 20 个。

Declared in ZIMDefines.h

属性

messageInfoList

public NSArray<ZIMMessageLiteInfo *> * messageInfoList

可包含文本、图片、文件、音频、视频、自定义消息，数组长度不超过 20。

业务场景：可用于发送图文组合消息。

注意事项：总的 item 数量不超过 20，图片最多10个，文件、音频、视频、自定义消息最多各 1 个。其中图片、文件、音频、视频的大小和格式的限制与对应的富媒体消息一致。

type

public ZIMMessageType type

消息类型。

messageID

public long long messageID

标识这条消息的唯一 ID。

业务场景：可用于索引其他消息。

注意事项：开发者主动创建一条消息时，不需要修改这个参数，此参数仅在回调时有值。

timestamp

public unsigned long long timestamp

标识一条消息的发送时间。

业务场景：用于呈现一条消息的发送时间，并可用于消息排序。

注意事项：此为标准 UNIX 时间戳，单位为毫秒。

senderUserID

public NSString * senderUserID

展示本条消息发送者的 userID。

conversationID

public NSString * conversationID

会话的 ID，相同会话类型下的 ID 是唯一的。

direction

public ZIMMessageDirection direction

用于描述消息的方向是发送还是接收。

sentStatus

public ZIMMessageSentStatus sentStatus

描述消息的发送状态。

conversationType

public ZIMConversationType conversationType

该消息所属会话的类型。

conversationSeq

public unsigned long long conversationSeq

表示该消息在会话中的序号。

orderKey

public long long orderKey

orderKey 越大消息越新，可用于消息排序。

localMessageID

public long long localMessageID

SDK 本地生成的 MessageID,开发者无需关注。

isUserInserted

public BOOL isUserInserted

该消息是否是开发者通过 [insertMessageToLocalDB] 接口插入的消息。

默认值：false。

receiptStatus

public ZIMMessageReceiptStatus receiptStatus

描述该消息的回执状态。

业务场景：用于在回执消息中，判断当前消息是处于什么状态。

extendedData

public NSString extendedData

消息拓展字段。

业务场景：可为消息附加拓展字段，然后发送给对端。
是否必填：否。

支持版本：2.6.0 及以上。
注意事项：长度为1k，可联系技术支持进行配置。

localExtendedData

public NSString * localExtendedData

isBroadcastMessage

public BOOL isBroadcastMessage

该消息是否是全员推送消息。

是否必填：SDK内部赋值。

isMentionAll

public BOOL isMentionAll

是否需要提醒所有人。业务表现可为“@所有人”。

业务场景：例如在群或者房间可使用。
是否必填：否。
默认值：false。
建议值：如果需要提醒所有人，可以设置为 true。

注意事项：该值并不会在消息文本上增加 @所有人的字样，需要开发者自行实现。

支持版本 : 2.14.0 及以上。

mentionedUserIDs

public NSArray\<NSString *> * mentionedUserIDs

提醒一批相关的用户。业务表现可为“@某用户”。

业务场景：发消息时可以带上
是否必填：否。

注意事项：该值并不会在消息文本上增加 @某用户的字样，需要开发者自行实现。

支持版本 : 2.14.0 及以上。

messageSeq

public unsigned long long messageSeq

表示该消息在会话中的序号。

rootRepliedCount

public unsigned int rootRepliedCount

回复消息树对应的根消息的回复消息数量。

repliedInfo

public ZIMMessageRepliedInfo repliedInfo

回复消息引用的源消息的信息。

editorUserID

public NSString * editorUserID

本条消息最新的编辑者的 userID。

editedTime

public unsigned long long editedTime

本条消息最新的编辑时间戳。

isGroupTargetedMessage

public BOOL isGroupTargetedMessage

标识该消息是否为群定向消息。

pinnedUserID

public NSString * pinnedUserID

该消息的最后一次置顶的置顶者。

业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。

pinnedTime

public long long pinnedTime

该消息最后一次置顶的置顶时间。

业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。

ZIMMultipleMessageLiteInfo

组合消息的简要信息对象。

详情

标识一条组合消息。

Declared in ZIMDefines.h

属性

messageInfoList

public NSArray<ZIMMessageLiteInfo *> * messageInfoList

组合消息的元素列表。

type

public ZIMMessageType type

消息类型。

ZIMOfflinePushPrivateMessageTemplate

离线推送私信模版。

详情

根据 OPUSH私信模版校验能力接入说明,OPPO 在新消息分类的基础上新增了推送私信模版，当您在 OPPO 控制台配置好私信模版后，如需在推送时应用对应模版，可在 ZIMPushConfig 为 privateMessageTemplate 赋值。

Declared in ZIM.h

属性

templateID

public NSString * templateID

OPPO 推送私信模板 ID，下发对应私信模板时必须携带。如果resourceID 中 OPPO 的 category 设置分类为内容与营销，则此字段无效。详细请参见 [OPUSH私信模版校验能力接入说明](https://open.oppomobile.com/documentation/page/info?id=12391

titleParameters

public NSString * titleParameters

json 字符串， OPPO 推送标题模板填充参数。例：私信模板 ID 标题模板为：欢迎来到 $\{city\}$ ， $\{city\}$ 欢迎您。此参数内容为："{"city":"北京"}"。

contentParameters

public NSString * contentParameters

json 字符串，OPPO 推送内容模板填充参数。例：私信模板 ID 对应的内容模板为：欢迎 $\{userName\}$ 来到 $\{city\}$ 。此参数内容为："{"userName":"汤姆"，"city":"深圳市"}"。

ZIMPushConfig

详情描述:离线推送配置。

详情

发送离线推送前的配置。

Declared in ZIMDefines.h

属性

title

public NSString * title

用于设置推送标题。

是否必填：非必填。

content

public NSString * content

用于设置离线推送的内容。

是否必填：非必填。

payload

public NSString * payload

用于设置离线推送的透传字段。

是否必填：非必填。

resourcesID

public NSString * resourcesID

由开发者自定义，长度不超过 32 个字符的字符串，用于映射多个厂商进阶配置的离线推送字段，将多个厂商的推送配置抽象为一种您自定的推送策略。详细介绍与配置步骤请参考 resourcesID 说明。

默认值：在未设置 resourceID 的情况下，推送类型为普通弹窗推送（APNs 为 Alert，FCM 为 Notification Message）。
是否必填：非必填。

enableBadge

public BOOL enableBadge

推送是否携带角标信息开关。

badgeIncrement

public int badgeIncrement

推送携带的增量角标数。

voIPConfig

public ZIMVoIPConfig voIPConfig

如果您使用 Flutter、RN ZPNs, 离线推送接收端设备有 iOS 且使用了 VoIP 推送类型，可以通过该参数来自定义一些 VoIP 的选项。

privateMessageTemplate

public ZIMOfflinePushPrivateMessageTemplate privateMessageTemplate

如果您使用 OPPO 推送，可以通过该结构来应用 OPPO 私信模版，否则可以忽略，默认为空。

ZIMRevokeMessage

撤回消息对象基类。

详情

标识一条撤回消息。

注意事项：该基类是所有撤回消息的基础，包含撤回消息所需要的属性。

Declared in ZIMDefines.h

属性

revokeType

public ZIMRevokeType revokeType

撤回类型。

revokeStatus

public ZIMMessageRevokeStatus revokeStatus

撤回状态。

revokeTimestamp

public int revokeTimestamp

撤回时间戳。

operatedUserID

public NSString * operatedUserID

撤回操作者的用户 ID。

revokeExtendedData

public NSString * revokeExtendedData

撤回附带的消息。

originalMessageType

public ZIMMessageType originalMessageType

原始消息类型。

originalTextMessageContent

public NSString * originalTextMessageContent

原始消息内容。

type

public ZIMMessageType type

消息类型。

messageID

public long long messageID

标识这条消息的唯一 ID。

业务场景：可用于索引其他消息。

注意事项：开发者主动创建一条消息时，不需要修改这个参数，此参数仅在回调时有值。

timestamp

public unsigned long long timestamp

标识一条消息的发送时间。

业务场景：用于呈现一条消息的发送时间，并可用于消息排序。

注意事项：此为标准 UNIX 时间戳，单位为毫秒。

senderUserID

public NSString * senderUserID

展示本条消息发送者的 userID。

conversationID

public NSString * conversationID

会话的 ID，相同会话类型下的 ID 是唯一的。

direction

public ZIMMessageDirection direction

用于描述消息的方向是发送还是接收。

sentStatus

public ZIMMessageSentStatus sentStatus

描述消息的发送状态。

conversationType

public ZIMConversationType conversationType

该消息所属会话的类型。

conversationSeq

public unsigned long long conversationSeq

表示该消息在会话中的序号。

orderKey

public long long orderKey

orderKey 越大消息越新，可用于消息排序。

localMessageID

public long long localMessageID

SDK 本地生成的 MessageID,开发者无需关注。

isUserInserted

public BOOL isUserInserted

该消息是否是开发者通过 [insertMessageToLocalDB] 接口插入的消息。

默认值：false。

receiptStatus

public ZIMMessageReceiptStatus receiptStatus

描述该消息的回执状态。

业务场景：用于在回执消息中，判断当前消息是处于什么状态。

extendedData

public NSString extendedData

消息拓展字段。

业务场景：可为消息附加拓展字段，然后发送给对端。
是否必填：否。

支持版本：2.6.0 及以上。
注意事项：长度为1k，可联系技术支持进行配置。

localExtendedData

public NSString * localExtendedData

isBroadcastMessage

public BOOL isBroadcastMessage

该消息是否是全员推送消息。

是否必填：SDK内部赋值。

isMentionAll

public BOOL isMentionAll

是否需要提醒所有人。业务表现可为“@所有人”。

业务场景：例如在群或者房间可使用。
是否必填：否。
默认值：false。
建议值：如果需要提醒所有人，可以设置为 true。

注意事项：该值并不会在消息文本上增加 @所有人的字样，需要开发者自行实现。

支持版本 : 2.14.0 及以上。

mentionedUserIDs

public NSArray\<NSString *> * mentionedUserIDs

提醒一批相关的用户。业务表现可为“@某用户”。

业务场景：发消息时可以带上
是否必填：否。

注意事项：该值并不会在消息文本上增加 @某用户的字样，需要开发者自行实现。

支持版本 : 2.14.0 及以上。

messageSeq

public unsigned long long messageSeq

表示该消息在会话中的序号。

rootRepliedCount

public unsigned int rootRepliedCount

回复消息树对应的根消息的回复消息数量。

repliedInfo

public ZIMMessageRepliedInfo repliedInfo

回复消息引用的源消息的信息。

editorUserID

public NSString * editorUserID

本条消息最新的编辑者的 userID。

editedTime

public unsigned long long editedTime

本条消息最新的编辑时间戳。

isGroupTargetedMessage

public BOOL isGroupTargetedMessage

标识该消息是否为群定向消息。

pinnedUserID

public NSString * pinnedUserID

该消息的最后一次置顶的置顶者。

业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。

pinnedTime

public long long pinnedTime

该消息最后一次置顶的置顶时间。

业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。

ZIMRevokeMessageLiteInfo

撤回消息的简要信息对象。

Declared in ZIMDefines.h

属性

type

public ZIMMessageType type

消息类型。

ZIMRoomAdvancedConfig

房间高级属性配置。

详情

房间的高级属性配置。

Declared in ZIMDefines.h

属性

roomAttributes

public std::unordered_map<std::string, std::string> & roomAttributes

房间中的房间属性，用户可以自定义

是否必填：是。

roomDestroyDelayTime

public unsigned int roomDestroyDelayTime

房间延迟销毁时间，单位为秒。最长房间延迟销毁时间是3小时。

业务场景：房间人数为0时，设置房间时间，保证这段时间内房间的存在。
是否必填：非必填。

ZIMRoomAttributesBatchOperationConfig

房间属性设置的行为属性。

详情

房间属性设置的行为属性。

Declared in ZIMDefines.h

属性

isDeleteAfterOwnerLeft

public BOOL isDeleteAfterOwnerLeft

业务场景：语聊房场景中，麦位上的人被踢出后，自动删除麦位信息。
是否必填：非必填。
默认值：false。

isForce

public BOOL isForce

是否可以强制修改其他用户的房间属性。如果为true，则可以修改其他用户的房间属性，如果为false，则不允许修改其他用户的房间属性。

业务场景：语聊房场景中，房主强制修改麦位信息。
是否必填：非必填。
默认值：false。

isUpdateOwner

public BOOL isUpdateOwner

是否更新涉及到的房间属性的拥有者。

业务场景：强行变更该房间属性的拥有人为操作者。
是否必填：非必填。
默认值：false。

ZIMRoomAttributesDeleteConfig

房间属性删除的行为属性。

详情

房间属性删除的行为属性。

Declared in ZIMDefines.h

属性

isForce

public BOOL isForce

是否可以强制删除其他用户的房间属性。如果为true，则可以删除其他用户的房间属性，如果为false，则不允许删除其他用户的房间属性。

业务场景：语聊房场景中，房主强制删除麦位信息。
是否必填：非必填。
默认值：false。

ZIMRoomAttributesSetConfig

房间属性设置的行为属性。

详情

房间属性设置的行为属性。

Declared in ZIMDefines.h

属性

isDeleteAfterOwnerLeft

public BOOL isDeleteAfterOwnerLeft

房间属性在拥有者离开房间后自动删除。

业务场景：语聊房场景中，麦位上的人被踢出后，自动删除麦位信息。
是否必填：非必填。
默认值：false。

isForce

public BOOL isForce

是否可以强制修改其他用户的房间属性。如果为true，则可以修改其他用户的房间属性，如果为false，则不允许修改其他用户的房间属性。

业务场景：语聊房场景中，房主强制修改麦位信息。
是否必填：非必填。
默认值：false。

isUpdateOwner

public BOOL isUpdateOwner

是否更新涉及到的房间属性的拥有者。

业务场景：强行变更该房间属性的拥有人为操作者。
是否必填：非必填。
默认值：false。

ZIMRoomAttributesUpdateInfo

房间属性变更通知。

详情

房间属性变更通知。

Declared in ZIMDefines.h

属性

action

public ZIMRoomAttributesUpdateAction action

房间属性变更通知的行为信息。

是否必填：是。

roomAttributes

public std::unordered_map<std::string, std::string> roomAttributes

房间属性。

是否必填：否。

ZIMRoomFullInfo

房间详细资料对象。

详情

标识一个房间的详细资料。

Declared in ZIMDefines.h

属性

baseInfo

public ZIMRoomInfo baseInfo

房间基类对象。

ZIMRoomInfo

房间资料基础对象。

详情

标识一个唯一房间。

Declared in ZIMDefines.h

属性

roomID

public NSString * roomID

房间 ID，最大 128 字节的字符串，由开发者自定义生成。

是否必填：必填。
取值范围：最大 128 字节的字符串。仅支持数字，英文字符和 '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'。

roomName

public NSString * roomName

房间名，由开发者自定义生成，最大长度不超过 64 字节的字符串。

是否必填：必填。

ZIMRoomMemberAttributesInfo

房间用户属性信息。

详情

描述房间用户属性的类，包含 UserID 以及其对应的属性。

Declared in ZIMDefines.h

属性

userID

public NSString * userID

用户 ID。

attributes

public NSDictionary<NSString *,NSString *> * attributes

房间用户属性。

ZIMRoomMemberAttributesOperatedInfo

房间用户属性操作信息。

详情

房间用户属性操作信息，包含成功操作的属性与失败的 Key。

Declared in ZIMDefines.h

属性

attributesInfo

public ZIMRoomMemberAttributesInfo attributesInfo

房间用户属性信息。

errorKeys

public NSArray<NSString *> * errorKeys

房间用户属性操作失败的 Key。

ZIMRoomMemberAttributesQueryConfig

房间用户属性查询配置。

详情

房间用户属性查询配置。

Declared in ZIMDefines.h

属性

nextFlag

public NSString * nextFlag

房间用户属性的查询锚点。

是否必填：非必填，首次默认为空，表示从头开始查询。

count

public unsigned int count

分页查询的数量。

是否必填：必填。

ZIMRoomMemberAttributesSetConfig

房间用户属性设置配置。

详情

房间用户属性设置配置，包含可配置用户离开后是否保留用户属性等。

业务场景：开发者可以在设置房间用户属性时，根据自身的实际应用场景选择使用。

Declared in ZIMDefines.h

属性

isDeleteAfterOwnerLeft

public BOOL isDeleteAfterOwnerLeft

配置房间用户属性在用户离开房间后，是否保存下来。

是否必填：非必填。
默认值：true。

ZIMRoomMemberAttributesUpdateInfo

房间用户属性更新信息。

详情

房间用户属性更新信息。

Declared in ZIMDefines.h

属性

attributesInfo

public ZIMRoomMemberAttributesInfo attributesInfo

房间用户属性。

ZIMRoomMemberInfo

房间用户信息。

详情

描述房间用户的类。

Declared in ZIMDefines.h

属性

userID

public NSString * userID

用户 ID，由开发者自定义生成。

是否必填：必填。
取值范围：最大 32 字节的字符串。仅支持数字，英文字符和 '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'。
隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。

注意事项：注意 userID 在同一个 appID 下需唯一，否则会出现互踢的情况。强烈建议 userID 与业务 APP 的用户 ID 一一对应，即一个 userID 与一个真实用户是固定且唯一的，而不应该是以随机的 userID 的方式传给 SDK 的方式。因为唯一且固定的 userID 可以让 ZEGO 技术人员快速定位线上问题。

userName

public NSString * userName

用户 name，由开发者自定义生成。

是否必填：非必填。
取值范围：2.0.0 及以后版本，支持最大 256 字节的字符串。
隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。

userAvatarUrl

public NSString * userAvatarUrl

用户头像，由开发者自定义生成。

是否必填：非必填。
取值范围：特殊字符不受限制，最大长度为500字节。
隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。

支持版本：2.13.0 及以上。
注意事项：房间成员列表需要在 2.18.0 版本后才会返回该值。

userExtendedData

public NSString * userExtendedData

用户的扩展字段信息。

注意事项：仅房间用户时，该属性有值。

ZIMRoomMemberQueryConfig

用于查询房间成员的配置。

详情

查找成员时，需要配置此对象。

Declared in ZIMDefines.h

属性

nextFlag

public NSString * nextFlag

分页查询的标识位，首次查询时，将此字段设为空字符串。若回调的 "nextFlag" 字段不是空字符串，说明还没结束，需要将其设置到此处以继续下一页的查询。

业务场景：开发者可根据该字段进行分页查询成员列表，第一次查询传空。
是否必填：非必填。
默认值：空。

count

public unsigned int count

一次获取多少房间成员。

业务场景：开发者可以根据该参数来决定一次需要查询多少房间成员。
是否必填：必填。

注意事项：分页获取房间成员以降低开销，建议单次获取 100 人以内。若该处填写值为 0，SDK 会默认查询 100 人。

ZIMRoomOperatedInfo

房间操作信息。

详情

房间操作信息。

Declared in ZIMDefines.h

属性

userID

public NSString * userID

操作者的 UserID。

ZIMSelfUserInfo

携带当前用户的用户信息、规则。

详情

携带当前用户的用户信息、规则。

Declared in ZIMDefines.h

属性

userRule

属性

userIDs

public NSArray\<NSString *\> * userIDs

如果您需要查询指定的用户是否在当前用户的订阅列表中，请传入该值，否则将会返回订阅表中的所有用户。

ZIMTextMessage

普通文本消息对象。

详情

标识一条普通文本消息。

注意事项：回调时若基类的 Type 参数为 Text，可将基类消息对象强转为此类。

Declared in ZIMDefines.h

属性

message

public NSString * message

消息的内容，支持任意数据。如果此消息的类型为 Text 文本消息，则应当为标准 UTF-8 字符串。

是否必填：发送端必填，否则消息会发送失败。

type

public ZIMMessageType type

消息类型。

messageID

public long long messageID

标识这条消息的唯一 ID。

业务场景：可用于索引其他消息。

注意事项：开发者主动创建一条消息时，不需要修改这个参数，此参数仅在回调时有值。

timestamp

public unsigned long long timestamp

标识一条消息的发送时间。

业务场景：用于呈现一条消息的发送时间，并可用于消息排序。

注意事项：此为标准 UNIX 时间戳，单位为毫秒。

senderUserID

public NSString * senderUserID

展示本条消息发送者的 userID。

conversationID

public NSString * conversationID

会话的 ID，相同会话类型下的 ID 是唯一的。

direction

public ZIMMessageDirection direction

用于描述消息的方向是发送还是接收。

sentStatus

public ZIMMessageSentStatus sentStatus

描述消息的发送状态。

conversationType

public ZIMConversationType conversationType

该消息所属会话的类型。

conversationSeq

public unsigned long long conversationSeq

表示该消息在会话中的序号。

orderKey

public long long orderKey

orderKey 越大消息越新，可用于消息排序。

localMessageID

public long long localMessageID

SDK 本地生成的 MessageID,开发者无需关注。

isUserInserted

public BOOL isUserInserted

该消息是否是开发者通过 [insertMessageToLocalDB] 接口插入的消息。

默认值：false。

receiptStatus

public ZIMMessageReceiptStatus receiptStatus

描述该消息的回执状态。

业务场景：用于在回执消息中，判断当前消息是处于什么状态。

extendedData

public NSString extendedData

消息拓展字段。

业务场景：可为消息附加拓展字段，然后发送给对端。
是否必填：否。

支持版本：2.6.0 及以上。
注意事项：长度为1k，可联系技术支持进行配置。

localExtendedData

public NSString * localExtendedData

isBroadcastMessage

public BOOL isBroadcastMessage

该消息是否是全员推送消息。

是否必填：SDK内部赋值。

isMentionAll

public BOOL isMentionAll

是否需要提醒所有人。业务表现可为“@所有人”。

业务场景：例如在群或者房间可使用。
是否必填：否。
默认值：false。
建议值：如果需要提醒所有人，可以设置为 true。

注意事项：该值并不会在消息文本上增加 @所有人的字样，需要开发者自行实现。

支持版本 : 2.14.0 及以上。

mentionedUserIDs

public NSArray\<NSString *> * mentionedUserIDs

提醒一批相关的用户。业务表现可为“@某用户”。

业务场景：发消息时可以带上
是否必填：否。

注意事项：该值并不会在消息文本上增加 @某用户的字样，需要开发者自行实现。

支持版本 : 2.14.0 及以上。

messageSeq

public unsigned long long messageSeq

表示该消息在会话中的序号。

rootRepliedCount

public unsigned int rootRepliedCount

回复消息树对应的根消息的回复消息数量。

repliedInfo

public ZIMMessageRepliedInfo repliedInfo

回复消息引用的源消息的信息。

editorUserID

public NSString * editorUserID

本条消息最新的编辑者的 userID。

editedTime

public unsigned long long editedTime

本条消息最新的编辑时间戳。

isGroupTargetedMessage

public BOOL isGroupTargetedMessage

标识该消息是否为群定向消息。

pinnedUserID

public NSString * pinnedUserID

该消息的最后一次置顶的置顶者。

业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。

pinnedTime

public long long pinnedTime

该消息最后一次置顶的置顶时间。

业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。

方法

ZIMTextMessage

- (void)ZIMTextMessage;

Declared in ZIMDefines.h

ZIMTextMessageLiteInfo

普通文本消息简要信息对象。

详情

标识一条普通文本消息的简要信息。

注意事项：回调时若基类的 Type 参数为 Text，可将基类消息简要信息对象强转为此类。

Declared in ZIMDefines.h

属性

message

public NSString * message

消息的内容，支持任意数据。如果此消息的类型为 Text 文本消息，则应当为标准 UTF-8 字符串。

是否必填：发送端必填，否则消息会发送失败。

type

public ZIMMessageType type

消息类型。

方法

ZIMTextMessageLiteInfo

- (void)ZIMTextMessageLiteInfo;

Declared in ZIMDefines.h

ZIMTipsMessage

Tips 消息对象。

详情

标识一条 Tips 消息。

注意事项：回调时若基类的 Type 参数为 Tips，可将基类消息对象强转为此类。

Declared in ZIMDefines.h

属性

event

public ZIMTipsMessageEvent event

Tips 消息对应的事件。

operatedUser

public ZIMUserInfo * operatedUser

Tips 消息对应行为的触发者。

targetUserList

public NSArray<ZIMUserInfo> * targetUserList

Tips 消息对应操作的目标用户列表。

changeInfo

public ZIMTipsMessageChangeInfo * changeInfo

Tips 消息对应操作的附加信息。

type

public ZIMMessageType type

消息类型。

messageID

public long long messageID

标识这条消息的唯一 ID。

业务场景：可用于索引其他消息。

注意事项：开发者主动创建一条消息时，不需要修改这个参数，此参数仅在回调时有值。

timestamp

public unsigned long long timestamp

标识一条消息的发送时间。

业务场景：用于呈现一条消息的发送时间，并可用于消息排序。

注意事项：此为标准 UNIX 时间戳，单位为毫秒。

senderUserID

public NSString * senderUserID

展示本条消息发送者的 userID。

conversationID

public NSString * conversationID

会话的 ID，相同会话类型下的 ID 是唯一的。

direction

public ZIMMessageDirection direction

用于描述消息的方向是发送还是接收。

sentStatus

public ZIMMessageSentStatus sentStatus

描述消息的发送状态。

conversationType

public ZIMConversationType conversationType

该消息所属会话的类型。

conversationSeq

public unsigned long long conversationSeq

表示该消息在会话中的序号。

orderKey

public long long orderKey

orderKey 越大消息越新，可用于消息排序。

localMessageID

public long long localMessageID

SDK 本地生成的 MessageID,开发者无需关注。

isUserInserted

public BOOL isUserInserted

该消息是否是开发者通过 [insertMessageToLocalDB] 接口插入的消息。

默认值：false。

receiptStatus

public ZIMMessageReceiptStatus receiptStatus

描述该消息的回执状态。

业务场景：用于在回执消息中，判断当前消息是处于什么状态。

extendedData

public NSString extendedData

消息拓展字段。

业务场景：可为消息附加拓展字段，然后发送给对端。
是否必填：否。

支持版本：2.6.0 及以上。
注意事项：长度为1k，可联系技术支持进行配置。

localExtendedData

public NSString * localExtendedData

isBroadcastMessage

public BOOL isBroadcastMessage

该消息是否是全员推送消息。

是否必填：SDK内部赋值。

isMentionAll

public BOOL isMentionAll

是否需要提醒所有人。业务表现可为“@所有人”。

业务场景：例如在群或者房间可使用。
是否必填：否。
默认值：false。
建议值：如果需要提醒所有人，可以设置为 true。

注意事项：该值并不会在消息文本上增加 @所有人的字样，需要开发者自行实现。

支持版本 : 2.14.0 及以上。

mentionedUserIDs

public NSArray\<NSString *> * mentionedUserIDs

提醒一批相关的用户。业务表现可为“@某用户”。

业务场景：发消息时可以带上
是否必填：否。

注意事项：该值并不会在消息文本上增加 @某用户的字样，需要开发者自行实现。

支持版本 : 2.14.0 及以上。

messageSeq

public unsigned long long messageSeq

表示该消息在会话中的序号。

rootRepliedCount

public unsigned int rootRepliedCount

回复消息树对应的根消息的回复消息数量。

repliedInfo

public ZIMMessageRepliedInfo repliedInfo

回复消息引用的源消息的信息。

editorUserID

public NSString * editorUserID

本条消息最新的编辑者的 userID。

editedTime

public unsigned long long editedTime

本条消息最新的编辑时间戳。

isGroupTargetedMessage

public BOOL isGroupTargetedMessage

标识该消息是否为群定向消息。

pinnedUserID

public NSString * pinnedUserID

该消息的最后一次置顶的置顶者。

业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。

pinnedTime

public long long pinnedTime

该消息最后一次置顶的置顶时间。

业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。

ZIMTipsMessageChangeInfo

Tips 消息额外信息。

详情

Tips 消息额外信息。

Declared in ZIMDefines.h

属性

type

public ZIMTipsMessageChangeInfoType type

Tips 消息额外信息类型。

ZIMTipsMessageGroupChangeInfo

Tips 消息群相关变化事件附加信息。

详情

Tips 消息群相关变化事件附加信息。

Declared in ZIMDefines.h

属性

groupDataFlag

public unsigned int groupDataFlag

如果群名，群头像，群公告存在复数变更，则需要由该字段的值知道哪些存在变更。其中 0b0001 是群名，0b0010 是群公告，0b0100 是群头像。

groupName

public NSString * groupName

如果群名发生变更，则此处会展示变更后的值。

groupNotice

public NSString * groupNotice

如果群名发生变更，则此处会展示变更后的值。

groupAvatarUrl

public NSString * groupAvatarUrl

如果群头像发生变更，则此处会展示变更后的值。

groupMutedInfo

public ZIMGroupMuteInfo * groupMutedInfo

如果群禁言状态发生变更，则此处会展示变更后的值。

type

public ZIMTipsMessageChangeInfoType type

Tips 消息额外信息类型。

ZIMTipsMessageGroupMemberChangeInfo

Tips 消息群成员相关变化事件附加信息。

详情

Tips 消息群成员相关变化事件附加信息。

Declared in ZIMDefines.h

属性

memberRole

public int memberRole

如果群成员角色发生了变化，这里会展示变更后的角色。

muteExpiredTime

public unsigned long long muteExpiredTime

如果群成员禁言时间发生了变化，这里会展示新的禁言时间。

groupNewOwner

public ZIMGroupMemberSimpleInfo * groupNewOwner

当群主离开群，或被服务端踢出群组时，群内新群主的信息。

业务场景：用于当群主离开群，或被服务端踢出群组时业务层做 UI 展示时使用。

type

public ZIMTipsMessageChangeInfoType type

Tips 消息额外信息类型。

ZIMTipsMessagePinStatusChangeInfo

Tips 消息群消息置顶状态变化事件附加信息。

详情

Tips 消息群消息置顶状态变化事件附加信息。

Declared in ZIMDefines.h

属性

isPinned

public BOOL isPinned

描述本次操作是置顶操作还是取消置顶操作。

type

public ZIMTipsMessageChangeInfoType type

Tips 消息额外信息类型。

ZIMUserFullInfo

用户详细资料对象。

详情

标识一个唯一用户。

注意事项：注意 userID 在同一个 appID 下需唯一，否则会出现互踢的情况。强烈建议 userID 与业务 APP 的用户 ID 一一对应，即一个 userID 与一个真实用户是固定且唯一的，而不应该是以随机的 userID 的方式传给 SDK 的方式。因为唯一且固定的 userID 可以让 ZEGO 技术人员快速定位线上问题。

Declared in ZIMDefines.h

属性

baseInfo

public ZIMUserInfo baseInfo

用户基本信息。

是否必填：必填。

userAvatarUrl

deprecated

public NSString * userAvatarUrl

用户头像 URL。

是否必填：非必填。

使用限制：最大 500 字节，无特殊字符限制。

已废弃

废弃于 2.13.0 版本。如需获取用户头像 URL，请查看 baseInfo 的 userAvatarUrl。

extendedData

public NSString * extendedData

用户扩展信息。

是否必填：非必填。
隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。

ZIMUserInfo

用户资料对象。

详情

标识一个唯一用户。

注意事项：注意 userID 在同一个 appID 下需唯一，否则会出现互踢的情况。强烈建议 userID 与业务 APP 的用户 ID 一一对应，即一个 userID 与一个真实用户是固定且唯一的，而不应该是以随机的 userID 的方式传给 SDK 的方式。因为唯一且固定的 userID 可以让 ZEGO 技术人员快速定位线上问题。

Declared in ZIMDefines.h

属性

userID

public NSString * userID

用户 ID，由开发者自定义生成。

是否必填：必填。
取值范围：最大 32 字节的字符串。仅支持数字，英文字符和 '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'。
隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。

注意事项：注意 userID 在同一个 appID 下需唯一，否则会出现互踢的情况。强烈建议 userID 与业务 APP 的用户 ID 一一对应，即一个 userID 与一个真实用户是固定且唯一的，而不应该是以随机的 userID 的方式传给 SDK 的方式。因为唯一且固定的 userID 可以让 ZEGO 技术人员快速定位线上问题。

userName

public NSString * userName

用户 name，由开发者自定义生成。

是否必填：非必填。
取值范围：2.0.0 及以后版本，支持最大 256 字节的字符串。
隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。

userAvatarUrl

public NSString * userAvatarUrl

用户头像，由开发者自定义生成。

是否必填：非必填。
取值范围：特殊字符不受限制，最大长度为500字节。
隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。

支持版本：2.13.0 及以上。
注意事项：房间成员列表需要在 2.18.0 版本后才会返回该值。

userExtendedData

public NSString * userExtendedData

用户的扩展字段信息。

注意事项：仅房间用户时，该属性有值。

ZIMUserOfflinePushRule

用户离线推送规则的数据类。

详情

用户离线推送规则的数据类。

Declared in ZIMDefines.h

属性

onlinePlatforms

public List\<int> onlinePlatforms

与该数据类中的 notToReceiveOfflinePushPlatforms 成员变量搭配使用。onlinePlatforms 指定的平台在线时，notToReceiveOfflinePushPlatforms 指定的平台将不会收到离线推送。

取值范围：请填入 ZIMPlatformType 枚举中平台对应的枚举值。

notToReceiveOfflinePushPlatforms

public List\<int> notToReceiveOfflinePushPlatforms

与该数据类中的 onlinePlatforms 成员变量搭配使用。onlinePlatforms 指定的平台在线时，notToReceiveOfflinePushPlatforms 指定的平台将不会收到离线推送。

取值范围：请填入 ZIMPlatformType 枚举中平台对应的枚举值。

ZIMUserStatus

用户状态相关数据。

详情

包含用户在线状态的相关数据。

Declared in ZIMDefines.h

属性

userID

public NSString * userID

单个用户的唯一标识符。

onlineStatus

public ZIMUserOnlineStatus onlineStatus

表示用户当前在线状态的枚举。

onlinePlatforms

public List\<Number> onlinePlatforms

当前用户的在线平台列表，可以用于展示这名用户在哪些平台在线，如 iPhone 在线、电脑端在线。平台取值含义请参考 ZIMPlatform。

lastUpdateTime

public long lastUpdateTime

用户 onlineStatus 或 customStatus 最后一次变更时的时间戳,取两者较大值。

lastOnlineStatusUpdateTime

public long lastOnlineStatusUpdateTime

用户 onlineStatus 最后一次变更时的时间戳，可以用于展示 xxx 分钟前离线/登录。

lastCustomStatusUpdateTime

public long lastCustomStatusUpdateTime

用户 customStatus 最后一次变更时的时间戳，可以用于展示自定义状态的最后变更时间。

customStatus

public NSString * customStatus

ZIMUserStatusSubscribeConfig

subscribeUsersStatus 批量订阅用户在线状态接口的配置项。

详情

批量订阅用户在线状态接口的配置项。

Declared in ZIMDefines.h

属性

subscriptionDuration

public unsigned int subscriptionDuration

用于设置这次订阅的有效时长。

是否必填：必填。
取值范围：1 ～ 43200（30 天），单位为分钟。

注意事项：超过订阅时长后，这名被订阅用户将会从订阅列表中删除，之后这名用户的状态变更，将不会再同步给订阅者。

ZIMUserStatusSubscription

用户态订阅信息。包含用户的在线状态、在线平台列表、订阅过期时间戳等。

详情

用户状态订阅信息。包含用户的在线状态、在线平台列表、订阅过期时间戳等。

支持版本：2.18.0

Declared in ZIMDefines.h

属性

userStatus

public ZIMUserStatus userStatus

这名用户的在线状态有关的数据。

subscribeExpiredTime

public long subscribeExpiredTime

这名用户订阅过期的时间戳。

ZIMUsersInfoQueryConfig

用户信息查询配置。

详情

详细描述：用户信息查询配置，可以选择从本地查询或者从服务端查询。从本地查询无限频约束，从服务端查询有限频约束，10 s 内最多只能查询 10 个用户详细配置。

Declared in ZIMDefines.h

属性

isQueryFromServer

public BOOL isQueryFromServer

是否从服务端查询用户详细信息。从本地查询无限频约束，从服务端查询有限频约束，10 s 内最多只能查询 10 个用户详细配置。

是否必填：非必填。
默认值：false。

ZIMVideoMessage

视频消息对象。

详情

标识一条视频消息。

使用限制：仅支持视频编码格式为 H264 和 H265 的视频文件在消息发送成功后获取该视频首帧的宽、高信息。
注意事项：回调时若基类的 Type 参数为 Video，可将基类消息对象强转为此类。

Declared in ZIMDefines.h

属性

videoDuration

public unsigned long long videoDuration

视频文件的时长。

是否必填：发送本地视频时，发送端必填，不填会导致视频消息发送失败。

videoFirstFrameLocalPath

public NSString * videoFirstFrameLocalPath

视频文件的首帧图本地路径。

是否必填：发送端不需要填，当调用 [downloadMediaFile] 下载之后， SDK 会生成该值。

videoFirstFrameDownloadUrl

public NSString * videoFirstFrameDownloadUrl

视频文件的缩略图外部下载 URL。当开发者将首帧图上传到自己的服务器上时，可以通过该字段让 SDK 透传到其他用户中。

是否必填：发送端选填，当 fileDownloadUrl 填入后，该字段才生效。

videoFirstFrameSize

public CGSize videoFirstFrameSize

视频首帧宽高。在 2.19.0 版本后对于透传图片消息（即该 URL 由客户自行传入的情况）支持传入，ZIM 会做透传处理；对于本地图片消息如果传入，ZIM 会在发送时检查是否正确，如果不正确将会自动纠正。

业务场景：用户需要绘出图片 UI 时，用于确定视频首帧宽高的参数。

fileLocalPath

public NSString * fileLocalPath

媒体消息的文件的本地绝对路径。

是否必填：如果发送本地文件，则发送端必填，否则消息会发送失败。

fileDownloadUrl

public NSString * fileDownloadUrl

媒体消息的外部下载 URL，用于开发者将媒体文件上传到自己的服务器中时，通过填入该 URL 让 SDK 透传到其他用户中。

是否必填：如果发送的是外部 URL，发送端必填。

fileUID

public NSString * fileUID

媒体文件的唯一 ID。

是否必填：发送端不需要填，该值由 SDK 生成。

fileName

public NSString * fileName

媒体文件的文件名。

是否必填：如果发送的是外部 URL，则需要填写该值，且需要包含文件扩展名。如果发送的是本地文件，该值选填。

fileSize

public unsigned long long fileSize

媒体文件的大小。

是否必填：发送端不需要填，该值由 SDK 生成。

type

public ZIMMessageType type

消息类型。

messageID

public long long messageID

标识这条消息的唯一 ID。

业务场景：可用于索引其他消息。

注意事项：开发者主动创建一条消息时，不需要修改这个参数，此参数仅在回调时有值。

timestamp

public unsigned long long timestamp

标识一条消息的发送时间。

业务场景：用于呈现一条消息的发送时间，并可用于消息排序。

注意事项：此为标准 UNIX 时间戳，单位为毫秒。

senderUserID

public NSString * senderUserID

展示本条消息发送者的 userID。

conversationID

public NSString * conversationID

会话的 ID，相同会话类型下的 ID 是唯一的。

direction

public ZIMMessageDirection direction

用于描述消息的方向是发送还是接收。

sentStatus

public ZIMMessageSentStatus sentStatus

描述消息的发送状态。

conversationType

public ZIMConversationType conversationType

该消息所属会话的类型。

conversationSeq

public unsigned long long conversationSeq

表示该消息在会话中的序号。

orderKey

public long long orderKey

orderKey 越大消息越新，可用于消息排序。

localMessageID

public long long localMessageID

SDK 本地生成的 MessageID,开发者无需关注。

isUserInserted

public BOOL isUserInserted

该消息是否是开发者通过 [insertMessageToLocalDB] 接口插入的消息。

默认值：false。

receiptStatus

public ZIMMessageReceiptStatus receiptStatus

描述该消息的回执状态。

业务场景：用于在回执消息中，判断当前消息是处于什么状态。

extendedData

public NSString extendedData

消息拓展字段。

业务场景：可为消息附加拓展字段，然后发送给对端。
是否必填：否。

支持版本：2.6.0 及以上。
注意事项：长度为1k，可联系技术支持进行配置。

localExtendedData

public NSString * localExtendedData

isBroadcastMessage

public BOOL isBroadcastMessage

该消息是否是全员推送消息。

是否必填：SDK内部赋值。

isMentionAll

public BOOL isMentionAll

是否需要提醒所有人。业务表现可为“@所有人”。

业务场景：例如在群或者房间可使用。
是否必填：否。
默认值：false。
建议值：如果需要提醒所有人，可以设置为 true。

注意事项：该值并不会在消息文本上增加 @所有人的字样，需要开发者自行实现。

支持版本 : 2.14.0 及以上。

mentionedUserIDs

public NSArray\<NSString *> * mentionedUserIDs

提醒一批相关的用户。业务表现可为“@某用户”。

业务场景：发消息时可以带上
是否必填：否。

注意事项：该值并不会在消息文本上增加 @某用户的字样，需要开发者自行实现。

支持版本 : 2.14.0 及以上。

messageSeq

public unsigned long long messageSeq

表示该消息在会话中的序号。

rootRepliedCount

public unsigned int rootRepliedCount

回复消息树对应的根消息的回复消息数量。

repliedInfo

public ZIMMessageRepliedInfo repliedInfo

回复消息引用的源消息的信息。

editorUserID

public NSString * editorUserID

本条消息最新的编辑者的 userID。

editedTime

public unsigned long long editedTime

本条消息最新的编辑时间戳。

isGroupTargetedMessage

public BOOL isGroupTargetedMessage

标识该消息是否为群定向消息。

pinnedUserID

public NSString * pinnedUserID

该消息的最后一次置顶的置顶者。

业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。

pinnedTime

public long long pinnedTime

该消息最后一次置顶的置顶时间。

业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。

ZIMVideoMessageLiteInfo

视频消息的简要信息对象。

详情

标识一条视频消息。

使用限制：仅支持视频编码格式为 H264 和 H265 的视频文件在消息发送成功后获取该视频首帧的宽、高信息。

Declared in ZIMDefines.h

属性

videoDuration

public unsigned long long videoDuration

视频文件的时长。

是否必填：发送本地视频时，发送端必填，不填会导致视频消息发送失败。

videoFirstFrameLocalPath

public NSString * videoFirstFrameLocalPath

视频文件的首帧图本地路径。

是否必填：发送端不需要填，当调用 [downloadMediaFile] 下载之后， SDK 会生成该值。

videoFirstFrameDownloadUrl

public NSString * videoFirstFrameDownloadUrl

视频文件的缩略图外部下载 URL。当开发者将首帧图上传到自己的服务器上时，可以通过该字段让 SDK 透传到其他用户中。

是否必填：发送端选填，当 fileDownloadUrl 填入后，该字段才生效。

fileLocalPath

public NSString * fileLocalPath

媒体消息的文件的本地绝对路径。

是否必填：如果发送本地文件，则发送端必填，否则消息会发送失败。

fileDownloadUrl

public NSString * fileDownloadUrl

媒体消息的外部下载 URL，用于开发者将媒体文件上传到自己的服务器中时，通过填入该 URL 让 SDK 透传到其他用户中。

是否必填：如果发送的是外部 URL，发送端必填。

fileName

public NSString * fileName

媒体文件的文件名。

是否必填：如果发送的是外部 URL，则需要填写该值，且需要包含文件扩展名。如果发送的是本地文件，该值选填。

fileSize

public unsigned long long fileSize

媒体文件的大小。

是否必填：发送端不需要填，该值由 SDK 生成。

type

public ZIMMessageType type

消息类型。

ZIMVoIPConfig

提供发起 iOS VoIP 离线推送类型的信息。

详情

提供发起 iOS VoIP 离线推送类型的信息。

Declared in ZIMDefines.h

属性

iOSVoIPHandleType

public ZIMCXHandleType iOSVoIPHandleType

VoIP 发起方联系信息类型，默认为不指定类型。

iOSVoIPHandleValue

public NSString * iOSVoIPHandleValue

VoIP 发起方联系信息内容，与 iOSVoIPHandleType 相关。当 iOSVoIPHandleType 为 PhoneNumber 时，Value 为一串数字；当 iOSVoIPHandleType 为 EmailAddress 时，Value 为电子邮箱地址；当联系信息为其他类型时，Value 通常遵循某种特定格式，如用户名、数字 ID 或 URL。

iOSVoIPHasVideo

public BOOL iOSVoIPHasVideo

是否为视频通话，默认为音频。

ZPNsConfig

ZPNs 推送配置类。

详情

ZPNs 推送配置类。

业务场景：在该类添加各厂商推送所需的配置项以及是否开启的布尔值。

Declared in ZPNs.h

属性

apptype

private int apptype

用于指定当前项目对应 ZEGO 控制台的第几套离线推送配置。

业务场景：如需在不同 bundleID / 包名上使用相同的 AppID 时。
是否必填：非必填。
默认值：不设置该值的话，默认为第一套（1）。
建议值：应当与当前 bundle ID/包名相关的离线推送证书在 ZEGO 控制台上配置的 App type 保持一致。比如第二套的话这里填 2 。

ZPNsManager

方法

unregisterAPNs

- (void)unregisterAPNs;

不需要离线推送时可调用此方法反注册。

调用时机/通知时机：需要反注册时调用。

支持版本：2.5.0 及以上版本。
使用限制：需要在 [registerAPNs] 调用后才可调用。