Enum
ZIMAudioANSMode
主动噪声抑制模式。
属性
Soft
Soft=(0)软ANS。在大多数情况下，音质不会受到损害，但一些噪音将继续存在。
Medium
Medium=(1)中等ANS。它可能会损坏一些音质，但有很好的降噪效果。
Aggressive
Aggressive=(2)侵略性的ANS:它可能会严重损害音质，但它确实具有良好的降噪效果。
Ai
Ai=(3)AI模式ANS，会对音乐造成很大的伤害，所以不能使用对需要采集背景的声源进行噪声抑制声音。使用前请联系ZEGO技术支持。
AiBalanced
AiBalanced=(4)平衡AI模式ANS。会对音乐造成很大的伤害，所以不能用于需要采集的声源的噪声抑制背景声音。使用前请联系ZEGO技术支持。
ZIMAudioRouteType
音频路由类型。
属性
Speaker
Speaker=(0)扬声器。
Receiver
Receiver=(1)听筒。
ZIMBlacklistChangeAction
黑名单列表变更行为。
详情
黑名单列表变更行为。
属性
Added
Added=(0)新增行为。
Removed
Removed=(1)删除行为。
ZIMCXHandleType
VoIP 发起方联系信息类型。
属性
PhoneNumber
PhoneNumber=(2)一个电话号码。
EmailAddress
EmailAddress=(3)一个电子邮件地址。
Generic
Generic=(1)未指定的句柄类型。
ZIMCallInvitationMode
呼叫邀请模式。
详情
呼叫邀请模式。
属性
General
General=(0)普通模式。
Advanced
Advanced=(1)进阶模式。
Unknown
Unknown=(-1)未知类型，做为保底枚举值。
ZIMCallState
呼叫状态。
详情
呼叫状态。
属性
Unknown
Unknown=(-1)未知。
Started
Started=(1)已发起。
Ended
Ended=(2)已结束。
ZIMCallUserState
呼叫用户状态。
详情
呼叫用户状态。
属性
Inviting
Inviting=(0)邀请中。
Accepted
Accepted=(1)已接受。
Rejected
Rejected=(2)已拒绝。
Cancelled
Cancelled=(3)已取消。
Offline
Offline=(4)离线。
Received
Received=(5)已接收。
Timeout
Timeout=(6)超时。
Quit
Quit=(7)退出。
Unknown
Unknown=(-1)未知。
Ended
Ended=(8)结束。
NotYetReceived
NotYetReceived=(9)未收到。
BeCancelled
BeCancelled=(10)被取消。
ZIMConnectionEvent
导致连接状态发生变更的事件。
详情
使得连接状态 Connection State 发生变化的原因。
- 业务场景：可用于判断登录/登出是否成功，以及处理断网等异常情况。
- 注意事项：请配合 Connection State 参数使用。
属性
Success
Success=(0)成功。
- 业务场景：和连接相关操作执行成功时，连接状态机变更回调中会带上该枚举值，用户可通过该枚举判断调用的连接相关操作执行的结果。
ActiveLogin
ActiveLogin=(1)用户主动登录。
- 业务场景：用户主动执行登陆操作时，连接状态机变更回调中会带上该枚举值，用户可通过该枚举判断登录操作是否为用户主动执行。
LoginTimeout
LoginTimeout=(2)连接超时。
LoginInterrupted
LoginInterrupted=(3)网络连接临时中断。
- 业务场景：用户因网络连接临时中断而离线时，连接状态机变更回调中会带上该枚举值，用户可通过该枚举了解造成用户离线的事件。
KickedOut
KickedOut=(4)被踢下线。
- 业务场景：用户因被踢出而离线时，连接状态机变更回调中会带上该枚举值，用户可通过该枚举了解造成用户离线的事件。
TokenExpired
TokenExpired=(5)因登录 Token 过期而断开连接。
- 业务场景：当开发者使用 Token 鉴权登录后，在 Token 有效期超过后还没调用 [renewToken] 更新 Token 时，将会断开连接。
ZIMConnectionState
连接状态。
详情
标识当前连接状态的状态机。
- 业务场景：可用于判断登录/登出是否成功，以及处理断网等异常情况。
- 注意事项：请配合 Event 参数使用。
属性
Disconnected
Disconnected=(0)未连接状态，在登录前和登出之后进入该状态。
- 业务场景：如果登录的过程出现稳态异常，例如 AppID 或 Token 不正确，或者有相同用户名在其他地方登录导致本端被踢下线，都会进入该状态。
Connecting
Connecting=(1)正在请求连接状态，登录动作执行成功后会进入此状态。
- 业务场景：通常通过该状态进行应用界面的展示。如果因为网络质量不佳产生的中断， SDK 会进行内部重试，也会回到正在请求连接状态。
Connected
Connected=(2)连接成功状态。
- 业务场景：进入该状态表示登录已经成功，用户可以正常使用 SDK 的功能。
Reconnecting
Reconnecting=(3)正在进行重新连接状态。
- 业务场景：进入该状态表示正在重新登录。
ZIMConversationEvent
会话改变事件。
详情
会话改变的事件。
- 业务场景：用于接收会话改变时的事件原因。
属性
Added
Added=(0)会话新增事件。
Updated
Updated=(1)会话更新事件。
Disabled
Disabled=(2)会话不可用事件。
Deleted
Deleted=(3)会话删除事件。
ZIMConversationNotificationStatus
会话通知状态枚举。
详情
会话通知状态。
- 业务场景：可以通过改枚举来判断会话的通知状态。
属性
Notify
Notify=(1)会话通知为开
DoNotDisturb
DoNotDisturb=(2)会话通知为关
ZIMConversationSyncState
标识了 SDK 从后台同步会话列表的状态。
详情
标识了 SDK 从后台同步会话列表的状态，业务层可由此状态在 UI 上做不同展示。
属性
Started
Started =(0)开始从后台同步会话列表。
Finished
Finished =(1)完成从后台同步会话列表。
Failed
Failed =(2)从后台同步会话列表失败。
ZIMConversationType
会话类型。
属性
Peer
Peer=(0)单聊会话。
Room
Room=(1)房间会话。
Group
Group=(2)群聊会话。
Unknown
Unknown=(3)未知。
ZIMErrorCode
错误码定义。
详情
开发者可根据错误码在官网开发者文档中找到错误码详情。
- 业务场景：可用于收集并记录使用 SDK 过程中出现的错误。
属性
Success
Success=(0)成功，没有异常。
- 业务场景：基本错误码，用于示意操作执行无误。
Failed
Failed=(1)失败，保底错误。
- 业务场景：基本错误码，用于保底策略中使用。
CommonModuleParamInvalid
CommonModuleParamInvalid=(6000001)传入参数非法。
- 业务场景：用于接口调用因错误参数失败时的保底策略。
CommonModuleNotInit
CommonModuleNotInit=(6000002)未初始化 SDK。
- 业务场景：用于 ZIM SDK 未初始化成功时即执行操作的错误返回。
CommonModuleInvalidAppID
CommonModuleInvalidAppID=(6000003)无效 AppID。
- 业务场景：用于因无效 AppID 导致的错误返回。
CommonModuleTriggerSDKFrequencyLimit
CommonModuleTriggerSDKFrequencyLimit=(6000004)触发 SDK 限频。
CommonModuleTriggerServerFrequencyLimit
CommonModuleTriggerServerFrequencyLimit=(600005)触发后台业务限频。
CommonModuleSwitchServerError
CommonModuleSwitchServerError=(6000006)Switch 服务器报错。
CommonModuleIMServerError
CommonModuleIMServerError=(6000007)ZIM 服务内部错误。
CommonModuleIMDatabaseError
CommonModuleIMDatabaseError=(6000008)ZIM 内部数据库错误。
CommonModuleIMServerDisconnect
CommonModuleIMServerDisconnect=(6000009)发送请求时断开了连接。
CommonModuleUploadLogError
CommonModuleUploadLogError=(6000010)上传日志失败。
NetworkModuleCommonError
NetworkModuleCommonError=(6000101)登录失败。
NetworkModuleServerError
NetworkModuleServerError=(6000102)内部原因，致使登录失败。
NetworkModuleTokenInvalid
NetworkModuleTokenInvalid=(6000103)Token 无效。
NetworkModuleNetworkError
NetworkModuleNetworkError=(6000104)网络错误。
NetworkModuleTokenExpired
NetworkModuleTokenExpired=(6000106)Token 过期。
NetworkModuleTokenVersionError
NetworkModuleTokenVersionError=(6000107)Token 版本号错误。
NetworkModuleTokenTimeIsTooShort
NetworkModuleTokenTimeIsTooShort=(6000108)Token 持续时间过短。
NetworkModuleUserHasAlreadyLogged
NetworkModuleUserHasAlreadyLogged=(6000111)当前设备登录多个账号。
NetworkModuleUserIsNotLogged
NetworkModuleUserIsNotLogged=(6000121)用户未登录。
MessageModuleCommonError
MessageModuleCommonError=(6000201)发送消息内部错误。
MessageModuleServerError
MessageModuleServerError=(6000202)发送消息后台服务错误。
MessageModuleSendMessageFailed
MessageModuleSendMessageFailed=(6000203)消息发送失败。
MessageModuleTargetDoesNotExist
MessageModuleTargetDoesNotExist=(6000204)消息发送目标不存在。
MessageModuleCallError
MessageModuleCallError=(6000270)呼叫邀请错误。
MessageModuleCancelCallError
MessageModuleCancelCallError=(6000271)取消呼叫错误。
MessageModuleCallServerError
MessageModuleCallServerError=(6000272)呼叫邀请后台错误。
MessageModuleIsNotInvitor
MessageModuleIsNotInvitor=(6000273)用户非邀请者操作错误。
MessageModuleIsNotInvitee
MessageModuleIsNotInvitee=(6000274)用户非被邀者操作错误。
MessageModuleCallAlreadyExists
MessageModuleCallAlreadyExists=(6000275)呼叫已存在错误。
MessageModuleCallDoesNotExist
MessageModuleCallDoesNotExist=(6000276)呼叫不存在错误。
RoomModuleCommonError
RoomModuleCommonError=(6000301)房间相关操作错误。
RoomModuleServerError
RoomModuleServerError=(6000302)房间操作后台失败。
RoomModuleCreateRoomError
RoomModuleCreateRoomError=(6000303)创建房间失败。
RoomModuleJoinRoomError
RoomModuleJoinRoomError=(6000304)进入房间失败。
RoomModuleLeaveRoomError
RoomModuleLeaveRoomError=(6000306)离开房间失败。
RoomModuleUserIsNotInTheRoom
RoomModuleUserIsNotInTheRoom=(6000321)用户不在房间内错误。
RoomModuleTheRoomDoesNotExist
RoomModuleTheRoomDoesNotExist=(6000322)房间不存在错误。
RoomModuleTheRoomAlreadyExists
RoomModuleTheRoomAlreadyExists=(6000323)房间已存在错误。
RoomModuleTheNumberOfExistingRoomsHasReachedLimit
RoomModuleTheNumberOfExistingRoomsHasReachedLimit=(6000324)已存在的房间数量达到上限。
RoomModuleTheNumberOfJoinedRoomsHasReachedLimit
RoomModuleTheNumberOfJoinedRoomsHasReachedLimit=(6000325)已加入的房间数量达到上限。
RoomModuleRoomAttributesCommonError
RoomModuleRoomAttributesCommonError=(6000330)房间属性操作失败。
RoomModuleRoomAttributesOperationFailedCompletely
RoomModuleRoomAttributesOperationFailedCompletely=(6000331)房间属性操作完全失败。
RoomModuleRoomAttributesOperationFailedPartly
RoomModuleRoomAttributesOperationFailedPartly=(6000332)房间属性操作部分失败。
RoomModuleRoomAttributesQueryFailed
RoomModuleRoomAttributesQueryFailed=(6000333)房间属性查询失败。
RoomModuleTheNumberOfRoomAttributesExceedsLimit
RoomModuleTheNumberOfRoomAttributesExceedsLimit=(6000334)房间属性数量达到上限。
RoomModuleTheLengthOfRoomAttributeKeyExceedsLimit
RoomModuleTheLengthOfRoomAttributeKeyExceedsLimit=(6000335)房间属性 Key 长度达到上限。
RoomModuleTheLengthOfRoomAttributeValueExceedsLimit
RoomModuleTheLengthOfRoomAttributeValueExceedsLimit=(6000336)房间属性 Value 长度达到上限。
RoomModuleTheTotalLengthOfRoomAttributesValueExceedsLimit
RoomModuleTheTotalLengthOfRoomAttributesValueExceedsLimit=(6000337)房间属性总长度达到上限。
GroupModuleCommonError
GroupModuleCommonError=(6000501)群相关操作报错。
GroupModuleServerError
GroupModuleServerError=(6000502)群相关后台报错。
GroupModuleCreateGroupError
GroupModuleCreateGroupError=(6000503)创建群失败。
GroupModuleDismissGroupError
GroupModuleDismissGroupError=(6000504)解散群失败。
GroupModuleJoinGroupError
GroupModuleJoinGroupError=(6000505)加入群失败。
GroupModuleLeaveGroupError
GroupModuleLeaveGroupError=(6000506)离开群失败。
GroupModuleKickoutGroupMemberError
GroupModuleKickoutGroupMemberError=(6000507)踢出群成员失败。
GroupModuleInviteUserIntoGroupError
GroupModuleInviteUserIntoGroupError=(6000508)邀请用户入群失败。
GroupModuleTransferOwnerError
GroupModuleTransferOwnerError=(6000509)转移群主失败。
GroupModuleUpdateGroupInfoError
GroupModuleUpdateGroupInfoError=(6000510)更新群信息失败。
GroupModuleQueryGroupInfoError
GroupModuleQueryGroupInfoError=(6000511)查询群信息失败。
GroupModuleGroupAttributesOperationFailed
GroupModuleGroupAttributesOperationFailed=(6000512)操作群属性失败。
GroupModuleGroupAttributesQueryFailed
GroupModuleGroupAttributesQueryFailed=(6000513)查询群属性失败。
GroupModuleUpdateGroupMemberInfoError
GroupModuleUpdateGroupMemberInfoError=(6000514)更新群成员信息失败。
GroupModuleQueryGroupMemberInfoError
GroupModuleQueryGroupMemberInfoError=(6000515)查询群成员信息失败。
GroupModuleQueryGroupListError
GroupModuleQueryGroupListError=(6000516)查询群列表失败。
GroupModuleQueryGroupMemberListError
GroupModuleQueryGroupMemberListError=(6000517)查询群成员列表失败。
GroupModuleUserIsNotInTheGroup
GroupModuleUserIsNotInTheGroup=(6000521)用户不在群内错误。
GroupModuleMemberIsAlreadyInTheGroup
GroupModuleMemberIsAlreadyInTheGroup=(6000522)用户已在群内错误。
GroupModuleGroupDoesNotExist
GroupModuleGroupDoesNotExist=(6000523)群不存在错误。
GroupModuleGroupAlreadyExists
GroupModuleGroupAlreadyExists=(6000524)群已存在错误。
GroupModuleGroupMemberHasReachedLimit
GroupModuleGroupMemberHasReachedLimit=(6000525)群成员达到上限错误。
GroupModuleGroupAttributeDoesNotExist
GroupModuleGroupAttributeDoesNotExist=(6000526)群属性不存在错误。
GroupModuleTheNumberOfGroupAttributesExceedsLimit
GroupModuleTheNumberOfGroupAttributesExceedsLimit=(6000531)群属性数量达到上限错误。
GroupModuleTheLengthOfGroupAttributeKeyExceedsLimit
GroupModuleTheLengthOfGroupAttributeKeyExceedsLimit=(6000532)群属性 Key 长度达到上限错误。
GroupModuleTheLengthOfGroupAttributeValueExceedsLimit
GroupModuleTheLengthOfGroupAttributeValueExceedsLimit=(6000533)群属性 Value 长度达到上限错误。
GroupModuleTheTotalLengthOfGroupAttributesValueExceedsLimit
GroupModuleTheTotalLengthOfGroupAttributesValueExceedsLimit=(6000534)群属性总长度达到上限。
GroupModuleNoCorrespondingOperationAuthority
GroupModuleNoCorrespondingOperationAuthority=(6000541)群操作权限错误。
GroupModuleGroupDatabaseError
GroupModuleGroupDatabaseError=(6000542)群数据库错误。
ConversationModuleCommonError
ConversationModuleCommonError=(6000601)会话操作错误。
ConversationModuleServerError
ConversationModuleServerError=(6000602)会话后台错误。
ConversationModuleConversationDoesNotExist
ConversationModuleConversationDoesNotExist=(6000603)会话不存在错误。
MessageModuleFileNotExist
MessageModuleFileNotExist=(6000211)文件不存在错误。
MessageModuleFileServerError
MessageModuleFileServerError=(6000212)文件操作后台错误。
MessageModuleFileTypeUnsupported
MessageModuleFileTypeUnsupported=(6000213)不支持的文件类型错误。
MessageModuleFileSizeInvalid
MessageModuleFileSizeInvalid=(6000214)文件大小非法。
MessageModuleFileDurationInvalid
MessageModuleFileDurationInvalid=(6000215)音视频文件时长非法。
MessageModuleAuditRejected
MessageModuleAuditRejected=(6000221)消息未通过审核。
MessageModuleAuditFailed
MessageModuleAuditFailed=(6000222)消息审核失败。
ZIMErrorCodeCommonModuleUserInfoQueriedLimit
ZIMErrorCodeCommonModuleUserInfoQueriedLimit=(6000012)用户后台查询限频。
ZIMErrorCodeCommonModuleUnsupportedRequest
ZIMErrorCodeCommonModuleUnsupportedRequest=(6000013)当前套餐不支持该操作。
RoomModuleRoomMemberAttributesCommonError
RoomModuleRoomMemberAttributesCommonError=(6000350)房间用户属性失败。
RoomModuleTheTotalLengthOfRoomMemberAttributesExceedsLimit
RoomModuleTheTotalLengthOfRoomMemberAttributesExceedsLimit=(6000351)房间用户属性总长度达到上限。
RoomModuleTheLengthOfRoomMemberAttributesKeyExceedsLimit
RoomModuleTheLengthOfRoomMemberAttributesKeyExceedsLimit=(6000352)房间用户属性 Key 长度达到上限。
RoomModuleTheLengthOfRoomMemberAttributesValueExceedsLimit
RoomModuleTheLengthOfRoomMemberAttributesValueExceedsLimit=(6000353)房间用户属性 Value 长度达到上限。
RoomModuleTheMemberNumberOfRoomMemberAttributesExceedsLimit
RoomModuleTheMemberNumberOfRoomMemberAttributesExceedsLimit=(6000357)房间用户属性数量达到上限。
MessageModuleReceiptReadError
MessageModuleReceiptReadError=(6000277)设置回执消息为已读错误。
CommonModuleUserIsNotExist
CommonModuleUserIsNotExist=(6000011)用户不存在。
MessageModuleMessageExceedsRevokeTime
MessageModuleMessageExceedsRevokeTime=(6000278)欲撤回消息但已超过撤回时限。
MessageModuleMessageHasBeenRevoked
MessageModuleMessageHasBeenRevoked=(6000279)欲撤回消息但消息已被撤回。
ZIM_ERROR_CODE_MESSAGE_MODULE_FILE_DURATION_INVALID
ZIM_ERROR_CODE_MESSAGE_MODULE_FILE_DURATION_INVALID=(6000216)文件权限错误。
ZIM_ERROR_CODE_MESSAGE_MODULE_FILE_PERMISSION_DENIED
ZIM_ERROR_CODE_MESSAGE_MODULE_FILE_PERMISSION_DENIED=(6000217)文件下载失败。
ZIMErrorCodeMessageModuleFileDownloadLimit
ZIMErrorCodeMessageModuleFileDownloadLimit=(6000218)文件大小下载超过限制。
ZIMErrorCodeMessageModuleFileDownloadUrlNotFound
ZIMErrorCodeMessageModuleFileDownloadUrlNotFound=(6000219)Url资源未找到。
ZIM_ERROR_CODE_MESSAGE_MODULE_FILE_DOWNLOAD_HTTP_REQUEST_SERVER_ERROR
ZIM_ERROR_CODE_MESSAGE_MODULE_FILE_DOWNLOAD_HTTP_REQUEST_SERVER_ERROR=(6000220)下载url发生服务端错误。
ZIMErrorCodeCommonModuleExceedDAULimit
ZIMErrorCodeCommonModuleExceedDAULimit=(6000015)超出了该 AppID 日活用户上限。
ZIMErrorCodeCommonModuleExceedMAULimit
ZIMErrorCodeCommonModuleExceedMAULimit=(6000016)超出了该 AppID 月活用户上限。
ZIM_ERROR_CODE_ROOM_MODULE_THE_ROOM_IS_CONNECTING
ZIM_ERROR_CODE_ROOM_MODULE_THE_ROOM_IS_CONNECTING=(6000326)多次重复尝试 createRoom、joinRoom 或 enterRoom 等接口或对于正在连接中的房间执行操作。请等待 onRoomStateChanged 返回房间连接结果的返回后再执行操作。
MessageModuleMessageReactionTypeExisted
MessageModuleMessageReactionTypeExisted=(6000280)表示用户在对一条消息进行某个 key 的表态或者删除表态时，该 key 已经被该用户表态过或者删除过。 处理方式：开发者可进行弹窗提示，或者不进行特殊处理。
MessageModuleCallInviteUserDoesNotExist
MessageModuleCallInviteUserDoesNotExist=(6000281)发起呼叫邀请时，所有被邀请者均未注册。 处理方式：1. 请确认被邀请者注册状态，如果拟被邀请的用户尚未注册，请先注册。2. 如果用户已注册，请检查被邀请者列表中的 UserID 是否正确。
MessageModuleMessageReceiptLimit
MessageModuleMessageReceiptLimit=(6000282)说明：调用 sendMessageReceiptsRead 接口一次性将 10 条以上消息设置为已读。请减少传入的消息数量到 10 条以内。
MessageModuleUserAlreadyInTheCall
MessageModuleUserAlreadyInTheCall=(6000283)说明：调用 callJoin 接口的设备，已在进阶模式呼叫且为主设备。 无需处理。
GroupModuleGroupWithDismissed
GroupModuleGroupWithDismissed=(6000527)说明：使用已被销毁的群 ID 创建群组。请使用其他 ID。
MessageModuleTheCallIsNotAdvancedModeError
MessageModuleTheCallIsNotAdvancedModeError=(6000284)说明：调用 callJoin，callQuit，callEnd，callingInvite 等进阶模式接口时，传入了普通模式呼叫 ID。请确认 callID 及其模式。
zim_error_code_network_module_user_id_error
zim_error_code_network_module_user_id_error=(6000124)说明：本次离线登录传入的 user id 与上次成功登录 user id 不匹配。
zim_error_code_message_module_sender_in_blacklist
zim_error_code_message_module_sender_in_blacklist=(6000284)说明：对方把你拉黑后或者你把对方拉黑后，尝试发消息时返回该报错。
zim_error_code_friend_module_already_add_to_blacklist
zim_error_code_friend_module_already_add_to_blacklist=(6000804 )说明：添加到黑名单时，如果对方已经在黑名单中，会返回该错误码。
zim_error_code_friend_module_cannot_add_self_to_blacklist
zim_error_code_friend_module_cannot_add_self_to_blacklist=(6000805 )说明：试图添加自己到黑名单中返回该错误码。
zim_error_code_friend_module_already_delete_from_blacklist
zim_error_code_friend_module_already_delete_from_blacklist=(6000806)说明：该用户已经从黑名单移除。
zim_error_code_friend_module_user_not_in_blacklist
zim_error_code_friend_module_user_not_in_blacklist=(6000807)说明：该用户不在黑名单中。
zim_error_code_friend_module_blacklist_list_quantity_limit
zim_error_code_friend_module_blacklist_list_quantity_limit=(6000808)说明：黑名单超出最大数量限制。
zim_error_code_friend_module_add_blacklist_fail
zim_error_code_friend_module_add_blacklist_fail=(6000815 )说明：黑名单添加失败，具体原因需要看 ZIMErrorUserInfo 中的 reason。
zim_error_code_friend_module_del_blacklist_fail
zim_error_code_friend_module_del_blacklist_fail=(6000816)说明：删除黑名单失败，具体原因需要看 ZIMErrorUserInfo 中的 reason。
zim_error_code_room_module_room_member_query_failed_completely
zim_error_code_room_module_room_member_query_failed_completely=(6000311)批量查询房间成员全部查询失败。
ZIMFriendApplicationListChangeAction
好友申请列表变更行为。
详情
好友申请列表变更行为。
属性
Added
Added=(0)新增行为
Deleted
Deleted=(1)删除行为。
ZIMFriendApplicationState
好友申请状态。
属性
Waiting
Waiting=(1)待响应。
Accepted
Accepted=(2)已接受。
Rejected
Rejected=(3)已拒绝。
Expired
Expired=(4)已过期。
Disabled
Disabled=(5)已失效
ZIMFriendApplicationType
好友申请类型。
属性
None
None=(0)空类型。
Received
Received=(1)收到的申请。
Sent
Sent=(2)发送的申请。
Both
Both=(3)双方都发起的申请。
ZIMFriendDeleteType
删除好友类型。
属性
Both
Both=(0)双向删除。
Single
Single=(1)单向删除。
ZIMFriendListChangeAction
好友列表变更行为。
详情
好友列表变更行为。
属性
Added
Added=(0)新增行为
Deleted
Deleted=(1)删除行为。
ZIMFriendRelationCheckType
好友关系检查类型。
属性
Both
Both=(0)双向检查。
Single
Single=(1)单向检查。
ZIMGeofencingType
地理围栏类型。
- 业务场景：例如当指定的地理围栏区域为欧洲时，不区分 App 用户所在区域，SDK 实际访问的区域将为欧洲。
属性
None
None=(0)默认类型。
Include
Include=(1)联合模式。
Exclude
Exclude=(2)排除模式。
ZIMGroupApplicationListChangeAction
入群申请列表变更行为。
详情
入群申请列表变更行为。
属性
Added
Added=(0)新增行为
ZIMGroupApplicationState
入群申请状态。
属性
Waiting
Waiting=(1)待响应。
Accepted
Accepted=(2)已接受。
Rejected
Rejected=(3)已拒绝。
Expired
Expired=(4)已过期。
Disabled
Disabled=(5)已失效
ZIMGroupApplicationType
入群申请类型。
属性
None
None=(0)空。
Join
Join=(1)加入申请。
Invite
Invite=(2)邀请申请。
BeInvite
BeInvite=(3)被邀请的申请。
ZIMGroupAttributesUpdateAction
群组属性变更行为。
详情
群组属性变更行为。
属性
Set
Set=(0)设置行为。
Delete
Delete=(1)删除行为。
ZIMGroupBeInviteMode
邀请目标验证模式。
属性
None
None=(0)被邀请人直接进入群。
Auth
Auth=(1)需要被邀请人同意才能加入群。
ZIMGroupEnterType
加入群组的类型。
详情
加入群组的类型。
属性
Unknown
Unknown=(0)未知类型。
Created
Created=(1)创建群时加入。
JoinApply
JoinApply=(2)申请加入群。
Joined
Joined=(3)直接加入群。
Invited
Invited=(4)直接邀请入群。
InviteApply
InviteApply=(5)邀请申请入群。
ZIMGroupEvent
群组事件。
详情
群组事件。
属性
NONE
NONE=(0)空。
Created
Created=(1)创建群。
Dismissed
Dismissed=(2)解散群。
Joined
Joined=(3)加入群。
Invited
Invited=(4)邀请入群。
Left
Left=(5)离开群。
KickedOut
KickedOut=(6)踢出群。
ZIMGroupInviteMode
邀请模式。
属性
Any
Any=(0)群内所有人都可邀请。
Admin
Admin=(1)群主或管理员才能邀请。
ZIMGroupJoinMode
入群模式。
属性
Any
Any=(0)任何人可直接加入群。
Auth
Auth=(1)需要群主或管理员审批。
Forbid
Forbid=(2)禁止加入群。
ZIMGroupMemberEvent
群成员事件。
详情
详细描述: 群成员事件。
属性
NONE
NONE=(0)空。
Joined
Joined=(1)已加入。
Left
Left=(2)离开。
KickedOut
KickedOut=(4)被踢出。
Invited
Invited=(5)被邀请。
ZIMGroupMemberState
群成员状态。
详情
群成员状态。
属性
Quit
Quit=(0)离开。
Enter
Enter=(1)进入。
ZIMGroupMessageNotificationStatus
群组通知状态枚举。
详情
群组通知状态。
- 业务场景：可以通过改枚举来判断群组的通知状态。
属性
Notify
Notify=(1)群组通知为开
Disturb
Disturb=(2)群组通知为关
ZIMGroupMuteMode
群组禁言模式。
详情
群组禁言模式。
属性
None
None=(0)取消禁言。
Normal
Normal=(1)群普通成员禁言模式。
All
All=(2)群全体禁言。
Custom
Custom=(3)自定义群禁言模式。
ZIMGroupState
群状态。
详情
群状态。
属性
Quit
Quit=(0)离开。
Enter
Enter=(1)进入。
ZIMMediaFileType
媒体文件类型
详情
允许下载的媒体文件类型，包含图片原图、大图、缩略图，一般文件，音频文件，视频文件及其首帧图。
属性
OriginalFile
OriginalFile=(1)原始文件类型，适用于图片原图、音频文件以及视频文件。当调用 [downloadMediaFile] 后，SDK 将更新 ZIMFileMessage 里的 fileLocalPath 属性。
LargeImage
LargeImage=(2)图片大图类型。当调用 [downloadMediaFile] 后，SDK 将更新 ZIMImageMessage 里的 largeImageLocalPath 属性。
Thumbnail
Thumbnail=(3)图片缩略图类型。当调用 [downloadMediaFile] 后，SDK 将更新 ZIMImageMessage 里的 thumbnailLocalPath 属性。
VideoFirstFrame
VideoFirstFrame=(4)视频首帧图类型。当调用 [downloadMediaFile] 后，SDK 将更新 ZIMImageMessage 里的 thumbnailLocalPath 属性。
ZIMMessageDirection
消息的方向。
详情
描写当前消息是发送的还是接受的。
属性
Send
Send=(0)消息已发送。
Receive
Receive=(1)消息已接受。
ZIMMessageMentionedType
消息提醒的类型
详情
标志消息提醒的类型
- 业务场景：用于判断该提醒所属的类型
属性
UNKNOWN
UNKNOWN=(-1)未知类型
MENTION_ME
MENTION_ME=(1)提醒我
mention_all
mention_all=(2)提醒所有人
mention_all_and_me
mention_all_and_me=(3)提醒所有人且提醒我
ZIMMessageOrder
消息顺序。
详情
用于表示消息列表的顺序。
属性
Descending
Descending=(0)代表消息列表降序 (消息列表顺序从新到旧)。
Ascending
Ascending=(1)代表消息列表升序 (消息列表顺序从旧到新)。
ZIMMessagePinStatus
消息置顶状态枚举。
详情
消息置顶状态。
- 业务场景：可以通过枚举来判断消息的置顶状态。
属性
NotPinned
NotPinned=(0)取消置顶
Pinned
Pinned=(1)置顶
Updated
Updated=(2)置顶信息更新
ZIMMessagePriority
消息的优先级。
详情
标识一条消息的优先级。
- 业务场景：可用于设置一条消息被发送时的优先级，优先级越高，可靠性越高，低优先级的可能因为弱网而被丢弃。
属性
Low
Low=(1)低优先级。
- 业务场景：一般用于发送房间内的弹幕等不重要的消息。
Medium
Medium=(2)中优先级。
- 业务场景：一般用于发送常规聊天信息。
High
High=(3)高优先级。
- 业务场景：一般用于发送房间内礼物、打赏等重要的信息。
ZIMMessageReceiptStatus
详情
回执状态
属性
None
None=(0)不是回执。
Processing
Processing=(1)回执进行中。
Done
Done=(2)回执已完成。
Expired
Expired=(3)回执已过期。
Failed
Failed=(4)回执已失败。
ZIMMessageRepliedInfoState
回复消息所引用的源消息状态。
属性
Normal
Normal=(0)正常状态。
Deleted
Deleted=(1)已删除。
NotFound
NotFound=(2)未找到。
ZIMMessageRevokeStatus
消息撤回状态。
详情
标识当前撤回消息的状态。
属性
UNKNOWN
UNKNOWN=(-1)未知状态。
SELF_REVOKE
SELF_REVOKE=(0)主动撤回。
SYSTEM_REVOKE
SYSTEM_REVOKE=(1)系统撤回。
API_REVOKE
API_REVOKE=(2)服务端 API 撤回。
ADMIN_REVOKE
ADMIN_REVOKE=(3)群管理员撤回。
GROUP_OWNER_REVOKE
GROUP_OWNER_REVOKE=(4)群主撤回。
AUDIT_REJECT_REVOKE
AUDIT_REJECT_REVOKE=(6)未通过审核撤回。
ZIMMessageSentStatus
消息发送的情况。
详情
描述当前发送的消息的情况。
属性
Sending
Sending=(0)消息发送中。
Success
Success=(1)消息发送成功。
Failed
Failed=(2)消息发送失败。
ZIMMessageType
消息类型。
详情
标识当前消息的类型。
- 业务场景：可用于判断此消息是哪种类型的消息。
属性
Text
Text=(1)普通文本消息，可用于传递普通文本消息。
Command
Command=(2)自定义二进制消息，可用于传递自定义的二进制消息。该消息类型不支持离线消息和本地存储。
Unknown
Unknown=(0)未知类型，收到未知类型的消息，表明发送方可能发送了该用户不支持的消息类型，需要建议用户更新版本。
Barrage
Barrage=(20)弹幕消息，可用于直播间发送的弹幕。该消息类型不支持离线消息和本地存储。
Image
Image=(11)图片消息，可用于发送图片消息，仅支持 ".jpg", ".jpeg", ".png", ".bmp", ".gif", ".tiff" 图片类型。发送图片后，服务端将会生成原图的大图和缩略图。
File
File=(12)文件消息，用于发送文件消息，无文件类型限制。
Audio
Audio=(13)音频消息，用于发送音频消息，仅支持 ".mp3" 音频类型。
Video
Video=(14)视频消息，用于发送视频消息，仅支持 ".mp4", ".mov" 视频类型。发送视频消息后，服务端将会生成该视频文件的首帧图。
System
System=(30)系统消息，常用于业务层需要自定义的本地消息，通常用于插入本地消息接口。（自 2.8.0 起废弃，请使用自定义消息类型替代）。
Revoke
Revoke=(31)撤回消息。
Combine
Combine=(100)合并消息。
Custom
Custom=(200)自定义消息。
Tips
Tips=(32)Tips 消息。
Multiple
Multiple=(10)组合消息，可用于发送文本、富媒体文件、自定义消息的组合消息。
ZIMPlatformType
SDK 运行的平台
详情
SDK 运行的平台。
属性
Win
Win=(1)Windows 平台。
IPhoneOS
IPhoneOS=(2)iOS 平台。
Android
Android=(3)Android 平台。
MacOS
MacOS=(4)MacOS 平台。
Linux
Linux=(5)Linux 平台。
Web
Web=(6)Web 平台。
MiniProgram
MiniProgram=(7)小程序平台。
IPadOS
IPadOS=(9)iPad 平台。
Unknown
Unknown=(32)不属于上述平台的平台。
ZIMRevokeType
消息撤回类型。
详情
标识当前撤回消息的类型。
- 业务场景：可用于判断此消息是哪种撤回类型的消息。
属性
TWO_WAY
TWO_WAY=(1)双边撤回。
ONE_WAY
ONE_WAY=(2)单边撤回。
ZIMRoomAttributesUpdateAction
房间属性变更行为。
详情
房间属性变更行为。
属性
Set
Set=(0)设置行为。
Delete
Delete=(1)删除行为。
ZIMRoomEvent
导致房间连接状态发生变更的事件。
详情
使得连接状态 Connection State 发生变化的原因。
- 业务场景：可用于判断登录/登出是否成功，以及处理断网等异常情况。
- 注意事项：请配合 Connection State 参数使用
属性
Success
Success=(0)成功。
NetworkInterrupted
NetworkInterrupted=(1)房间网络临时中断。
NetworkDisconnected
NetworkDisconnected=(2)房间网络断开。
RoomNotExist
RoomNotExist=(3)房间不存在。
ActiveCreate
ActiveCreate=(4)用户开始创建房间。
CreateFailed
CreateFailed=(5)创建房间失败。
ActiveEnter
ActiveEnter=(6)用户开始进入房间。
EnterFailed
EnterFailed=(7)用户进入房间失败。
KickedOut
KickedOut=(8)用户被踢出房间。
ConnectTimeout
ConnectTimeout=(9)链接超时。
KickedOutByOtherDevice
KickedOutByOtherDevice=(10)多端登录进入相同房间导致用户被踢出房间。
ActiveSwitch
ActiveSwitch=(11)切换房间。
SwitchFailed
SwitchFailed=(12)切换房间失败。
ZIMRoomState
详情描述：描述用户与房间的连接状态。
详情
描述用户与房间的连接状态。
- 注意事项：请配合 ZIMRoomEvent 参数使用
属性
Disconnected
Disconnected=(0)代表与房间的连接中断，[createRoom]、[joinRoom]、[enterRoom] 调用失败，断网时间过长导致房间心跳超时、后台通知该用户已被踢出房间、登出会抛这个状态。
Connecting
Connecting=(1)connecting 代表与房间的连接状态处于连接中，[createRoom]、[joinRoom]、[enterRoom] 调用后，后台未回包，网络断开会抛出这个状态。
Connected
Connected=(2)connected 代表与房间连接正常。[createRoom]、[joinRoom]、[enterRoom] 调用成功，断网重连且房间心跳未超时、会抛出这个状态。
ZIMTipsMessageChangeInfoType
Tips 消息附加信息的类型。
详情
Tips 消息附加信息的类型。
属性
GroupDataChanged
GroupDataChanged=(1)群名、群头像、群公告存在复数变更事件。
GroupNoticeChanged
GroupNoticeChanged=(2)群公告变更事件。
GroupNameChanged
GroupNameChanged=(3)群名变更事件。
GroupAvatarUrlChanged
GroupAvatarUrlChanged=(4)群头像变更事件。
GroupMuteChanged
GroupMuteChanged=(5)群禁言状态变更事件。
GroupOwnerTransferred
GroupOwnerTransferred=(10)群主转移事件。
GroupMemberRoleChanged
GroupMemberRoleChanged=(11)群成员角色变更事件。
GroupMemberMuteChanged
GroupMemberMuteChanged=(12)群成员禁言状态变更事件。
GroupMessagePinInfoChanged
GroupMessagePinInfoChanged=(21)群消息置顶或取消置顶事件。
ZIMTipsMessageEvent
Tips 消息事件。
详情
用于标识 tips 消息对应的事件，客户可通过不同枚举读取不同字段。
属性
GroupCreated
GroupCreated=(1)GroupDismissed
GroupDismissed=(2)GroupJoined
GroupJoined=(3)GroupInvited
GroupInvited=(4)GroupLeft
GroupLeft=(5)GroupKickedOut
GroupKickedOut=(6)GroupInfoChanged
GroupInfoChanged=(7)GroupMemberInfoChanged
GroupMemberInfoChanged=(8)GroupMessagePinned
GroupMessagePinned=(9)ZIMUserOnlineStatus
用户在线状态。
详情
用户在线状态。
属性
Online
Online=(0)在线。用户已登录且网络状态良好的情况下会处于该状态。
Offline
Offline=(1)离线。用户未调用 logout 主动登出，因为网络断开、app 被杀、退后台、锁屏等原因于后台的长链接断开后，将处于该状态。
Logout
Logout=(2)登出。用户主动登出会处于该状态。
ZIMUserOnlineStatusUnknown
ZIMUserOnlineStatusUnknown=(99)未知状态。保底枚举。
ZIMUserRelationType
好友关系类型。
属性
SingleNo
SingleNo=(1)A 的好友表中没有 B，但无法确定 B 的好友表中是否有 A。
SingleHave
SingleHave=(2)A 的好友表中有 B，但无法确定 B 的好友表中是否有 A。
BothAllNo
BothAllNo=(3)A 的好友表中没有 B，B 的好友表中也没有 A。
BothSelfHave
BothSelfHave=(4)A 的好友表中有 B，但 B 的好友表中没有 A。
BothOtherHave
BothOtherHave=(5)A 的好友表中没有 B，但 B 的好友表中有 A。
BothAllHave
BothAllHave=(6)A 的好友表中有 B，B 的好友表中也有 A。
ZPNsEnvironment
APP 当前的离线推送环境。请根据 iOS 打包时选择的证书为 development 还是 description 填写。
详情
APP 当前的离线推送环境。请根据 iOS 打包时选择的证书为 development 还是 description 填写。
属性
Production
Production=(0)证书为 distribution 时，ZPNsEnvironment 为 Production。
Development
Development=(1)打包使用的证书为 development 时，ZPNsIOSEnvironment 为 Development。
ZPNsIOSEnvironment
APP 当前的离线推送环境。请根据 iOS 打包时选择的证书为 development 还是 description 填写。
详情
APP 当前的离线推送环境。请根据 iOS 打包时选择的证书为 development 还是 description 填写。
- 支持版本：ZPNs 2.5.0 及以上版本。
属性
Production
Production=(0)证书为 distribution 时，ZPNsIOSEnvironment 为 Production。
Development
Development=(1)打包使用的证书为 development 时，ZPNsIOSEnvironment 为 Development。
Automatic
Automatic=(2)如果您尚不清楚当前所处的 ZPNsIOSEnvironment，请填 ZPNsIOSEnvironment.Automatic。Automaic 可能受 iOS 系统版本影响，若 iOS 系统进行大版本更新后，请留意 ZPNs 发布日志是否存在相关更新说明。
ZPNsPushSourceType
属性
APNs
APNs=(1)苹果 APNs
FCM
FCM=(2)谷歌 FCM
HuaWei
HuaWei=(3)华为
XiaoMi
XiaoMi=(4)小米
Oppo
Oppo=(5)Oppo
Vivo
Vivo=(6)Vivo
HONOR
HONOR=(7)HONOR