Interface
ZIMAllRoomLeftResult
离开所有房间的结果的回调。
属性
roomIDs
roomIDs: string[] 房间 ID 列表。
ZIMAppConfig
ZIM 应用配置，包含 AppID。
属性
appID
appID: number - 是否必填：必填。
ZIMAudioMessage
音频消息对象。
详情
标识一条音频消息。
- 注意事项：回调时若基类的 Type 参数为 Audio，可将基类消息对象强转为此类。
属性
audioDuration
audioDuration: number 音频文件的时长。
- 是否必填：发送本地音频消息时，发送端必填，不填会导致音频消息发送失败。
fileLocalPath
fileLocalPath: File 媒体消息的文件对象。
- 是否必填：如果发送本地文件，则发送端必填，否则消息会发送失败。
fileDownloadUrl
fileDownloadUrl: string 媒体消息的外部下载 URL，用于开发者将媒体文件上传到自己的服务器中时，通过填入该 URL 让 SDK 透传到其他用户中。
- 是否必填：如果发送的是外部 URL，发送端必填。
fileUID
fileUID: string 媒体文件的唯一 ID。
- 是否必填：发送端不需要填，该值由 SDK 生成。
fileName
fileName: string 媒体文件的文件名。
- 是否必填：如果发送的是外部 URL，则需要填写该值，且需要包含文件扩展名。如果发送的是本地文件，该值选填。
fileSize
fileSize: number 媒体文件的大小。
- 是否必填：发送端不需要填，该值由 SDK 生成。
type
messageID
messageID: string 标识这条消息的唯一 ID。
- 业务场景：可用于索引其他消息。
- 注意事项：开发者主动创建一条消息时，不需要修改这个参数，此参数仅在回调时有值。
timestamp
timestamp: number 标识一条消息的发送时间。
- 业务场景：用于呈现一条消息的发送时间，并可用于消息排序。
- 注意事项：此为标准 UNIX 时间戳，单位为毫秒。
senderUserID
senderUserID: string 展示本条消息发送者的 userID。
conversationID
conversationID: string 会话的 ID，相同会话类型下的 ID 是唯一的。
direction
sentStatus
conversationType
conversationSeq
conversationSeq: number 表示该消息在会话中的序号。
orderKey
orderKey: number orderKey 越大消息越新，可用于消息排序。
localMessageID
localMessageID: string SDK 本地生成的 MessageID,开发者无需关注。
isUserInserted
isUserInserted: boolean 该消息是否是开发者通过 [insertMessageToLocalDB] 接口插入的消息。
- 默认值：false。
receiptStatus
extendedData
extendedData: string 消息拓展字段。
- 业务场景：可为消息附加拓展字段，然后发送给对端。
- 是否必填：否。
- 支持版本：2.6.0 及以上。
- 注意事项：长度为1k，可联系技术支持进行配置。
localExtendedData
localExtendedData: string 仅本端可见的消息拓展字段，可附带额外的信息存储到本地，可通过 [updateMessageLocalExtendedData] 修改，目前长度的限制是 128K。如有特殊需求，可联系 ZEGO 技术支持进行配置。
isBroadcastMessage
isBroadcastMessage: boolean 该消息是否是全员推送消息。
- 是否必填：SDK内部赋值。
isMentionAll
isMentionAll: boolean 是否需要提醒所有人。业务表现可为“@所有人”。
- 业务场景：例如在群或者房间可使用。
- 是否必填：否。
- 默认值：false。
- 建议值：如果需要提醒所有人，可以设置为 true。
- 注意事项：该值并不会在消息文本上增加 @所有人 的字样，需要开发者自行实现。
支持版本 : 2.14.0 及以上。
mentionedUserIDs
mentionedUserIDs: string[] 提醒一批相关的用户。业务表现可为“@某用户”。
- 业务场景：发消息时可以带上
- 是否必填：否。
- 注意事项：该值并不会在消息文本上增加 @某用户 的字样，需要开发者自行实现。
支持版本 : 2.14.0 及以上。
messageSeq
messageSeq: number 表示该消息在会话中的序号。
rootRepliedCount
rootRepliedCount: number 回复消息树对应的根消息的回复消息数量。
repliedInfo
editorUserID
editorUserID: string 本条消息最新的编辑者的 userID。
editedTime
editedTime: number 本条消息最新的编辑时间戳。
isGroupTargetedMessage
isGroupTargetedMessage: boolean 标识该消息是否为群定向消息。
pinnedUserID
pinnedUserID: string 该消息的最后一次置顶的置顶者。
- 业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。
pinnedTime
pinnedTime: number 该消息最后一次置顶的置顶时间。
- 业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。
ZIMAudioMessageLiteInfo
音频消息的简要信息对象。
详情
标识一条音频消息。
属性
audioDuration
audioDuration: number 音频文件的时长。
- 是否必填：发送本地音频消息时，发送端必填，不填会导致音频消息发送失败。
fileLocalPath
fileLocalPath: File 媒体消息的文件对象。
- 是否必填：如果发送本地文件，则发送端必填，否则消息会发送失败。
fileDownloadUrl
fileDownloadUrl: string 媒体消息的外部下载 URL，用于开发者将媒体文件上传到自己的服务器中时，通过填入该 URL 让 SDK 透传到其他用户中。
- 是否必填：如果发送的是外部 URL，发送端必填。
fileName
fileName: string 媒体文件的文件名。
- 是否必填：如果发送的是外部 URL，则需要填写该值，且需要包含文件扩展名。如果发送的是本地文件，该值选填。
fileSize
fileSize: number 媒体文件的大小。
- 是否必填：发送端不需要填，该值由 SDK 生成。
type
ZIMBarrageMessage
弹幕消息类。
详情
弹幕消息类，不会出现在会话中，也不会存入历史消息。
属性
message
message: string 弹幕消息内容。
type
messageID
messageID: string 标识这条消息的唯一 ID。
- 业务场景：可用于索引其他消息。
- 注意事项：开发者主动创建一条消息时，不需要修改这个参数，此参数仅在回调时有值。
timestamp
timestamp: number 标识一条消息的发送时间。
- 业务场景：用于呈现一条消息的发送时间，并可用于消息排序。
- 注意事项：此为标准 UNIX 时间戳，单位为毫秒。
senderUserID
senderUserID: string 展示本条消息发送者的 userID。
conversationID
conversationID: string 会话的 ID，相同会话类型下的 ID 是唯一的。
direction
sentStatus
conversationType
conversationSeq
conversationSeq: number 表示该消息在会话中的序号。
orderKey
orderKey: number orderKey 越大消息越新，可用于消息排序。
localMessageID
localMessageID: string SDK 本地生成的 MessageID,开发者无需关注。
isUserInserted
isUserInserted: boolean 该消息是否是开发者通过 [insertMessageToLocalDB] 接口插入的消息。
- 默认值：false。
receiptStatus
extendedData
extendedData: string 消息拓展字段。
- 业务场景：可为消息附加拓展字段，然后发送给对端。
- 是否必填：否。
- 支持版本：2.6.0 及以上。
- 注意事项：长度为1k，可联系技术支持进行配置。
localExtendedData
localExtendedData: string 仅本端可见的消息拓展字段，可附带额外的信息存储到本地，可通过 [updateMessageLocalExtendedData] 修改，目前长度的限制是 128K。如有特殊需求，可联系 ZEGO 技术支持进行配置。
isBroadcastMessage
isBroadcastMessage: boolean 该消息是否是全员推送消息。
- 是否必填：SDK内部赋值。
isMentionAll
isMentionAll: boolean 是否需要提醒所有人。业务表现可为“@所有人”。
- 业务场景：例如在群或者房间可使用。
- 是否必填：否。
- 默认值：false。
- 建议值：如果需要提醒所有人，可以设置为 true。
- 注意事项：该值并不会在消息文本上增加 @所有人 的字样，需要开发者自行实现。
支持版本 : 2.14.0 及以上。
mentionedUserIDs
mentionedUserIDs: string[] 提醒一批相关的用户。业务表现可为“@某用户”。
- 业务场景：发消息时可以带上
- 是否必填：否。
- 注意事项：该值并不会在消息文本上增加 @某用户 的字样，需要开发者自行实现。
支持版本 : 2.14.0 及以上。
messageSeq
messageSeq: number 表示该消息在会话中的序号。
rootRepliedCount
rootRepliedCount: number 回复消息树对应的根消息的回复消息数量。
repliedInfo
editorUserID
editorUserID: string 本条消息最新的编辑者的 userID。
editedTime
editedTime: number 本条消息最新的编辑时间戳。
isGroupTargetedMessage
isGroupTargetedMessage: boolean 标识该消息是否为群定向消息。
pinnedUserID
pinnedUserID: string 该消息的最后一次置顶的置顶者。
- 业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。
pinnedTime
pinnedTime: number 该消息最后一次置顶的置顶时间。
- 业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。
ZIMBlacklistCheckedResult
确认用户是否被拉黑的结果的返回。
详情
确认用户是否被拉黑的结果的返回。
- 业务场景：进行确认用户是否被拉黑操作后，成功与否可以通过该回调得知。
- 相关接口：[checkUserIsInBlacklist]，确认用户是否被拉黑。
属性
isUserInBlacklist
isUserInBlacklist: boolean 用户是否被拉黑。
ZIMBlacklistQueriedResult
查询黑名单的结果的返回。
详情
查询黑名单的结果的返回。
- 业务场景：进行查询黑名单操作后，成功与否可以通过该回调得知。
- 相关接口：[queryBlacklist]，查询黑名单。
属性
blacklist
nextFlag
nextFlag: number 当前查询锚点下标。
ZIMBlacklistQueryConfig
黑名单查询配置。
详情
通过该配置可以设置查询总条数以及分页查询
属性
count
count: number 数量。
- 是否必填：必填。
nextFlag
nextFlag: number 下一个标志。
- 是否必填：非必填，首次默认为 0，表示从头开始查询。
ZIMBlacklistUsersAddedResult
添加用户至黑名单的结果的返回。
详情
添加用户至黑名单的结果的返回。
- 业务场景：进行添加用户至黑名单操作后，成功与否可以通过该回调得知。
- 相关接口：[addUsersToBlacklist]，添加用户至黑名单。
属性
errorUserList
ZIMBlacklistUsersRemovedResult
移除用户出黑名单的结果的返回。
详情
移除用户出黑名单的结果的返回。
- 业务场景：进行移除用户出黑名单操作后，成功与否可以通过该回调得知。
- 相关接口：[removeUsersFromBlacklist]，移除用户出黑名单。
属性
errorUserList
ZIMCallAcceptConfig
接受呼叫邀请设置的行为属性。
详情
接受呼叫邀请设置的行为属性。
属性
extendedData
extendedData: string 扩展字段，邀请者可通过该字段携带信息给被邀请者。
- 是否必填：必填。
ZIMCallAcceptanceSentResult
呼叫邀请已接受信息。
属性
callID
callID: string 呼叫邀请 ID。
ZIMCallCancelConfig
取消呼叫邀请设置的行为属性。
详情
取消呼叫邀请设置的行为属性。
属性
extendedData
extendedData: string 扩展字段，邀请者可通过该字段携带信息给被邀请者。
- 是否必填：非必填。
- 默认值：""。
pushConfig
ZIMCallCancelSentResult
呼叫邀请已取消信息。
详情
呼叫邀请已取消信息。
属性
errorInvitees
errorInvitees: string[] 取消呼叫邀请失败的用户 ID。
callID
callID: string 呼叫邀请 ID。
ZIMCallEndConfig
结束呼叫邀请设置的行为属性。
详情
结束呼叫邀请设置的行为属性。
属性
extendedData
extendedData: string 扩展字段，邀请者可通过该字段携带信息给被邀请者。
- 是否必填：非必填。
pushConfig
ZIMCallEndSentResult
结束当前呼叫的返回结果。
属性
callID
callID: string 呼叫邀请 ID。
createTime
createTime: number 创建呼叫的时间戳。
acceptTime
acceptTime: number 当前用户接受呼叫邀请的时间戳。
endTime
endTime: number 结束当前呼叫的时间戳。
ZIMCallInfo
呼叫邀请信息。
详情
呼叫邀请信息。
属性
callID
callID: string 呼叫邀请 ID。
caller
caller: string 呼叫邀请发起者 ID。
mode
state
extendedData
extendedData: string 创建呼叫邀请附加信息。
createTime
createTime: number 呼叫邀请创建时间戳。
endTime
endTime: number 呼叫邀请结束时间。
callUserList
ZIMCallInvitationListQueriedResult
查询呼叫邀请列表的返回结果。
属性
callList
nextFlag
nextFlag: number 分页查询的标识位，首次查询时，将此字段设为空字符串。若回调的 "nextFlag" 字段不是空字符串，说明还没结束，需要将其设置到此处以继续下一页的查询。
ZIMCallInvitationQueryConfig
查询呼叫邀请列表的设置属性。
详情
查询呼叫邀请列表的设置属性。
属性
count
count: number 查询条数，最多限制 100 条。传入数值超过 100，按照 100 处理。
- 是否必填：必填。
nextFlag
nextFlag: number 查询列表的标志位。首次查询时无需填充，查询后 callback 会返回一个 nextFlag,下次查询时填入可以在上一次的基础上继续往后查询。
- 是否必填：非必填。
ZIMCallInvitationSentResult
呼叫邀请已发送信息。
详情
呼叫邀请已发送信息。
属性
timeout
timeout: number 详细描述：呼叫邀请的超时时间设置，单位为秒。
errorInvitees
callID
callID: string 呼叫邀请 ID。
errorUserList
ZIMCallInviteConfig
发送呼叫邀请设置的行为属性。
详情
发送呼叫邀请设置的行为属性。
属性
timeout
timeout: number - 是否必填：非必填。
- 默认值：90。
extendedData
extendedData: string 扩展字段，邀请者可通过该字段携带信息给被邀请者。
pushConfig
mode
enableNotReceivedCheck
enableNotReceivedCheck: boolean 通过值为 true 的情况下，本次呼叫邀请以及后续呼叫中邀请将会检测邀请是否送达。
- 业务场景：主叫发起呼叫邀请后，如果被叫在 5 秒内（可提单给技术支持配置为 3 秒或 4 秒）因断网、未上线等原因没有接收到本次邀请，该用户状态将会变为 notYetReceived 暂未送达状态。您可使用该状态流转向用户提示该用户可能不在线。当被叫后续在呼叫超时前上线，此状态会流转为 received 已送达状态。
- 是否必填：非必填。
- 默认值：false。
- 注意事项：该属性在 2.15.0 及后续版本生效，新版本发送给老版本开启了送达检测的呼叫邀请，老版本将继续展示 inviting 状态而非 notYetReceived。
ZIMCallJoinConfig
加入呼叫邀请设置的行为属性。
详情
加入呼叫邀请设置的行为属性。
属性
extendedData
extendedData: string 扩展字段，邀请者可通过该字段携带信息给被邀请者。
ZIMCallJoinSentResult
加入呼叫的结果回调。
属性
callID
callID: string 呼叫邀请 ID。
createTime
createTime: number 当次呼叫邀请的创建时间的时间戳。
joinTime
joinTime: number 本人加入呼叫邀请的时间戳。
extendedData
extendedData: string 调用结束呼叫时附带的透传字段。
callUserList
ZIMCallQuitConfig
退出呼叫邀请设置的行为属性。
详情
退出呼叫邀请设置的行为属性。
属性
extendedData
extendedData: string 扩展字段，邀请者可通过该字段携带信息给被邀请者。
- 是否必填：必填。
pushConfig
ZIMCallQuitSentResult
退出当前呼叫的返回结果。
属性
callID
callID: string 呼叫邀请 ID。
createTime
createTime: number 创建呼叫的时间戳。
acceptTime
acceptTime: number 当前用户接受呼叫邀请的时间戳。
quitTime
quitTime: number 当前用户退出呼叫的时间戳。
ZIMCallRejectConfig
用于设置拒绝呼叫邀请的配置项。
详情
用于发送拒绝邀请时自定义呼叫邀请的配置。
- 业务场景：用户需要在调用拒绝呼叫邀请时将配置项传入接口。
属性
extendedData
extendedData: string 用于发送拒绝邀请时附加自定义内容的额外字段。
- 业务场景：用户需要再拒绝时给邀请方传一些自定义内容时使用。
- 是否必填：必填。
- 默认值：""。
ZIMCallRejectionSentResult
呼叫邀请已拒绝信息。
属性
callID
callID: string 呼叫邀请 ID。
ZIMCallUserInfo
呼叫邀请用户信息。
详情
呼叫邀请用户信息。
属性
userID
userID: string 用户ID。
- 取值范围：最大 32 字节的字符串。仅支持数字，英文字符 和 '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'。
state
extendedData
extendedData: string 呼叫邀请用户信息中的附加信息。
ZIMCallingInvitationSentResult
邀请他人进入呼叫的返回结果信息。
属性
callID
callID: string 呼叫邀请 ID。
errorInvitees
ZIMCallingInviteConfig
邀请用户进入当前呼叫设置的行为属性。
详情
邀请用户进入当前呼叫设置的行为属性。
属性
pushConfig
ZIMCombineMessage
合并消息对象基类。
详情
标识一条合并消息。
- 支持版本：2.14.0 及以上。
属性
title
title: string 合并消息标题。
summary
summary: string 合并消息的概要
combineID
combineID: string 合并消息 ID，SDK 内部使用
messageList
type
messageID
messageID: string 标识这条消息的唯一 ID。
- 业务场景：可用于索引其他消息。
- 注意事项：开发者主动创建一条消息时，不需要修改这个参数，此参数仅在回调时有值。
timestamp
timestamp: number 标识一条消息的发送时间。
- 业务场景：用于呈现一条消息的发送时间，并可用于消息排序。
- 注意事项：此为标准 UNIX 时间戳，单位为毫秒。
senderUserID
senderUserID: string 展示本条消息发送者的 userID。
conversationID
conversationID: string 会话的 ID，相同会话类型下的 ID 是唯一的。
direction
sentStatus
conversationType
conversationSeq
conversationSeq: number 表示该消息在会话中的序号。
orderKey
orderKey: number orderKey 越大消息越新，可用于消息排序。
localMessageID
localMessageID: string SDK 本地生成的 MessageID,开发者无需关注。
isUserInserted
isUserInserted: boolean 该消息是否是开发者通过 [insertMessageToLocalDB] 接口插入的消息。
- 默认值：false。
receiptStatus
extendedData
extendedData: string 消息拓展字段。
- 业务场景：可为消息附加拓展字段，然后发送给对端。
- 是否必填：否。
- 支持版本：2.6.0 及以上。
- 注意事项：长度为1k，可联系技术支持进行配置。
localExtendedData
localExtendedData: string 仅本端可见的消息拓展字段，可附带额外的信息存储到本地，可通过 [updateMessageLocalExtendedData] 修改，目前长度的限制是 128K。如有特殊需求，可联系 ZEGO 技术支持进行配置。
isBroadcastMessage
isBroadcastMessage: boolean 该消息是否是全员推送消息。
- 是否必填：SDK内部赋值。
isMentionAll
isMentionAll: boolean 是否需要提醒所有人。业务表现可为“@所有人”。
- 业务场景：例如在群或者房间可使用。
- 是否必填：否。
- 默认值：false。
- 建议值：如果需要提醒所有人，可以设置为 true。
- 注意事项：该值并不会在消息文本上增加 @所有人 的字样，需要开发者自行实现。
支持版本 : 2.14.0 及以上。
mentionedUserIDs
mentionedUserIDs: string[] 提醒一批相关的用户。业务表现可为“@某用户”。
- 业务场景：发消息时可以带上
- 是否必填：否。
- 注意事项：该值并不会在消息文本上增加 @某用户 的字样，需要开发者自行实现。
支持版本 : 2.14.0 及以上。
messageSeq
messageSeq: number 表示该消息在会话中的序号。
rootRepliedCount
rootRepliedCount: number 回复消息树对应的根消息的回复消息数量。
repliedInfo
editorUserID
editorUserID: string 本条消息最新的编辑者的 userID。
editedTime
editedTime: number 本条消息最新的编辑时间戳。
isGroupTargetedMessage
isGroupTargetedMessage: boolean 标识该消息是否为群定向消息。
pinnedUserID
pinnedUserID: string 该消息的最后一次置顶的置顶者。
- 业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。
pinnedTime
pinnedTime: number 该消息最后一次置顶的置顶时间。
- 业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。
ZIMCombineMessageDetailQueriedResult
查询合并消息详情结果的回调。
详情
开发者拉取合并消息详情后，执行结果的回调。
- 通知时机：当开发者调用 [queryCombineMessageDetail] 接口时，会触发该回调。
- 相关接口：通过 [queryCombineMessageDetail] 拉取合并消息详情，拉取的成功与否会通过本回调通知。
- 支持版本：2.14.0 及以上。
属性
message
ZIMCombineMessageLiteInfo
合并消息的简要信息对象。
详情
标识一条合并消息。
属性
title
title: string 合并消息标题。
summary
summary: string 合并消息的概要
type
ZIMCommandMessage
自定义二进制消息对象。
详情
标识一条二进制消息。
- 注意事项：回调时若基类的 Type 参数为 command，可将基类消息对象强转为此类。
属性
message
message: Uint8Array 消息的内容，支持任意数据。
- 是否必填：发送端必填，否则消息会发送失败。
type
messageID
messageID: string 标识这条消息的唯一 ID。
- 业务场景：可用于索引其他消息。
- 注意事项：开发者主动创建一条消息时，不需要修改这个参数，此参数仅在回调时有值。
timestamp
timestamp: number 标识一条消息的发送时间。
- 业务场景：用于呈现一条消息的发送时间，并可用于消息排序。
- 注意事项：此为标准 UNIX 时间戳，单位为毫秒。
senderUserID
senderUserID: string 展示本条消息发送者的 userID。
conversationID
conversationID: string 会话的 ID，相同会话类型下的 ID 是唯一的。
direction
sentStatus
conversationType
conversationSeq
conversationSeq: number 表示该消息在会话中的序号。
orderKey
orderKey: number orderKey 越大消息越新，可用于消息排序。
localMessageID
localMessageID: string SDK 本地生成的 MessageID,开发者无需关注。
isUserInserted
isUserInserted: boolean 该消息是否是开发者通过 [insertMessageToLocalDB] 接口插入的消息。
- 默认值：false。
receiptStatus
extendedData
extendedData: string 消息拓展字段。
- 业务场景：可为消息附加拓展字段，然后发送给对端。
- 是否必填：否。
- 支持版本：2.6.0 及以上。
- 注意事项：长度为1k，可联系技术支持进行配置。
localExtendedData
localExtendedData: string 仅本端可见的消息拓展字段，可附带额外的信息存储到本地，可通过 [updateMessageLocalExtendedData] 修改，目前长度的限制是 128K。如有特殊需求，可联系 ZEGO 技术支持进行配置。
isBroadcastMessage
isBroadcastMessage: boolean 该消息是否是全员推送消息。
- 是否必填：SDK内部赋值。
isMentionAll
isMentionAll: boolean 是否需要提醒所有人。业务表现可为“@所有人”。
- 业务场景：例如在群或者房间可使用。
- 是否必填：否。
- 默认值：false。
- 建议值：如果需要提醒所有人，可以设置为 true。
- 注意事项：该值并不会在消息文本上增加 @所有人 的字样，需要开发者自行实现。
支持版本 : 2.14.0 及以上。
mentionedUserIDs
mentionedUserIDs: string[] 提醒一批相关的用户。业务表现可为“@某用户”。
- 业务场景：发消息时可以带上
- 是否必填：否。
- 注意事项：该值并不会在消息文本上增加 @某用户 的字样，需要开发者自行实现。
支持版本 : 2.14.0 及以上。
messageSeq
messageSeq: number 表示该消息在会话中的序号。
rootRepliedCount
rootRepliedCount: number 回复消息树对应的根消息的回复消息数量。
repliedInfo
editorUserID
editorUserID: string 本条消息最新的编辑者的 userID。
editedTime
editedTime: number 本条消息最新的编辑时间戳。
isGroupTargetedMessage
isGroupTargetedMessage: boolean 标识该消息是否为群定向消息。
pinnedUserID
pinnedUserID: string 该消息的最后一次置顶的置顶者。
- 业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。
pinnedTime
pinnedTime: number 该消息最后一次置顶的置顶时间。
- 业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。
方法
ZIMCommandMessage
ZIMCommandMessage(): voidZIMConversation
会话具体内容。
详情
会话的具体内容。
属性
conversationID
conversationID: string 会话ID。
conversationName
conversationName: string conversationName,与会话对应的 groupName/userName 值相同。
type
unreadMessageCount
unreadMessageCount: number 会话未读数。
lastMessage
orderKey
orderKey: number 用于描述消息在会话中的顺序，orderKey 越大越新。
notificationStatus
conversationAvatarUrl
conversationAvatarUrl: string 会话头像 URL。单聊会话头像 URL 与用户头像 URL 相同，群聊会话头像 URL 与群头像 URL 相同。
- 使用限制： 最大 500 字节，无特殊字符限制。
isPinned
isPinned: boolean 会话是否置顶。
- 支持版本：2.8.0。
mentionedInfoList
mentionedInfoList: ZIMMessageMentionedInfo[] 当在会话的消息中被提醒到或者被提醒所有人时，该数组会有记录。
- 业务场景：比如可以在会话列表根据该数组显示当前会话有多少个提醒，还可以显示是哪个用户的提醒。
conversationAlias
conversationAlias: string 会话别名，通过 [updateFriendAlias] 设置好友备注后，对应的单聊会话该参数会同步修改。通过 [updateGroupAlias] 设置群备注后，对应的群聊会话该参数会同步修改。
- 业务场景：为好友或群组设置备注后，渲染会话页时，对应的会话优先选择展示 alias 别名，而不是 conversation name（好友的用户名或群组名）。
marks
marks: std::vector\<int> 描述了该会话现有的所有标记。
- 业务场景：业务层可以按照不同会话拥有的不同标记做分组逻辑等。
draft
draft: string 会话草稿，当设置会话草稿后，会话中会带有该字段。
ZIMConversationBaseInfo
会话简要内容。
详情
会话的简要内容。
属性
conversationID
conversationID: string 会话ID。
conversationType
ZIMConversationChangeInfo
会话变更信息。
详情
包含会话变更后的信息。
属性
event
conversation
ZIMConversationDeleteConfig
删除会话配置。
详情
删除会话的相关配置。
属性
isAlsoDeleteServerConversation
isAlsoDeleteServerConversation: boolean 是否删除服务端会话
- 是否必填：非必填。
- 默认值：true。
ZIMConversationDeletedResult
会话删除的回调结果。
属性
conversationID
conversationID: string 详细描述：会话 ID。
conversationType
ZIMConversationDraftSetResult
会话设置草稿的回调结果。
属性
conversationID
conversationID: string 详细描述：会话 ID。
conversationType
ZIMConversationFilterOption
查询会话的相关过滤项。
详情
查询会话时可配置的过滤项。
属性
marks
marks: std::vector\<int> 会话标记列表，只支持 [1, 20] 的整数。若列表包含 -1，查询结果为所有已标记会话；若列表包含 0，查询结果为所有无标记的会话；若传入多个标记，查询结果为所有传入标记的并集；若列表为空，则查询结果为所有会话。
- 业务场景：需要查询包含指定的会话标记时可使用该过滤项。
conversationTypes
conversationTypes: std::vector<ZIMConversationType> 会话类型。仅支持单聊和群聊。
- 业务场景：需要按照会话类型查询时可使用该过滤项。
isOnlyUnreadConversation
isOnlyUnreadConversation: boolean 是否仅查询存在未读数的会话。传 true 时，则仅查询存在未读数的会话。传 false 时，则查询时将不考虑会话是否存在未读数。
- 业务场景：需要查询出仅存在消息未读数的会话。
ZIMConversationListQueriedResult
会话列表查询的回调结果。
属性
conversationList
ZIMConversationMessageReceiptReadSentResult
设置回执会话已读的回调接口。
详情
设置回执会话已读的回调接口。
- 业务场景：开发者可以通过该回调中的 [errorCode] 判断是否设置成功。
- 通知时机：当开发者调用 [sendConversationMessageReceiptRead] 接口时，会触发该回调。
- 相关接口：通过 [sendConversationMessageReceiptRead] 设置回执的会话已读的结果成功与否会通过本回调通知。
- 支持版本：2.5.0 及以上。
属性
conversationID
conversationID: string 详细描述：会话 ID。
conversationType
ZIMConversationNotificationStatusSetResult
会话通知状态设置的回调结果。
属性
conversationID
conversationID: string 详细描述：会话 ID。
conversationType
ZIMConversationPinnedListQueriedResult
置顶会话列表查询回调。
详情
查询置顶会话列表后通过该回调返回查询结果。
- 业务场景：可在该回调内做置顶会话列表查询后的逻辑。
- 通知时机：调用 [queryConversationPinnedList] 接口查询置顶会话列表后触发。
- 支持版本：2.8.0 及以上。
属性
conversationList
ZIMConversationPinnedStateUpdatedResult
会话置顶状态变更的回调结果。
详情
更新会话置顶状态后通过该回调返回查询结果。
- 业务场景：可在该回调内做更新会话置顶状态后的逻辑。
- 通知时机：更新会话置顶状态后触发。
- 支持版本：2.8.0 及以上。
属性
conversationID
conversationID: string 详细描述：会话 ID。
conversationType
ZIMConversationQueriedResult
会话查询回调。
详情
查询会话后通过该回调返回查询结果。
- 业务场景：可在该回调内做会话查询后的逻辑。
- 通知时机：调用 [queryConversation] 接口查询会话后触发。
- 支持版本：2.8.0 及以上。
属性
conversation
ZIMConversationQueryConfig
查询会话的相关配置。
详情
查询会话时可配置的信息。
属性
nextConversation
count
count: number 需要查询的会话数量。
- 是否必填：必填。
ZIMConversationSearchConfig
会话搜索配置。
详情
会话搜索配置。
属性
nextFlag
nextFlag: number 分页拉取表示 ，初始时填 0，后续填从 callback 里返回的 nextFlag，以获取下一分页的数据。
totalConversationCount
totalConversationCount: number 搜索一次可获取的消息数量。建议小于 20，以降低性能开销。
- 是否必填：必填。
conversationMessageCount
conversationMessageCount: number 搜索一次，可获取单个会话的本地消息数量，建议小于 10，以降低性能开销。
keywords
keywords: string[] 搜索关键字，最多支持 5 个，否则会报错。例如：传入 "1" 和 "2"，则搜索结果只会展示消息同时包含 "1" 和 "2" 这两个关键字的会话。
messageTypes
subMessageTypes
subMessageTypes: number[] 自定义消息的子类型，取值范围为 [0,200]。开发者可基于此搜索具体的自定义类型。
senderUserIDs
senderUserIDs: string[] 发送用户 ID，最多支持 5 个。例如，传入 "zego2023"，则搜索结果只会展示 "zego2023" 用户发过消息的会话。
startTime
startTime: number 搜索的起始时间点，单位：毫秒，默认为 0，格式：UTC 时间戳。
endTime
endTime: number 搜索的结束时间点，必须大于 startTime，单位：毫秒，默认为 0，格式：UTC 时间戳。
ZIMConversationSearchInfo
会话搜索信息。
属性
conversationID
conversationID: string 要搜索的本地消息的会话 ID。
conversationType
totalMessageCount
totalMessageCount: number 总消息条数。
messageList
ZIMConversationTotalUnreadMessageCountQueryConfig
查询会话未读消息总数的相关配置项。
详情
查询会话未读消息总数时可配置的过滤项。
属性
marks
marks: std::vector\<int> 会话标记列表，只支持 [1, 20] 的整数。若列表包含 -1，查询结果为所有已标记会话；若列表包含 0，查询结果为所有无标记的会话；若传入多个标记，查询结果为所有传入标记的并集；若列表为空，则查询结果为所有会话。
- 业务场景：需要查询包含指定的会话标记时可使用该过滤项。
conversationTypes
conversationTypes: std::vector<ZIMConversationType> 会话类型。仅支持单聊和群聊。
- 业务场景：需要按照会话类型查询时可使用该过滤项。
ZIMConversationUnreadMessageCountClearedResult
会话未读数清除的回调结果。
属性
conversationID
conversationID: string 详细描述：会话 ID。
conversationType
ZIMConversationsSearchedResult
基于本地消息搜索本地会话结果的返回。
详情
基于本地消息搜索本地会话结果的返回。
- 业务场景：进行本地会话消息搜索操作后，成功与否可以通过该回调得知。
- 相关接口：[searchLocalConversations]，基于本地消息搜索本地会话。
属性
conversationSearchInfoList
nextFlag
nextFlag: number 分页标志。
ZIMCustomMessage
自定义消息对象。
详情
标识一条自定义消息。
- 支持版本：2.8.0 及以上。
- 注意事项：回调时若基类的 Type 参数为 Custom，可将基类消息对象强转为此类。
属性
message
message: string 消息的文本内容，应为标准 UTF-8 字符串。
- 是否必填：发送端必填，否则消息会发送失败。
subType
subType: number 消息的子类型，用于客户自定义不同自定义消息的用法。取值范围为 [0, 200]。
- 是否必填：发送端必填，否则消息会发送失败。
searchedContent
searchedContent: string 自定义消息的检索字段。由于无法通过直接搜索 message 字段来搜索自定义消息，您可把该自定义消息中希望被搜索的内容（如投票的标题等）拼接后放到此参数（长度上限默认为 64 字节），以便后续搜索。
type
messageID
messageID: string 标识这条消息的唯一 ID。
- 业务场景：可用于索引其他消息。
- 注意事项：开发者主动创建一条消息时，不需要修改这个参数，此参数仅在回调时有值。
timestamp
timestamp: number 标识一条消息的发送时间。
- 业务场景：用于呈现一条消息的发送时间，并可用于消息排序。
- 注意事项：此为标准 UNIX 时间戳，单位为毫秒。
senderUserID
senderUserID: string 展示本条消息发送者的 userID。
conversationID
conversationID: string 会话的 ID，相同会话类型下的 ID 是唯一的。
direction
sentStatus
conversationType
conversationSeq
conversationSeq: number 表示该消息在会话中的序号。
orderKey
orderKey: number orderKey 越大消息越新，可用于消息排序。
localMessageID
localMessageID: string SDK 本地生成的 MessageID,开发者无需关注。
isUserInserted
isUserInserted: boolean 该消息是否是开发者通过 [insertMessageToLocalDB] 接口插入的消息。
- 默认值：false。
receiptStatus
extendedData
extendedData: string 消息拓展字段。
- 业务场景：可为消息附加拓展字段，然后发送给对端。
- 是否必填：否。
- 支持版本：2.6.0 及以上。
- 注意事项：长度为1k，可联系技术支持进行配置。
localExtendedData
localExtendedData: string 仅本端可见的消息拓展字段，可附带额外的信息存储到本地，可通过 [updateMessageLocalExtendedData] 修改，目前长度的限制是 128K。如有特殊需求，可联系 ZEGO 技术支持进行配置。
isBroadcastMessage
isBroadcastMessage: boolean 该消息是否是全员推送消息。
- 是否必填：SDK内部赋值。
isMentionAll
isMentionAll: boolean 是否需要提醒所有人。业务表现可为“@所有人”。
- 业务场景：例如在群或者房间可使用。
- 是否必填：否。
- 默认值：false。
- 建议值：如果需要提醒所有人，可以设置为 true。
- 注意事项：该值并不会在消息文本上增加 @所有人 的字样，需要开发者自行实现。
支持版本 : 2.14.0 及以上。
mentionedUserIDs
mentionedUserIDs: string[] 提醒一批相关的用户。业务表现可为“@某用户”。
- 业务场景：发消息时可以带上
- 是否必填：否。
- 注意事项：该值并不会在消息文本上增加 @某用户 的字样，需要开发者自行实现。
支持版本 : 2.14.0 及以上。
messageSeq
messageSeq: number 表示该消息在会话中的序号。
rootRepliedCount
rootRepliedCount: number 回复消息树对应的根消息的回复消息数量。
repliedInfo
editorUserID
editorUserID: string 本条消息最新的编辑者的 userID。
editedTime
editedTime: number 本条消息最新的编辑时间戳。
isGroupTargetedMessage
isGroupTargetedMessage: boolean 标识该消息是否为群定向消息。
pinnedUserID
pinnedUserID: string 该消息的最后一次置顶的置顶者。
- 业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。
pinnedTime
pinnedTime: number 该消息最后一次置顶的置顶时间。
- 业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。
ZIMCustomMessageLiteInfo
自定义消息的简要对象。
详情
标识一条自定义消息。
属性
message
message: string 消息的文本内容，为标准 UTF-8 字符串。
- 是否必填：发送端必填，否则消息会发送失败。
subType
subType: number 消息的子类型，用于客户自定义不同自定义消息的用法。取值范围为 [0, 200]。
- 是否必填：发送端必填，否则消息会发送失败。
searchedContent
searchedContent: string 自定义消息的检索字段。由于无法通过直接搜索 message 字段来搜索自定义消息，您可把该自定义消息中希望被搜索的内容（如投票的标题等）拼接后放到此参数（长度上限默认为 64 字节），以便后续搜索。
type
ZIMError
错误信息
详情
错误信息。
属性
code
message
message: string 错误信息描述。
ZIMErrorUserInfo
失败用户信息类。
详情
用于展示失败的用户以及失败的原因。
属性
userID
userID: string userID。
- 取值范围：最大 32 字节的字符串。仅支持数字，英文字符 和 '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'。
reason
reason: number 描述查询失败原因的 reason。
ZIMEventHandler
详情
回调。
方法
blacklistChanged
blacklistChanged(zim: ZIM, data: ZIMEventOfBlacklistChangedResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfBlacklistChangedResult | 事件回调的结果。 |
详情
当黑名单列表发生变化时会回调当前方法
- 调用时机：通过 [create] 创建ZIM实例后。
- 相关接口：[addUsersToBlacklist]。
- 支持版本：2.13.0 及以上。
friendListChanged
friendListChanged(zim: ZIM, data: ZIMEventOfFriendListChangedResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfFriendListChangedResult | 事件回调的结果。 |
详情
当好友列表发生变化时会回调当前方法
- 调用时机：通过 [create] 创建ZIM实例后。
- 相关接口：[addFriend]。
- 支持版本：2.14.0 及以上。
friendApplicationListChanged
friendApplicationListChanged(zim: ZIM, data: ZIMEventOfFriendApplicationListChangedResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfFriendApplicationListChangedResult | 事件回调的结果。 |
详情
当好友列表发生变化时会回调当前方法
- 调用时机：通过 [create] 创建ZIM实例后。
- 相关接口：[sendFriendApplication]。
- 支持版本：2.14.0 及以上。
friendApplicationUpdated
friendApplicationUpdated(zim: ZIM, data: ZIMEventOfFriendApplicationUpdatedResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfFriendApplicationUpdatedResult | 事件回调的结果。 |
详情
当好友申请列表发生更新时会回调当前方法
- 调用时机：通过 [create] 创建ZIM实例后。
- 相关接口：[acceptFriendApplication] [rejectFriendApplication]。
- 支持版本：2.14.0 及以上。
friendInfoUpdated
friendInfoUpdated(zim: ZIM, data: ZIMEventOfFriendInfoUpdatedResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfFriendInfoUpdatedResult | 事件回调的结果。 |
详情
当好友信息更新时候会触发该回调。
- 调用时机：通过 [create] 创建ZIM实例后。
- 相关接口：[updateFriendAlias] [updateFriendAttributes]。
- 支持版本：2.14.0 及以上。
userStatusUpdated
userStatusUpdated(zim: ZIM, userStatusList: List<ZIMUserStatus>): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | zim 实例。 |
| userStatusList | List<ZIMUserStatus> | 携带用户在线状态数据的列表。 |
详情
用户在线状态变更通知。
- 业务场景：当业务上需关注某些人的在线状态，比如展示在线的群成员，通过 subscribeUsersStatus 接口订阅这些用户后，这些用户的在线状态以及订阅有效期间在线状态发生的变更将通过此接口通知给您。
- 调用时机/通知时机：当前用户首次订阅目标用户后，如果目标用户首次被添加到订阅列表，或者被订阅的用户的在线状态、在线平台列表时，该事件将会被触发。此外，当前用户如果开通了多端登录，并且在线平台发生了变更时，该回调也会被触发。
- 支持版本：2.18.0
- 注意事项：当 userStatusUpdated 回调返回当前用户的 userStatus 信息时，其中的 onlineStatus 将为 unknown, lastUpdateTime 为 0,并不能真实反馈在线状态，请根据 connectionStateChanged 来映射当前用户的在线状态。
error
connectionStateChanged
connectionStateChanged(zim: ZIM, data: ZIMEventOfConnectionStateChangedResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfConnectionStateChangedResult | 事件回调的结果。 |
详情
连接状态发生改变时会通过该回调将目前的状态与事件通知用户。
- 业务场景：需要监测连接状态，以及使得连接状态改变的事件时，可通过该回调中的 [ZIMConnectionState] 和 [ZIMConnectionEvent] 以完成不同的业务逻辑。
- 通知时机：连接状态发生改变时会回调此函数通知。
- 支持版本：1.1.0 及以上。
tokenWillExpire
tokenWillExpire(zim: ZIM, data: ZIMEventOfTokenWillExpireResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfTokenWillExpireResult | 事件回调的结果。 |
详情
当收到此回调时，开发者应当及时调用 [renewToken] 函数更新 Token。
- 通知时机：在鉴权 Token 只剩下 30 秒时，SDK 会回调此函数通知开发者更新鉴权 Token。若开发者 [login] 时传入的鉴权 Token 不足 30 秒的有效期，则在 [login] 成功之后即会回调出来。
- 相关参考：详情请参考鉴权 Token 生成 https://doc-zh.zego.im/article/11617 。
- 支持版本：1.1.0 及以上。
userInfoUpdated
userInfoUpdated(zim: ZIM, data: ZIMEventOfUserInfoUpdatedResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfUserInfoUpdatedResult | 事件回调的结果。 |
详情
多端登录场景时，用户在 A 设备修改自己的信息后，其他在线的多端设备会收到此回调。对于离线设备，用户上线后，需要调用 [queryUsersInfo] 接口，主动查询用户信息。
- 支持版本：2.11.0 及以上。
userRuleUpdated
userRuleUpdated(zim: ZIM, data: ZIMEventOfUserRuleUpdatedResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfUserRuleUpdatedResult | 事件回调的结果。 |
详情
用户规则变更的回调。
- 通知时机：当前用户的用户规则发生变更时，会通过该回调通知所有端。
- 支持版本：2.15.0 及以后版本。
callInvitationReceived
callInvitationReceived(zim: ZIM, data: ZIMEventOfCallInvitationReceivedResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfCallInvitationReceivedResult | 事件回调的结果。 |
详情
邀请者发起呼叫邀请后，当被邀请者在线时，将会收到此回调。
- 业务场景：被邀请者会在邀请者发送呼叫邀请后，会收到此回调。
- 调用时机：通过 [create] 创建ZIM实例后。
- 相关接口：[callInvite]。
- 支持版本：2.0.0 及以上。
- 注意事项：若用户不在邀请列表里面或者不在线，则不会收到该回调。
callInvitationCreated
callInvitationCreated(zim: ZIM, data: ZIMEventOfCallInvitationCreatedResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfCallInvitationCreatedResult | 事件回调的结果。 |
详情
邀请者发起呼叫邀请后，当邀请者在线时，将会收到此回调。
- 业务场景：邀请者会在发送呼叫邀请后，会收到此回调。
- 调用时机：通过 [create] 创建ZIM实例后。
- 相关接口：[callInvite]。
- 支持版本：2.13.0 及以上。
- 注意事项：若用户不在邀请列表里面或者不在线，则不会收到该回调。
callInvitationCancelled
callInvitationCancelled(zim: ZIM, data: ZIMEventOfCallInvitationCancelledResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfCallInvitationCancelledResult | 事件回调的结果。 |
详情
邀请者取消呼叫邀请后，当被邀请者在线时，将会收到此回调。
- 业务场景：被邀请者会在邀请者取消呼叫邀请后，会收到此回调。
- 调用时机：通过 [create] 创建ZIM实例后。
- 相关接口：[callCancel]。
- 支持版本：2.0.0 及以上。
- 注意事项：若用户不在取消邀请列表里面或者不在线，则不会收到该回调。
callInvitationTimeout
callInvitationTimeout(zim: ZIM, data: ZIMEventOfCallInvitationTimeoutResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfCallInvitationTimeoutResult | 事件回调的结果。 |
详情
当呼叫邀请超时后，被邀请者没有响应，被邀请者会收到此回调。
- 业务场景：被邀请者没有在超时时间前响应，被邀请者会收到此回调。
- 调用时机：通过 [create] 创建ZIM实例后。
- 相关接口：[callInvite]、[callAccept]、 [callReject]。
- 支持版本：2.0.0 及以上。
- 注意事项：若用户不在邀请列表或者不在线，则不会收到该回调。
callInvitationAccepted
callInvitationAccepted(zim: ZIM, data: ZIMEventOfCallInvitationAcceptedResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfCallInvitationAcceptedResult | 事件回调的结果。 |
详情
被邀请者接受呼叫邀请后，当邀请者在线时，将会收到此回调。
- 业务场景：邀请者会在邀请者接受呼叫邀请后，会收到此回调。
- 调用时机：通过 [create] 创建ZIM实例后。
- 相关接口：[callAccept]。
- 支持版本：2.0.0 及以上。
- 注意事项：若用户不是发起这次呼叫邀请的邀请者或者不在线，则不会收到该回调。
callInvitationRejected
callInvitationRejected(zim: ZIM, data: ZIMEventOfCallInvitationRejectedResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfCallInvitationRejectedResult | 事件回调的结果。 |
详情
被邀请者拒绝呼叫邀请后，当邀请者在线时，将会收到此回调。
- 业务场景：邀请者会在邀请者拒绝呼叫邀请后，会收到此回调。
- 调用时机：通过 [create] 创建ZIM实例并登录后。
- 相关接口：[callReject]。
- 支持版本：2.0.0 及以上。
- 注意事项：若用户不是发起这次呼叫邀请的邀请者或者不在线，则不会收到该回调。
callInviteesAnsweredTimeout
callInviteesAnsweredTimeout(zim: ZIM, data: ZIMEventOfCallInviteesAnsweredTimeoutResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfCallInviteesAnsweredTimeoutResult | 事件回调的结果。 |
详情
当呼叫邀请超时后，被邀请者没有响应，邀请者会收到此回调。
- 业务场景：被邀请者没有在超时时间前响应，邀请者会收到此回调。
- 调用时机：通过 [create] 创建ZIM实例后。
- 相关接口：[callInvite]、[callAccept]、 [callReject]。
- 支持版本：2.0.0 及以上。
- 注意事项：若用户不是发起这次呼叫邀请的邀请者或者不在线，则不会收到该回调。
callInvitationEnded
callInvitationEnded(zim: ZIM, data: ZIMEventOfCallInvitationEndedResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfCallInvitationEndedResult | 事件回调的结果。 |
详情
当进阶模式呼叫邀请建立后，某一参与者结束呼叫后，所有参与者会收到此回调。
- 相关接口：[callEnd]
- 支持版本：2.9.0 及以上。
- 注意事项：若用户不是发起这次呼叫的参与者或者不在线，则不会收到该回调。
callUserStateChanged
callUserStateChanged(zim: ZIM, data: ZIMEventOfCallUserStateChangedResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfCallUserStateChangedResult | 事件回调的结果。 |
详情
监听呼叫用户状态变化。
- 通知时机：当呼叫邀请发起后，呼叫中有新的成员被邀请，或者成员接受、拒绝、退出，或者成员应答超时，当前呼叫邀请中所有用户状态为 "Inviting"、"Accepted" 和 "Received" 的用户可在此处收到此回调。若通知时成员不在线，登录成功时呼叫仍然未结束，离线期间的所有成员的状态变更会一次补发给这名用户。详细流程请阅读 https://doc-zh.zego.im/article/13930。
- 相关接口：[callInvite]、[callingInvite]、[callAccept]、 [callReject]、[callQuit]。
- 支持版本：2.9.0 及以上。
- 注意事项：若用户不是这次呼叫的成员（主叫和被叫)，则不会收到该回调。
groupStateChanged
groupStateChanged(zim: ZIM, data: ZIMEventOfGroupStateChangedResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfGroupStateChangedResult | 事件回调的结果。 |
详情
群组状态发生变更通知回调。
- 业务场景： 需要根据群组状态进行交互的场景。
- 通知时机：群组创建、加入、离开、解散操作时会触发通知。
- 相关接口：[createGroup]，创建群组。[joinGroup]，加入群组。[leaveGroup]，离开群组。[dismissGroup]，解散群组。
groupAliasUpdated
groupAliasUpdated(zim: ZIM, data: ZIMEventOfGroupAliasUpdatedResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfGroupAliasUpdatedResult | 事件回调的结果。 |
详情
群组备注变更通知回调。
- 业务场景： 群组备注发生变更时，此通知向修改操作用户的所有端同步最新群备注。
- 通知时机：群组备注发生变更。
- 相关接口：[updateGroupAlias]，更新群组备注。
groupNameUpdated
groupNameUpdated(zim: ZIM, data: ZIMEventOfGroupNameUpdatedResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfGroupNameUpdatedResult | 事件回调的结果。 |
详情
群组名称发生变更通知回调。
- 业务场景： 群组名称发生变更时，需要同步最新群名称。
- 通知时机：群组名称发生变更。
- 相关接口：[updateGroupName]，更新群组名称。
groupAvatarUrlUpdated
groupAvatarUrlUpdated(zim: ZIM, data: ZIMEventOfGroupAvatarUrlUpdatedResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfGroupAvatarUrlUpdatedResult | 事件回调的结果。 |
详情
群组头像 URL 发生变更通知回调。
- 业务场景： 群组头像 URL 发生变更时，需要同步最新群头像 URL 。
- 通知时机：群组头像 URL 发生变更。
- 相关接口：[updateGroupAvatarUrl]，更新群组头像 URL 。
groupNoticeUpdated
groupNoticeUpdated(zim: ZIM, data: ZIMEventOfGroupNoticeUpdatedResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfGroupNoticeUpdatedResult | 事件回调的结果。 |
详情
群组公告发生变更通知回调。
- 业务场景： 群组公告发生变更时，需要同步最新公告内容。
- 通知时机：群组公告发生变更。
- 相关接口：[updateGroupNotice]，更新群组公告。
groupMutedInfoUpdated
groupMutedInfoUpdated(zim: ZIM, data: ZIMEventOfGroupMutedInfoUpdatedResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfGroupMutedInfoUpdatedResult | 事件回调的结果。 |
详情
群组禁言信息发生变更通知回调。
- 业务场景： 群组禁言信息发生变更时获知变更详情。
- 通知时机：群组禁言信息发生变更。
- 相关接口：[muteGroup]，群组禁言。
groupVerifyInfoUpdated
groupVerifyInfoUpdated(zim: ZIM, data: ZIMEventOfGroupVerifyInfoUpdatedResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfGroupVerifyInfoUpdatedResult | 事件回调的结果。 |
详情
入群验证模式发生变更通知回调。
- 通知时机：入群验证模式发生变更。
- 相关接口：[updateGroupJoinMode，updateGroupInviteMode，updateGroupBeInviteMode]，更新入群验证模式。
groupAttributesUpdated
groupAttributesUpdated(zim: ZIM, data: ZIMEventOfGroupAttributesUpdatedResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfGroupAttributesUpdatedResult | 事件回调的结果。 |
详情
群组属性发生变更通知回调。
- 业务场景： 群组属性发生变更时，需要同步最新群属性内容。
- 通知时机：设置、更新、删除群组属性时触发。
- 相关接口：[setGroupAttributes]，更新群组属性。[deleteGroupAttributes]，删除群组属性。
groupMemberStateChanged
groupMemberStateChanged(zim: ZIM, data: ZIMEventOfGroupMemberStateChangedResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfGroupMemberStateChangedResult | 事件回调的结果。 |
详情
群成员状态发生变更通知回调。
- 业务场景： 需要根据群成员状态进行交互的场景。
- 通知时机：群组创建、加入、离开、解散，邀请用户进群、将用户踢出群组操作时会触发通知。
- 相关接口：[createGroup]，创建群组。[joinGroup]，加入群组。[leaveGroup]，离开群组。[dismissGroup]，解散群组。[intiveUsersIntoGroup]，邀请用户进入群组。[kickGroupMembers]，将用户踢出群组。
groupMemberInfoUpdated
groupMemberInfoUpdated(zim: ZIM, data: ZIMEventOfGroupMemberInfoUpdatedResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfGroupMemberInfoUpdatedResult | 事件回调的结果。 |
详情
群组成员基本信息变更操作结果的返回。
- 业务场景：群组成员基本信息发生变更后，需要在页面进行展示或其他交互。
- 通知时机：群组成员基本信息变更结束后的结果返回。
- 相关接口：[setGroupMemberNickname]，更新群成员昵称。[setGroupMemberRole]，更新群成员角色。[transferGroupOwner]，群主转让。
groupApplicationListChanged
groupApplicationListChanged(zim: ZIM, data: ZIMEventOfGroupApplicationListChangedResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfGroupApplicationListChangedResult | 事件回调的结果。 |
详情
当入群申请列表发生变化时会回调当前方法
- 调用时机：通过 [create] 创建ZIM实例后。
- 相关接口：[sendGroupJoinApplication]，[sendGroupInviteApplications]。
- 支持版本：2.15.0 及以上。
groupApplicationUpdated
groupApplicationUpdated(zim: ZIM, data: ZIMEventOfGroupApplicationUpdatedResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfGroupApplicationUpdatedResult | 事件回调的结果。 |
详情
当入群申请列表发生变化时会回调当前方法
- 调用时机：通过 [create] 创建ZIM实例后。
- 相关接口：[acceptGroupJoinApplication]，[rejectGroupJoinApplication]，[acceptGroupInviteApplication]，[rejectGroupInviteApplication]。
- 支持版本：2.15.0 及以上。
conversationChanged
conversationChanged(zim: ZIM, data: ZIMEventOfConversationChangedResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfConversationChangedResult | 事件回调的结果。 |
详情
当会话发生增加、删除、修改、置顶、取消置顶时，触发该回调返回会话更新的通知。
- 通知时机：当会话存在新的消息更新、或会话本身增加、删除、修改时触发通知。
- 相关接口：可通过 [sendPeerMessage] 、[sendGroupMessage]、[sendRoomMessage]、[deleteConversation]、[deleteMessage]、[deleteMessageByConversationID]、[updateConversationPinnedState] 触发。
- 支持版本：2.0.0 及以上。
- 注意事项：conversationID 与单聊的 toUserID、群聊的 GroupID 一致。
conversationMessageReceiptChanged
conversationMessageReceiptChanged(zim: ZIM, data: ZIMEventOfMessageReceiptChangedResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfMessageReceiptChangedResult | 事件回调的结果。 |
详情
当消息接收方进行会话已读后，消息发送方通过此回调得知。
- 通知时机：当消息接收方进行会话已读时触发通知。
- 相关接口：当对端调用通过 [sendConversationMessageReceiptRead] 触发。
- 支持版本：2.5.0 及以上。
conversationSyncStateChanged
conversationSyncStateChanged(zim: ZIM, state: ZIMConversationSyncState): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| state | ZIMConversationSyncState | 会话同步的状态。 |
详情
当 SDK 首次登录后开始从服务端同步会话的流程，以及流程完成或失败时，触发该回调返回会话更新的通知。
- 通知时机：当 SDK 确认需要从服务端拉取列表数据时触发通知。
- 支持版本：2.21.0 及以上。
- 注意事项：conversationID 与单聊的 toUserID、群聊的 GroupID 一致。
conversationsAllDeleted
conversationsAllDeleted(zim: ZIM, data: ZIMEventOfConversationsAllDeletedResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfConversationsAllDeletedResult | 事件回调的结果。 |
详情
该回调返回全部会话被删除的通知。
- 通知时机：当其他端删除全部会话时，本端触发通知。
- 相关接口：可通过 [deleteAllConversations] 触发。
- 支持版本：2.12.0 及以上。
messageReceiptChanged
messageReceiptChanged(zim: ZIM, data: ZIMEventOfMessageReceiptChangedResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfMessageReceiptChangedResult | 事件回调的结果。 |
详情
当消息接收方进行消息已读后，消息发送方通过此回调得知。
- 通知时机：当消息接收方进行消息已读时触发通知。
- 相关接口：当对端调用通过 [sendMessageReceiptsRead] 触发。
- 支持版本：2.5.0 及以上。
conversationTotalUnreadMessageCountUpdated
conversationTotalUnreadMessageCountUpdated(zim: ZIM, data: ZIMEventOfConversationTotalUnreadMessageCountUpdatedResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfConversationTotalUnreadMessageCountUpdatedResult | 事件回调的结果。 |
详情
该回调用于返回会话的总未读数。
- 通知时机：登录时、调用 [deleteConversation]、[deleteMessage]、[deleteAllMessage]、[clearConversationUnreadMessageCount] 、[clearConversationTotalUnreadMessageCount] 使消息未读数发生变化触发该回调。
- 相关接口：[deleteConversation]、[deleteMessage]、[deleteMessage]、[clearConversationUnreadMessageCount]、[clearConversationTotalUnreadMessageCount]
- 支持版本：2.0.0 及以上。
groupMessageReceived
groupMessageReceived(zim: ZIM, data: ZIMEventOfReceiveConversationMessageResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfReceiveConversationMessageResult | 事件回调的结果。 |
详情
用户在线时，可通过此回调接收在线群组消息。用户重新登录 ZIM SDK 后，可以通过通过此回调接收离线期间（最长7天）收到的所有群聊消息。
- 调用时机：通过 [create] 创建 ZIM 实例后，且所在群成员发送消息时，会收到该回调。
- 相关接口：可通过 [sendGroupMessage] 向其他群成员发送消息。
- 支持版本：2.18.0 及以上。
peerMessageReceived
peerMessageReceived(zim: ZIM, data: ZIMEventOfReceiveConversationMessageResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfReceiveConversationMessageResult | 事件回调的结果。 |
详情
用户在线时，可通过此回调接收在线单聊消息。用户重新登录 ZIM SDK 后，可以通过此回调接收离线期间（最长 7 天）收到的所有单聊消息。
- 调用时机：通过 [create] 创建 ZIM 实例后，且该其他用户向你发送消息时，会收到该回调。
- 相关接口：可通过 [sendPeerMessage] 向其他成员发送消息。
- 支持版本：2.18.0 及以上。
roomMessageReceived
roomMessageReceived(zim: ZIM, data: ZIMEventOfReceiveConversationMessageResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfReceiveConversationMessageResult | 事件回调的结果。 |
详情
用户在线时，可通过此回调接收在线房间消息。用户从离线恢复到在线后，若仍在房间中，即可通过此回调接收离线期间内的所有房间消息。
- 调用时机：通过 [create] 创建 ZIM 实例后，且该其他用户向当前已经加入或创建的房间发送消息时，会收到该回调。
- 相关接口：可通过 [sendRoomMessage] 向其他房间成员发送消息。
- 支持版本：2.18.0 及以上。
messageEdited
messageEdited(zim: ZIM, data: ZIMEventOfMessageEditedResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfMessageEditedResult | 事件回调的结果。 |
详情
当其他人编辑消息成功时，将会收到此回调。
- 调用时机：通过 [create] 创建 ZIM 实例后，且其他用户编辑消息成功时，会收到该回调。
- 相关接口：可通过 [editMessage] 编辑自己发送成功的消息。
- 支持版本：2.20.0 及以上。
messagePinStatusChanged
messagePinStatusChanged(zim: ZIM, data: ZIMEventOfMessagePinnedStatusResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfMessagePinnedStatusResult | 事件回调的结果。 |
详情
当会话内消息被置顶或取消置顶成功时，将会收到此通知。
- 调用时机：通过 [create] 创建 ZIM 实例后，且其他用户置顶或取消置顶消息成功时，会收到该回调。
- 相关接口：可通过 [pinMessage] 编辑自己发送成功的消息。
- 支持版本：2.25.0 及以上。
messageRevokeReceived
messageRevokeReceived(zim: ZIM, data: ZIMEventOfMessageRevokeReceivedResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfMessageRevokeReceivedResult | 事件回调的结果。 |
详情
当其他人发来消息然后撤回时，将会收到此回调。
- 调用时机：通过 [create] 创建 ZIM 实例后，且该其他用户向你发送消息后撤回时，会收到该回调。
- 相关接口：可通过 [revokeMessage] 撤回向其他成员发送的消息。
- 支持版本：2.5.0 及以上。
messageSentStatusChanged
messageSentStatusChanged(zim: ZIM, data: ZIMEventOfMessageSentStatusChangedResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfMessageSentStatusChangedResult | 事件回调的结果。 |
详情
当消息发送状态发生变化时，将会收到此回调。
- 调用时机：发送消息状态发生变化时，会收到该回调。
- 相关接口：可通过 [sendMessage] 向其他成员发送的消息。
- 支持版本：2.6.0 及以上。
broadcastMessageReceived
broadcastMessageReceived(zim: ZIM, data: ZIMEventOfBroadcastMessageReceivedResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfBroadcastMessageReceivedResult | 事件回调的结果。 |
详情
当收到服务端接口 [SendMessageToAllUsers] 发送的消息时收到该回调。
- 调用时机：登录 ZIM 服务后，且服务端调用接口 [SendMessageToAllUsers] 发送的消息时，会收到该回调。
- 支持版本：2.10.0 及以上。
messageReactionsChanged
messageReactionsChanged(zim: ZIM, data: ZIMEventOfMessageReactionsChangedResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfMessageReactionsChangedResult | 表态变更事件的结果。 |
详情
当表态发生变更时收到该回调。
- 调用时机：通过 [create] 创建 ZIM 实例后且登录前，即可注册此回调。
- 通知时机：其他用户对单聊或群聊的消息添加或删除表态后。
- 相关接口：[addMessageReaction]、[deleteMessageReaction]。
- 支持版本：2.10.0 及以上。
messageDeleted
messageDeleted(zim: ZIM, data: ZIMEventOfMessageDeletedResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfMessageDeletedResult | 事件回调的结果。 |
详情
多端登录场景时，用户在 A 设备删除服务端消息后，其他在线的多端设备会收到此回调。
- 支持版本：2.11.0 及以上。
receivePeerMessage
receivePeerMessage(zim: ZIM, data: ZIMEventOfReceiveConversationMessageResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfReceiveConversationMessageResult | 事件回调的结果。 |
详情
当收到其他人发来的点对点消息时，将会收到此回调。
- 调用时机：通过 [create] 创建 ZIM 实例后，且该其他用户向你发送消息时，会收到该回调。
- 相关接口：可通过 [sendPeerMessage] 向其他成员发送消息。
- 支持版本：1.1.0 及以上。
receiveRoomMessage
receiveRoomMessage(zim: ZIM, data: ZIMEventOfReceiveConversationMessageResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfReceiveConversationMessageResult | 事件回调的结果。 |
详情
当收到房间内消息时，将会收到此回调。
- 调用时机：通过 [create] 创建 ZIM 实例后，且该其他用户向当前已经加入或创建的房间发送消息时，会收到该回调。
- 相关接口：可通过 [sendRoomMessage] 向其他房间成员发送消息。
- 支持版本：1.1.0 及以上。
messageRepliedCountChanged
messageRepliedCountChanged(zim: ZIM, data: ZIMEventOfMessageRepliedCountChangedResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfMessageRepliedCountChangedResult | 事件回调的结果。 |
详情
有新的回复消息时，其对应的的根消息的回复数量通过此事件告知。
- 支持版本：2.17.0 及以上。
messageRepliedInfoChanged
messageRepliedInfoChanged(zim: ZIM, data: ZIMEventOfMessageRepliedInfoChangedResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfMessageRepliedInfoChangedResult | 事件回调的结果。 |
详情
回复消息引用的源消息被删除和撤回后，收到的回复消息的变更事件。
- 支持版本：2.17.0 及以上。
receiveGroupMessage
receiveGroupMessage(zim: ZIM, data: ZIMEventOfReceiveConversationMessageResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfReceiveConversationMessageResult | 事件回调的结果。 |
详情
当收到群消息时，将会收到此回调。
- 调用时机：通过 [create] 创建 ZIM 实例后，且所在群成员发送消息时，会收到该回调。
- 相关接口：可通过 [sendGroupMessage] 向其他群成员发送消息。
- 支持版本：2.0.0 及以上。
roomStateChanged
roomStateChanged(zim: ZIM, data: ZIMEventOfRoomStateChangedResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfRoomStateChangedResult | 事件回调的结果。 |
详情
房间连接状态发生改变的事件回调。
- 调用时机：用户位于房间中且房间状态改变时触发此回调。
- 相关接口：可通过 [onTokenWillExpire]，在token快要过期时会收到该回调。
- 支持版本：1.1.0 及以上。
roomMemberJoined
roomMemberJoined(zim: ZIM, data: ZIMEventOfRoomMemberChangedResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfRoomMemberChangedResult | 事件回调的结果。 |
详情
加入一个房间后，当有其他成员也加入到此房间时，将会收到此回调。
- 业务场景：当房间内有其他成员加入时，会调用此回调。
- 调用时机：通过 [create] 创建ZIM实例后，且该用户位于其他成员加入的房间中时可调用该接口。
- 相关接口：可通过 [onRoomMemberLeft]，在有其他房间成员离开时，收到此回调。
- 支持版本：1.1.0 及以上。
- 注意事项：若用户当前不在此房间内，则不会调用该回调。
roomMemberLeft
roomMemberLeft(zim: ZIM, data: ZIMEventOfRoomMemberChangedResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例对象。 |
| data | ZIMEventOfRoomMemberChangedResult | 事件回调的结果。 |
详情
加入一个房间后，当有其他成员离开此房间时，将会收到此回调。
- 业务场景：当房间内有其他成员离开房间时，会调用此回调。
- 调用时机：通过 [create] 创建 ZIM 实例后，且该用户位于其他成员同一房间中时可调用该接口。
- 相关接口：可通过 [onRoomMemberJoined]，在有其他房间成员加入时，收到此回调。
- 支持版本：1.1.0 及以上。
- 注意事项：若用户当前不在此房间内，则不会调用该回调。
roomAttributesUpdated
roomAttributesUpdated(zim: ZIM, data: ZIMEventOfRoomAttributesUpdatedResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | zim实例。 |
| data | ZIMEventOfRoomAttributesUpdatedResult | 事件回调的结果。 |
详情
当房间中的房间属性发生变更时，通过该回调通知。
- 业务场景：语聊房场景下，有其他用户上下麦的通知。
- 通知时机：房间中的房间属性发生变更会触发该通知。
- 支持版本：1.3.0。
roomAttributesBatchUpdated
roomAttributesBatchUpdated(zim: ZIM, data: ZIMEventOfRoomAttributesUpdatedResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | zim实例。 |
| data | ZIMEventOfRoomAttributesUpdatedResult | 事件回调的结果。 |
详情
当房间中的房间属性发生变更时，通过该回调通知。
- 业务场景：语聊房场景下，有其他用户上下麦的通知。
- 通知时机：房间中的房间属性发生变更会触发该通知。
- 支持版本：1.3.0。
roomMemberAttributesUpdated
roomMemberAttributesUpdated(zim: ZIM, data: ZIMEventOfRoomMembersAttributesUpdatedResult): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| zim | ZIM | ZIM 实例。 |
| data | ZIMEventOfRoomMembersAttributesUpdatedResult | 事件回调的结果。 |
详情
当房间内有用户的属性发生变更时，将会收到该回调。
ZIMEventOfBlacklistChangedResult
blacklistChanged 事件回调的结果。
属性
userList
action
ZIMEventOfBroadcastMessageReceivedResult
broadcastMessageReceived 事件回调的结果。
属性
message
ZIMEventOfCallInvitationAcceptedResult
callInvitationAccepted 事件回调的结果。
属性
callID
callID: string 呼叫邀请 ID。
invitee
invitee: string 被邀请者ID。
extendedData
extendedData: string 扩展字段，邀请者可通过该字段携带信息给被邀请者。
ZIMEventOfCallInvitationCancelledResult
callInvitationCancelled 事件回调的结果。
属性
callID
callID: string 呼叫邀请 ID。
inviter
inviter: string 邀请者 ID。
extendedData
extendedData: string 扩展字段，邀请者可通过该字段携带信息给被邀请者。
mode
ZIMEventOfCallInvitationCreatedResult
callInvitationCreated 事件回调的结果。
详情
发起呼叫邀请成功后，用户会收到该回调。
属性
callID
callID: string 呼叫邀请 ID。
timeout
timeout: number 呼叫邀请的超时时间设置，单位为秒。
extendedData
extendedData: string 扩展字段，邀请者可通过该字段携带信息给被邀请者。
caller
caller: string 呼叫邀请发起者 ID。
createTime
createTime: number 呼叫邀请创建时间戳。
callUserList
mode
ZIMEventOfCallInvitationEndedResult
callInvitationEnded 事件回调的结果。
属性
callID
callID: string 呼叫邀请 ID。
mode
caller
caller: string 呼叫发起者。
operatedUserID
operatedUserID: string 呼叫结束调用者。
extendedData
extendedData: string 呼叫结束附加信息。
endTime
endTime: number 结束呼叫时间戳。
ZIMEventOfCallInvitationReceivedResult
callInvitationReceived 事件回调的结果。
属性
callID
callID: string 呼叫邀请 ID。
inviter
inviter: string 邀请者 ID。
timeout
timeout: number 呼叫邀请的超时时间设置，单位为秒。
extendedData
extendedData: string 扩展字段，邀请者可通过该字段携带信息给被邀请者。
mode
caller
caller: string 呼叫邀请发起者 ID。
createTime
createTime: number 呼叫邀请创建时间戳。
callUserList
ZIMEventOfCallInvitationRejectedResult
callInvitationRejected 事件回调的结果。
属性
callID
callID: string 呼叫邀请 ID。
invitee
invitee: string 被邀请者ID。
extendedData
extendedData: string 扩展字段，邀请者可通过该字段携带信息给被邀请者。
ZIMEventOfCallInvitationTimeoutResult
callInvitationTimeout 事件回调的结果。
属性
callID
callID: string 呼叫邀请 ID。
mode
ZIMEventOfCallInviteesAnsweredTimeoutResult
callInviteesAnsweredTimeout 事件回调的结果。
属性
callID
callID: string 呼叫邀请 ID。
invitees
invitees: string[] 超时的被邀请者 ID。
ZIMEventOfCallUserStateChangedResult
callUserStateChanged 事件回调的结果。
详情
呼叫邀请用户状态变更回调。
属性
callID
callID: string 呼叫邀请 ID。
callUserList
ZIMEventOfConnectionStateChangedResult
connectionStateChanged 事件回调的结果。
属性
state
event
extendedData
extendedData: string 事件发生时的额外信息，标准 JSON 格式字符串。
ZIMEventOfConversationChangedResult
conversationChanged 事件回调的结果。
属性
infoList
ZIMEventOfConversationTotalUnreadMessageCountUpdatedResult
conversationTotalUnreadMessageCountUpdated 事件回调的结果。
属性
totalUnreadMessageCount
totalUnreadMessageCount: number 更新后的总未读数。
ZIMEventOfConversationsAllDeletedResult
conversationsAllDeleted 事件回调的结果。
属性
count
count: number 删除的全部会话的数量。
ZIMEventOfFriendApplicationListChangedResult
friendApplicationListChanged 事件回调的结果。
属性
applicationList
action
ZIMEventOfFriendApplicationUpdatedResult
friendApplicationUpdated 事件回调的结果。
属性
applicationList
ZIMEventOfFriendInfoUpdatedResult
friendInfoUpdated 事件回调的结果。
属性
friendList
ZIMEventOfFriendListChangedResult
friendListChanged 事件回调的结果。
属性
friendList
action
ZIMEventOfGroupAliasUpdatedResult
群备注更新的结果回调。
详情
群备注更新操作结果的返回。
- 业务场景：进行群备注更新操作后，成功与否可以通过该回调得知。
- 通知时机：群备注更新操作结束后的结果返回。
- 相关接口：[updateGroupAlias]，更新群备注。
属性
groupID
groupID: string 群组 ID。
groupAlias
groupAlias: string 群备注。
ZIMEventOfGroupApplicationListChangedResult
groupApplicationListChanged 事件回调的结果。
属性
applicationList
action
ZIMEventOfGroupApplicationUpdatedResult
groupApplicationUpdated 事件回调的结果。
属性
applicationList
ZIMEventOfGroupAttributesUpdatedResult
groupAttributesUpdated 事件回调的结果。
属性
groupID
groupID: string 发送群属性更新的groupID。
infoList
operatedInfo
ZIMEventOfGroupAvatarUrlUpdatedResult
groupAvatarUrlUpdated 事件回调的结果。
属性
groupID
groupID: string 发生群头像 URL 更新的groupID。
groupAvatarUrl
groupAvatarUrl: string 更新后的群头像 URL。
operatedInfo
ZIMEventOfGroupMemberInfoUpdatedResult
groupMemberInfoUpdated 事件回调的结果。
属性
operatedInfo
userList
groupID
groupID: string 发生成员信息变更的groupID。
ZIMEventOfGroupMemberStateChangedResult
groupMemberStateChanged 事件回调的结果。
属性
state
event
operatedInfo
userList
groupID
groupID: string 发生成员状态变更的groupID。
ZIMEventOfGroupMutedInfoUpdatedResult
groupMutedInfoUpdated 事件回调的结果。
属性
groupID
groupID: string groupID。
muteInfo
operatedInfo
ZIMEventOfGroupNameUpdatedResult
groupNameUpdated 事件回调的结果。
属性
groupID
groupID: string 发生群名称更新的groupID。
groupName
groupName: string 更新后的群名称。
operatedInfo
ZIMEventOfGroupNoticeUpdatedResult
groupNoticeUpdated 事件回调的结果。
属性
groupID
groupID: string 发生群公告更新的groupID。
groupNotice
groupNotice: string 更新后的群公告。
operatedInfo
ZIMEventOfGroupStateChangedResult
groupStateChanged 事件回调的结果。
属性
state
event
operatedInfo
groupInfo
ZIMEventOfGroupVerifyInfoUpdatedResult
groupVerifyInfoUpdated 事件回调的结果。
属性
groupID
groupID: string groupID。
verifyInfo
operatedInfo
ZIMEventOfMessageDeletedResult
messageDeleted 事件回调的结果。
属性
conversationID
conversationID: string 会话 ID。
conversationType
isDeleteConversationAllMessage
isDeleteConversationAllMessage: boolean 是否删除会话当前所有消息。
messageList
messageDeleteType
messageDeleteType: ZIMMessageDeleteType [messageDeleted] 被触发的原因。
ZIMEventOfMessageEditedResult
messageEdited 事件回调的结果。
属性
messageList
ZIMEventOfMessageReactionsChangedResult
messageReactionsChanged 事件回调的结果。
属性
reactions
ZIMEventOfMessageReceiptChangedResult
messageReceiptChanged 或 conversationMessageReceiptChanged 事件回调的结果。
属性
infos
ZIMEventOfMessageRepliedCountChangedResult
messageRepliedCountChanged 事件回调的结果。
属性
infos
ZIMEventOfMessageRepliedInfoChangedResult
messageRepliedInfoChanged 事件回调的结果。
属性
messageList
ZIMEventOfMessageRevokeReceivedResult
messageRevokeReceived 事件回调的结果。
属性
messageList
ZIMEventOfMessageSentStatusChangedResult
messageSentStatusChanged 事件回调的结果。
属性
infos
ZIMEventOfReceiveConversationMessageResult
receivePeerMessage、receiveRoomMessage、receiveGroupMessage 事件回调的结果。
属性
messageList
fromConversationID
fromConversationID: string 消息的会话 ID。
info
info: ZIMMessageReceivedInfo 接收消息事件相关的属性。
ZIMEventOfRoomAttributesUpdatedResult
roomAttributesUpdated、roomAttributesBatchUpdated 事件回调的结果。
属性
infos
roomID
roomID: string 房间 ID。
ZIMEventOfRoomMemberChangedResult
roomMemberJoined、roomMemberLeft 事件回调的结果。
属性
memberList
roomID
roomID: string 房间 ID。
ZIMEventOfRoomMembersAttributesUpdatedResult
roomMemberAttributesUpdated 事件回调的结果。
属性
roomID
roomID: string 房间 ID。
infos
operatedInfo
ZIMEventOfRoomStateChangedResult
roomStateChanged 事件回调的结果。
属性
state
event
extendedData
extendedData: string 事件发生时的额外信息，标准 JSON 格式字符串。
roomID
roomID: string 房间 ID。
ZIMEventOfTokenWillExpireResult
tokenWillExpire 事件回调的结果。
属性
second
second: number Token 即将过期的剩余时间，单位秒。
ZIMEventOfUserInfoUpdatedResult
userInfoUpdated 事件回调的结果。
属性
info
ZIMEventOfUserRuleUpdatedResult
userRuleUpdated 事件回调的结果。
属性
userRule
ZIMFileMessage
文件消息对象。
详情
标识一条文件消息。
- 注意事项：回调时若基类的 Type 参数为 File，可将基类消息对象强转为此类。
属性
fileLocalPath
fileLocalPath: File 媒体消息的文件对象。
- 是否必填：如果发送本地文件，则发送端必填，否则消息会发送失败。
fileDownloadUrl
fileDownloadUrl: string 媒体消息的外部下载 URL，用于开发者将媒体文件上传到自己的服务器中时，通过填入该 URL 让 SDK 透传到其他用户中。
- 是否必填：如果发送的是外部 URL，发送端必填。
fileUID
fileUID: string 媒体文件的唯一 ID。
- 是否必填：发送端不需要填，该值由 SDK 生成。
fileName
fileName: string 媒体文件的文件名。
- 是否必填：如果发送的是外部 URL，则需要填写该值，且需要包含文件扩展名。如果发送的是本地文件，该值选填。
fileSize
fileSize: number 媒体文件的大小。
- 是否必填：发送端不需要填，该值由 SDK 生成。
type
messageID
messageID: string 标识这条消息的唯一 ID。
- 业务场景：可用于索引其他消息。
- 注意事项：开发者主动创建一条消息时，不需要修改这个参数，此参数仅在回调时有值。
timestamp
timestamp: number 标识一条消息的发送时间。
- 业务场景：用于呈现一条消息的发送时间，并可用于消息排序。
- 注意事项：此为标准 UNIX 时间戳，单位为毫秒。
senderUserID
senderUserID: string 展示本条消息发送者的 userID。
conversationID
conversationID: string 会话的 ID，相同会话类型下的 ID 是唯一的。
direction
sentStatus
conversationType
conversationSeq
conversationSeq: number 表示该消息在会话中的序号。
orderKey
orderKey: number orderKey 越大消息越新，可用于消息排序。
localMessageID
localMessageID: string SDK 本地生成的 MessageID,开发者无需关注。
isUserInserted
isUserInserted: boolean 该消息是否是开发者通过 [insertMessageToLocalDB] 接口插入的消息。
- 默认值：false。
receiptStatus
extendedData
extendedData: string 消息拓展字段。
- 业务场景：可为消息附加拓展字段，然后发送给对端。
- 是否必填：否。
- 支持版本：2.6.0 及以上。
- 注意事项：长度为1k，可联系技术支持进行配置。
localExtendedData
localExtendedData: string 仅本端可见的消息拓展字段，可附带额外的信息存储到本地，可通过 [updateMessageLocalExtendedData] 修改，目前长度的限制是 128K。如有特殊需求，可联系 ZEGO 技术支持进行配置。
isBroadcastMessage
isBroadcastMessage: boolean 该消息是否是全员推送消息。
- 是否必填：SDK内部赋值。
isMentionAll
isMentionAll: boolean 是否需要提醒所有人。业务表现可为“@所有人”。
- 业务场景：例如在群或者房间可使用。
- 是否必填：否。
- 默认值：false。
- 建议值：如果需要提醒所有人，可以设置为 true。
- 注意事项：该值并不会在消息文本上增加 @所有人 的字样，需要开发者自行实现。
支持版本 : 2.14.0 及以上。
mentionedUserIDs
mentionedUserIDs: string[] 提醒一批相关的用户。业务表现可为“@某用户”。
- 业务场景：发消息时可以带上
- 是否必填：否。
- 注意事项：该值并不会在消息文本上增加 @某用户 的字样，需要开发者自行实现。
支持版本 : 2.14.0 及以上。
messageSeq
messageSeq: number 表示该消息在会话中的序号。
rootRepliedCount
rootRepliedCount: number 回复消息树对应的根消息的回复消息数量。
repliedInfo
editorUserID
editorUserID: string 本条消息最新的编辑者的 userID。
editedTime
editedTime: number 本条消息最新的编辑时间戳。
isGroupTargetedMessage
isGroupTargetedMessage: boolean 标识该消息是否为群定向消息。
pinnedUserID
pinnedUserID: string 该消息的最后一次置顶的置顶者。
- 业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。
pinnedTime
pinnedTime: number 该消息最后一次置顶的置顶时间。
- 业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。
ZIMFileMessageLiteInfo
文件消息的简要信息对象。
详情
标识一条文件消息。
属性
fileLocalPath
fileLocalPath: File 媒体消息的文件对象。
- 是否必填：如果发送本地文件，则发送端必填，否则消息会发送失败。
fileDownloadUrl
fileDownloadUrl: string 媒体消息的外部下载 URL，用于开发者将媒体文件上传到自己的服务器中时，通过填入该 URL 让 SDK 透传到其他用户中。
- 是否必填：如果发送的是外部 URL，发送端必填。
fileName
fileName: string 媒体文件的文件名。
- 是否必填：如果发送的是外部 URL，则需要填写该值，且需要包含文件扩展名。如果发送的是本地文件，该值选填。
fileSize
fileSize: number 媒体文件的大小。
- 是否必填：发送端不需要填，该值由 SDK 生成。
type
ZIMFriendAddConfig
添加好友设置的行为属性。
详情
添加好友设置的行为属性。
属性
wording
wording: string 添加好友附言。
friendAlias
friendAlias: string 好友备注。
friendAttributes
friendAttributes: Record<string, string> 好友属性。最多设置 5 个。属性的 key 仅支持从 k0 ～ k4 取值。
ZIMFriendAddedResult
添加好友的返回结果。
详情
添加好友的结果的返回。
- 业务场景：进行确添加好友操作后，成功与否可以通过该回调得知。
- 相关接口：[addFriend]，添加好友。
属性
friendInfo
ZIMFriendAliasUpdatedResult
更新好友备注的返回结果。
详情
更新好友备注的返回结果。
- 业务场景：进行更新好友备注操作后，成功与否可以通过该回调得知。
- 相关接口：[updateFriendAlias]，更新好友备注。
属性
friendInfo
ZIMFriendApplicationAcceptConfig
接受好友申请的行为属性。
详情
接受好友申请的行为属性。
属性
friendAlias
friendAlias: string 好友别名。
friendAttributes
friendAttributes: Record<string, string> 好友属信
pushConfig
ZIMFriendApplicationAcceptedResult
接受好友申请的返回结果。
详情
接受好友申请的返回结果。
- 业务场景：进行接受好友申请操作后，成功与否可以通过该回调得知。
- 相关接口：[acceptFriendApplication]，接受好友申请。
属性
friendInfo
ZIMFriendApplicationInfo
好友申请信息。
详情
好友申请信息。
属性
applyUser
wording
wording: string 好友申请附言。
createTime
createTime: number 好友添加时间。
updateTime
updateTime: number 好友申请状态更新时间。
type
state
ZIMFriendApplicationListQueriedResult
查询好友申请列表的返回结果。
详情
查询好友申请列表的返回结果。
- 业务场景：进行查询好友列表操作后，成功与否可以通过该回调得知。
- 相关接口：[queryFriendApplicationList]，查询好友申请列表。
属性
applicationList
nextFlag
nextFlag: number 当前查询锚点下标。
ZIMFriendApplicationListQueryConfig
查询好友申请列表配置。
详情
查询好友申请列表配置。
属性
count
count: number 当前查询总数。
nextFlag
nextFlag: number 当前查询锚点下标。
ZIMFriendApplicationRejectConfig
拒绝好友申请的行为属性。
详情
拒绝好友申请的行为属性。
属性
pushConfig
ZIMFriendApplicationRejectedResult
拒绝好友申请的返回结果。
详情
拒绝好友申请的返回结果。
- 业务场景：进行拒绝好友申请操作后，成功与否可以通过该回调得知。
- 相关接口：[rejectFriendApplication]，拒绝好友申请。
属性
userInfo
ZIMFriendApplicationSendConfig
发起好友申请的行为属性。
详情
发起好友申请的行为属性。
属性
wording
wording: string 添加好友附言。
friendAlias
friendAlias: string 好友备注。
friendAttributes
friendAttributes: Record<string, string> 好友属性。最多设置 5 个。属性的 key 仅支持从 k0 ～ k4 取值。
pushConfig
ZIMFriendApplicationSentResult
发起好友申请的返回结果。
详情
发起好友申请的返回结果。
- 业务场景：进行发起好友申请操作后，成功与否可以通过该回调得知。
- 相关接口：[sendFriendApplication]，发起好友申请。
属性
applicationInfo
ZIMFriendAttributesUpdatedResult
更新好友属性的返回结果。
详情
更新好友属性的返回结果。
- 业务场景：进行更新好友属性操作后，成功与否可以通过该回调得知。
- 相关接口：[updateFriendAttributes]，更新好友属性。
属性
friendInfo
ZIMFriendDeleteConfig
删除好友设置的行为属性。
详情
添加好友设置的行为属性。
属性
type
ZIMFriendInfo
好友信息。
详情
好友信息。
属性
userID
userID: string 操作者的 UserID。
friendAlias
friendAlias: string 好友备注。
friendAttributes
friendAttributes: Record<string, string> 好友属性。最多设置 5 个。属性的 key 仅支持从 k0 ～ k4 取值。
createTime
createTime: number 好友添加时间。
userName
userName: string 用户 name，由开发者自定义生成。
- 是否必填：非必填。
- 取值范围：2.0.0 及以后版本，支持最大 256 字节的字符串。
- 隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。
userAvatarUrl
userAvatarUrl: string 用户头像，由开发者自定义生成。
- 是否必填：非必填。
- 取值范围：特殊字符不受限制，最大长度为500字节。
- 隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。
- 支持版本：2.14.0 及以上。
- 注意事项：房间成员列表需要在 2.18.0 版本后才会返回该值。
userExtendedData
userExtendedData: string 用户的扩展字段信息。
- 注意事项：仅房间用户时，该属性有值。
ZIMFriendListQueriedResult
查询好友列表的返回结果。
详情
查询好友列表的返回结果。
- 业务场景：进行查询好友列表操作后，成功与否可以通过该回调得知。
- 相关接口：[queryFriendList]，查询好友列表。
属性
friendList
nextFlag
nextFlag: number 当前查询锚点下标。
ZIMFriendListQueryConfig
查询好友列表配置。
详情
查询好友列表配置。
属性
count
count: number 当前查询总数。
nextFlag
nextFlag: number 当前查询锚点下标。
ZIMFriendRelationCheckConfig
检查好友关系的行为属性。
详情
检查好友关系的行为属性。
属性
type
ZIMFriendRelationInfo
好友关系信息。
详情
好友关系信息。
属性
userID
userID: string 用户ID。
type
ZIMFriendsDeletedResult
删除好友的返回结果。
详情
删除好友的返回结果。
- 业务场景：进行删除好友操作后，成功与否可以通过该回调得知。
- 相关接口：[deleteFriends]，批量删除好友。
属性
errorUserList
ZIMFriendsInfoQueriedResult
批量查询好友信息的返回结果。
详情
批量查询好友信息的返回结果。
- 业务场景：进行批量查询好友信息操作后，成功与否可以通过该回调得知。
- 相关接口：[queryFriendsInfo]，批量查询好友信息。
属性
friendInfos
errorUserList
ZIMFriendsRelationCheckedResult
检查好友关系的返回结果。
详情
发起好友申请的返回结果。
- 业务场景：进行检查好友关系操作后，成功与否可以通过该回调得知。
- 相关接口：[checkFriendsRelation]，检查好友关系。
属性
relationInfos
errorUserList
ZIMFriendsSearchConfig
搜索本地好友配置。
详情
搜索本地好友配置。
属性
keywords
keywords: string[] 搜索关键词列表。
isAlsoMatchFriendAlias
isAlsoMatchFriendAlias: boolean 是否匹配好友别名。
count
count: number 当前搜索总数。
nextFlag
nextFlag: number 当前搜索起止下标。
ZIMFriendsSearchedResult
搜索本地好友的返回结果。
详情
搜索本地好友的返回结果。
- 业务场景：进行本地好友搜索操作后，成功与否可以通过该回调得知。
- 相关接口：[searchLocalFriends]，搜索本地好友。
属性
friendInfos
nextFlag
nextFlag: number 当前查询锚点下标。
ZIMGroup
群组列表的完整的信息。
详情
群组列表的完整的信息。
属性
baseInfo
notificationStatus
groupAlias
groupAlias: string 用户自定的仅该用户可见的群备注。
ZIMGroupAdvancedConfig
群组高级配置。
详情
群组高级配置。
- 是否必填：是。
属性
groupAttributes
groupAttributes: Record<string, string> 群组属性，最多可配置 10 个。
- 是否必填：否。
groupNotice
groupNotice: string 群公告。
- 是否必填：否。
maxMemberCount
maxMemberCount: number 群成员最大数量。
- 业务场景：当需要限制群成员数量时使用。
- 是否必填：否。
- 默认值：0。
- 取值范围：[0, 套餐默认的最大群成员数量]。
- 注意事项：支持版本 2.15 及以上。
joinMode
inviteMode
beInviteMode
ZIMGroupAliasUpdatedResult
群备注更新的结果回调。
详情
群备注更新操作结果的返回。
- 业务场景：进行群备注更新操作后，成功与否可以通过该回调得知。
- 通知时机：群备注更新操作结束后的结果返回。
- 相关接口：[updateGroupAlias]，更新群备注。
属性
groupID
groupID: string 群组 ID。
groupAlias
groupAlias: string 群备注。
ZIMGroupApplicationInfo
入群申请信息。
属性
applyUser
wording
wording: string 入群申请附言。
createTime
createTime: number 入群申请创建时间戳，单位为毫秒。
updateTime
updateTime: number 入群申请状态更新时间，单位为毫秒。
type
state
groupInfo
operatedUser
ZIMGroupApplicationListQueriedResult
查询入群申请列表的结果。
详情
入群申请列表查询结果的返回。
- 业务场景：进行入群申请列表查询后，成功与否可以通过该回调得知。
- 相关接口：[queryGroupApplicationList]，查询入群申请列表。
属性
applicationList
nextFlag
nextFlag: number 下一个标志。
ZIMGroupApplicationListQueryConfig
入群申请查询配置。
详情
通过该配置可以设置查询总条数以及分页查询
属性
count
count: number 数量，建议不超过 30。
- 是否必填：必填。
nextFlag
nextFlag: number 下一个标志。
- 是否必填：非必填，首次默认为 0，表示从头开始查询。
ZIMGroupAttributesOperatedResult
群属性操作结果的返回。
属性
groupID
groupID: string 群组 ID。
errorKeys
errorKeys: string[] 错误的键。
ZIMGroupAttributesQueriedResult
查询群属性结果的返回。
详情
群属性查询结果的返回。
- 业务场景：进行自定义属性查询后，成功与否可以通过该回调得知。
- 通知时机：群属性查询后的结果返回。
- 相关接口：[queryGroupAttributes]，查询房间属性。
属性
groupID
groupID: string 群组 ID。
groupAttributes
groupAttributes: Record<string, string> 群属性。
ZIMGroupAttributesUpdateInfo
群属性更新信息。
详情
群属性更新信息。
属性
action
groupAttributes
groupAttributes: Record<string, string> 群属性。
ZIMGroupAvatarUrlUpdatedResult
群头像 URL 更新的结果的返回。
属性
groupID
groupID: string 群组 ID。
groupAvatarUrl
groupAvatarUrl: string 群头像 URL。
ZIMGroupBeInviteModeUpdatedResult
被邀请入群验证模式更新的结果。
属性
groupID
groupID: string 群组 ID。
mode
ZIMGroupConversation
群会话对象，继承自ZIMGroupConversation。
详情
群会话对象，继承自ZIMGroupConversation。
属性
mutedExpiredTime
mutedExpiredTime: long long 群禁言的过期时间。
isDisabled
isDisabled: boolean 这个群会话是否为不可用的状态。
conversationID
conversationID: string 会话ID。
conversationName
conversationName: string conversationName,与会话对应的 groupName/userName 值相同。
type
unreadMessageCount
unreadMessageCount: number 会话未读数。
lastMessage
orderKey
orderKey: number 用于描述消息在会话中的顺序，orderKey 越大越新。
notificationStatus
conversationAvatarUrl
conversationAvatarUrl: string 会话头像 URL。单聊会话头像 URL 与用户头像 URL 相同，群聊会话头像 URL 与群头像 URL 相同。
- 使用限制： 最大 500 字节，无特殊字符限制。
isPinned
isPinned: boolean 会话是否置顶。
- 支持版本：2.8.0。
mentionedInfoList
mentionedInfoList: ZIMMessageMentionedInfo[] 当在会话的消息中被提醒到或者被提醒所有人时，该数组会有记录。
- 业务场景：比如可以在会话列表根据该数组显示当前会话有多少个提醒，还可以显示是哪个用户的提醒。
conversationAlias
conversationAlias: string 会话别名，通过 [updateFriendAlias] 设置好友备注后，对应的单聊会话该参数会同步修改。通过 [updateGroupAlias] 设置群备注后，对应的群聊会话该参数会同步修改。
- 业务场景：为好友或群组设置备注后，渲染会话页时，对应的会话优先选择展示 alias 别名，而不是 conversation name（好友的用户名或群组名）。
marks
marks: std::vector\<int> 描述了该会话现有的所有标记。
- 业务场景：业务层可以按照不同会话拥有的不同标记做分组逻辑等。
draft
draft: string 会话草稿，当设置会话草稿后，会话中会带有该字段。
ZIMGroupCreatedResult
创建群的结果的返回。
属性
groupInfo
userList
errorUserList
errorUserList: ZIMErrorUser[] 错误用户列表。
ZIMGroupDismissedResult
解散群的结果的返回。
属性
groupID
groupID: string 群组 ID。
ZIMGroupEnterInfo
群成员入群时的信息。
属性
enterType
enterTime
enterTime: number 入群时服务端的时间戳。
operatedUser
ZIMGroupFullInfo
群组完整的信息。
详情
群组完整的信息。
属性
baseInfo
groupAttributes
groupAttributes: HashMap<String, String> 群组属性。
groupNotice
groupNotice: string 群公告。
notificationStatus
mutedInfo
createTime
createTime: number 群创建时的服务端的时间戳。
- 注意事项：支持版本 2.15 及以上。
maxMemberCount
maxMemberCount: number 群成员最大数量。
- 注意事项：支持版本 2.15 及以上。
verifyInfo
groupAlias
groupAlias: string 用户自定的仅该用户可见的群备注。
ZIMGroupInfo
群组信息。
详情
群组信息。
属性
groupID
groupID: string 群组ID。
- 是否必填：非必填,若 groupID 为空后台会自动生成。
- 取值范围：最大 32 字节的字符串。仅支持数字，英文字符 和 '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'。且不能以 ’#‘ 开头
groupName
groupName: string 群名称。
- 是否必填：非必填。
- 取值范围：最大 50 字节的字符串。
groupAvatarUrl
groupAvatarUrl: string 群头像 URL。
- 是否必填：非必填。
- 使用限制： 最大 500 字节，无特殊字符限制。
ZIMGroupInfoQueriedResult
群信息查询的结果的返回。
属性
groupInfo
ZIMGroupInviteApplicationAcceptConfig
接受邀请入群申请的配置。
属性
pushConfig
ZIMGroupInviteApplicationAcceptedResult
接受邀请入群申请的结果。
属性
groupID
groupID: string 群组 ID。
inviterUserID
inviterUserID: string 邀请人ID。
ZIMGroupInviteApplicationRejectConfig
拒绝邀请入群申请的配置。
属性
pushConfig
ZIMGroupInviteApplicationRejectedResult
拒绝邀请入群申请的结果。
属性
groupID
groupID: string 群组 ID。
inviterUserID
inviterUserID: string 邀请人ID。
ZIMGroupInviteApplicationSendConfig
发送邀请入群申请的配置。
属性
wording
wording: string 申请的附言。
pushConfig
ZIMGroupInviteApplicationsSentResult
发送邀请入群申请的结果。
属性
groupID
groupID: string 群组 ID。
errorUserList
ZIMGroupInviteModeUpdatedResult
邀请入群验证模式更新的结果。
属性
groupID
groupID: string 群组 ID。
mode
ZIMGroupJoinApplicationAcceptConfig
接受加群申请的配置。
属性
pushConfig
ZIMGroupJoinApplicationAcceptedResult
接受加群申请的结果。
属性
groupID
groupID: string 群组 ID。
userID
userID: string 申请人ID。
ZIMGroupJoinApplicationRejectConfig
拒绝加群申请的配置。
属性
pushConfig
ZIMGroupJoinApplicationRejectedResult
拒绝加群申请的结果。
属性
groupID
groupID: string 群组 ID。
userID
userID: string 申请人ID。
ZIMGroupJoinApplicationSendConfig
发送加群申请的配置。
属性
wording
wording: string 申请的附言。
pushConfig
ZIMGroupJoinApplicationSentResult
发送加群申请的结果。
属性
groupID
groupID: string 群组 ID。
ZIMGroupJoinModeUpdatedResult
加群验证模式更新的结果。
属性
groupID
groupID: string 群组 ID。
mode
ZIMGroupJoinedResult
加入群的结果的返回。
属性
groupInfo
ZIMGroupLeftResult
离开群的结果的返回。
属性
groupID
groupID: string 群组 ID。
ZIMGroupListQueriedResult
查询群列表的结果的返回。
属性
groupList
ZIMGroupMemberCountQueriedResult
查询群成员数量的结果的返回。
详情
查询群成员数量操作结果的返回。
- 业务场景：进行查询群成员数量操作后，成功与否可以通过该回调得知。
- 通知时机：查询群成员数量操作结束后的结果返回。
- 相关接口：[queryGroupMemberCount]，查询群成员数量。
属性
groupID
groupID: string 群组 ID。
count
count: number 群成员数量。
ZIMGroupMemberInfo
群组成员信息。
详情
群组成员信息。
属性
memberNickname
memberNickname: string 群组成员昵称。
memberRole
memberRole: number 群角色，1：群主，2：管理员，3：群成员。
memberAvatarUrl
memberAvatarUrl: string 群成员头像 URL。
- 使用限制： 最大 500 字节，无特殊字符限制。
muteExpiredTime
muteExpiredTime: number 群成员禁言过期时间。为 0 时即不禁言，为 -1 时即永久禁言。
groupEnterInfo
userID
userID: string 用户 ID，由开发者自定义生成。
- 是否必填：必填。
- 取值范围：最大 32 字节的字符串。仅支持数字，英文字符 和 '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'。
- 隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。
- 注意事项：注意 userID 在同一个 appID 下需唯一，否则会出现互踢的情况。 强烈建议 userID 与业务 APP 的用户 ID 一一对应，即一个 userID 与一个真实用户是固定且唯一的，而不应该是以随机的 userID 的方式传给 SDK 的方式。因为唯一且固定的 userID 可以让 ZEGO 技术人员快速定位线上问题。
userName
userName: string 用户 name，由开发者自定义生成。
- 是否必填：非必填。
- 取值范围：2.0.0 及以后版本，支持最大 256 字节的字符串。
- 隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。
userAvatarUrl
userAvatarUrl: string 用户头像，由开发者自定义生成。
- 是否必填：非必填。
- 取值范围：特殊字符不受限制，最大长度为500字节。
- 隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。
- 支持版本：2.14.0 及以上。
- 注意事项：房间成员列表需要在 2.18.0 版本后才会返回该值。
userExtendedData
userExtendedData: string 用户的扩展字段信息。
- 注意事项：仅房间用户时，该属性有值。
ZIMGroupMemberInfoQueriedResult
群成员查询的结果的返回。
属性
groupID
groupID: string 群组 ID。
userInfo
ZIMGroupMemberKickedResult
踢出群成员的结果的返回。
属性
groupID
groupID: string 群组 ID。
kickedUserIDs
kickedUserIDs: string[] List of kicked members.
errorUserList
errorUserList: ZIMErrorUser[] 踢出失败的用户列表。
ZIMGroupMemberListQueriedResult
查询群成员列表的结果的返回。
详情
查询群成员列表操作结果的返回。
- 业务场景：进行查询群成员列表操作后，成功与否可以通过该回调得知。
- 通知时机：查询群成员列表操作结束后的结果返回。
- 相关接口：[queryGroupMemberList]，查询群成员列表。
属性
groupID
groupID: string 群组 ID。
userList
nextFlag
nextFlag: number 下一个标志。
ZIMGroupMemberMuteConfig
群组成员禁言配置。
详情
群组成员禁言配置。
- 是否必填：是。
属性
duration
duration: number 群组成员禁言时长，单位是 秒。取值为 -1，即永久禁言。如需实现非永久禁言，取值上限为 604800（即 7 天）。如需上调，请联系 ZEGO 技术支持。
- 是否必填：必填。
ZIMGroupMemberMutedListQueriedResult
查询群禁言成员列表的结果的返回。
详情
查询群成员禁言列表操作结果的返回。
- 业务场景：进行查询群禁言成员列表操作后，成功与否可以通过该回调得知。
- 通知时机：查询群禁言成员列表操作结束后的结果返回。
- 相关接口：[queryGroupMemberMutedList]，查询群禁言成员列表。
属性
groupID
groupID: string 群 ID
nextFlag
nextFlag: number 下一个标志。
userList
ZIMGroupMemberMutedListQueryConfig
群禁言成员列表查询配置。
详情
群禁言成员列表查询配置。
属性
count
count: number 数量。
- 是否必填：必填。
nextFlag
nextFlag: number 下一个标志。
- 是否必填：非必填，首次默认为空，表示从头开始查询。
ZIMGroupMemberNicknameUpdatedResult
成员群昵称更新的结果的返回。
属性
groupID
groupID: string 群组 ID。
forUserID
forUserID: string 用户ID。
nickname
nickname: string 昵称。
ZIMGroupMemberQueryConfig
群成员查询配置。
详情
群成员查询配置。
属性
count
count: number 数量，上限为 100，超过 100 则按照 100 处理。
- 是否必填：必填。
nextFlag
nextFlag: number 下一个标志。
- 是否必填：非必填，首次默认为空，表示从头开始查询。
ZIMGroupMemberRoleUpdatedResult
成员角色更新的结果的返回。
属性
groupID
groupID: string 群组 ID。
forUserID
forUserID: string 用户ID。
role
role: number 角色。
ZIMGroupMemberSearchConfig
群成员搜索配置。
详情
群成员搜索配置。
属性
count
count: number 结果的数量。
- 是否必填：必填。
nextFlag
nextFlag: number 查询的 flag ，第一次调用接口时填 0。后续再次调用接口时填从 callback 里返回的 nextFlag，以便获取剩余数据。
- 是否必填：非必填
keywords
keywords: string[] 搜索关键字，最多支持 5 个，否则会报错。例如：传入 "1" 和 "2"，则搜索结果只会展示名称同时包含 "1" 和 "2" 这两个关键字的群成员。
- 是否必填：否
- 注意事项：最多支持填写 5 个，否则会报错。
isAlsoMatchGroupMemberNickname
isAlsoMatchGroupMemberNickname: boolean 搜索范围是否包括群成员用户昵称，默认为 false。
- 是否必填：否。
- 默认值：false。
ZIMGroupMemberSimpleInfo
群成员简要信息。
属性
memberNickname
memberNickname: string 群组成员昵称。
memberRole
memberRole: number 群角色，1：群主，2：管理员，3：群成员。
userID
userID: string 用户 ID，由开发者自定义生成。
- 是否必填：必填。
- 取值范围：最大 32 字节的字符串。仅支持数字，英文字符 和 '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'。
- 隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。
- 注意事项：注意 userID 在同一个 appID 下需唯一，否则会出现互踢的情况。 强烈建议 userID 与业务 APP 的用户 ID 一一对应，即一个 userID 与一个真实用户是固定且唯一的，而不应该是以随机的 userID 的方式传给 SDK 的方式。因为唯一且固定的 userID 可以让 ZEGO 技术人员快速定位线上问题。
userName
userName: string 用户 name，由开发者自定义生成。
- 是否必填：非必填。
- 取值范围：2.0.0 及以后版本，支持最大 256 字节的字符串。
- 隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。
userAvatarUrl
userAvatarUrl: string 用户头像，由开发者自定义生成。
- 是否必填：非必填。
- 取值范围：特殊字符不受限制，最大长度为500字节。
- 隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。
- 支持版本：2.14.0 及以上。
- 注意事项：房间成员列表需要在 2.18.0 版本后才会返回该值。
userExtendedData
userExtendedData: string 用户的扩展字段信息。
- 注意事项：仅房间用户时，该属性有值。
ZIMGroupMembersMutedResult
群成员禁言的结果的返回。
详情
群成员禁言的结果的返回。
- 业务场景：进行群成员禁言操作后，成功与否可以通过该回调得知。
- 相关接口：[muteGroupMembers]，群成员禁言。
属性
groupID
groupID: string 群 ID
isMute
isMute: boolean 群成员禁言或解除群成员禁言。
duration
duration: number 群成员禁言时长，单位为 秒。
mutedUserIDs
mutedUserIDs: string[] 成功被修改禁言状态的群成员 ID 列表。
errorUserList
ZIMGroupMembersSearchedResult
搜索群成员的结果的返回。
详情
搜索群成员的结果的返回。
- 业务场景：进行群成员搜索操作后，成功与否可以通过该回调得知。
- 相关接口：[searchLocalGroupMembers]，搜索群成员。
属性
groupID
groupID: string 群组 ID。
userList
nextFlag
nextFlag: number 分页拉取标志，第一次调用接口时填 0。后续再次调用接口时填从 Promise 回调里返回的 nextFlag，以便获取剩余数据。
ZIMGroupMessageReceiptMemberListQueriedResult
查询群回执消息具体已读/未读成员列表的回调接口。
详情
查询群回执消息具体已读/未读成员列表的回调接口。
- 业务场景：开发者可以通过该回调中的 [errorCode] 判断是否发送成功。
- 通知时机：当开发者调用 [queryGroupMessageReceiptReadMemberList] / [queryGroupMessageReceiptUnreadMemberList] 接口时，会触发该回调。
- 支持版本：2.5.0 及以上。
属性
nextFlag
nextFlag: number 查询下一页对应的 flag，用于给 [ZIMGroupMessageReceiptMemberQueryConfig] 的 nextFlag 参数使用。
userList
groupID
groupID: string 群组 ID。
ZIMGroupMessageReceiptMemberQueryConfig
详情
群消息回执已读/未读成员查询配置。
属性
count
count: number 需要查询的群成员数量。
- 是否必填：必填。
nextFlag
nextFlag: number 下一个标志。初始填 0，后续从 [ZIMGroupMessageReceiptMemberListQueriedResult] 回调拿到下一个的 nextFlag。
ZIMGroupMuteConfig
群组禁言配置。
详情
群组禁言配置。
- 是否必填：是。
属性
mode
duration
duration: number 群组禁言时长，单位是 秒。取值为 -1，即永久禁言。如需实现非永久禁言，取值上限为 604800（即 7 天）。如需上调，请联系 ZEGO 技术支持。
- 是否必填：必填。
roles
roles: number[] 群角色列表。
- 是否必填：仅当 ZIMGroupMuteMode 为 Custom 时，此字段才有意义。
- 注意事项：当列表中有 3（普通用户）时，必须同时存在其他角色，且不能为 1、2、4。如果仅需要禁言普通用户时，ZIMGroupMuteMode 需为 Normal。
ZIMGroupMuteInfo
群组禁言信息。
详情
群组禁言信息。
属性
mode
expiredTime
expiredTime: number 群组禁言过期时间，单位为秒。为 0 时为不禁言，为 -1 时为永久禁言。
roles
roles: number[] 群被禁言角色列表。
ZIMGroupMutedResult
群禁言的结果的返回。
详情
群禁言的结果的返回。
- 业务场景：进行群禁言操作后，成功与否可以通过该回调得知。
- 相关接口：[muteGroup]，群禁言。
属性
groupID
groupID: string 群组 ID。
isMute
isMute: boolean 禁言或解除禁言。
mutedInfo
ZIMGroupNameUpdatedResult
群名称更新的结果的返回。
属性
groupID
groupID: string 群组 ID。
groupName
groupName: string 群名称。
ZIMGroupNoticeUpdatedResult
群公告更新的结果的返回。
属性
groupID
groupID: string 群组 ID。
groupNotice
groupNotice: string 群公告。
ZIMGroupOperatedInfo
群组引发事件变化操作者的信息。
详情
群组引发事件变化操作者的信息。
属性
operatedUserInfo
operatedUserInfo: ZIMGroupMemberInfo 群成员信息。
userID
userID: string 操作者的用户 ID。
userName
userName: string 操作者的用户名。
memberNickname
memberNickname: string 操作者的群成员昵称。
memberRole
memberRole: number 操作者的群成员角色。
ZIMGroupOwnerTransferredResult
群主转让的结果的返回。
属性
groupID
groupID: string 群组 ID。
toUserID
toUserID: string 用户ID。
ZIMGroupSearchConfig
群搜索配置。
详情
群搜索配置。
属性
count
count: number 搜索一次，可获取的群组数量。建议小于 20，以降低性能开销。
- 是否必填：必填。
nextFlag
nextFlag: number 查询的 flag 。
- 是否必填：首次查询时填 0。后续再次调用接口时，填从 Promise 回调里返回的 nextFlag，以便获取下一分页数据。
keywords
keywords: string[] 搜索关键字。例如：传入 "1" 和 "2"，则搜索结果只会展示群名称同时包含 "1" 和 "2" 这两个关键字的群组。
- 是否必填：否
- 注意事项：最多支持填写 5 个，否则会报错。
isAlsoMatchGroupMemberNickname
isAlsoMatchGroupMemberNickname: boolean 搜索范围是否包括群成员用户昵称，默认为 false。
- 是否必填：否。
- 默认值：false。
isAlsoMatchGroupMemberUserName
isAlsoMatchGroupMemberUserName: boolean 搜索范围是否包括群成员用户名称，默认为 false。
- 是否必填：否。
- 默认值：false。
ZIMGroupSearchInfo
群搜索信息。
详情
群组搜索信息。
属性
groupInfo
userList
ZIMGroupUsersInvitedResult
用户被邀请进群的结果的返回。
属性
groupID
groupID: string 群组 ID。
userList
errorUserList
errorUserList: ZIMErrorUser[] 邀请失败的用户列表。
ZIMGroupVerifyInfo
入群的验证模式。
属性
joinMode
inviteMode
beInviteMode
ZIMGroupsSearchedResult
搜索群的结果的返回。
详情
搜索群操作结果的返回。
- 业务场景：进行群搜索操作后，成功与否可以通过该回调得知。
- 相关接口：[searchLocalGroups]，搜索群组。
属性
groupSearchInfoList
nextFlag
nextFlag: number 分页标志。
ZIMImageMessage
图片消息对象。
详情
标识一条图片消息。
- 注意事项：回调时若基类的 Type 参数为 Image，可将基类消息对象强转为此类。
属性
thumbnailDownloadUrl
thumbnailDownloadUrl: string 图片文件的缩略图外部下载 URL。当开发者将缩略图上传到自己的服务器上时，可以通过该字段让 SDK 透传到其他用户中。
- 是否必填：发送端选填，当 fileDownloadUrl 填入后，该字段才生效。
largeImageDownloadUrl
largeImageDownloadUrl: string 图片文件的大图外部下载 URL。当开发者将大图上传到自己的服务器上时，可以通过该字段让 SDK 透传到其他用户中。
- 是否必填：发送端选填，当 fileDownloadUrl 填入后，该字段才生效。
originalImageWidth
originalImageWidth: number 原图宽。在 2.19.0 版本后对于透传图片消息（即该 URL 由客户自行传入的情况）支持传入，ZIM 会做透传处理；对于本地图片消息如果传入，ZIM 会在发送时检查是否正确，如果不正确将会自动纠正。
- 业务场景：用户需要绘出图片 UI 时，用于确定原图宽度的参数，单位为像素。
originalImageHeight
originalImageHeight: number 原图高。在 2.19.0 版本后对于透传图片消息（即该 URL 由客户自行传入的情况）支持传入，ZIM 会做透传处理；对于本地图片消息如果传入，ZIM 会在发送时检查是否正确，如果不正确将会自动纠正。
- 业务场景：用户需要绘出图片 UI 时，用于确定原图高度的参数，单位为像素。
largeImageWidth
largeImageWidth: number 大图宽。当发送本地图片时，ZIM 服务会将原图的最短边压缩至 720 像素，对另一边做等比压缩。当原图最短边小于 720 像素时，则不压缩。在 2.19.0 版本后对于透传图片消息（即该 URL 由客户自行传入的情况）支持传入，ZIM 会做透传处理；对于本地图片消息如果传入，ZIM 会在发送时检查是否正确，如果不正确将会自动纠正。
- 业务场景：用户需要绘出图片 UI 时，用于确定大图宽度的参数,单位为像素。
largeImageHeight
largeImageHeight: number 大图高。当发送本地图片时，ZIM 服务会将原图的最短边压缩至 720 像素，对另一边做等比压缩。当原图最短边小于 720 像素时，则不压缩。在 2.19.0 版本后对于透传图片消息（即该 URL 由客户自行传入的情况）支持传入，ZIM 会做透传处理；对于本地图片消息如果传入，ZIM 会在发送时检查是否正确，如果不正确将会自动纠正。
- 业务场景：用户需要绘出图片 UI 时，用于确定大图高度的参数,单位为像素。
thumbnailWidth
thumbnailWidth: number 缩略图宽。当发送本地图片时，ZIM 服务会将原图的最短边压缩至 198 像素，对另一边做等比压缩。当原图最短边小于 198 像素时，则不压缩。在 2.19.0 版本后对于透传图片消息（即该 URL 由客户自行传入的情况）支持传入，ZIM 会做透传处理；对于本地图片消息如果传入，ZIM 会在发送时检查是否正确，如果不正确将会自动纠正。
- 业务场景：用户需要绘出图片 UI 时，用于确定缩略图宽度的参数,单位为像素。
thumbnailHeight
thumbnailHeight: number 缩略图高。当发送本地图片时，ZIM 服务会将原图的最短边压缩至 198 像素，对另一边做等比压缩。当原图最短边小于 198 像素时，则不压缩。在 2.19.0 版本后对于透传图片消息（即该 URL 由客户自行传入的情况）支持传入，ZIM 会做透传处理；对于本地图片消息如果传入，ZIM 会在发送时检查是否正确，如果不正确将会自动纠正。
- 业务场景：用户需要绘出图片 UI 时，用于确定缩略图高度的参数,单位为像素。
fileLocalPath
fileLocalPath: File 媒体消息的文件对象。
- 是否必填：如果发送本地文件，则发送端必填，否则消息会发送失败。
fileDownloadUrl
fileDownloadUrl: string 媒体消息的外部下载 URL，用于开发者将媒体文件上传到自己的服务器中时，通过填入该 URL 让 SDK 透传到其他用户中。
- 是否必填：如果发送的是外部 URL，发送端必填。
fileUID
fileUID: string 媒体文件的唯一 ID。
- 是否必填：发送端不需要填，该值由 SDK 生成。
fileName
fileName: string 媒体文件的文件名。
- 是否必填：如果发送的是外部 URL，则需要填写该值，且需要包含文件扩展名。如果发送的是本地文件，该值选填。
fileSize
fileSize: number 媒体文件的大小。
- 是否必填：发送端不需要填，该值由 SDK 生成。
type
messageID
messageID: string 标识这条消息的唯一 ID。
- 业务场景：可用于索引其他消息。
- 注意事项：开发者主动创建一条消息时，不需要修改这个参数，此参数仅在回调时有值。
timestamp
timestamp: number 标识一条消息的发送时间。
- 业务场景：用于呈现一条消息的发送时间，并可用于消息排序。
- 注意事项：此为标准 UNIX 时间戳，单位为毫秒。
senderUserID
senderUserID: string 展示本条消息发送者的 userID。
conversationID
conversationID: string 会话的 ID，相同会话类型下的 ID 是唯一的。
direction
sentStatus
conversationType
conversationSeq
conversationSeq: number 表示该消息在会话中的序号。
orderKey
orderKey: number orderKey 越大消息越新，可用于消息排序。
localMessageID
localMessageID: string SDK 本地生成的 MessageID,开发者无需关注。
isUserInserted
isUserInserted: boolean 该消息是否是开发者通过 [insertMessageToLocalDB] 接口插入的消息。
- 默认值：false。
receiptStatus
extendedData
extendedData: string 消息拓展字段。
- 业务场景：可为消息附加拓展字段，然后发送给对端。
- 是否必填：否。
- 支持版本：2.6.0 及以上。
- 注意事项：长度为1k，可联系技术支持进行配置。
localExtendedData
localExtendedData: string 仅本端可见的消息拓展字段，可附带额外的信息存储到本地，可通过 [updateMessageLocalExtendedData] 修改，目前长度的限制是 128K。如有特殊需求，可联系 ZEGO 技术支持进行配置。
isBroadcastMessage
isBroadcastMessage: boolean 该消息是否是全员推送消息。
- 是否必填：SDK内部赋值。
isMentionAll
isMentionAll: boolean 是否需要提醒所有人。业务表现可为“@所有人”。
- 业务场景：例如在群或者房间可使用。
- 是否必填：否。
- 默认值：false。
- 建议值：如果需要提醒所有人，可以设置为 true。
- 注意事项：该值并不会在消息文本上增加 @所有人 的字样，需要开发者自行实现。
支持版本 : 2.14.0 及以上。
mentionedUserIDs
mentionedUserIDs: string[] 提醒一批相关的用户。业务表现可为“@某用户”。
- 业务场景：发消息时可以带上
- 是否必填：否。
- 注意事项：该值并不会在消息文本上增加 @某用户 的字样，需要开发者自行实现。
支持版本 : 2.14.0 及以上。
messageSeq
messageSeq: number 表示该消息在会话中的序号。
rootRepliedCount
rootRepliedCount: number 回复消息树对应的根消息的回复消息数量。
repliedInfo
editorUserID
editorUserID: string 本条消息最新的编辑者的 userID。
editedTime
editedTime: number 本条消息最新的编辑时间戳。
isGroupTargetedMessage
isGroupTargetedMessage: boolean 标识该消息是否为群定向消息。
pinnedUserID
pinnedUserID: string 该消息的最后一次置顶的置顶者。
- 业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。
pinnedTime
pinnedTime: number 该消息最后一次置顶的置顶时间。
- 业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。
ZIMImageMessageLiteInfo
图片消息的简要信息对象。
详情
标识一条图片消息。
属性
thumbnailDownloadUrl
thumbnailDownloadUrl: string 图片文件的缩略图外部下载 URL。当开发者将缩略图上传到自己的服务器上时，可以通过该字段让 SDK 透传到其他用户中。
- 是否必填：发送端选填，当 fileDownloadUrl 填入后，该字段才生效。
largeImageDownloadUrl
largeImageDownloadUrl: string 图片文件的大图外部下载 URL。当开发者将大图上传到自己的服务器上时，可以通过该字段让 SDK 透传到其他用户中。
- 是否必填：发送端选填，当 fileDownloadUrl 填入后，该字段才生效。
originalImageWidth
originalImageWidth: number 原图宽。
- 业务场景：用户需要绘出图片 UI 时，用于确定原图宽度的参数，单位为像素。
originalImageHeight
originalImageHeight: number 原图高。
- 业务场景：用户需要绘出图片 UI 时，用于确定原图高度的参数，单位为像素。
largeImageWidth
largeImageWidth: number 大图宽。当发送本地图片时，ZIM 服务会将原图的最短边压缩至 720 像素，对另一边做等比压缩。当原图最短边小于 720 像素时，则不压缩。
- 业务场景：用户需要绘出图片 UI 时，用于确定大图宽度的参数,单位为像素。
largeImageHeight
largeImageHeight: number 大图高。当发送本地图片时，ZIM 服务会将原图的最短边压缩至 720 像素，对另一边做等比压缩。当原图最短边小于 720 像素时，则不压缩。
- 业务场景：用户需要绘出图片 UI 时，用于确定大图高度的参数,单位为像素。
thumbnailWidth
thumbnailWidth: number 缩略图宽。当发送本地图片时，ZIM 服务会将原图的最短边压缩至 198 像素，对另一边做等比压缩。当原图最短边小于 198 像素时，则不压缩。
- 业务场景：用户需要绘出图片 UI 时，用于确定缩略图宽度的参数,单位为像素。
thumbnailHeight
thumbnailHeight: number 缩略图高。当发送本地图片时，ZIM 服务会将原图的最短边压缩至 198 像素，对另一边做等比压缩。当原图最短边小于 198 像素时，则不压缩。
- 业务场景：用户需要绘出图片 UI 时，用于确定缩略图高度的参数,单位为像素。
fileLocalPath
fileLocalPath: File 媒体消息的文件对象。
- 是否必填：如果发送本地文件，则发送端必填，否则消息会发送失败。
fileDownloadUrl
fileDownloadUrl: string 媒体消息的外部下载 URL，用于开发者将媒体文件上传到自己的服务器中时，通过填入该 URL 让 SDK 透传到其他用户中。
- 是否必填：如果发送的是外部 URL，发送端必填。
fileName
fileName: string 媒体文件的文件名。
- 是否必填：如果发送的是外部 URL，则需要填写该值，且需要包含文件扩展名。如果发送的是本地文件，该值选填。
fileSize
fileSize: number 媒体文件的大小。
- 是否必填：发送端不需要填，该值由 SDK 生成。
type
ZIMLogConfig
日志配置。
详情
配置日志文件保存路径和日志文件大小上限。
属性
logLevel
logLevel: string 本地日志级别。级别越高，打印日志越少。
value: 'debug' | 'info' | 'warn' | 'error' | 'report' | 'disable'
ZIMLoginConfig
登录相关参数配置。
详情
登录相关参数。
- 业务场景：用于登录时设置不同的参数。
- 支持版本：2.13.0 及以上。
属性
userName
userName: string 用户昵称。
- 业务场景：用于登录同时修改用户昵称的场景，无需变更时传空。
- 是否必填：否。
token
token: string 登录时携带的 token。
- 业务场景：仅在使用 token 鉴权的场景中传入。
- 是否必填：否。
isOfflineLogin
isOfflineLogin: boolean 是否是离线登录。
- 业务场景：在离线登录时需要传入 true。
- 是否必填：否。
- 默认值：false。
customStatus
customStatus: string 用户自定义状态，默认最大值为 64 字节，默认过期时间为 1 天，过期后重置为空字符串。登录时，如果该字段为空字符串（默认为空字符串），那么不会修改当前用户的自定义状态。
- 支持版本：2.20.0
ZIMMediaMessage
媒体消息对象基类。
详情
标识一条媒体消息。
- 注意事项：该基类是所有媒体消息的基础，包含媒体消息所需要的属性。
属性
fileLocalPath
fileLocalPath: File 媒体消息的文件对象。
- 是否必填：如果发送本地文件，则发送端必填，否则消息会发送失败。
fileDownloadUrl
fileDownloadUrl: string 媒体消息的外部下载 URL，用于开发者将媒体文件上传到自己的服务器中时，通过填入该 URL 让 SDK 透传到其他用户中。
- 是否必填：如果发送的是外部 URL，发送端必填。
fileUID
fileUID: string 媒体文件的唯一 ID。
- 是否必填：发送端不需要填，该值由 SDK 生成。
fileName
fileName: string 媒体文件的文件名。
- 是否必填：如果发送的是外部 URL，则需要填写该值，且需要包含文件扩展名。如果发送的是本地文件，该值选填。
fileSize
fileSize: number 媒体文件的大小。
- 是否必填：发送端不需要填，该值由 SDK 生成。
type
messageID
messageID: string 标识这条消息的唯一 ID。
- 业务场景：可用于索引其他消息。
- 注意事项：开发者主动创建一条消息时，不需要修改这个参数，此参数仅在回调时有值。
timestamp
timestamp: number 标识一条消息的发送时间。
- 业务场景：用于呈现一条消息的发送时间，并可用于消息排序。
- 注意事项：此为标准 UNIX 时间戳，单位为毫秒。
senderUserID
senderUserID: string 展示本条消息发送者的 userID。
conversationID
conversationID: string 会话的 ID，相同会话类型下的 ID 是唯一的。
direction
sentStatus
conversationType
conversationSeq
conversationSeq: number 表示该消息在会话中的序号。
orderKey
orderKey: number orderKey 越大消息越新，可用于消息排序。
localMessageID
localMessageID: string SDK 本地生成的 MessageID,开发者无需关注。
isUserInserted
isUserInserted: boolean 该消息是否是开发者通过 [insertMessageToLocalDB] 接口插入的消息。
- 默认值：false。
receiptStatus
extendedData
extendedData: string 消息拓展字段。
- 业务场景：可为消息附加拓展字段，然后发送给对端。
- 是否必填：否。
- 支持版本：2.6.0 及以上。
- 注意事项：长度为1k，可联系技术支持进行配置。
localExtendedData
localExtendedData: string 仅本端可见的消息拓展字段，可附带额外的信息存储到本地，可通过 [updateMessageLocalExtendedData] 修改，目前长度的限制是 128K。如有特殊需求，可联系 ZEGO 技术支持进行配置。
isBroadcastMessage
isBroadcastMessage: boolean 该消息是否是全员推送消息。
- 是否必填：SDK内部赋值。
isMentionAll
isMentionAll: boolean 是否需要提醒所有人。业务表现可为“@所有人”。
- 业务场景：例如在群或者房间可使用。
- 是否必填：否。
- 默认值：false。
- 建议值：如果需要提醒所有人，可以设置为 true。
- 注意事项：该值并不会在消息文本上增加 @所有人 的字样，需要开发者自行实现。
支持版本 : 2.14.0 及以上。
mentionedUserIDs
mentionedUserIDs: string[] 提醒一批相关的用户。业务表现可为“@某用户”。
- 业务场景：发消息时可以带上
- 是否必填：否。
- 注意事项：该值并不会在消息文本上增加 @某用户 的字样，需要开发者自行实现。
支持版本 : 2.14.0 及以上。
messageSeq
messageSeq: number 表示该消息在会话中的序号。
rootRepliedCount
rootRepliedCount: number 回复消息树对应的根消息的回复消息数量。
repliedInfo
editorUserID
editorUserID: string 本条消息最新的编辑者的 userID。
editedTime
editedTime: number 本条消息最新的编辑时间戳。
isGroupTargetedMessage
isGroupTargetedMessage: boolean 标识该消息是否为群定向消息。
pinnedUserID
pinnedUserID: string 该消息的最后一次置顶的置顶者。
- 业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。
pinnedTime
pinnedTime: number 该消息最后一次置顶的置顶时间。
- 业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。
ZIMMediaMessageLiteInfo
媒体消息简要信息对象基类。
详情
标识一条媒体消息。
- 注意事项：该基类是所有媒体消息简要信息的基础，包含媒体消息简要信息所需要的属性。
属性
fileLocalPath
fileLocalPath: File 媒体消息的文件对象。
- 是否必填：如果发送本地文件，则发送端必填，否则消息会发送失败。
fileDownloadUrl
fileDownloadUrl: string 媒体消息的外部下载 URL，用于开发者将媒体文件上传到自己的服务器中时，通过填入该 URL 让 SDK 透传到其他用户中。
- 是否必填：如果发送的是外部 URL，发送端必填。
fileName
fileName: string 媒体文件的文件名。
- 是否必填：如果发送的是外部 URL，则需要填写该值，且需要包含文件扩展名。如果发送的是本地文件，该值选填。
fileSize
fileSize: number 媒体文件的大小。
- 是否必填：发送端不需要填，该值由 SDK 生成。
type
ZIMMediaMessageSendNotification
媒体消息发送时的通知回调，可以通过此通知获取消息对象发送前的相关信息
详情
通过该通知，开发者可以获取到消息对象发送前的相关信息，如 localMessageID 等。
- 业务场景：当开发者需要记录和缓存消息发送前的相关信息，可以通过监听该通知获取。
- 注意事项：若无需监听，可传空。
方法
onMessageAttached
onMessageAttached(message: ZIMMediaMessage): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| message | ZIMMediaMessage | 当前发送的消息对象。 |
详情
为传入的消息对象赋予 localMessgeID 并返回。
- 业务场景：在消息发送成功前，可以对应其消息 localMessageID，实现发送前 loading 的效果。
- 通知时机：发送消息后，消息发送成功前触发。
- 支持版本：2.4.0 及以上。
ZIMMediaMessageSentResult
发送媒体消息的结果的回调。
- 相关接口：通过 [sendMediaMessage] 发送消息。
- 支持版本：2.2.0 及以上。
属性
message
ZIMMessage
消息对象的基类。
详情
标识一条消息的基本参数。
- 注意事项：其中的部分参数如 Message ID 仅在回调时有值。 开发者主动创建此对象用于发送消息时不需要给这些参数赋值。
属性
type
messageID
messageID: string 标识这条消息的唯一 ID。
- 业务场景：可用于索引其他消息。
- 注意事项：开发者主动创建一条消息时，不需要修改这个参数，此参数仅在回调时有值。
timestamp
timestamp: number 标识一条消息的发送时间。
- 业务场景：用于呈现一条消息的发送时间，并可用于消息排序。
- 注意事项：此为标准 UNIX 时间戳，单位为毫秒。
senderUserID
senderUserID: string 展示本条消息发送者的 userID。
conversationID
conversationID: string 会话的 ID，相同会话类型下的 ID 是唯一的。
direction
sentStatus
conversationType
conversationSeq
conversationSeq: number 表示该消息在会话中的序号。
orderKey
orderKey: number orderKey 越大消息越新，可用于消息排序。
localMessageID
localMessageID: string SDK 本地生成的 MessageID,开发者无需关注。
isUserInserted
isUserInserted: boolean 该消息是否是开发者通过 [insertMessageToLocalDB] 接口插入的消息。
- 默认值：false。
receiptStatus
extendedData
extendedData: string 消息拓展字段。
- 业务场景：可为消息附加拓展字段，然后发送给对端。
- 是否必填：否。
- 支持版本：2.6.0 及以上。
- 注意事项：长度为1k，可联系技术支持进行配置。
localExtendedData
localExtendedData: string 仅本端可见的消息拓展字段，可附带额外的信息存储到本地，可通过 [updateMessageLocalExtendedData] 修改，目前长度的限制是 128K。如有特殊需求，可联系 ZEGO 技术支持进行配置。
isBroadcastMessage
isBroadcastMessage: boolean 该消息是否是全员推送消息。
- 是否必填：SDK内部赋值。
isMentionAll
isMentionAll: boolean 是否需要提醒所有人。业务表现可为“@所有人”。
- 业务场景：例如在群或者房间可使用。
- 是否必填：否。
- 默认值：false。
- 建议值：如果需要提醒所有人，可以设置为 true。
- 注意事项：该值并不会在消息文本上增加 @所有人 的字样，需要开发者自行实现。
支持版本 : 2.14.0 及以上。
mentionedUserIDs
mentionedUserIDs: string[] 提醒一批相关的用户。业务表现可为“@某用户”。
- 业务场景：发消息时可以带上
- 是否必填：否。
- 注意事项：该值并不会在消息文本上增加 @某用户 的字样，需要开发者自行实现。
支持版本 : 2.14.0 及以上。
messageSeq
messageSeq: number 表示该消息在会话中的序号。
rootRepliedCount
rootRepliedCount: number 回复消息树对应的根消息的回复消息数量。
repliedInfo
editorUserID
editorUserID: string 本条消息最新的编辑者的 userID。
editedTime
editedTime: number 本条消息最新的编辑时间戳。
isGroupTargetedMessage
isGroupTargetedMessage: boolean 标识该消息是否为群定向消息。
pinnedUserID
pinnedUserID: string 该消息的最后一次置顶的置顶者。
- 业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。
pinnedTime
pinnedTime: number 该消息最后一次置顶的置顶时间。
- 业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。
ZIMMessageDeleteConfig
删除消息配置。
详情
删除消息的相关配置。
属性
isAlsoDeleteServerMessage
isAlsoDeleteServerMessage: boolean 是否删除服务器消息的标志。
- 是否必填：非必填。
- 默认值：false。
ZIMMessageDeletedResult
删除消息的回调。
详情
删除消息后通过该回调返回消息删除的结果。
- 业务场景：开发者可以通过该回调中的 [errorCode] 判断是否删除成功。
- 通知时机：调用删除消息接口 [deleteMessage] 后触发。
- 相关接口：[deleteMessage]。
- 支持版本：2.0.0 及以上。
属性
conversationID
conversationID: string 会话 ID。
conversationType
ZIMMessageEditConfig
详情
（空类）编辑消息的相关配置。
ZIMMessageEditedResult
编辑消息的结果的回调。
- 相关接口：通过 [editMessage] 编辑消息。
- 支持版本：2.20.0 及以上。
属性
message
ZIMMessageInsertedResult
插入本地消息的结果的回调。
详情
插入本地消息的结果的回调。
- 业务场景：开发者可以通过该回调中的 [errorCode] 判断是否插入成功。
- 通知时机：当开发者调用 [insertMessageToLocalDB] 接口时，会触发该回调。
- 相关接口：通过[insertMessageToLocalDB] 插入本地消息，成功与否会通过本回调通知。
- 支持版本：2.4.0 及以上。
属性
message
ZIMMessageLiteInfo
消息简要信息对象的基类。
详情
标识一条消息的基本参数。
属性
type
ZIMMessageLocalExtendedDataUpdatedResult
更新消息本地拓展字段的回调。
详情
开发者修改消息本地扩展信息后的回调。
- 业务场景：开发者可以通过该回调中的 [errorCode] 判断是否操作成功。
- 通知时机：当开发者调用 [updateMessageLocalExtendedData] 接口时，会触发该回调。
- 支持版本：2.9.0 及以上。
属性
message
ZIMMessageMentionedInfo
消息提醒信息。
详情
消息提醒信息。
属性
messageID
messageID: number 消息ID，用于匹配该提醒信息是属于哪一条消息
- 是否必填：不需要开发者填写
fromUserID
fromUserID: string 来自哪个用户。
- 是否必填：不需要开发者填写。
type
messageSeq
messageSeq: number 消息 seq。
ZIMMessagePinStatusChangeInfo
消息置顶状态变更通知。
详情
当会话内一条消息被成功置顶或取消置顶并触发通知时，可以通过该结构获取被操作的消息与当前置顶状态。
属性
pinStatus
message
ZIMMessagePinnedResult
置顶或取消置顶消息的结果的回调。
- 相关接口：通过 [pinMessage] 置顶或取消置顶消息。
- 支持版本：2.25.0 及以上。
ZIMMessageQueriedResult
开发者通过该回调获取查询到的消息列表，可以做历史消息显示。
详情
查询消息列表的结果回调。
- 业务场景：开发者通过该回调获取查询到的消息列表，可以做历史消息显示。
- 通知时机：调用查询历史消息接口 [queryHistoryMessage] 后，查询到的消息列表会通过本回调通知。
- 相关接口：通过 [queryHistoryMessage] 查询历史消息，查询到的消息列表会通过本回调通知。
- 支持版本：2.0.0 及以上。
属性
messageList
conversationID
conversationID: string 会话 ID。
conversationType
ZIMMessageQueryConfig
查询消息配置。
详情
查询消息的相关配置。
属性
nextMessage
count
count: number 查询消息的条数。
- 是否必填：必填。
reverse
reverse: boolean 是否反序查询的标志。
- 是否必填：非必填。
- 默认值：false。
ZIMMessageReaction
表态具体内容。
详情
表态具体内容。
属性
conversationID
conversationID: string 会话 ID。
conversationType
messageID
messageID: number 表态的消息 ID。
reactionType
reactionType: string 表态类型，由您定义，长度上限为 32 字节。
isSelfIncluded
isSelfIncluded: boolean 已表态用户中是否包含自己。
totalCount
totalCount: number 表态的用户总数。
userList
ZIMMessageReactionAddedResult
增加消息表态的结果的回调。
详情
开发者增加消息表态 后，执行结果的回调。
- 通知时机：当开发者调用 [addMessageReaction] 接口时，会触发该回调。
- 相关接口：通过 [addMessageReaction] ，成功与否会通过本回调通知。
- 支持版本：2.10.0 及以上。
属性
reaction
ZIMMessageReactionDeletedResult
删除消息表态的结果的回调。
详情
开发者删除消息表态 后，执行结果的回调。
- 通知时机：当开发者调用 [deleteMessageReaction] 接口时，会触发该回调。
- 相关接口：通过 [deleteMessageReaction] ，成功与否会通过本回调通知。
- 支持版本：2.10.0 及以上。
属性
reaction
ZIMMessageReactionUserInfo
表态用户信息。
详情
描述表态用户的类。
属性
userID
userID: string 用户 ID
ZIMMessageReactionUserListQueriedResult
拉取消息表态用户的结果的回调。
详情
开发者拉取消息表态用户列表后，执行结果的回调。
- 通知时机：当开发者调用 [queryMessageReactionUserList] 接口时，会触发该回调。
- 相关接口：通过 [queryMessageReactionUserList] ，拉取表态用户的成功与否会通过本回调通知。
- 支持版本：2.10.0 及以上。
属性
message
userList
reactionType
reactionType: string 表态的类型。
nextFlag
nextFlag: number 查询锚点，用于下一次分页传给 [ZIMMessageReactionUserQueryConfig] 查询使用。
totalCount
totalCount: number 表态的用户总数。
ZIMMessageReactionUserQueryConfig
用于查询表态详情成员的配置。
详情
查询表态成员时，需要配置此对象。
属性
nextFlag
nextFlag: number 分页查询的标识位，首次查询时，将此字段设为空字符串。若 [ZIMMessageReactionUserListQueriedResult] 回调的 "nextFlag" 字段不是空字符串，说明还没结束，需要将其设置到此处以继续下一页的查询。
- 业务场景：开发者可根据该字段进行分页查询成员列表，第一次查询传空。
- 是否必填：非必填。
- 默认值：空。
count
count: number 一次获取多少表态的成员。上限为 100，超出 100 会导致错误。
- 业务场景：开发者可以根据该参数来决定一次需要查询多少房间成员。
- 是否必填：必填。
- 注意事项：分页获取表态成员以降低开销，建议单次获取 20 人以内。若该处填写值为 0，SDK 会默认查询 100 人。
reactionType
reactionType: string 表态类型，由您自行定义。
ZIMMessageReceiptInfo
回执信息。
详情
回执信息。
属性
status
messageID
messageID: string 消息ID。
- 业务场景：开发者可根据这个ID 匹配已经加载过的消息列表。
- 是否必填：否，SDK填充。
conversationID
conversationID: string 会话ID。
- 业务场景：用于表示这是属于哪个会话的回执信息。
- 是否必填：否，SDK填充。
conversationType
readMemberCount
readMemberCount: number 表示该回执的已读人数。
- 业务场景：用于查询回执的信息时，可显示该消息已被多少人已读。
- 是否必填：否。
- 默认值：0。
- 注意事项：该值表示有多少人已读过该消息，仅适用于消息已读；如果是非自己发送的消息，该值为0。
unreadMemberCount
unreadMemberCount: number 表示该回执的未读人数。
- 业务场景：用于查询回执的信息时，可显示该消息已被多少人未读。
- 是否必填：否。
- 默认值：0。
- 注意事项：该值表示有多少人还没读过该消息，仅适用于消息已读；如果是非自己发送的消息，该值为0。
isSelfOperated
isSelfOperated: boolean 多端登录场景时，A 设备设置消息回执已读后，其他在线多端设备用于区分是否自己设置的消息回执已读。
readTime
readTime: number 消息回执已读时的服务端时间戳。
- 默认值：0。
- 注意事项：对应消息发送者，其值为会话成员全部已读时的时间戳，对于消息接收者，其值为设置消息回执已读时的时间戳。
ZIMMessageReceiptsInfoQueriedResult
查询回执消息信息的回调接口。
详情
查询回执消息信息的回调接口。
- 业务场景：开发者可以通过该回调中的 [errorCode] 判断是否发送成功。
- 通知时机：当开发者调用 [queryMessageReceiptsInfo] 接口时，会触发该回调。
- 相关接口：通过 [queryMessageReceiptsInfo] 查询回执的信息的结果成功与否会通过本回调通知。
- 支持版本：2.5.0 及以上。
属性
infos
errorMessageIDs
errorMessageIDs: string[] 查询消息回执信息错误的消息ID。
ZIMMessageReceiptsReadSentResult
设置回执消息已读的回调接口。
详情
设置回执消息已读的回调接口。
- 业务场景：开发者可以通过该回调中的 [errorCode] 判断是否设置成功。
- 通知时机：当开发者调用 [sendMessageReceiptsRead] 接口时，会触发该回调。
- 相关接口：通过 [sendMessageReceiptsRead] 设置回执的消息已读的结果成功与否会通过本回调通知。
- 支持版本：2.5.0 及以上。
属性
conversationID
conversationID: string 详细描述：会话 ID。
conversationType
errorMessageIDs
errorMessageIDs: string[] 设置消息回执失败对应的消息ID。
ZIMMessageRepliedInfo
回复消息引用的源消息的描述信息。
属性
state
sentTime
sentTime: number 源消息的发送服务端时间戳（UTC）。
senderUserID
senderUserID: string 源消息的发送者用户 ID。
messageSeq
messageSeq: number 源消息的seq。
messageInfo
messageID
messageID: string 源消息 ID。
ZIMMessageRepliedListQueriedResult
查询回复消息列表的结果的回调。
属性
rootRepliedInfo
messageList
nextFlag
nextFlag: number 查询锚点，用于下一次分页传给 [ZIMMessageRepliedListQueryConfig] 查询使用。
ZIMMessageRepliedListQueryConfig
用于查询回复消息列表的配置。
属性
nextFlag
nextFlag: number 分页查询的标识位，首次查询时，将此字段设为0。若 [queryMessageRepliedList] 回调的 "nextFlag" 字段不为0，说明还没结束，需要将其设置到此处以继续下一页的查询。
count
count: number 单次查询的数量。上限为 100，超出 100 会导致错误。
- 是否必填：必填。
ZIMMessageRevokeConfig
详情
撤回消息的相关配置。
属性
revokeExtendedData
revokeExtendedData: string 撤回附加消息。
- 是否必填：非必填。
pushConfig
ZIMMessageRevokedResult
撤回消息的结果的回调。
详情
开发者撤回消息 后，执行结果的回调。
- 通知时机：当开发者调用 [revokeMessage] 接口时，会触发该回调。
- 相关接口：通过 [revokeMessage] 撤回消息，撤回消息的成功与否会通过本回调通知。
- 支持版本：2.5.0 及以上。
属性
message
ZIMMessageRootRepliedCountInfo
回复消息树的回复数量的信息。
属性
conversationID
conversationID: string 会话 ID。
conversationType
messageID
messageID: string 根消息 ID。
count
count: number 回复消息树的回复数量。
ZIMMessageRootRepliedInfo
回复消息树的根消息的描述信息。
属性
state
sentTime
sentTime: number 根消息的发送时间戳。
senderUserID
senderUserID: string 根消息的发送者用户 ID。
repliedCount
repliedCount: number 回复消息树的回复数量。
message
ZIMMessageSearchConfig
消息搜索配置。
详情
消息搜索配置。
属性
nextMessage
nextMessage: ZIMMessage 分页拉取标志，即指拉取 nextMessage 之后或之前的消息，“之后”或“之前”由 order 值决定。 第一次搜索时，nextMessage 为 null。 之后搜索时，nextMessage 需传入上次查询到的消息列表的最后一条消息。
- 是否必填：否。
count
count: number 数量。建议小于 20 条，以降低性能开销。
- 是否必填：必填。
order
order: ZIMMessageOrder 搜索消息时 "order" 为 "DESCENDING" 时，表示对发送时间比 nextMessage 早的消息进行查询。若是首次查询消息时（即 nextMessage 为 null），则从本地存储的最后一条消息向前查询。"order" 为 "ASCENDING" 时，表示对发送时间比 nextMessage 晚的消息进行查询。若是首次查询消息时（即 nextMessage 为 null），则从本地存储的第一条消息向后查询。默认为 "DESCENDING"。
keywords
keywords: string[] 搜索关键字，最多支持 5 个，否则会报错。例如：传入 "1" 和 "2"，则搜索结果只会展示同时包含 "1" 和 "2" 这两个关键字的消息。
- 是否必填：否。
messageTypes
subMessageTypes
subMessageTypes: number[] 自定义消息的子类型，取值范围为 [0,200]。开发者可基于此搜索具体的自定义类型。
- 是否必填：否。
senderUserIDs
senderUserIDs: string[] 消息发送用户 ID，最多支持 5 个。例如，传入 "zego2023"，则搜索结果只会展示 "zego2023" 用户在该会话中发送的所有消息。
- 是否必填：否。
startTime
startTime: number 搜索的起始时间点，单位：毫秒，默认为 0，格式：UTC 时间戳。
- 是否必填：否。
endTime
endTime: number 搜索的结束时间点，必须大于 startTime，单位：毫秒，默认为 0，格式：UTC 时间戳。
- 是否必填：否。
ZIMMessageSendConfig
详情
发送消息的相关配置。
属性
pushConfig
priority
hasReceipt
hasReceipt: boolean 发送消息时候，该消息是否带回执。
- 业务场景：需要为一条消息带上回执时使用。
- 是否必填：非必填。
- 默认值：false。
isNotifyMentionedUsers
isNotifyMentionedUsers: boolean 发送消息时候，是否离线推送通知该消息提及到的用户。
- 是否必填：非必填。
- 默认值：true。
isRetrySend
isRetrySend: boolean 是否重发发送失败的消息。
- 是否必填：否。
disableUnreadMessageCount
disableUnreadMessageCount: boolean 标识本次发送的消息是否不计入未读消息数。
- 业务场景：需要发送一条不计入未读消息数的消息时，需要将该参数置为 true。
- 是否必填：否。
- 默认值：false。
ZIMMessageSendNotification
消息发送时的通知回调，可以通过此通知获取消息对象发送前的相关信息
详情
通过该通知，开发者可以获取到消息对象发送前的相关信息，如 localMessageID 等。
- 业务场景：当开发者需要记录和缓存消息发送前的相关信息，可以通过监听该通知获取。
- 注意事项：若无需监听，可传空。
方法
onMediaUploadingProgress
onMediaUploadingProgress(message: ZIMMediaMessage, currentFileSize: number, totalFileSize: number): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| message | ZIMMediaMessage | 当前文件上传的消息对象。 |
| currentFileSize | number | 当前进度，即当前文件上传的实时大小。 |
| totalFileSize | number | 总进度，即当前文件的总大小。 |
详情
发送媒体消息的进度回调。
- 业务场景：开发者可以通过该回调获得媒体消息的发送进度。
- 通知时机：当开发者调用 [sendMediaMessage] 接口时，会触发该回调，且在发送的过程中将会多次触发。
- 相关接口：通过 [sendMediaMessage]，发送进度情况会通过本回调通知。
- 支持版本：2.1.0 及以上。
onMessageAttached
onMessageAttached(message: ZIMMessage): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| message | ZIMMessage | 当前发送的消息对象。 |
详情
为传入的消息对象赋予 localMessgeID 并返回。
- 业务场景：在消息发送成功前，可以对应其消息 localMessageID，实现发送前 loading 的效果。
- 通知时机：发送消息后，消息发送成功前触发。
- 支持版本：2.4.0 及以上。
onMultipleMediaUploadingProgress
onMultipleMediaUploadingProgress(message: ZIMMultipleMessage, currentFileSize: number, totalFileSize: number, messageInfoIndex: number, currentIndexFileSize: number, totalIndexFileSize: number): void参数
| 名称 | 类型 | 描述 |
|---|---|---|
| message | ZIMMultipleMessage | 当前发送的消息对象。 |
| currentFileSize | number | 当前总共已上传的大小。 |
| totalFileSize | number | 待上传的总共的文件的大小。 |
| messageInfoIndex | number | 当前上传的文件所在数组的索引。 |
| currentIndexFileSize | number | 当前上传的文件的已上传的大小。 |
| totalIndexFileSize | number | 当前上传的文件的总的大小。 |
详情
发送组合消息的进度回调。
- 业务场景：开发者可以通过该回调获得组合消息里的媒体文件的上传进度。
- 通知时机：当开发者调用 [sendMessage] 接口时，会触发该回调，且在发送的过程中将会多次触发。
- 相关接口：通过 [sendMessage]，发送进度情况会通过本回调通知。
- 支持版本：2.19.0 及以上。
ZIMMessageSentResult
发送消息的结果的回调。
- 相关接口：通过 [sendPeerMessage] 、 [sendRoomMessage] 、 [sendGroupMessage] 发送消息。
- 支持版本：1.1.0 及以上。
属性
message
ZIMMessageSentStatusChangeInfo
消息状态变更通知。
详情
消息状态变更通知。
属性
message
status
reason
reason: string 此字段记录服务端发送前回调拦截消息导致 ZIM 拒绝发送的原因。若您开通了 ZIM 内容审核服务，并需在此字段中获取审核未通过导致的失败原因，请联系 ZEGO 技术支持进行配置。
ZIMMessagesGlobalSearchedResult
全局搜索本地消息结果的返回。
详情
全局搜索本地消息结果的返回。
- 业务场景：进行全局本地消息搜索操作后，成功与否可以通过该回调得知。
- 相关接口：[searchGlobalLocalMessages]，全局搜索本地消息。
属性
messageList
nextMessage
ZIMMessagesSearchedResult
搜索本地消息结果的返回。
详情
搜索本地消息结果的返回。
- 业务场景：进行本地消息搜索操作后，成功与否可以通过该回调得知。
- 相关接口：[searchLocalMessages]，搜索本地消息。
属性
messageList
conversationID
conversationID: string 会话 ID。
conversationType
nextMessage
ZIMMultipleMessage
组合消息对象。
详情
标识一条组合消息。
- 注意事项：仅支持文本、图片、文件、音频、视频、自定义消息的组合，且数量不超过 20 个。
属性
messageInfoList
messageInfoList: ZIMMessageLiteInfo[] 可包含文本、图片、文件、音频、视频、自定义消息，数组长度不超过 20。
- 业务场景：可用于发送图文组合消息。
- 注意事项：总的 item 数量不超过 20，图片最多10个，文件、音频、视频、自定义消息最多各 1 个。其中图片、文件、音频、视频的大小和格式的限制与对应的富媒体消息一致。
type
messageID
messageID: string 标识这条消息的唯一 ID。
- 业务场景：可用于索引其他消息。
- 注意事项：开发者主动创建一条消息时，不需要修改这个参数，此参数仅在回调时有值。
timestamp
timestamp: number 标识一条消息的发送时间。
- 业务场景：用于呈现一条消息的发送时间，并可用于消息排序。
- 注意事项：此为标准 UNIX 时间戳，单位为毫秒。
senderUserID
senderUserID: string 展示本条消息发送者的 userID。
conversationID
conversationID: string 会话的 ID，相同会话类型下的 ID 是唯一的。
direction
sentStatus
conversationType
conversationSeq
conversationSeq: number 表示该消息在会话中的序号。
orderKey
orderKey: number orderKey 越大消息越新，可用于消息排序。
localMessageID
localMessageID: string SDK 本地生成的 MessageID,开发者无需关注。
isUserInserted
isUserInserted: boolean 该消息是否是开发者通过 [insertMessageToLocalDB] 接口插入的消息。
- 默认值：false。
receiptStatus
extendedData
extendedData: string 消息拓展字段。
- 业务场景：可为消息附加拓展字段，然后发送给对端。
- 是否必填：否。
- 支持版本：2.6.0 及以上。
- 注意事项：长度为1k，可联系技术支持进行配置。
localExtendedData
localExtendedData: string 仅本端可见的消息拓展字段，可附带额外的信息存储到本地，可通过 [updateMessageLocalExtendedData] 修改，目前长度的限制是 128K。如有特殊需求，可联系 ZEGO 技术支持进行配置。
isBroadcastMessage
isBroadcastMessage: boolean 该消息是否是全员推送消息。
- 是否必填：SDK内部赋值。
isMentionAll
isMentionAll: boolean 是否需要提醒所有人。业务表现可为“@所有人”。
- 业务场景：例如在群或者房间可使用。
- 是否必填：否。
- 默认值：false。
- 建议值：如果需要提醒所有人，可以设置为 true。
- 注意事项：该值并不会在消息文本上增加 @所有人 的字样，需要开发者自行实现。
支持版本 : 2.14.0 及以上。
mentionedUserIDs
mentionedUserIDs: string[] 提醒一批相关的用户。业务表现可为“@某用户”。
- 业务场景：发消息时可以带上
- 是否必填：否。
- 注意事项：该值并不会在消息文本上增加 @某用户 的字样，需要开发者自行实现。
支持版本 : 2.14.0 及以上。
messageSeq
messageSeq: number 表示该消息在会话中的序号。
rootRepliedCount
rootRepliedCount: number 回复消息树对应的根消息的回复消息数量。
repliedInfo
editorUserID
editorUserID: string 本条消息最新的编辑者的 userID。
editedTime
editedTime: number 本条消息最新的编辑时间戳。
isGroupTargetedMessage
isGroupTargetedMessage: boolean 标识该消息是否为群定向消息。
pinnedUserID
pinnedUserID: string 该消息的最后一次置顶的置顶者。
- 业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。
pinnedTime
pinnedTime: number 该消息最后一次置顶的置顶时间。
- 业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。
ZIMMultipleMessageLiteInfo
组合消息的简要信息对象。
详情
标识一条组合消息。
属性
messageInfoList
type
ZIMOfflinePushPrivateMessageTemplate
离线推送私信模版。
详情
根据 OPUSH私信模版校验能力接入说明,OPPO 在新消息分类的基础上新增了推送私信模版，当您在 OPPO 控制台配置好私信模版后，如需在推送时应用对应模版，可在 ZIMPushConfig 为 privateMessageTemplate 赋值。
属性
templateID
templateID: string OPPO 推送私信模板 ID，下发对应私信模板时必须携带。如果resourceID 中 OPPO 的 category 设置分类为内容与营销，则此字段无效。详细请参见 [OPUSH私信模版校验能力接入说明](https://open.oppomobile.com/documentation/page/info?id=12391
titleParameters
titleParameters: string json 字符串， OPPO 推送标题模板填充参数。例：私信模板 ID 标题模板为：欢迎来到 ， 欢迎您。此参数内容为："{"city":"北京"}"。
contentParameters
contentParameters: string json 字符串，OPPO 推送内容模板填充参数。例：私信模板 ID 对应的内容模板为：欢迎 来到 。此参数内容为："{"userName":"汤姆"，"city":"深圳市"}"。
ZIMPinnedMessageListQueriedResult
开发者通过该回调获取查询到的置顶消息列表，可以做置顶消息显示。
详情
查询置顶消息列表的结果回调。
- 业务场景：开发者通过该回调获取查询到的置顶消息列表，可以做置顶消息显示。
- 通知时机：调用查询置顶消息接口 [queryPinnedMessageList] 后，查询到的置顶消息列表会通过本回调通知。
- 相关接口：通过 [queryPinnedMessageList] 查询历史消息，查询到的消息列表会通过本回调通知。
- 支持版本：2.25.0 及以上。
属性
messageList
ZIMPushConfig
详情描述:离线推送配置。
详情
发送离线推送前的配置。
属性
title
title: string 用于设置推送标题。
- 是否必填：非必填。
content
content: string 用于设置离线推送的内容。
- 是否必填：非必填。
payload
payload: string 用于设置离线推送的透传字段。
- 是否必填：非必填。
resourcesID
resourcesID: string 由开发者自定义，长度不超过 32 个字符的字符串，用于映射多个厂商进阶配置的离线推送字段，将多个厂商的推送配置抽象为一种您自定的推送策略。详细介绍与配置步骤请参考 resourcesID 说明。
- 默认值：在未设置 resourceID 的情况下，推送类型为普通弹窗推送（APNs 为 Alert，FCM 为 Notification Message）。
- 是否必填：非必填。
enableBadge
enableBadge: boolean 推送是否携带角标信息开关。
badgeIncrement
badgeIncrement: number 推送携带的增量角标数。
voIPConfig
voIPConfig: ZIMVoIPConfig 如果您使用 Flutter、RN ZPNs, 离线推送接收端设备有 iOS 且使用了 VoIP 推送类型，可以通过该参数来自定义一些 VoIP 的选项。
privateMessageTemplate
privateMessageTemplate: ZIMOfflinePushPrivateMessageTemplate 如果您使用 OPPO 推送，可以通过该结构来应用 OPPO 私信模版，否则可以忽略，默认为空。
ZIMRevokeMessage
撤回消息对象基类。
详情
标识一条撤回消息。
- 注意事项：该基类是所有撤回消息的基础，包含撤回消息所需要的属性。
属性
revokeType
revokeStatus
revokeTimestamp
revokeTimestamp: number 撤回时间戳。
operatedUserID
operatedUserID: string 撤回操作者的用户 ID。
revokeExtendedData
revokeExtendedData: string 撤回附带的消息。
originalMessageType
originalTextMessageContent
originalTextMessageContent: string 原始消息内容。
type
messageID
messageID: string 标识这条消息的唯一 ID。
- 业务场景：可用于索引其他消息。
- 注意事项：开发者主动创建一条消息时，不需要修改这个参数，此参数仅在回调时有值。
timestamp
timestamp: number 标识一条消息的发送时间。
- 业务场景：用于呈现一条消息的发送时间，并可用于消息排序。
- 注意事项：此为标准 UNIX 时间戳，单位为毫秒。
senderUserID
senderUserID: string 展示本条消息发送者的 userID。
conversationID
conversationID: string 会话的 ID，相同会话类型下的 ID 是唯一的。
direction
sentStatus
conversationType
conversationSeq
conversationSeq: number 表示该消息在会话中的序号。
orderKey
orderKey: number orderKey 越大消息越新，可用于消息排序。
localMessageID
localMessageID: string SDK 本地生成的 MessageID,开发者无需关注。
isUserInserted
isUserInserted: boolean 该消息是否是开发者通过 [insertMessageToLocalDB] 接口插入的消息。
- 默认值：false。
receiptStatus
extendedData
extendedData: string 消息拓展字段。
- 业务场景：可为消息附加拓展字段，然后发送给对端。
- 是否必填：否。
- 支持版本：2.6.0 及以上。
- 注意事项：长度为1k，可联系技术支持进行配置。
localExtendedData
localExtendedData: string 仅本端可见的消息拓展字段，可附带额外的信息存储到本地，可通过 [updateMessageLocalExtendedData] 修改，目前长度的限制是 128K。如有特殊需求，可联系 ZEGO 技术支持进行配置。
isBroadcastMessage
isBroadcastMessage: boolean 该消息是否是全员推送消息。
- 是否必填：SDK内部赋值。
isMentionAll
isMentionAll: boolean 是否需要提醒所有人。业务表现可为“@所有人”。
- 业务场景：例如在群或者房间可使用。
- 是否必填：否。
- 默认值：false。
- 建议值：如果需要提醒所有人，可以设置为 true。
- 注意事项：该值并不会在消息文本上增加 @所有人 的字样，需要开发者自行实现。
支持版本 : 2.14.0 及以上。
mentionedUserIDs
mentionedUserIDs: string[] 提醒一批相关的用户。业务表现可为“@某用户”。
- 业务场景：发消息时可以带上
- 是否必填：否。
- 注意事项：该值并不会在消息文本上增加 @某用户 的字样，需要开发者自行实现。
支持版本 : 2.14.0 及以上。
messageSeq
messageSeq: number 表示该消息在会话中的序号。
rootRepliedCount
rootRepliedCount: number 回复消息树对应的根消息的回复消息数量。
repliedInfo
editorUserID
editorUserID: string 本条消息最新的编辑者的 userID。
editedTime
editedTime: number 本条消息最新的编辑时间戳。
isGroupTargetedMessage
isGroupTargetedMessage: boolean 标识该消息是否为群定向消息。
pinnedUserID
pinnedUserID: string 该消息的最后一次置顶的置顶者。
- 业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。
pinnedTime
pinnedTime: number 该消息最后一次置顶的置顶时间。
- 业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。
ZIMRevokeMessageLiteInfo
撤回消息的简要信息对象。
属性
type
ZIMRoomAdvancedConfig
房间高级属性配置。
详情
房间的高级属性配置。
属性
roomAttributes
roomAttributes: Record<string, string> 房间中的房间属性，用户可以自定义
- 是否必填：是。
roomDestroyDelayTime
roomDestroyDelayTime: number 房间延迟销毁时间，单位为秒。最长房间延迟销毁时间是3小时。
- 业务场景：房间人数为0时，设置房间时间，保证这段时间内房间的存在。
- 是否必填：非必填。
ZIMRoomAttributesBatchOperatedResult
房间属性组合操作结果的返回。
属性
roomID
roomID: string 房间 ID。
ZIMRoomAttributesBatchOperationConfig
房间属性设置的行为属性。
详情
房间属性设置的行为属性。
属性
isDeleteAfterOwnerLeft
isDeleteAfterOwnerLeft: boolean - 业务场景：语聊房场景中，麦位上的人被踢出后，自动删除麦位信息。
- 是否必填：非必填。
- 默认值：false。
isForce
isForce: boolean 是否可以强制修改其他用户的房间属性。如果为true，则可以修改其他用户的房间属性，如果为false，则不允许修改其他用户的房间属性。
- 业务场景：语聊房场景中，房主强制修改麦位信息。
- 是否必填：非必填。
- 默认值：false。
isUpdateOwner
isUpdateOwner: boolean 是否更新涉及到的房间属性的拥有者。
- 业务场景：强行变更该房间属性的拥有人为操作者。
- 是否必填：非必填。
- 默认值：false。
ZIMRoomAttributesDeleteConfig
房间属性删除的行为属性。
详情
房间属性删除的行为属性。
属性
isForce
isForce: boolean 是否可以强制删除其他用户的房间属性。如果为true，则可以删除其他用户的房间属性，如果为false，则不允许删除其他用户的房间属性。
- 业务场景：语聊房场景中，房主强制删除麦位信息。
- 是否必填：非必填。
- 默认值：false。
ZIMRoomAttributesOperatedResult
房间属性操作结果的返回。
属性
errorKeys
errorKeys: string[] 操作失败的 keys。
roomID
roomID: string 房间 ID。
ZIMRoomAttributesQueriedResult
房间属性查询结果的返回。
属性
roomAttributes
roomAttributes: Record<string, string> 房间内的房间属性。
roomID
roomID: string 房间 ID。
ZIMRoomAttributesSetConfig
房间属性设置的行为属性。
详情
房间属性设置的行为属性。
属性
isDeleteAfterOwnerLeft
isDeleteAfterOwnerLeft: boolean 房间属性在拥有者离开房间后自动删除。
- 业务场景：语聊房场景中，麦位上的人被踢出后，自动删除麦位信息。
- 是否必填：非必填。
- 默认值：false。
isForce
isForce: boolean 是否可以强制修改其他用户的房间属性。如果为true，则可以修改其他用户的房间属性，如果为false，则不允许修改其他用户的房间属性。
- 业务场景：语聊房场景中，房主强制修改麦位信息。
- 是否必填：非必填。
- 默认值：false。
isUpdateOwner
isUpdateOwner: boolean 是否更新涉及到的房间属性的拥有者。
- 业务场景：强行变更该房间属性的拥有人为操作者。
- 是否必填：非必填。
- 默认值：false。
ZIMRoomAttributesUpdateInfo
房间属性变更通知。
详情
房间属性变更通知。
属性
action
roomAttributes
roomAttributes: Record<string, string> 房间属性。
- 是否必填：否。
ZIMRoomCreatedResult
创建房间的结果对象。
详情
标识创建房间的结果。
属性
roomInfo
ZIMRoomEnteredResult
进入房间的结果对象。
详情
标识进入房间的结果。
属性
roomInfo
ZIMRoomFullInfo
房间详细资料对象。
详情
标识一个房间的详细资料。
属性
baseInfo
ZIMRoomInfo
房间资料基础对象。
详情
标识一个唯一房间。
属性
roomID
roomID: string 房间 ID，最大 128 字节的字符串，由开发者自定义生成。
- 是否必填：必填。
- 取值范围：最大 128 字节的字符串。仅支持数字，英文字符 和 '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'。
roomName
roomName: string 房间名，由开发者自定义生成，最大长度不超过 64 字节的字符串。
- 是否必填：必填。
ZIMRoomJoinedResult
加入房间的结果对象。
详情
标识加入房间的结果。
属性
roomInfo
ZIMRoomLeftResult
离开房间的结果的回调。
属性
roomID
roomID: string 房间 ID。
ZIMRoomMemberAttributesInfo
房间用户属性信息。
详情
描述房间用户属性的类，包含 UserID 以及其对应的属性。
属性
userID
userID: string 用户 ID。
attributes
attributes: Record<string, string> 房间用户属性。
ZIMRoomMemberAttributesListQueriedResult
房间内用户属性列表查询结果的返回。
详情
分页查询房间内所有用户属性列表结果的返回。
- 业务场景：进行房间用户属性查询后，成功与否以及查询结果可以通过该回调得知。
- 通知时机：房间用户属性查询结束后的结果返回。
- 相关接口：[queryRoomMemberAttributesList]，查询房间用户属性。
- 支持版本：2.4.0。
属性
roomID
roomID: string 房间 ID。
infos
nextFlag
nextFlag: string 下一个分页查询的锚点，为空则代表已经查询完毕。
ZIMRoomMemberAttributesOperatedInfo
房间用户属性操作信息。
详情
房间用户属性操作信息，包含成功操作的属性与失败的 Key。
属性
attributesInfo
errorKeys
errorKeys: string[] 房间用户属性操作失败的 Key。
ZIMRoomMemberAttributesQueryConfig
房间用户属性查询配置。
详情
房间用户属性查询配置。
属性
nextFlag
nextFlag: string 房间用户属性的查询锚点。
- 是否必填：非必填，首次默认为空，表示从头开始查询。
count
count: number 分页查询的数量。
- 是否必填：必填。
ZIMRoomMemberAttributesSetConfig
房间用户属性设置配置。
详情
房间用户属性设置配置，包含可配置用户离开后是否保留用户属性等。
- 业务场景：开发者可以在设置房间用户属性时，根据自身的实际应用场景选择使用。
属性
isDeleteAfterOwnerLeft
isDeleteAfterOwnerLeft: boolean 配置房间用户属性在用户离开房间后，是否保存下来。
- 是否必填：非必填。
- 默认值：true。
ZIMRoomMemberAttributesUpdateInfo
房间用户属性更新信息。
详情
房间用户属性更新信息。
属性
attributesInfo
ZIMRoomMemberInfo
房间用户信息。
详情
描述房间用户的类。
属性
userID
userID: string 用户 ID，由开发者自定义生成。
- 是否必填：必填。
- 取值范围：最大 32 字节的字符串。仅支持数字，英文字符 和 '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'。
- 隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。
- 注意事项：注意 userID 在同一个 appID 下需唯一，否则会出现互踢的情况。 强烈建议 userID 与业务 APP 的用户 ID 一一对应，即一个 userID 与一个真实用户是固定且唯一的，而不应该是以随机的 userID 的方式传给 SDK 的方式。因为唯一且固定的 userID 可以让 ZEGO 技术人员快速定位线上问题。
userName
userName: string 用户 name，由开发者自定义生成。
- 是否必填：非必填。
- 取值范围：2.0.0 及以后版本，支持最大 256 字节的字符串。
- 隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。
userAvatarUrl
userAvatarUrl: string 用户头像，由开发者自定义生成。
- 是否必填：非必填。
- 取值范围：特殊字符不受限制，最大长度为500字节。
- 隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。
- 支持版本：2.14.0 及以上。
- 注意事项：房间成员列表需要在 2.18.0 版本后才会返回该值。
userExtendedData
userExtendedData: string 用户的扩展字段信息。
- 注意事项：仅房间用户时，该属性有值。
ZIMRoomMemberQueriedResult
查询房间成员列表的结果回调。
详情
查询房间成员列表的结果回调。
属性
memberList
nextFlag
nextFlag: string 分页查询的标识位，首次查询时，将此字段设为空字符串。若回调的 "nextFlag" 字段不是空字符串，说明还没结束，需要将其设置到此处以继续下一页的查询。
- 业务场景：开发者可根据该字段进行分页查询成员列表，第一次查询传空。
- 是否必填：非必填。
- 默认值：空。
roomID
roomID: string 房间 ID。
ZIMRoomMemberQueryConfig
用于查询房间成员的配置。
详情
查找成员时，需要配置此对象。
属性
nextFlag
nextFlag: string 分页查询的标识位，首次查询时，将此字段设为空字符串。若回调的 "nextFlag" 字段不是空字符串，说明还没结束，需要将其设置到此处以继续下一页的查询。
- 业务场景：开发者可根据该字段进行分页查询成员列表，第一次查询传空。
- 是否必填：非必填。
- 默认值：空。
count
count: number 一次获取多少房间成员。
- 业务场景：开发者可以根据该参数来决定一次需要查询多少房间成员。
- 是否必填：必填。
- 注意事项：分页获取房间成员以降低开销，建议单次获取 100 人以内。若该处填写值为 0，SDK 不会返回数据。
ZIMRoomMembersAttributesOperatedResult
房间属性操作结果的返回。
详情
房间用户属性操作结果的返回。
- 业务场景：进行自定义属性操作后，成功与否可以通过该回调得知。
- 通知时机：房间用户属性操作结束后的结果返回。
- 相关接口：[setRoomMembersAttributes]，新增或修改房间用户属性。
- 支持版本：2.4.0。
属性
roomID
roomID: string 房间 ID。
infos
errorUserList
errorUserList: string[] 出错的 UserID 列表。
ZIMRoomMembersAttributesQueriedResult
房间用户属性批量查询结果的返回。
详情
根据 UserID 列表，房间用户属性批量查询结果的返回。
- 业务场景：进行房间用户属性查询后，成功与否以及查询结果可以通过该回调得知。
- 通知时机：房间用户属性查询结束后的结果返回。
- 相关接口：[queryRoomMembersAttributes]，查询房间用户属性。
- 支持版本：2.4.0。
属性
roomID
roomID: string 房间 ID。
infos
ZIMRoomMembersQueriedResult
查询房间指定成员的结果回调。
详情
查询房间用户信息后通过该回调返回查询结果。
- 业务场景：可在该回调内做查询房间用户信息后的逻辑。
- 通知时机：查询房间用户信息后触发。
- 支持版本：2.8.0 及以上。
属性
memberList
errorUserList
roomID
roomID: string 房间 ID。
ZIMRoomOnlineMemberCountQueriedResult
查询房间在线成员数量回调。
详情
进行查询房间在线成员数量操作后，执行所获得的人数回调。
- 相关接口：可通过 [queryRoomOnlineMemberCount] 查询房间在线人数。
- 支持版本：1.1.0 及以上。
属性
count
count: number 房间的在线成员数量。
roomID
roomID: string 房间 ID。
ZIMRoomOperatedInfo
房间操作信息。
详情
房间操作信息。
属性
userID
userID: string 操作者的 UserID。
ZIMRoomSwitchedResult
切换房间的结果的回调。
详情
切换房间的结果的回调。
属性
roomInfo
ZIMSelfUserInfo
携带当前用户的用户信息、规则。
详情
携带当前用户的用户信息、规则。
属性
userRule
userRule: ZIMUserRule 当前用户的规则，设置信息。
userFullInfo
ZIMSelfUserInfoQueriedResult
查询个人用户信息、规则的结果回调。
属性
selfUserInfo
ZIMSelfUserRule
用户自身的规则类。
属性
offlinePushRule
ZIMSendingMessageCancelConfig
详情
（空类）取消发送消息的相关配置。
ZIMSubscribedUserStatusListQueriedResult
querySubscribedUserStatusList 查询当前用户订阅列表操作的结果回调。
详情
querySubscribedUserStatusList 查询当前用户订阅列表操作的结果回调。
属性
userStatusSubscriptionList
ZIMSubscribedUserStatusQueryConfig
querySubscribedUserStatusList 查询订阅列表接口的配置项。
详情
querySubscribedUserStatusList 查询订阅列表接口的配置项。
属性
userIDs
userIDs: string[] 如果您需要查询指定的用户是否在当前用户的订阅列表中，请传入该值，否则将会返回订阅表中的所有用户。
ZIMTextMessage
普通文本消息对象。
详情
标识一条普通文本消息。
- 注意事项：回调时若基类的 Type 参数为 Text，可将基类消息对象强转为此类。
属性
message
message: string 消息的内容，支持任意数据。如果此消息的类型为 Text 文本消息，则应当为标准 UTF-8 字符串。
- 是否必填：发送端必填，否则消息会发送失败。
type
messageID
messageID: string 标识这条消息的唯一 ID。
- 业务场景：可用于索引其他消息。
- 注意事项：开发者主动创建一条消息时，不需要修改这个参数，此参数仅在回调时有值。
timestamp
timestamp: number 标识一条消息的发送时间。
- 业务场景：用于呈现一条消息的发送时间，并可用于消息排序。
- 注意事项：此为标准 UNIX 时间戳，单位为毫秒。
senderUserID
senderUserID: string 展示本条消息发送者的 userID。
conversationID
conversationID: string 会话的 ID，相同会话类型下的 ID 是唯一的。
direction
sentStatus
conversationType
conversationSeq
conversationSeq: number 表示该消息在会话中的序号。
orderKey
orderKey: number orderKey 越大消息越新，可用于消息排序。
localMessageID
localMessageID: string SDK 本地生成的 MessageID,开发者无需关注。
isUserInserted
isUserInserted: boolean 该消息是否是开发者通过 [insertMessageToLocalDB] 接口插入的消息。
- 默认值：false。
receiptStatus
extendedData
extendedData: string 消息拓展字段。
- 业务场景：可为消息附加拓展字段，然后发送给对端。
- 是否必填：否。
- 支持版本：2.6.0 及以上。
- 注意事项：长度为1k，可联系技术支持进行配置。
localExtendedData
localExtendedData: string 仅本端可见的消息拓展字段，可附带额外的信息存储到本地，可通过 [updateMessageLocalExtendedData] 修改，目前长度的限制是 128K。如有特殊需求，可联系 ZEGO 技术支持进行配置。
isBroadcastMessage
isBroadcastMessage: boolean 该消息是否是全员推送消息。
- 是否必填：SDK内部赋值。
isMentionAll
isMentionAll: boolean 是否需要提醒所有人。业务表现可为“@所有人”。
- 业务场景：例如在群或者房间可使用。
- 是否必填：否。
- 默认值：false。
- 建议值：如果需要提醒所有人，可以设置为 true。
- 注意事项：该值并不会在消息文本上增加 @所有人 的字样，需要开发者自行实现。
支持版本 : 2.14.0 及以上。
mentionedUserIDs
mentionedUserIDs: string[] 提醒一批相关的用户。业务表现可为“@某用户”。
- 业务场景：发消息时可以带上
- 是否必填：否。
- 注意事项：该值并不会在消息文本上增加 @某用户 的字样，需要开发者自行实现。
支持版本 : 2.14.0 及以上。
messageSeq
messageSeq: number 表示该消息在会话中的序号。
rootRepliedCount
rootRepliedCount: number 回复消息树对应的根消息的回复消息数量。
repliedInfo
editorUserID
editorUserID: string 本条消息最新的编辑者的 userID。
editedTime
editedTime: number 本条消息最新的编辑时间戳。
isGroupTargetedMessage
isGroupTargetedMessage: boolean 标识该消息是否为群定向消息。
pinnedUserID
pinnedUserID: string 该消息的最后一次置顶的置顶者。
- 业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。
pinnedTime
pinnedTime: number 该消息最后一次置顶的置顶时间。
- 业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。
ZIMTextMessageLiteInfo
普通文本消息简要信息对象。
详情
标识一条普通文本消息的简要信息。
- 注意事项：回调时若基类的 Type 参数为 Text，可将基类消息简要信息对象强转为此类。
属性
message
message: string 消息的内容，支持任意数据。如果此消息的类型为 Text 文本消息，则应当为标准 UTF-8 字符串。
- 是否必填：发送端必填，否则消息会发送失败。
type
ZIMTipsMessage
Tips 消息对象。
详情
标识一条 Tips 消息。
- 注意事项：回调时若基类的 Type 参数为 Tips，可将基类消息对象强转为此类。
属性
event
operatedUser
targetUserList
changeInfo
type
messageID
messageID: string 标识这条消息的唯一 ID。
- 业务场景：可用于索引其他消息。
- 注意事项：开发者主动创建一条消息时，不需要修改这个参数，此参数仅在回调时有值。
timestamp
timestamp: number 标识一条消息的发送时间。
- 业务场景：用于呈现一条消息的发送时间，并可用于消息排序。
- 注意事项：此为标准 UNIX 时间戳，单位为毫秒。
senderUserID
senderUserID: string 展示本条消息发送者的 userID。
conversationID
conversationID: string 会话的 ID，相同会话类型下的 ID 是唯一的。
direction
sentStatus
conversationType
conversationSeq
conversationSeq: number 表示该消息在会话中的序号。
orderKey
orderKey: number orderKey 越大消息越新，可用于消息排序。
localMessageID
localMessageID: string SDK 本地生成的 MessageID,开发者无需关注。
isUserInserted
isUserInserted: boolean 该消息是否是开发者通过 [insertMessageToLocalDB] 接口插入的消息。
- 默认值：false。
receiptStatus
extendedData
extendedData: string 消息拓展字段。
- 业务场景：可为消息附加拓展字段，然后发送给对端。
- 是否必填：否。
- 支持版本：2.6.0 及以上。
- 注意事项：长度为1k，可联系技术支持进行配置。
localExtendedData
localExtendedData: string 仅本端可见的消息拓展字段，可附带额外的信息存储到本地，可通过 [updateMessageLocalExtendedData] 修改，目前长度的限制是 128K。如有特殊需求，可联系 ZEGO 技术支持进行配置。
isBroadcastMessage
isBroadcastMessage: boolean 该消息是否是全员推送消息。
- 是否必填：SDK内部赋值。
isMentionAll
isMentionAll: boolean 是否需要提醒所有人。业务表现可为“@所有人”。
- 业务场景：例如在群或者房间可使用。
- 是否必填：否。
- 默认值：false。
- 建议值：如果需要提醒所有人，可以设置为 true。
- 注意事项：该值并不会在消息文本上增加 @所有人 的字样，需要开发者自行实现。
支持版本 : 2.14.0 及以上。
mentionedUserIDs
mentionedUserIDs: string[] 提醒一批相关的用户。业务表现可为“@某用户”。
- 业务场景：发消息时可以带上
- 是否必填：否。
- 注意事项：该值并不会在消息文本上增加 @某用户 的字样，需要开发者自行实现。
支持版本 : 2.14.0 及以上。
messageSeq
messageSeq: number 表示该消息在会话中的序号。
rootRepliedCount
rootRepliedCount: number 回复消息树对应的根消息的回复消息数量。
repliedInfo
editorUserID
editorUserID: string 本条消息最新的编辑者的 userID。
editedTime
editedTime: number 本条消息最新的编辑时间戳。
isGroupTargetedMessage
isGroupTargetedMessage: boolean 标识该消息是否为群定向消息。
pinnedUserID
pinnedUserID: string 该消息的最后一次置顶的置顶者。
- 业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。
pinnedTime
pinnedTime: number 该消息最后一次置顶的置顶时间。
- 业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。
ZIMTipsMessageChangeInfo
Tips 消息额外信息。
详情
Tips 消息额外信息。
属性
type
ZIMTipsMessageGroupChangeInfo
Tips 消息群相关变化事件附加信息。
详情
Tips 消息群相关变化事件附加信息。
属性
groupDataFlag
groupDataFlag: number 如果群名，群头像，群公告存在复数变更，则需要由该字段的值知道哪些存在变更。其中 0b0001 是群名，0b0010 是群公告，0b0100 是群头像。
groupName
groupName: string 如果群名发生变更，则此处会展示变更后的值。
groupNotice
groupNotice: string 如果群名发生变更，则此处会展示变更后的值。
groupAvatarUrl
groupAvatarUrl: string 如果群头像发生变更，则此处会展示变更后的值。
groupMutedInfo
type
ZIMTipsMessageGroupMemberChangeInfo
Tips 消息群成员相关变化事件附加信息。
详情
Tips 消息群成员相关变化事件附加信息。
属性
memberRole
memberRole: number 如果群成员角色发生了变化，这里会展示变更后的角色。
muteExpiredTime
muteExpiredTime: number 如果群成员禁言时间发生了变化，这里会展示新的禁言时间。
groupNewOwner
groupNewOwner: ZIMGroupMemberSimpleInfo 当群主离开群，或被服务端踢出群组时，群内新群主的信息。
- 业务场景：用于当群主离开群，或被服务端踢出群组时业务层做 UI 展示时使用。
type
ZIMTipsMessagePinStatusChangeInfo
Tips 消息群消息置顶状态变化事件附加信息。
详情
Tips 消息群消息置顶状态变化事件附加信息。
属性
isPinned
isPinned: boolean 描述本次操作是置顶操作还是取消置顶操作。
type
ZIMTokenRenewedResult
更新 Token 的结果的回调。
详情
开发者更新 Token 后，执行结果的回调。
- 通知时机：当开发者调用 [renewToken] 接口时，会触发该回调。
- 相关接口：通过 [renewToken] 更新 Token，更新 Token 的成功与否会通过本回调通知。
- 支持版本：2.0.0 及以上。
属性
token
token: string 需要更新的鉴权 Token。
ZIMUserAvatarUrlUpdatedResult
更新 userAvatarUrl 的回调。
属性
userAvatarUrl
userAvatarUrl: string 修改后的 userAvatarUrl。
ZIMUserCustomStatusUpdatedResult
更新自定义状态的异步结果。
详情
更新自定义状态的异步结果。
属性
customStatus
customStatus: string 自定义状态。
ZIMUserExtendedDataUpdatedResult
更新 userExtendedData 的回调。
详情
开发者查询用户信息后的回调。
- 通知时机：当开发者调用 [queryUsersInfo] 接口时，会触发该回调。
- 相关接口：通过 [queryUsersInfo] 查询。
- 支持版本：2.2.0 及以上。
属性
extendedData
extendedData: string 修改后的 extendedData。
ZIMUserFullInfo
用户详细资料对象。
详情
标识一个唯一用户。
- 注意事项：注意 userID 在同一个 appID 下需唯一，否则会出现互踢的情况。强烈建议 userID 与业务 APP 的用户 ID 一一对应，即一个 userID 与一个真实用户是固定且唯一的，而不应该是以随机的 userID 的方式传给 SDK 的方式。因为唯一且固定的 userID 可以让 ZEGO 技术人员快速定位线上问题。
属性
baseInfo
userAvatarUrl
userAvatarUrl: string 用户头像 URL。
- 是否必填：非必填。
- 使用限制：最大 500 字节，无特殊字符限制。
extendedData
extendedData: string 用户扩展信息。
- 是否必填：非必填。
- 隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。
ZIMUserInfo
用户资料对象。
详情
标识一个唯一用户。
- 注意事项：注意 userID 在同一个 appID 下需唯一，否则会出现互踢的情况。强烈建议 userID 与业务 APP 的用户 ID 一一对应，即一个 userID 与一个真实用户是固定且唯一的，而不应该是以随机的 userID 的方式传给 SDK 的方式。因为唯一且固定的 userID 可以让 ZEGO 技术人员快速定位线上问题。
属性
userID
userID: string 用户 ID，由开发者自定义生成。
- 是否必填：必填。
- 取值范围：最大 32 字节的字符串。仅支持数字，英文字符 和 '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'。
- 隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。
- 注意事项：注意 userID 在同一个 appID 下需唯一，否则会出现互踢的情况。 强烈建议 userID 与业务 APP 的用户 ID 一一对应，即一个 userID 与一个真实用户是固定且唯一的，而不应该是以随机的 userID 的方式传给 SDK 的方式。因为唯一且固定的 userID 可以让 ZEGO 技术人员快速定位线上问题。
userName
userName: string 用户 name，由开发者自定义生成。
- 是否必填：非必填。
- 取值范围：2.0.0 及以后版本，支持最大 256 字节的字符串。
- 隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。
userAvatarUrl
userAvatarUrl: string 用户头像，由开发者自定义生成。
- 是否必填：非必填。
- 取值范围：特殊字符不受限制，最大长度为500字节。
- 隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。
- 支持版本：2.14.0 及以上。
- 注意事项：房间成员列表需要在 2.18.0 版本后才会返回该值。
userExtendedData
userExtendedData: string 用户的扩展字段信息。
- 注意事项：仅房间用户时，该属性有值。
ZIMUserNameUpdatedResult
更新 userName 的回调。
详情
开发者查询用户信息后的回调。
- 通知时机：当开发者调用 [queryUsersInfo] 接口时，会触发该回调。
- 相关接口：通过 [queryUsersInfo] 查询。
- 支持版本：2.2.0 及以上。
属性
userName
userName: string 修改后的 userName。
ZIMUserOfflinePushRule
用户离线推送规则的数据类。
详情
用户离线推送规则的数据类。
属性
onlinePlatforms
onlinePlatforms: number[] 与该数据类中的 notToReceiveOfflinePushPlatforms 成员变量搭配使用。onlinePlatforms 指定的平台在线时，notToReceiveOfflinePushPlatforms 指定的平台将不会收到离线推送。
- 取值范围：请填入 ZIMPlatformType 枚举中平台对应的枚举值。
notToReceiveOfflinePushPlatforms
notToReceiveOfflinePushPlatforms: number[] 与该数据类中的 onlinePlatforms 成员变量搭配使用。onlinePlatforms 指定的平台在线时，notToReceiveOfflinePushPlatforms 指定的平台将不会收到离线推送。
- 取值范围：请填入 ZIMPlatformType 枚举中平台对应的枚举值。
ZIMUserOfflinePushRuleUpdatedResult
更新用户离线推送规则的结果回调。
属性
offlinePushRule
ZIMUserStatus
用户状态相关数据。
详情
包含用户在线状态的相关数据。
属性
userID
userID: string 单个用户的唯一标识符。
onlineStatus
onlinePlatforms
onlinePlatforms: List\<Number> 当前用户的在线平台列表，可以用于展示这名用户在哪些平台在线，如 iPhone 在线、电脑端在线。平台取值含义请参考 ZIMPlatform。
lastUpdateTime
lastUpdateTime: number 用户 onlineStatus 或 customStatus 最后一次变更时的时间戳,取两者较大值。
lastOnlineStatusUpdateTime
lastOnlineStatusUpdateTime: number 用户 onlineStatus 最后一次变更时的时间戳，可以用于展示 xxx 分钟前离线/登录。
lastCustomStatusUpdateTime
lastCustomStatusUpdateTime: number 用户 customStatus 最后一次变更时的时间戳，可以用于展示自定义状态的最后变更时间。
customStatus
customStatus: string 用户自定义状态，默认最大值为 64 字节，默认过期时间为 1 天，过期后重置为空字符串。登录时，如果该字段为空字符串（默认为空字符串），那么不会修改当前用户的自定义状态。
ZIMUserStatusSubscribeConfig
subscribeUsersStatus 批量订阅用户在线状态接口的配置项。
详情
批量订阅用户在线状态接口的配置项。
属性
subscriptionDuration
subscriptionDuration: number 用于设置这次订阅的有效时长。
- 是否必填：必填。
- 取值范围：1 ～ 43200（30 天），单位为分钟。
- 注意事项：超过订阅时长后，这名被订阅用户将会从订阅列表中删除，之后这名用户的状态变更，将不会再同步给订阅者。
ZIMUserStatusSubscription
用户态订阅信息。包含用户的在线状态、在线平台列表、订阅过期时间戳等。
详情
用户状态订阅信息。包含用户的在线状态、在线平台列表、订阅过期时间戳等。
- 支持版本：2.18.0
属性
userStatus
subscribeExpiredTime
subscribeExpiredTime: number 这名用户订阅过期的时间戳。
ZIMUsersInfoQueriedResult
查询 userInfo 的回调。
详情
开发者查询用户信息后的回调。
- 通知时机：当开发者调用 [queryUsersInfo] 接口时，会触发该回调。
- 相关接口：通过 [queryUsersInfo] 查询。
- 支持版本：2.0.0 及以上。
属性
userList
errorUserList
ZIMUsersInfoQueryConfig
用户信息查询配置。
详情
详细描述：用户信息查询配置，可以选择从本地查询或者从服务端查询。从本地查询无限频约束，从服务端查询有限频约束，10 s 内最多只能查询 10 个用户详细配置。
属性
isQueryFromServer
isQueryFromServer: boolean 是否从服务端查询用户详细信息。从本地查询无限频约束，从服务端查询有限频约束，10 s 内最多只能查询 10 个用户详细配置。
- 是否必填：非必填。
- 默认值：false。
ZIMUsersStatusQueriedResult
批量查询用户状态接口 queryUsersStatus 的结果回调。
详情
批量查询用户状态接口 queryUsersStatus 的结果回调。
属性
userStatusList
errorUserList
ZIMUsersStatusSubscribedResult
批量订阅其他用户的用户状态的结果回调。
详情
批量订阅其他用户在线状态的结果回调。
属性
errorUserList
ZIMUsersStatusUnsubscribedResult
批量取消订阅已订阅用户的结果回调。
详情
unsubscribeUsersStatus 批量取消订阅接口的操作回调。
属性
errorUserList
ZIMVideoMessage
视频消息对象。
详情
标识一条视频消息。
- 使用限制：仅支持视频编码格式为 H264 和 H265 的视频文件在消息发送成功后获取该视频首帧的宽、高信息。
- 注意事项：回调时若基类的 Type 参数为 Video，可将基类消息对象强转为此类。
属性
videoDuration
videoDuration: number 视频文件的时长。
- 是否必填：发送本地视频时，发送端必填，不填会导致视频消息发送失败。
videoFirstFrameDownloadUrl
videoFirstFrameDownloadUrl: string 视频文件的缩略图外部下载 URL。当开发者将首帧图上传到自己的服务器上时，可以通过该字段让 SDK 透传到其他用户中。
- 是否必填：发送端选填，当 fileDownloadUrl 填入后，该字段才生效。
videoFirstFrameWidth
videoFirstFrameWidth: number 视频首帧宽度。在 2.19.0 版本后对于透传图片消息（即该 URL 由客户自行传入的情况）支持传入，ZIM 会做透传处理；对于本地图片消息如果传入，ZIM 会在发送时检查是否正确，如果不正确将会自动纠正。
- 业务场景：用户需要绘出图片 UI 时，用于确定视频首帧宽度的参数,单位为像素。
videoFirstFrameHeight
videoFirstFrameHeight: number 视频首帧高度。在 2.19.0 版本后对于透传图片消息（即该 URL 由客户自行传入的情况）支持传入，ZIM 会做透传处理；对于本地图片消息如果传入，ZIM 会在发送时检查是否正确，如果不正确将会自动纠正。
- 业务场景：用户需要绘出图片 UI 时，用于确定视频首帧高度的参数,单位为像素。
fileLocalPath
fileLocalPath: File 媒体消息的文件对象。
- 是否必填：如果发送本地文件，则发送端必填，否则消息会发送失败。
fileDownloadUrl
fileDownloadUrl: string 媒体消息的外部下载 URL，用于开发者将媒体文件上传到自己的服务器中时，通过填入该 URL 让 SDK 透传到其他用户中。
- 是否必填：如果发送的是外部 URL，发送端必填。
fileUID
fileUID: string 媒体文件的唯一 ID。
- 是否必填：发送端不需要填，该值由 SDK 生成。
fileName
fileName: string 媒体文件的文件名。
- 是否必填：如果发送的是外部 URL，则需要填写该值，且需要包含文件扩展名。如果发送的是本地文件，该值选填。
fileSize
fileSize: number 媒体文件的大小。
- 是否必填：发送端不需要填，该值由 SDK 生成。
type
messageID
messageID: string 标识这条消息的唯一 ID。
- 业务场景：可用于索引其他消息。
- 注意事项：开发者主动创建一条消息时，不需要修改这个参数，此参数仅在回调时有值。
timestamp
timestamp: number 标识一条消息的发送时间。
- 业务场景：用于呈现一条消息的发送时间，并可用于消息排序。
- 注意事项：此为标准 UNIX 时间戳，单位为毫秒。
senderUserID
senderUserID: string 展示本条消息发送者的 userID。
conversationID
conversationID: string 会话的 ID，相同会话类型下的 ID 是唯一的。
direction
sentStatus
conversationType
conversationSeq
conversationSeq: number 表示该消息在会话中的序号。
orderKey
orderKey: number orderKey 越大消息越新，可用于消息排序。
localMessageID
localMessageID: string SDK 本地生成的 MessageID,开发者无需关注。
isUserInserted
isUserInserted: boolean 该消息是否是开发者通过 [insertMessageToLocalDB] 接口插入的消息。
- 默认值：false。
receiptStatus
extendedData
extendedData: string 消息拓展字段。
- 业务场景：可为消息附加拓展字段，然后发送给对端。
- 是否必填：否。
- 支持版本：2.6.0 及以上。
- 注意事项：长度为1k，可联系技术支持进行配置。
localExtendedData
localExtendedData: string 仅本端可见的消息拓展字段，可附带额外的信息存储到本地，可通过 [updateMessageLocalExtendedData] 修改，目前长度的限制是 128K。如有特殊需求，可联系 ZEGO 技术支持进行配置。
isBroadcastMessage
isBroadcastMessage: boolean 该消息是否是全员推送消息。
- 是否必填：SDK内部赋值。
isMentionAll
isMentionAll: boolean 是否需要提醒所有人。业务表现可为“@所有人”。
- 业务场景：例如在群或者房间可使用。
- 是否必填：否。
- 默认值：false。
- 建议值：如果需要提醒所有人，可以设置为 true。
- 注意事项：该值并不会在消息文本上增加 @所有人 的字样，需要开发者自行实现。
支持版本 : 2.14.0 及以上。
mentionedUserIDs
mentionedUserIDs: string[] 提醒一批相关的用户。业务表现可为“@某用户”。
- 业务场景：发消息时可以带上
- 是否必填：否。
- 注意事项：该值并不会在消息文本上增加 @某用户 的字样，需要开发者自行实现。
支持版本 : 2.14.0 及以上。
messageSeq
messageSeq: number 表示该消息在会话中的序号。
rootRepliedCount
rootRepliedCount: number 回复消息树对应的根消息的回复消息数量。
repliedInfo
editorUserID
editorUserID: string 本条消息最新的编辑者的 userID。
editedTime
editedTime: number 本条消息最新的编辑时间戳。
isGroupTargetedMessage
isGroupTargetedMessage: boolean 标识该消息是否为群定向消息。
pinnedUserID
pinnedUserID: string 该消息的最后一次置顶的置顶者。
- 业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。
pinnedTime
pinnedTime: number 该消息最后一次置顶的置顶时间。
- 业务场景：该参数仅在 [queryPinnedMessageList] 或 [onMessagePinStatusChanged] 中会被赋值。
ZIMVideoMessageLiteInfo
视频消息的简要信息对象。
详情
标识一条视频消息。
- 使用限制：仅支持视频编码格式为 H264 和 H265 的视频文件在消息发送成功后获取该视频首帧的宽、高信息。
属性
videoDuration
videoDuration: number 视频文件的时长。
- 是否必填：发送本地视频时，发送端必填，不填会导致视频消息发送失败。
videoFirstFrameDownloadUrl
videoFirstFrameDownloadUrl: string 视频文件的缩略图外部下载 URL。当开发者将首帧图上传到自己的服务器上时，可以通过该字段让 SDK 透传到其他用户中。
- 是否必填：发送端选填，当 fileDownloadUrl 填入后，该字段才生效。
videoFirstFrameWidth
videoFirstFrameWidth: number 视频首帧宽度。
- 业务场景：用户需要绘出图片 UI 时，用于确定视频首帧宽度的参数,单位为像素。
videoFirstFrameHeight
videoFirstFrameHeight: number 视频首帧高度。
- 业务场景：用户需要绘出图片 UI 时，用于确定视频首帧高度的参数,单位为像素。
fileLocalPath
fileLocalPath: File 媒体消息的文件对象。
- 是否必填：如果发送本地文件，则发送端必填，否则消息会发送失败。
fileDownloadUrl
fileDownloadUrl: string 媒体消息的外部下载 URL，用于开发者将媒体文件上传到自己的服务器中时，通过填入该 URL 让 SDK 透传到其他用户中。
- 是否必填：如果发送的是外部 URL，发送端必填。
fileName
fileName: string 媒体文件的文件名。
- 是否必填：如果发送的是外部 URL，则需要填写该值，且需要包含文件扩展名。如果发送的是本地文件，该值选填。
fileSize
fileSize: number 媒体文件的大小。
- 是否必填：发送端不需要填，该值由 SDK 生成。
type
ZIMVoIPConfig
提供发起 iOS VoIP 离线推送类型的信息。
详情
提供发起 iOS VoIP 离线推送类型的信息。
属性
iOSVoIPHandleType
iOSVoIPHandleValue
iOSVoIPHandleValue: string VoIP 发起方联系信息内容，与 iOSVoIPHandleType 相关。当 iOSVoIPHandleType 为 PhoneNumber 时，Value 为一串数字；当 iOSVoIPHandleType 为 EmailAddress 时，Value 为电子邮箱地址；当联系信息为其他类型时，Value 通常遵循某种特定格式，如用户名、数字 ID 或 URL。
iOSVoIPHasVideo
iOSVoIPHasVideo: boolean 是否为视频通话，默认为音频。
ZPNsConfig
ZPNs 推送配置接口。
属性
apiKey
apiKey: string firebase配置的api 密钥。
authDomain
authDomain: string firebase配置的身份验证域。
projectId
projectId: string firebase配置的项目ID。
storageBucket
storageBucket: string firebase配置的存储。
messagingSenderId
messagingSenderId: string firebase 配置的消息发送程序 ID。
appId
appId: string firebase 配置的 app ID。
measurementId
measurementId: string firebase配置的测量Id。
vapidKey
vapidKey: string Web推送证书。
ZPNsMessage
ZPNs 消息类。
详情
ZPNs 消息类。
- 业务场景：使用此数据类的对象获取推送信息的详细内容。
属性
title
title: string 消息通知栏标题。
content
content: string 消息通知栏内容。
extras
extras: Record<string, string> 消息通知栏附加信息。