Struct

2026-01-21


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

ZIMAppConfig

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

Declared in entity/ZIMAppConfig.java

属性

appID

public long appID

是否必填：必填。

appSign

public String appSign

是否必填：必填。

ZIMAudioANSParam

噪声抑制参数

详情

包括噪声抑制模式。

Declared in ZIMAudioANSParam.java

属性

mode

public ZIMAudioANSMode mode

噪声抑制模式（ANS）。

ZIMAudioError

详情

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

Declared in ZIMAudioError.java

属性

code

public ZIMAudioErrorCode code

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

message

public String message

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

ZIMAudioFrameParam

详情

音频帧属性参数。

Declared in ZIMAudioFrameParam.java

属性

sampleRate

public Number sampleRate

音频采样率。

channels

public Number channels

音频通道数。

ZIMAudioMessage

音频消息对象。

详情

标识一条音频消息。

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

Declared in entity/ZIMAudioMessage.java

属性

audioDuration

public long audioDuration

音频文件的时长。

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

fileLocalPath

public String fileLocalPath

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

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

fileDownloadUrl

public String fileDownloadUrl

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

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

fileUID

public String fileUID

媒体文件的唯一 ID。

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

fileName

public String fileName

媒体文件的文件名。

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

fileSize

public long fileSize

媒体文件的大小。

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

type

public ZIMMessageType type

消息类型。

messageID

public long messageID

标识这条消息的唯一 ID。

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

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

timestamp

public long timestamp

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

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

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

senderUserID

public String senderUserID

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

conversationID

public String conversationID

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

direction

public ZIMMessageDirection direction

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

sentStatus

public ZIMMessageSentStatus sentStatus

描述消息的发送状态。

conversationType

public ZIMConversationType conversationType

该消息所属会话的类型。

conversationSeq

public long conversationSeq

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

orderKey

public long orderKey

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

localMessageID

public long localMessageID

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

isUserInserted

public boolean isUserInserted

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

默认值：false。

receiptStatus

public ZIMMessageReceiptStatus receiptStatus

描述该消息的回执状态。

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

extendedData

public String extendedData

消息拓展字段。

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

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

localExtendedData

public String localExtendedData

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

isBroadcastMessage

public boolean isBroadcastMessage

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

是否必填：SDK内部赋值。

isMentionAll

private boolean isMentionAll

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

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

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

支持版本 : 2.14.0 及以上。

mentionedUserIDs

private ArrayList\<String> mentionedUserIDs

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

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

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

支持版本 : 2.14.0 及以上。

messageSeq

public long messageSeq

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

rootRepliedCount

public int rootRepliedCount

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

repliedInfo

public ZIMMessageRepliedInfo repliedInfo

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

editorUserID

public String editorUserID

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

editedTime

public long editedTime

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

isGroupTargetedMessage

public boolean isGroupTargetedMessage

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

pinnedUserID

public String pinnedUserID

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

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

pinnedTime

public long pinnedTime

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

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

ZIMAudioMessageLiteInfo

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

详情

标识一条音频消息。

Declared in entity/ZIMAudioMessageLiteInfo.java

属性

audioDuration

public long audioDuration

音频文件的时长。

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

fileLocalPath

public String fileLocalPath

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

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

fileDownloadUrl

public String fileDownloadUrl

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

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

fileName

public String fileName

媒体文件的文件名。

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

fileSize

public long fileSize

媒体文件的大小。

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

type

public ZIMMessageType type

消息类型。

ZIMAudioPlayConfig

音频播放配置

详情

播放配置。配置指定当前需要播放的音频文件路径和路由类型。

Declared in ZIMAudioPlayConfig.java

属性

filePath

public String filePath

需要播放的文件的绝对路径。目前仅支持带有后缀 .mp3 或 .m4a 的完整绝对路径。当传入其他格式的文件路径时，SDK 将抛出非法文件路径错误。

routeType

public ZIMAudioRouteType routeType

播放时的起始音频路由类型。

ZIMAudioRecordConfig

音频录制参数

详情

配置录音文件输出路径和录制期间的最大录制时间。

Declared in ZIMAudioRecordConfig.java

属性

filePath

public String filePath

录音文件的输出路径。目前仅支持带有后缀 .mp3 或 .m4a 的完整绝对路径。当传入其他格式的文件路径时，SDK 将抛出非法文件路径错误。

maxDuration

public number maxDuration

最大录制时间，默认为 60000 毫秒，即 60 秒。此参数的单位为毫秒，最大值不超过 300000。

ZIMBarrageMessage

弹幕消息类。

详情

弹幕消息类，不会出现在会话中，也不会存入历史消息。

Declared in entity/ZIMBarrageMessage.java

属性

message

public String message

弹幕消息内容。

type

public ZIMMessageType type

消息类型。

messageID

public long messageID

标识这条消息的唯一 ID。

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

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

timestamp

public long timestamp

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

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

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

senderUserID

public String senderUserID

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

conversationID

public String conversationID

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

direction

public ZIMMessageDirection direction

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

sentStatus

public ZIMMessageSentStatus sentStatus

描述消息的发送状态。

conversationType

public ZIMConversationType conversationType

该消息所属会话的类型。

conversationSeq

public long conversationSeq

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

orderKey

public long orderKey

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

localMessageID

public long localMessageID

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

isUserInserted

public boolean isUserInserted

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

默认值：false。

receiptStatus

public ZIMMessageReceiptStatus receiptStatus

描述该消息的回执状态。

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

extendedData

public String extendedData

消息拓展字段。

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

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

localExtendedData

public String localExtendedData

isBroadcastMessage

public boolean isBroadcastMessage

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

是否必填：SDK内部赋值。

isMentionAll

private boolean isMentionAll

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

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

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

支持版本 : 2.14.0 及以上。

mentionedUserIDs

private ArrayList\<String> mentionedUserIDs

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

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

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

支持版本 : 2.14.0 及以上。

messageSeq

public long messageSeq

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

rootRepliedCount

public int rootRepliedCount

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

repliedInfo

public ZIMMessageRepliedInfo repliedInfo

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

editorUserID

public String editorUserID

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

editedTime

public long editedTime

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

isGroupTargetedMessage

public boolean isGroupTargetedMessage

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

pinnedUserID

public String pinnedUserID

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

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

pinnedTime

public long pinnedTime

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

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

ZIMBlacklistQueryConfig

黑名单查询配置。

详情

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

Declared in entity/ZIMBlacklistQueryConfig.java

属性

count

public int count

数量。

是否必填：必填。

nextFlag

public int nextFlag

下一个标志。

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

ZIMCacheConfig

缓存配置。

详情

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

Declared in entity/ZIMCacheConfig.java

属性

cachePath

public String cachePath

缓存文件的存储路径。

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

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

ZIMCallAcceptConfig

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

详情

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

Declared in entity/ZIMCallAcceptConfig.java

属性

extendedData

public String extendedData

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

是否必填：必填。

ZIMCallCancelConfig

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

详情

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

Declared in entity/ZIMCallCancelConfig.java

属性

extendedData

public String extendedData

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

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

pushConfig

public ZIMPushConfig pushConfig

离线推送配置。

是否必填：非必填。

ZIMCallEndConfig

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

详情

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

Declared in entity/ZIMCallAcceptConfig.java

属性

extendedData

public String extendedData

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

是否必填：非必填。

pushConfig

public ZIMPushConfig pushConfig

离线推送配置。

是否必填：非必填。

ZIMCallInfo

呼叫邀请信息。

详情

呼叫邀请信息。

Declared in entity/ZIMCallUserInfo.java

属性

callID

public String callID

呼叫邀请 ID。

caller

public String caller

呼叫邀请发起者 ID。

mode

public ZIMCallInvitationMode mode

呼叫邀请模式。

state

public ZIMCallState state

呼叫邀请状态。

extendedData

public String extendedData

创建呼叫邀请附加信息。

createTime

public number createTime

呼叫邀请创建时间戳。

endTime

public number endTime

呼叫邀请结束时间。

callUserList

public ZIMCallUserInfo[] callUserList

呼叫邀请成员列表。

ZIMCallInvitationAcceptedInfo

接受呼叫邀请信息。

详情

接受呼叫邀请信息。

Declared in entity/ZIMCallInvitationAcceptedInfo.java

属性

invitee

public String invitee

被邀请者ID。

extendedData

public String extendedData

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

ZIMCallInvitationCancelledInfo

取消呼叫邀请信息。

详情

取消呼叫邀请信息。

Declared in entity/ZIMCallInvitationCancelledInfo.java

属性

inviter

public String inviter

呼叫邀请的邀请者ID。

extendedData

public String extendedData

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

ZIMCallInvitationCreatedInfo

创建呼叫邀请的信息。

详情

创建呼叫邀请的信息。

Declared in entity/ZIMCallInvitationCreatedInfo.java

属性

timeout

public int timeout

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

extendedData

public String extendedData

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

mode

public ZIMCallInvitationMode mode

本次呼叫邀请的模式。

caller

public String caller

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

createTime

public long createTime

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

callUserList

public ArrayList<ZIMCallUserInfo> callUserList

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

ZIMCallInvitationEndedInfo

结束呼叫的操作信息。

详情

结束呼叫的操作信息。

Declared in ZIM.java

属性

caller

public String caller

当前呼叫的主叫。

operatedUserID

public String operatedUserID

结束呼叫的操作者。

extendedData

public String extendedData

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

mode

public ZIMCallInvitationMode mode

当次呼叫邀请的模式。

endTime

public long endTime

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

ZIMCallInvitationQueryConfig

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

详情

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

Declared in entity/ZIMCallAcceptConfig.java

属性

count

public int count

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

是否必填：必填。

nextFlag

public long nextFlag

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

是否必填：非必填。

ZIMCallInvitationReceivedInfo

接受呼叫邀请的信息。

详情

接受呼叫邀请的信息。

Declared in entity/ZIMCallInvitationReceivedInfo.java

属性

timeout

public int timeout

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

inviter

public String inviter

邀请者ID。

extendedData

public String extendedData

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

mode

public ZIMCallInvitationMode mode

本次呼叫邀请的模式。

caller

public String caller

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

createTime

public long createTime

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

callUserList

public ArrayList<ZIMCallUserInfo> callUserList

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

ZIMCallInvitationRejectedInfo

拒绝呼叫邀请信息。

详情

拒绝呼叫邀请信息。

Declared in entity/ZIMCallInvitationRejectedInfo.java

属性

invitee

public String invitee

被邀请者ID。

extendedData

public String extendedData

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

ZIMCallInvitationSentInfo

呼叫邀请已发送信息。

详情

呼叫邀请已发送信息。

Declared in entity/ZIMCallInvitationSentInfo.java

属性

timeout

public int timeout

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

errorInvitees

deprecated

public ArrayList<ZIMCallUserInfo> errorInvitees

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

已废弃

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

errorUserList

public ArrayList<ZIMErrorUserInfo> errorUserList

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

ZIMCallInvitationTimeoutInfo

有关超时通知的信息类。

详情

有关超时通知的信息类。

Declared in entity/ZIMCallInvitationAcceptedInfo.java

属性

mode

public ZIMCallInvitationMode mode

呼叫邀请的类型。

ZIMCallInviteConfig

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

详情

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

Declared in entity/ZIMCallInviteConfig.java

属性

timeout

public int timeout

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

extendedData

public String extendedData

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

pushConfig

public ZIMPushConfig pushConfig

离线推送配置。

是否必填：非必填。

mode

public ZIMCallInvitationMode mode

呼叫邀请模式配置。

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

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

enableNotReceivedCheck

public boolean enableNotReceivedCheck

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

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

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

ZIMCallJoinConfig

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

详情

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

Declared in entity/ZIMCallInviteConfig.java

属性

extendedData

public String extendedData

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

ZIMCallJoinSentInfo

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

详情

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

Declared in entity/ZIMCallJoinSentInfo.java

属性

createTime

public long createTime

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

joinTime

public long joinTime

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

extendedData

public String extendedData

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

callUserList

public ArrayList<ZIMCallUserInfo> callUserList

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

ZIMCallQuitConfig

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

详情

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

Declared in entity/ZIMCallAcceptConfig.java

属性

extendedData

public String extendedData

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

是否必填：必填。

pushConfig

public ZIMPushConfig pushConfig

离线推送配置。

是否必填：非必填。

ZIMCallQuitSentInfo

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

详情

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

Declared in entity/ZIMCallQuitSentInfo.java

属性

createTime

public long createTime

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

acceptTime

public long acceptTime

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

quitTime

public long quitTime

本人退出呼叫的时间戳。

ZIMCallRejectConfig

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

详情

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

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

Declared in entity/ZIMGroupFullInfo.java

属性

extendedData

public String extendedData

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

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

ZIMCallUserInfo

呼叫邀请用户信息。

详情

呼叫邀请用户信息。

Declared in entity/ZIMCallUserInfo.java

属性

userID

public String userID

用户ID。

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

state

public ZIMCallUserState state

用户状态。

extendedData

public String extendedData

呼叫邀请用户信息中的附加信息。

ZIMCallUserStateChangeInfo

呼叫成员状态变化信息。

详情

呼叫成员状态变化信息。

Declared in /ZIMCallUserStateChangeInfo.java

属性

callUserList

public ArrayList<ZIMCallUserInfo> callUserList

发生状态变化的呼叫成员列表。

ZIMCallingInvitationSentInfo

呼叫中邀请已发送信息。

详情

呼叫中邀请已发送信息。

Declared in entity/ZIMCallingInvitationSentInfo.java

属性

errorUserList

public ArrayList<ZIMErrorUserInfo> errorUserList

错误用户列表。

ZIMCallingInviteConfig

邀请用户进入当前呼叫设置的行为属性。

详情

邀请用户进入当前呼叫设置的行为属性。

Declared in entity/ZIMCallingInviteConfig.java

属性

pushConfig

public ZIMPushConfig pushConfig

离线推送配置。

是否必填：非必填。

ZIMCombineMessage

合并消息对象基类。

详情

标识一条合并消息。

支持版本：2.14.0 及以上。

Declared in entity/ZIMCombineMessage.java

属性

title

public String title

合并消息标题。

summary

public String summary

合并消息的概要

combineID

public String combineID

合并消息 ID，SDK 内部使用

messageList

public ArrayList<ZIMMessage> messageList

合并消息的子消息列表

type

public ZIMMessageType type

消息类型。

messageID

public long messageID

标识这条消息的唯一 ID。

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

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

timestamp

public long timestamp

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

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

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

senderUserID

public String senderUserID

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

conversationID

public String conversationID

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

direction

public ZIMMessageDirection direction

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

sentStatus

public ZIMMessageSentStatus sentStatus

描述消息的发送状态。

conversationType

public ZIMConversationType conversationType

该消息所属会话的类型。

conversationSeq

public long conversationSeq

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

orderKey

public long orderKey

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

localMessageID

public long localMessageID

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

isUserInserted

public boolean isUserInserted

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

默认值：false。

receiptStatus

public ZIMMessageReceiptStatus receiptStatus

描述该消息的回执状态。

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

extendedData

public String extendedData

消息拓展字段。

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

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

localExtendedData

public String localExtendedData

isBroadcastMessage

public boolean isBroadcastMessage

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

是否必填：SDK内部赋值。

isMentionAll

private boolean isMentionAll

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

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

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

支持版本 : 2.14.0 及以上。

mentionedUserIDs

private ArrayList\<String> mentionedUserIDs

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

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

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

支持版本 : 2.14.0 及以上。

messageSeq

public long messageSeq

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

rootRepliedCount

public int rootRepliedCount

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

repliedInfo

public ZIMMessageRepliedInfo repliedInfo

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

editorUserID

public String editorUserID

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

editedTime

public long editedTime

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

isGroupTargetedMessage

public boolean isGroupTargetedMessage

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

pinnedUserID

public String pinnedUserID

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

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

pinnedTime

public long pinnedTime

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

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

ZIMCombineMessageLiteInfo

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

详情

标识一条合并消息。

Declared in entity/ZIMCombineMessageLiteInfo.java

属性

title

public String title

合并消息标题。

summary

public String summary

合并消息的概要

type

public ZIMMessageType type

消息类型。

ZIMCommandMessage

自定义二进制消息对象。

详情

标识一条二进制消息。

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

Declared in entity/ZIMCommandMessage.java

属性

message

public byte[] message

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

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

type

public ZIMMessageType type

消息类型。

messageID

public long messageID

标识这条消息的唯一 ID。

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

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

timestamp

public long timestamp

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

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

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

senderUserID

public String senderUserID

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

conversationID

public String conversationID

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

direction

public ZIMMessageDirection direction

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

sentStatus

public ZIMMessageSentStatus sentStatus

描述消息的发送状态。

conversationType

public ZIMConversationType conversationType

该消息所属会话的类型。

conversationSeq

public long conversationSeq

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

orderKey

public long orderKey

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

localMessageID

public long localMessageID

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

isUserInserted

public boolean isUserInserted

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

默认值：false。

receiptStatus

public ZIMMessageReceiptStatus receiptStatus

描述该消息的回执状态。

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

extendedData

public String extendedData

消息拓展字段。

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

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

localExtendedData

public String localExtendedData

isBroadcastMessage

public boolean isBroadcastMessage

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

是否必填：SDK内部赋值。

isMentionAll

private boolean isMentionAll

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

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

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

支持版本 : 2.14.0 及以上。

mentionedUserIDs

private ArrayList\<String> mentionedUserIDs

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

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

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

支持版本 : 2.14.0 及以上。

messageSeq

public long messageSeq

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

rootRepliedCount

public int rootRepliedCount

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

repliedInfo

public ZIMMessageRepliedInfo repliedInfo

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

editorUserID

public String editorUserID

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

editedTime

public long editedTime

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

isGroupTargetedMessage

public boolean isGroupTargetedMessage

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

pinnedUserID

public String pinnedUserID

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

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

pinnedTime

public long pinnedTime

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

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

方法

ZIMCommandMessage

public ZIMCommandMessage

Declared in entity/ZIMCommandMessage.java

ZIMConversation

会话具体内容。

详情

会话的具体内容。

Declared in entity/ZIMConversation.java

属性

conversationID

public String conversationID

会话ID。

conversationName

public String conversationName

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

type

public ZIMConversationType type

会话类型。

unreadMessageCount

public int unreadMessageCount

会话未读数。

lastMessage

public ZIMMessage lastMessage

最后一条消息。

orderKey

public long orderKey

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

notificationStatus

public ZIMConversationNotificationStatus notificationStatus

会话通知状态。

conversationAvatarUrl

public String conversationAvatarUrl

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

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

isPinned

public boolean isPinned

会话是否置顶。

支持版本：2.8.0。

mentionedInfoList

public ArrayList<ZIMMessageMentionedInfo> mentionedInfoList

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

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

conversationAlias

public String conversationAlias

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

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

marks

public ArrayList\<Integer> marks

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

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

draft

public String draft

会话草稿，当设置会话草稿后，会话中会带有该字段。

ZIMConversationBaseInfo

会话简要内容。

详情

会话的简要内容。

Declared in entity/ZIMConversation.java

属性

conversationID

public String conversationID

会话ID。

conversationType

public ZIMConversationType conversationType

会话类型。

ZIMConversationChangeInfo

会话变更信息。

详情

包含会话变更后的信息。

Declared in callback/ZIMConversationChangeInfo.java

属性

event

public ZIMConversationEvent event

会话事件。

conversation

public ZIMConversation conversation

会话具体信息。

ZIMConversationDeleteConfig

删除会话配置。

详情

删除会话的相关配置。

Declared in entity/ZIMConversationDeleteConfig.java

属性

isAlsoDeleteServerConversation

public boolean isAlsoDeleteServerConversation

是否删除服务端会话

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

ZIMConversationFilterOption

查询会话的相关过滤项。

详情

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

Declared in entity/ZIMConversationQueryConfig

属性

marks

public ArrayList\<Integer> marks

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

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

conversationTypes

public ArrayList<ZIMConversationType> conversationTypes

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

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

isOnlyUnreadConversation

public boolean isOnlyUnreadConversation

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

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

ZIMConversationQueryConfig

查询会话的相关配置。

详情

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

Declared in entity/ZIMConversationQueryConfig

属性

nextConversation

public ZIMConversation nextConversation

需要查询的会话。

是否必填：非必填。

count

public int count

需要查询的会话数量。

是否必填：必填。

ZIMConversationSearchConfig

会话搜索配置。

详情

会话搜索配置。

Declared in entity/ZIMConversationSearchConfig.java

属性

nextFlag

public int nextFlag

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

totalConversationCount

public int totalConversationCount

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

是否必填：必填。

conversationMessageCount

public int conversationMessageCount

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

keywords

public ArrayList\<String> keywords

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

messageTypes

public ArrayList<ZIMMessageType> messageTypes

消息类型，可用于指定消息类型。支持传入多个类型。

subMessageTypes

public ArrayList\<Integer> subMessageTypes

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

senderUserIDs

public ArrayList\<String> senderUserIDs

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

startTime

public long startTime

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

endTime

public long endTime

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

ZIMConversationSearchInfo

会话搜索信息。

Declared in entity/ZIMConversationSearchInfo.java

属性

conversationID

public String conversationID

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

conversationType

public ZIMConversationType conversationType

会话类型。

totalMessageCount

public int totalMessageCount

总消息条数。

messageList

public ArrayList<ZIMMessage> messageList

搜索到的消息列表

ZIMConversationTotalUnreadMessageCountQueryConfig

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

详情

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

Declared in entity/ZIMConversationQueryConfig

属性

marks

public ArrayList\<Integer> marks

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

conversationTypes

public ArrayList<ZIMConversationType> conversationTypes

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

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

ZIMConversationsAllDeletedInfo

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

详情

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

Declared in entity/ZIMConversationsAllDeletedInfo.java

属性

count

public int count

会话被删除的数目。

ZIMCustomMessage

自定义消息对象。

详情

标识一条自定义消息。

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

Declared in entity/ZIMCustomMessage.java

属性

message

public String message

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

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

subType

public int subType

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

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

searchedContent

public String searchedContent

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

type

public ZIMMessageType type

消息类型。

messageID

public long messageID

标识这条消息的唯一 ID。

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

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

timestamp

public long timestamp

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

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

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

senderUserID

public String senderUserID

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

conversationID

public String conversationID

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

direction

public ZIMMessageDirection direction

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

sentStatus

public ZIMMessageSentStatus sentStatus

描述消息的发送状态。

conversationType

public ZIMConversationType conversationType

该消息所属会话的类型。

conversationSeq

public long conversationSeq

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

orderKey

public long orderKey

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

localMessageID

public long localMessageID

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

isUserInserted

public boolean isUserInserted

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

默认值：false。

receiptStatus

public ZIMMessageReceiptStatus receiptStatus

描述该消息的回执状态。

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

extendedData

public String extendedData

消息拓展字段。

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

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

localExtendedData

public String localExtendedData

isBroadcastMessage

public boolean isBroadcastMessage

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

是否必填：SDK内部赋值。

isMentionAll

private boolean isMentionAll

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

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

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

支持版本 : 2.14.0 及以上。

mentionedUserIDs

private ArrayList\<String> mentionedUserIDs

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

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

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

支持版本 : 2.14.0 及以上。

messageSeq

public long messageSeq

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

rootRepliedCount

public int rootRepliedCount

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

repliedInfo

public ZIMMessageRepliedInfo repliedInfo

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

editorUserID

public String editorUserID

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

editedTime

public long editedTime

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

isGroupTargetedMessage

public boolean isGroupTargetedMessage

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

pinnedUserID

public String pinnedUserID

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

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

pinnedTime

public long pinnedTime

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

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

ZIMCustomMessageLiteInfo

自定义消息的简要对象。

详情

标识一条自定义消息。

Declared in entity/ZIMCustomMessageLiteInfo.java

属性

message

public String message

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

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

subType

public int subType

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

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

searchedContent

public String searchedContent

type

public ZIMMessageType type

消息类型。

ZIMError

错误信息

详情

错误信息。

Declared in entity/ZIMError.java

属性

code

public ZIMErrorCode code

错误码枚举值。

message

public String message

错误信息描述。

ZIMErrorUserInfo

失败用户信息类。

详情

用于展示失败的用户以及失败的原因。

Declared in entity/ZIMErrorUserInfo.java

属性

userID

public String userID

userID。

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

reason

public int reason

描述查询失败原因的 reason。

ZIMFileCacheClearConfig

清理缓存配置。

详情

清理缓存配置。

Declared in entity/ZIMFileCacheClearConfig.java

属性

endTime

public long endTime

缓存清理的截至时间戳。

是否必填：非必填。

ZIMFileCacheInfo

文件缓存信息。

详情

文件缓存信息。

Declared in entity/ZIMFileCacheInfo.java

属性

totalFileSize

public long totalFileSize

总的文件大小，单位为字节（B）。

ZIMFileCacheQueryConfig

查询缓存配置。

详情

查询缓存配置。

Declared in entity/ZIMFileCacheQueryConfig.java

属性

endTime

public long endTime

查询缓存的截至时间戳。

是否必填：非必填。

ZIMFileMessage

文件消息对象。

详情

标识一条文件消息。

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

Declared in entity/ZIMFileMessage.java

属性

fileLocalPath

public String fileLocalPath

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

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

fileDownloadUrl

public String fileDownloadUrl

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

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

fileUID

public String fileUID

媒体文件的唯一 ID。

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

fileName

public String fileName

媒体文件的文件名。

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

fileSize

public long fileSize

媒体文件的大小。

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

type

public ZIMMessageType type

消息类型。

messageID

public long messageID

标识这条消息的唯一 ID。

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

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

timestamp

public long timestamp

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

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

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

senderUserID

public String senderUserID

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

conversationID

public String conversationID

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

direction

public ZIMMessageDirection direction

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

sentStatus

public ZIMMessageSentStatus sentStatus

描述消息的发送状态。

conversationType

public ZIMConversationType conversationType

该消息所属会话的类型。

conversationSeq

public long conversationSeq

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

orderKey

public long orderKey

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

localMessageID

public long localMessageID

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

isUserInserted

public boolean isUserInserted

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

默认值：false。

receiptStatus

public ZIMMessageReceiptStatus receiptStatus

描述该消息的回执状态。

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

extendedData

public String extendedData

消息拓展字段。

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

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

localExtendedData

public String localExtendedData

isBroadcastMessage

public boolean isBroadcastMessage

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

是否必填：SDK内部赋值。

isMentionAll

private boolean isMentionAll

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

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

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

支持版本 : 2.14.0 及以上。

mentionedUserIDs

private ArrayList\<String> mentionedUserIDs

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

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

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

支持版本 : 2.14.0 及以上。

messageSeq

public long messageSeq

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

rootRepliedCount

public int rootRepliedCount

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

repliedInfo

public ZIMMessageRepliedInfo repliedInfo

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

editorUserID

public String editorUserID

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

editedTime

public long editedTime

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

isGroupTargetedMessage

public boolean isGroupTargetedMessage

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

pinnedUserID

public String pinnedUserID

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

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

pinnedTime

public long pinnedTime

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

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

ZIMFileMessageLiteInfo

文件消息的简要信息对象。

详情

标识一条文件消息。

Declared in entity/ZIMFileMessageLiteInfo.java

属性

fileLocalPath

public String fileLocalPath

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

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

fileDownloadUrl

public String fileDownloadUrl

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

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

fileName

public String fileName

媒体文件的文件名。

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

fileSize

public long fileSize

媒体文件的大小。

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

type

public ZIMMessageType type

消息类型。

ZIMFriendAddConfig

添加好友设置的行为属性。

详情

添加好友设置的行为属性。

Declared in entity/ZIMCallInviteConfig.java

属性

wording

public String wording

添加好友附言。

friendAlias

public String friendAlias

好友备注。

friendAttributes

public HashMap<String, String> friendAttributes

好友属性。最多设置 5 个。属性的 key 仅支持从 k0 ～ k4 取值。

ZIMFriendApplicationAcceptConfig

接受好友申请的行为属性。

详情

接受好友申请的行为属性。

Declared in entity/ZIMCallInviteConfig.java

属性

friendAlias

public String friendAlias

好友别名。

friendAttributes

public HashMap<String, String> friendAttributes

好友属信

pushConfig

public ZIMPushConfig pushConfig

离线推送配置

ZIMFriendApplicationInfo

好友申请信息。

详情

好友申请信息。

Declared in entity/ZIMFriendApplicationInfo.java

属性

applyUser

public ZIMUserInfo applyUser

如果自己是申请人，则这里是被申请人信息；如果自己是被申请人，则这里是申请人信息；

wording

public String wording

好友申请附言。

createTime

public int createTime

好友添加时间。

updateTime

public int updateTime

好友申请状态更新时间。

type

public ZIMFriendApplicationType type

好友申请类型。

state

public ZIMFriendApplicationState state

好友申请状态。

ZIMFriendApplicationListQueryConfig

查询好友申请列表配置。

详情

查询好友申请列表配置。

Declared in entity/ZIMCallInviteConfig.java

属性

count

public int count

当前查询总数。

nextFlag

public int nextFlag

当前查询锚点下标。

ZIMFriendApplicationRejectConfig

拒绝好友申请的行为属性。

详情

拒绝好友申请的行为属性。

Declared in entity/ZIMCallInviteConfig.java

属性

pushConfig

public ZIMPushConfig pushConfig

离线推送配置

ZIMFriendApplicationSendConfig

发起好友申请的行为属性。

详情

发起好友申请的行为属性。

Declared in entity/ZIMFriendApplicationSendConfig.java

属性

wording

public String wording

添加好友附言。

friendAlias

public String friendAlias

好友备注。

friendAttributes

public HashMap<String, String> friendAttributes

好友属性。最多设置 5 个。属性的 key 仅支持从 k0 ～ k4 取值。

pushConfig

public ZIMPushConfig pushConfig

离线推送配置。

ZIMFriendDeleteConfig

删除好友设置的行为属性。

详情

添加好友设置的行为属性。

Declared in entity/ZIMCallInviteConfig.java

属性

type

public ZIMFriendDeleteType type

删除类型。

ZIMFriendInfo

好友信息。

详情

好友信息。

Declared in entity/ZIMFriendInfo.java

属性

userID

public String userID

操作者的 UserID。

friendAlias

public String friendAlias

好友备注。

friendAttributes

public HashMap<String, String> friendAttributes

好友属性。最多设置 5 个。属性的 key 仅支持从 k0 ～ k4 取值。

createTime

public int createTime

好友添加时间。

userName

public String userName

用户 name，由开发者自定义生成。

是否必填：非必填。
取值范围：2.0.0 及以后版本，支持最大 256 字节的字符串。
隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。

userAvatarUrl

public String userAvatarUrl

用户头像，由开发者自定义生成。

是否必填：非必填。
取值范围：特殊字符不受限制，最大长度为500字节。
隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。

支持版本：2.13.0 及以上。
注意事项：房间成员列表需要在 2.18.0 版本后才会返回该值。

userExtendedData

public String userExtendedData

用户的扩展字段信息。

注意事项：仅房间用户时，该属性有值。

ZIMFriendListQueryConfig

查询好友列表配置。

详情

查询好友列表配置。

Declared in entity/ZIMCallInviteConfig.java

属性

count

public int count

当前查询总数。

nextFlag

public int nextFlag

当前查询锚点下标。

ZIMFriendRelationCheckConfig

检查好友关系的行为属性。

详情

检查好友关系的行为属性。

Declared in entity/ZIMCallInviteConfig.java

属性

type

public ZIMFriendRelationCheckType type

检查类型。

ZIMFriendRelationInfo

好友关系信息。

详情

好友关系信息。

Declared in entity/ZIMFriendRelationInfo.java

属性

userID

public String userID

用户ID。

type

public ZIMUserRelationType type

好友关系类型。

ZIMFriendsSearchConfig

搜索本地好友配置。

详情

搜索本地好友配置。

Declared in entity/ZIMCallInviteConfig.java

属性

keywords

public ArrayList\<String> keywords

搜索关键词列表。

isAlsoMatchFriendAlias

public boolean isAlsoMatchFriendAlias

是否匹配好友别名。

count

public int count

当前搜索总数。

nextFlag

public int nextFlag

当前搜索起止下标。

ZIMGroup

群组列表的完整的信息。

详情

群组列表的完整的信息。

Declared in entity/ZIMGroupFullInfo.java

属性

baseInfo

public ZIMGroupInfo baseInfo

基本群组信息。

notificationStatus

public ZIMGroupMessageNotificationStatus notificationStatus

群组消息通知状态。

groupAlias

public String groupAlias

用户自定的仅该用户可见的群备注。

ZIMGroupAdvancedConfig

群组高级配置。

详情

群组高级配置。

是否必填：是。

Declared in entity/ZIMGroupAdvancedConfig.java

属性

groupAttributes

public HashMap<String, String> groupAttributes

群组属性，最多可配置 10 个。

是否必填：否。

groupNotice

public String groupNotice

群公告。

是否必填：否。

maxMemberCount

public int maxMemberCount

群成员最大数量。

业务场景：当需要限制群成员数量时使用。
是否必填：否。
默认值：0。
取值范围：[0, 套餐默认的最大群成员数量]。

注意事项：支持版本 2.15 及以上。

joinMode

public ZIMGroupJoinMode joinMode

入群模式。

是否必填：否。

注意事项：支持版本 2.15 及以上。

inviteMode

public ZIMGroupInviteMode inviteMode

邀请模式。

是否必填：否。

注意事项：支持版本 2.15 及以上。

beInviteMode

public ZIMGroupBeInviteMode beInviteMode

邀请目标验证模式。

是否必填：否。

注意事项：支持版本 2.15 及以上。

ZIMGroupApplicationInfo

入群申请信息。

Declared in entity/ZIMGroupApplicationInfo.java

属性

applyUser

public ZIMUserInfo applyUser

类型为加入申请时是申请人，类型为邀请申请时是被邀请人，类型为被邀请申请时是邀请人。

wording

public String wording

入群申请附言。

createTime

public long createTime

入群申请创建时间戳，单位为毫秒。

updateTime

public long updateTime

入群申请状态更新时间，单位为毫秒。

type

public ZIMGroupApplicationType type

入群申请类型。

state

public ZIMGroupApplicationState state

入群申请状态。

groupInfo

public ZIMGroupInfo groupInfo

申请入群的群信息。

operatedUser

public ZIMGroupMemberSimpleInfo operatedUser

同意外部用户加群申请的操作人。

ZIMGroupApplicationListQueryConfig

入群申请查询配置。

详情

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

Declared in entity/ZIMGroupApplicationListQueryConfig.java

属性

count

public int count

数量，建议不超过 30。

是否必填：必填。

nextFlag

public int nextFlag

下一个标志。

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

ZIMGroupAttributesUpdateInfo

群属性更新信息。

详情

群属性更新信息。

Declared in entity/ZIMGroupAttributesUpdateInfo.java

属性

action

public ZIMGroupAttributesUpdateAction action

群属性更新行为。

groupAttributes

public HashMap<String, String> groupAttributes

群属性。

ZIMGroupConversation

群会话对象，继承自ZIMGroupConversation。

详情

群会话对象，继承自ZIMGroupConversation。

Declared in ZIMGroupConversation.java

属性

mutedExpiredTime

public long long mutedExpiredTime

群禁言的过期时间。

isDisabled

public boolean isDisabled

这个群会话是否为不可用的状态。

conversationID

public String conversationID

会话ID。

conversationName

public String conversationName

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

type

public ZIMConversationType type

会话类型。

unreadMessageCount

public int unreadMessageCount

会话未读数。

lastMessage

public ZIMMessage lastMessage

最后一条消息。

orderKey

public long orderKey

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

notificationStatus

public ZIMConversationNotificationStatus notificationStatus

会话通知状态。

conversationAvatarUrl

public String conversationAvatarUrl

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

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

isPinned

public boolean isPinned

会话是否置顶。

支持版本：2.8.0。

mentionedInfoList

public ArrayList<ZIMMessageMentionedInfo> mentionedInfoList

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

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

conversationAlias

public String conversationAlias

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

marks

public ArrayList\<Integer> marks

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

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

draft

public String draft

会话草稿，当设置会话草稿后，会话中会带有该字段。

ZIMGroupEnterInfo

群成员入群时的信息。

Declared in entity/ZIMGroupEnterInfo.java

属性

enterType

public ZIMGroupEnterType enterType

入群类型。

enterTime

public long enterTime

入群时服务端的时间戳。

operatedUser

public ZIMGroupMemberSimpleInfo operatedUser

同意加群申请的操作人或者邀请入群申请的邀请人。

ZIMGroupFullInfo

群组完整的信息。

详情

群组完整的信息。

Declared in entity/ZIMGroupFullInfo.java

属性

baseInfo

public ZIMGroupInfo baseInfo

基本群组信息。

groupAttributes

public HashMap<String, String> groupAttributes

群组属性。

groupNotice

public String groupNotice

群公告。

notificationStatus

public ZIMGroupMessageNotificationStatus notificationStatus

群组消息通知状态。

mutedInfo

public ZIMGroupMuteInfo mutedInfo

群禁言信息。

createTime

public long createTime

群创建时的服务端的时间戳。

注意事项：支持版本 2.15 及以上。

maxMemberCount

public int maxMemberCount

群成员最大数量。

注意事项：支持版本 2.15 及以上。

verifyInfo

public ZIMGroupVerifyInfo verifyInfo

入群的验证模式。

注意事项：支持版本 2.15 及以上。

groupAlias

public String groupAlias

用户自定的仅该用户可见的群备注。

ZIMGroupInfo

群组信息。

详情

群组信息。

Declared in entity/ZIMGroupInfo.java

属性

groupID

public String groupID

群组ID。

是否必填：非必填,若 groupID 为空后台会自动生成。
取值范围：最大 32 字节的字符串。仅支持数字，英文字符和 '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'。且不能以 ’#‘ 开头

groupName

public String groupName

群名称。

是否必填：非必填。
取值范围：最大 50 字节的字符串。

groupAvatarUrl

public String groupAvatarUrl

群头像 URL。

是否必填：非必填。

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

ZIMGroupInviteApplicationAcceptConfig

接受邀请入群申请的配置。

Declared in entity/ZIMGroupInviteApplicationAcceptConfig.java

属性

pushConfig

public ZIMPushConfig pushConfig

离线推送配置。

ZIMGroupInviteApplicationRejectConfig

拒绝邀请入群申请的配置。

Declared in entity/ZIMGroupInviteApplicationRejectConfig.java

属性

pushConfig

public ZIMPushConfig pushConfig

离线推送配置。

ZIMGroupInviteApplicationSendConfig

发送邀请入群申请的配置。

Declared in entity/ZIMGroupInviteApplicationSendConfig.java

属性

wording

public String wording

申请的附言。

pushConfig

public ZIMPushConfig pushConfig

离线推送配置。

ZIMGroupJoinApplicationAcceptConfig

接受加群申请的配置。

Declared in entity/ZIMGroupJoinApplicationAcceptConfig.java

属性

pushConfig

public ZIMPushConfig pushConfig

离线推送配置。

ZIMGroupJoinApplicationRejectConfig

拒绝加群申请的配置。

Declared in entity/ZIMGroupJoinApplicationRejectConfig.java

属性

pushConfig

public ZIMPushConfig pushConfig

离线推送配置。

ZIMGroupJoinApplicationSendConfig

发送加群申请的配置。

Declared in entity/ZIMGroupJoinApplicationSendConfig.java

属性

wording

public String wording

申请的附言。

pushConfig

public ZIMPushConfig pushConfig

离线推送配置。

ZIMGroupMemberInfo

群组成员信息。

详情

群组成员信息。

Declared in entity/ZIMGroupMemberInfo.java

属性

memberNickname

public String memberNickname

群组成员昵称。

memberRole

public int memberRole

群角色，1：群主，2：管理员，3：群成员。

memberAvatarUrl

deprecated

public String memberAvatarUrl

群成员头像 URL。

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

已废弃

废弃于 2.13.0 版本。如需获取群成员头像 URL，请查看 userAvatarUrl。

muteExpiredTime

public long muteExpiredTime

群成员禁言过期时间。为 0 时即不禁言，为 -1 时即永久禁言。

groupEnterInfo

public ZIMGroupEnterInfo groupEnterInfo

群成员入群时的信息。

注意事项：支持版本 2.15 及以上。

userID

public String userID

用户 ID，由开发者自定义生成。

是否必填：必填。
取值范围：最大 32 字节的字符串。仅支持数字，英文字符和 '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'。
隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。

注意事项：注意 userID 在同一个 appID 下需唯一，否则会出现互踢的情况。强烈建议 userID 与业务 APP 的用户 ID 一一对应，即一个 userID 与一个真实用户是固定且唯一的，而不应该是以随机的 userID 的方式传给 SDK 的方式。因为唯一且固定的 userID 可以让 ZEGO 技术人员快速定位线上问题。

userName

public String userName

用户 name，由开发者自定义生成。

是否必填：非必填。
取值范围：2.0.0 及以后版本，支持最大 256 字节的字符串。
隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。

userAvatarUrl

public String userAvatarUrl

用户头像，由开发者自定义生成。

是否必填：非必填。
取值范围：特殊字符不受限制，最大长度为500字节。
隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。

支持版本：2.13.0 及以上。
注意事项：房间成员列表需要在 2.18.0 版本后才会返回该值。

userExtendedData

public String userExtendedData

用户的扩展字段信息。

注意事项：仅房间用户时，该属性有值。

ZIMGroupMemberMuteConfig

群组成员禁言配置。

详情

群组成员禁言配置。

是否必填：是。

Declared in entity/ZIMGroupMemberMuteConfig.java

属性

duration

public int duration

群组成员禁言时长，单位是秒。取值为 -1，即永久禁言。如需实现非永久禁言，取值上限为 604800（即 7 天）。如需上调，请联系 ZEGO 技术支持。

是否必填：必填。

ZIMGroupMemberMutedListQueryConfig

群禁言成员列表查询配置。

详情

群禁言成员列表查询配置。

Declared in entity/ZIMGroupMemberMutedListQueryConfig.java

属性

count

public int count

数量。

是否必填：必填。

nextFlag

public long nextFlag

下一个标志。

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

ZIMGroupMemberQueryConfig

群成员查询配置。

详情

群成员查询配置。

Declared in entity/ZIMGroupMemberQueryConfig.java

属性

count

public int count

数量，上限为 100，超过 100 则按照 100 处理。

是否必填：必填。

nextFlag

public int nextFlag

下一个标志。

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

ZIMGroupMemberSearchConfig

群成员搜索配置。

详情

群成员搜索配置。

Declared in entity/ZIMGroupMemberSearchConfig.java

属性

count

public int count

结果的数量。

是否必填：必填。

nextFlag

public int nextFlag

查询的 flag ，第一次调用接口时填 0。后续再次调用接口时填从 callback 里返回的 nextFlag，以便获取剩余数据。

是否必填：非必填

keywords

public ArrayList\<String> keywords

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

是否必填：否

注意事项：最多支持填写 5 个，否则会报错。

isAlsoMatchGroupMemberNickname

public boolean isAlsoMatchGroupMemberNickname

搜索范围是否包括群成员用户昵称，默认为 false。

是否必填：否。
默认值：false。

ZIMGroupMemberSimpleInfo

群成员简要信息。

Declared in entity/ZIMGroupMemberSimpleInfo.java

属性

memberNickname

public String memberNickname

群组成员昵称。

memberRole

public int memberRole

群角色，1：群主，2：管理员，3：群成员。

userID

public String userID

用户 ID，由开发者自定义生成。

是否必填：必填。
取值范围：最大 32 字节的字符串。仅支持数字，英文字符和 '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'。
隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。

注意事项：注意 userID 在同一个 appID 下需唯一，否则会出现互踢的情况。强烈建议 userID 与业务 APP 的用户 ID 一一对应，即一个 userID 与一个真实用户是固定且唯一的，而不应该是以随机的 userID 的方式传给 SDK 的方式。因为唯一且固定的 userID 可以让 ZEGO 技术人员快速定位线上问题。

userName

public String userName

用户 name，由开发者自定义生成。

是否必填：非必填。
取值范围：2.0.0 及以后版本，支持最大 256 字节的字符串。
隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。

userAvatarUrl

public String userAvatarUrl

用户头像，由开发者自定义生成。

是否必填：非必填。
取值范围：特殊字符不受限制，最大长度为500字节。
隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。

支持版本：2.13.0 及以上。
注意事项：房间成员列表需要在 2.18.0 版本后才会返回该值。

userExtendedData

public String userExtendedData

用户的扩展字段信息。

注意事项：仅房间用户时，该属性有值。

ZIMGroupMessageReceiptMemberQueryConfig

详情

群消息回执已读/未读成员查询配置。

Declared in entity/ZIMGroupMessageReceiptMemberQueryConfig.java

属性

count

public int count

需要查询的群成员数量。

是否必填：必填。

nextFlag

public int nextFlag

下一个标志。初始填 0，后续从 [ZIMGroupMessageReceiptMemberListQueriedCallback] 回调拿到下一个的 nextFlag。

ZIMGroupMuteConfig

群组禁言配置。

详情

群组禁言配置。

是否必填：是。

Declared in entity/ZIMGroupMuteConfig.java

属性

mode

public ZIMGroupMuteMode mode

群组禁言模式。

默认值：All，全体禁言。
是否必填：是。

duration

public int duration

群组禁言时长，单位是秒。取值为 -1，即永久禁言。如需实现非永久禁言，取值上限为 604800（即 7 天）。如需上调，请联系 ZEGO 技术支持。

是否必填：必填。

roles

public ArrayList<Integer> roles

群角色列表。

是否必填：仅当 ZIMGroupMuteMode 为 Custom 时，此字段才有意义。

注意事项：当列表中有 3（普通用户）时，必须同时存在其他角色，且不能为 1、2、4。如果仅需要禁言普通用户时，ZIMGroupMuteMode 需为 Normal。

ZIMGroupMuteInfo

群组禁言信息。

详情

群组禁言信息。

Declared in entity/ZIMGroupMuteInfo.java

属性

mode

public ZIMGroupMuteMode mode

群组禁言模式。

expiredTime

public long expiredTime

群组禁言过期时间，单位为秒。为 0 时为不禁言，为 -1 时为永久禁言。

roles

public ArrayList\<Integer> roles

群被禁言角色列表。

ZIMGroupOperatedInfo

群组引发事件变化操作者的信息。

详情

群组引发事件变化操作者的信息。

Declared in entity/ZIMGroupOperatedInfo.java

属性

operatedUserInfo

deprecated

public ZIMGroupMemberInfo operatedUserInfo

群成员信息。

已废弃

自 2.3.0 版本已废弃，请使用该类的其他属性。同时，该属性类无法获取到群成员的头像 URL 信息。

userID

public String userID

操作者的用户 ID。

userName

public String userName

操作者的用户名。

memberNickname

public String memberNickname

操作者的群成员昵称。

memberRole

public int memberRole

操作者的群成员角色。

ZIMGroupSearchConfig

群搜索配置。

详情

群搜索配置。

Declared in entity/ZIMGroupSearchConfig.java

属性

count

public int count

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

是否必填：必填。

nextFlag

public int nextFlag

查询的 flag 。

是否必填：首次查询时填 0。后续再次调用接口时，填从 Callback 回调里返回的 nextFlag，以便获取下一分页数据。

keywords

public ArrayList\<String> keywords

搜索关键字。例如：传入 "1" 和 "2"，则搜索结果只会展示群名称同时包含 "1" 和 "2" 这两个关键字的群组。

是否必填：否

注意事项：最多支持填写 5 个，否则会报错。

isAlsoMatchGroupMemberNickname

public boolean isAlsoMatchGroupMemberNickname

搜索范围是否包括群成员用户昵称，默认为 false。

是否必填：否。
默认值：false。

isAlsoMatchGroupMemberUserName

public boolean isAlsoMatchGroupMemberUserName

搜索范围是否包括群成员用户名称，默认为 false。

是否必填：否。
默认值：false。

ZIMGroupSearchInfo

群搜索信息。

详情

群组搜索信息。

Declared in entity/ZIMGroupSearchInfo.java

属性

groupInfo

public ZIMGroupInfo groupInfo

群信息

userList

public ArrayList<ZIMGroupMemberInfo> userList

群成员信息。

ZIMGroupVerifyInfo

入群的验证模式。

Declared in entity/ZIMGroupVerifyInfo.java

属性

joinMode

public ZIMGroupJoinMode joinMode

加入群的验证模式。

inviteMode

public ZIMGroupInviteMode inviteMode

邀请入群的验证模式。

beInviteMode

public ZIMGroupBeInviteMode beInviteMode

被邀请入群的验证模式。

ZIMImageMessage

图片消息对象。

详情

标识一条图片消息。

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

Declared in entity/ZIMImageMessage.java

属性

thumbnailLocalPath

public String thumbnailLocalPath

图片文件的缩略图本地路径。

是否必填：发送端不需要填，当调用 [downloadMediaFile] 下载之后， SDK 会生成该值。

thumbnailDownloadUrl

public String thumbnailDownloadUrl

图片文件的缩略图外部下载 URL。当开发者将缩略图上传到自己的服务器上时，可以通过该字段让 SDK 透传到其他用户中。

是否必填：发送端选填，当 fileDownloadUrl 填入后，该字段才生效。

largeImageLocalPath

public String largeImageLocalPath

图片文件的大图本地路径。

是否必填：发送端不需要填，当调用 [downloadMediaFile] 下载之后， SDK 会生成该值。

largeImageDownloadUrl

public String largeImageDownloadUrl

图片文件的大图外部下载 URL。当开发者将大图上传到自己的服务器上时，可以通过该字段让 SDK 透传到其他用户中。

是否必填：发送端选填，当 fileDownloadUrl 填入后，该字段才生效。

originalImageWidth

public int originalImageWidth

原图宽。在 2.19.0 版本后对于透传图片消息（即该 URL 由客户自行传入的情况）支持传入，ZIM 会做透传处理；对于本地图片消息如果传入，ZIM 会在发送时检查是否正确，如果不正确将会自动纠正。

业务场景：用户需要绘出图片 UI 时，用于确定原图宽度的参数，单位为像素。

originalImageHeight

public int originalImageHeight

原图高。在 2.19.0 版本后对于透传图片消息（即该 URL 由客户自行传入的情况）支持传入，ZIM 会做透传处理；对于本地图片消息如果传入，ZIM 会在发送时检查是否正确，如果不正确将会自动纠正。

业务场景：用户需要绘出图片 UI 时，用于确定原图高度的参数，单位为像素。

largeImageWidth

public int largeImageWidth

大图宽。当发送本地图片时，ZIM 服务会将原图的最短边压缩至 720 像素，对另一边做等比压缩。当原图最短边小于 720 像素时，则不压缩。在 2.19.0 版本后对于透传图片消息（即该 URL 由客户自行传入的情况）支持传入，ZIM 会做透传处理；对于本地图片消息如果传入，ZIM 会在发送时检查是否正确，如果不正确将会自动纠正。

业务场景：用户需要绘出图片 UI 时，用于确定大图宽度的参数,单位为像素。

largeImageHeight

public int largeImageHeight

大图高。当发送本地图片时，ZIM 服务会将原图的最短边压缩至 720 像素，对另一边做等比压缩。当原图最短边小于 720 像素时，则不压缩。在 2.19.0 版本后对于透传图片消息（即该 URL 由客户自行传入的情况）支持传入，ZIM 会做透传处理；对于本地图片消息如果传入，ZIM 会在发送时检查是否正确，如果不正确将会自动纠正。

业务场景：用户需要绘出图片 UI 时，用于确定大图高度的参数,单位为像素。

thumbnailWidth

public int thumbnailWidth

缩略图宽。当发送本地图片时，ZIM 服务会将原图的最短边压缩至 198 像素，对另一边做等比压缩。当原图最短边小于 198 像素时，则不压缩。在 2.19.0 版本后对于透传图片消息（即该 URL 由客户自行传入的情况）支持传入，ZIM 会做透传处理；对于本地图片消息如果传入，ZIM 会在发送时检查是否正确，如果不正确将会自动纠正。

业务场景：用户需要绘出图片 UI 时，用于确定缩略图宽度的参数,单位为像素。

thumbnailHeight

public int thumbnailHeight

缩略图高。当发送本地图片时，ZIM 服务会将原图的最短边压缩至 198 像素，对另一边做等比压缩。当原图最短边小于 198 像素时，则不压缩。在 2.19.0 版本后对于透传图片消息（即该 URL 由客户自行传入的情况）支持传入，ZIM 会做透传处理；对于本地图片消息如果传入，ZIM 会在发送时检查是否正确，如果不正确将会自动纠正。

业务场景：用户需要绘出图片 UI 时，用于确定缩略图高度的参数,单位为像素。

fileLocalPath

public String fileLocalPath

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

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

fileDownloadUrl

public String fileDownloadUrl

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

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

fileUID

public String fileUID

媒体文件的唯一 ID。

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

fileName

public String fileName

媒体文件的文件名。

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

fileSize

public long fileSize

媒体文件的大小。

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

type

public ZIMMessageType type

消息类型。

messageID

public long messageID

标识这条消息的唯一 ID。

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

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

timestamp

public long timestamp

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

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

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

senderUserID

public String senderUserID

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

conversationID

public String conversationID

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

direction

public ZIMMessageDirection direction

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

sentStatus

public ZIMMessageSentStatus sentStatus

描述消息的发送状态。

conversationType

public ZIMConversationType conversationType

该消息所属会话的类型。

conversationSeq

public long conversationSeq

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

orderKey

public long orderKey

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

localMessageID

public long localMessageID

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

isUserInserted

public boolean isUserInserted

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

默认值：false。

receiptStatus

public ZIMMessageReceiptStatus receiptStatus

描述该消息的回执状态。

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

extendedData

public String extendedData

消息拓展字段。

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

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

localExtendedData

public String localExtendedData

isBroadcastMessage

public boolean isBroadcastMessage

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

是否必填：SDK内部赋值。

isMentionAll

private boolean isMentionAll

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

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

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

支持版本 : 2.14.0 及以上。

mentionedUserIDs

private ArrayList\<String> mentionedUserIDs

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

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

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

支持版本 : 2.14.0 及以上。

messageSeq

public long messageSeq

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

rootRepliedCount

public int rootRepliedCount

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

repliedInfo

public ZIMMessageRepliedInfo repliedInfo

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

editorUserID

public String editorUserID

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

editedTime

public long editedTime

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

isGroupTargetedMessage

public boolean isGroupTargetedMessage

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

pinnedUserID

public String pinnedUserID

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

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

pinnedTime

public long pinnedTime

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

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

ZIMImageMessageLiteInfo

图片消息的简要信息对象。

详情

标识一条图片消息。

Declared in entity/ZIMImageMessageLiteInfo.java

属性

thumbnailLocalPath

public String thumbnailLocalPath

图片文件的缩略图本地路径。

是否必填：发送端不需要填，当调用 [downloadMediaFile] 下载之后， SDK 会生成该值。

thumbnailDownloadUrl

public String thumbnailDownloadUrl

图片文件的缩略图外部下载 URL。当开发者将缩略图上传到自己的服务器上时，可以通过该字段让 SDK 透传到其他用户中。

是否必填：发送端选填，当 fileDownloadUrl 填入后，该字段才生效。

largeImageLocalPath

public String largeImageLocalPath

图片文件的大图本地路径。

是否必填：发送端不需要填，当调用 [downloadMediaFile] 下载之后， SDK 会生成该值。

largeImageDownloadUrl

public String largeImageDownloadUrl

图片文件的大图外部下载 URL。当开发者将大图上传到自己的服务器上时，可以通过该字段让 SDK 透传到其他用户中。

是否必填：发送端选填，当 fileDownloadUrl 填入后，该字段才生效。

originalImageWidth

public int originalImageWidth

原图宽。

业务场景：用户需要绘出图片 UI 时，用于确定原图宽度的参数，单位为像素。

originalImageHeight

public int originalImageHeight

原图高。

业务场景：用户需要绘出图片 UI 时，用于确定原图高度的参数，单位为像素。

largeImageWidth

public int largeImageWidth

大图宽。当发送本地图片时，ZIM 服务会将原图的最短边压缩至 720 像素，对另一边做等比压缩。当原图最短边小于 720 像素时，则不压缩。

业务场景：用户需要绘出图片 UI 时，用于确定大图宽度的参数,单位为像素。

largeImageHeight

public int largeImageHeight

大图高。当发送本地图片时，ZIM 服务会将原图的最短边压缩至 720 像素，对另一边做等比压缩。当原图最短边小于 720 像素时，则不压缩。

业务场景：用户需要绘出图片 UI 时，用于确定大图高度的参数,单位为像素。

thumbnailWidth

public int thumbnailWidth

缩略图宽。当发送本地图片时，ZIM 服务会将原图的最短边压缩至 198 像素，对另一边做等比压缩。当原图最短边小于 198 像素时，则不压缩。

业务场景：用户需要绘出图片 UI 时，用于确定缩略图宽度的参数,单位为像素。

thumbnailHeight

public int thumbnailHeight

缩略图高。当发送本地图片时，ZIM 服务会将原图的最短边压缩至 198 像素，对另一边做等比压缩。当原图最短边小于 198 像素时，则不压缩。

业务场景：用户需要绘出图片 UI 时，用于确定缩略图高度的参数,单位为像素。

fileLocalPath

public String fileLocalPath

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

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

fileDownloadUrl

public String fileDownloadUrl

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

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

fileName

public String fileName

媒体文件的文件名。

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

fileSize

public long fileSize

媒体文件的大小。

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

type

public ZIMMessageType type

消息类型。

ZIMLogConfig

日志配置。

详情

配置日志文件保存路径和日志文件大小上限。

Declared in entity/ZIMLogConfig.java

属性

logPath

public String logPath

日志文件的存储路径，默认路径参考官网文档。

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

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

logSize

public long logSize

日志文件大小上限 (Bytes)。

是否必填：非必填。
默认值：默认大小 5MB (5 * 1024 * 1024 Bytes)。
建议值：建议使用默认大小，太大会导致磁盘占用过多，太小会导致日志记录不全。

ZIMLoginConfig

登录相关参数配置。

详情

登录相关参数。

业务场景：用于登录时设置不同的参数。

支持版本：2.13.0 及以上。

Declared in entity/ZIMLoginConfig.java

属性

userName

public String userName

用户昵称。

业务场景：用于登录同时修改用户昵称的场景，无需变更时传空。
是否必填：否。

token

public String token

登录时携带的 token。

业务场景：仅在使用 token 鉴权的场景中传入。
是否必填：否。

isOfflineLogin

public boolean isOfflineLogin

是否是离线登录。

业务场景：在离线登录时需要传入 true。
是否必填：否。
默认值：false。

customStatus

public String customStatus

用户自定义状态，默认最大值为 64 字节，默认过期时间为 1 天，过期后重置为空字符串。登录时，如果该字段为空字符串（默认为空字符串），那么不会修改当前用户的自定义状态。

支持版本：2.20.0

ZIMMediaDownloadConfig

下载媒体文件的配置。

Declared in entity/ZIMConversationDeleteConfig.java

属性

messageInfoIndex

public int messageInfoIndex

下载组合消息里的某个文件所在数组的索引。

是否必填：下载组合消息的文件时必填。

ZIMMediaMessage

媒体消息对象基类。

详情

标识一条媒体消息。

注意事项：该基类是所有媒体消息的基础，包含媒体消息所需要的属性。

Declared in entity/ZIMFileMessage.java

属性

fileLocalPath

public String fileLocalPath

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

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

fileDownloadUrl

public String fileDownloadUrl

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

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

fileUID

public String fileUID

媒体文件的唯一 ID。

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

fileName

public String fileName

媒体文件的文件名。

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

fileSize

public long fileSize

媒体文件的大小。

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

type

public ZIMMessageType type

消息类型。

messageID

public long messageID

标识这条消息的唯一 ID。

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

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

timestamp

public long timestamp

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

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

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

senderUserID

public String senderUserID

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

conversationID

public String conversationID

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

direction

public ZIMMessageDirection direction

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

sentStatus

public ZIMMessageSentStatus sentStatus

描述消息的发送状态。

conversationType

public ZIMConversationType conversationType

该消息所属会话的类型。

conversationSeq

public long conversationSeq

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

orderKey

public long orderKey

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

localMessageID

public long localMessageID

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

isUserInserted

public boolean isUserInserted

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

默认值：false。

receiptStatus

public ZIMMessageReceiptStatus receiptStatus

描述该消息的回执状态。

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

extendedData

public String extendedData

消息拓展字段。

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

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

localExtendedData

public String localExtendedData

isBroadcastMessage

public boolean isBroadcastMessage

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

是否必填：SDK内部赋值。

isMentionAll

private boolean isMentionAll

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

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

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

支持版本 : 2.14.0 及以上。

mentionedUserIDs

private ArrayList\<String> mentionedUserIDs

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

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

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

支持版本 : 2.14.0 及以上。

messageSeq

public long messageSeq

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

rootRepliedCount

public int rootRepliedCount

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

repliedInfo

public ZIMMessageRepliedInfo repliedInfo

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

editorUserID

public String editorUserID

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

editedTime

public long editedTime

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

isGroupTargetedMessage

public boolean isGroupTargetedMessage

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

pinnedUserID

public String pinnedUserID

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

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

pinnedTime

public long pinnedTime

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

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

ZIMMediaMessageLiteInfo

媒体消息简要信息对象基类。

详情

标识一条媒体消息。

注意事项：该基类是所有媒体消息简要信息的基础，包含媒体消息简要信息所需要的属性。

Declared in entity/ZIMMediaMessageLiteInfo.java

属性

fileLocalPath

public String fileLocalPath

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

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

fileDownloadUrl

public String fileDownloadUrl

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

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

fileName

public String fileName

媒体文件的文件名。

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

fileSize

public long fileSize

媒体文件的大小。

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

type

public ZIMMessageType type

消息类型。

ZIMMessage

消息对象的基类。

详情

标识一条消息的基本参数。

注意事项：其中的部分参数如 Message ID 仅在回调时有值。开发者主动创建此对象用于发送消息时不需要给这些参数赋值。

Declared in entity/ZIMMessage.java

属性

type

public ZIMMessageType type

消息类型。

messageID

public long messageID

标识这条消息的唯一 ID。

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

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

timestamp

public long timestamp

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

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

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

senderUserID

public String senderUserID

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

conversationID

public String conversationID

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

direction

public ZIMMessageDirection direction

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

sentStatus

public ZIMMessageSentStatus sentStatus

描述消息的发送状态。

conversationType

public ZIMConversationType conversationType

该消息所属会话的类型。

conversationSeq

public long conversationSeq

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

orderKey

public long orderKey

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

localMessageID

public long localMessageID

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

isUserInserted

public boolean isUserInserted

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

默认值：false。

receiptStatus

public ZIMMessageReceiptStatus receiptStatus

描述该消息的回执状态。

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

extendedData

public String extendedData

消息拓展字段。

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

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

localExtendedData

public String localExtendedData

isBroadcastMessage

public boolean isBroadcastMessage

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

是否必填：SDK内部赋值。

isMentionAll

private boolean isMentionAll

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

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

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

支持版本 : 2.14.0 及以上。

mentionedUserIDs

private ArrayList\<String> mentionedUserIDs

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

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

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

支持版本 : 2.14.0 及以上。

messageSeq

public long messageSeq

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

rootRepliedCount

public int rootRepliedCount

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

repliedInfo

public ZIMMessageRepliedInfo repliedInfo

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

editorUserID

public String editorUserID

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

editedTime

public long editedTime

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

isGroupTargetedMessage

public boolean isGroupTargetedMessage

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

pinnedUserID

public String pinnedUserID

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

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

pinnedTime

public long pinnedTime

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

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

ZIMMessageDeleteConfig

删除消息配置。

详情

删除消息的相关配置。

Declared in entity/ZIMConversationDeleteConfig.java

属性

isAlsoDeleteServerMessage

public boolean isAlsoDeleteServerMessage

是否删除服务器消息的标志。

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

ZIMMessageDeletedInfo

被删除的消息信息。

Declared in entity/ZIMMessageDeletedInfo.java

属性

conversationID

public String conversationID

会话 ID。

conversationType

public ZIMConversationType conversationType

会话类型。

messageList

public ArrayList<ZIMMessage> messageList

删除的消息列表。

isDeleteConversationAllMessage

deprecated

public boolean isDeleteConversationAllMessage

是否删除会话当前所有消息。

已废弃

该字段在 2.14.0 版本被废弃。

messageDeleteType

public ZIMMessageDeleteType messageDeleteType

[onMessageDeleted] 被触发的原因。

ZIMMessageEditConfig

详情

（空类）编辑消息的相关配置。

Declared in entity/ZIMMessageEditConfig.java

ZIMMessageExportConfig

详情

导出消息的相关配置。该 Config 目前为预留参数。

Declared in entity/ZIMMessageExportConfig.java

ZIMMessageImportConfig

详情

导入消息的相关配置。该 Config 目前为预留参数。

Declared in entity/ZIMMessageImportConfig.java

ZIMMessageLiteInfo

消息简要信息对象的基类。

详情

标识一条消息的基本参数。

Declared in entity/ZIMMessageLiteInfo.java

属性

type

public ZIMMessageType type

消息类型。

ZIMMessageMentionedInfo

消息提醒信息。

详情

消息提醒信息。

Declared in entity/ZIMMessageMentionedInfo.java

属性

messageID

public long messageID

消息ID，用于匹配该提醒信息是属于哪一条消息

是否必填：不需要开发者填写

fromUserID

public String fromUserID

来自哪个用户。

是否必填：不需要开发者填写。

type

public ZIMMessageMentionedType type

消息提醒的类型，用于区分是提醒自己的还是提醒全部人的

是否必填：不需要开发者填写

messageSeq

public long messageSeq

消息 seq。

ZIMMessagePinStatusChangeInfo

消息置顶状态变更通知。

详情

当会话内一条消息被成功置顶或取消置顶并触发通知时，可以通过该结构获取被操作的消息与当前置顶状态。

Declared in entity/ZIMMessagePinStatusChangeInfo.java

属性

pinStatus

public ZIMMessagePinStatus pinStatus

消息置顶状态。

message

public ZIMMessage message

根消息对象。

ZIMMessageQueryConfig

查询消息配置。

详情

查询消息的相关配置。

Declared in entity/ZIMConversationDeleteConfig.java

属性

nextMessage

public ZIMMessage nextMessage

查询消息的锚点。

是否必填：首次查询时不必填，后续分页查询时，需要填此参数。

count

public int count

查询消息的条数。

是否必填：必填。

reverse

public Boolean reverse

是否反序查询的标志。

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

ZIMMessageReaction

表态具体内容。

详情

表态具体内容。

Declared in entity/ZIMMessageReaction.java

属性

conversationID

public String conversationID

会话 ID。

conversationType

public ZIMConversationType conversationType

会话类型。

messageID

public long messageID

表态的消息 ID。

reactionType

public String reactionType

表态类型，由您定义，长度上限为 32 字节。

isSelfIncluded

public boolean isSelfIncluded

已表态用户中是否包含自己。

totalCount

public int totalCount

表态的用户总数。

userList

public ArrayList<ZIMMessageReactionUserInfo> userList

表态的用户列表。

ZIMMessageReactionUserInfo

表态用户信息。

详情

描述表态用户的类。

Declared in entity/ZIMMessageReactionUserInfo.java

属性

userID

public String userID

用户 ID

ZIMMessageReactionUserQueryConfig

用于查询表态详情成员的配置。

详情

查询表态成员时，需要配置此对象。

Declared in entity/ZIMQueryMemberConfig.java

属性

nextFlag

public long nextFlag

分页查询的标识位，首次查询时，将此字段设为空字符串。若 [ZIMMessageReactionUserListQueriedCallback] 回调的 "nextFlag" 字段不是空字符串，说明还没结束，需要将其设置到此处以继续下一页的查询。

业务场景：开发者可根据该字段进行分页查询成员列表，第一次查询传空。
是否必填：非必填。
默认值：空。

count

public int count

一次获取多少表态的成员。上限为 100，超出 100 会导致错误。

业务场景：开发者可以根据该参数来决定一次需要查询多少房间成员。
是否必填：必填。

注意事项：分页获取表态成员以降低开销，建议单次获取 20 人以内。若该处填写值为 0，SDK 会默认查询 100 人。

reactionType

public String reactionType

表态类型，由您自行定义。

ZIMMessageReceiptInfo

回执信息。

详情

回执信息。

Declared in entity/ZIMMessageReceiptInfo.java

属性

status

public ZIMMessageReceiptStatus status

回执的状态。

messageID

public long messageID

消息ID。

业务场景：开发者可根据这个ID 匹配已经加载过的消息列表。
是否必填：否，SDK填充。

conversationID

public String conversationID

会话ID。

业务场景：用于表示这是属于哪个会话的回执信息。
是否必填：否，SDK填充。

conversationType

public ZIMConversationType conversationType

会话类型。

业务场景：用于表示这个会话所属类型。
是否必填：否，SDK填充。

readMemberCount

public int readMemberCount

表示该回执的已读人数。

业务场景：用于查询回执的信息时，可显示该消息已被多少人已读。
是否必填：否。
默认值：0。

注意事项：该值表示有多少人已读过该消息，仅适用于消息已读；如果是非自己发送的消息，该值为0。

unreadMemberCount

public int unreadMemberCount

表示该回执的未读人数。

业务场景：用于查询回执的信息时，可显示该消息已被多少人未读。
是否必填：否。
默认值：0。

注意事项：该值表示有多少人还没读过该消息，仅适用于消息已读；如果是非自己发送的消息，该值为0。

isSelfOperated

public boolean isSelfOperated

多端登录场景时，A 设备设置消息回执已读后，其他在线多端设备用于区分是否自己设置的消息回执已读。

readTime

public long readTime

消息回执已读时的服务端时间戳。

默认值：0。

注意事项：对应消息发送者，其值为会话成员全部已读时的时间戳，对于消息接收者，其值为设置消息回执已读时的时间戳。

ZIMMessageReceivedInfo

消息接收事件携带相关信息的结构体。

详情

消息接收事件携带相关信息的结构体。

支持版本：2.18.0 及以上版本。

Declared in ZIMMessageReceivedInfo.java

属性

isOfflineMessage

public boolean isOfflineMessage

消息是否为当前用户离线、短暂断网、登出期间发送，是的话为 true。

ZIMMessageRepliedInfo

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

Declared in entity/ZIMMessageRepliedInfo.java

属性

state

public ZIMMessageRepliedInfoState state

源消息状态。

sentTime

public long sentTime

源消息的发送服务端时间戳（UTC）。

senderUserID

public String senderUserID

源消息的发送者用户 ID。

messageSeq

public long messageSeq

源消息的seq。

messageInfo

public ZIMMessageLiteInfo messageInfo

源消息的简要信息。

messageID

public long messageID

源消息 ID。

ZIMMessageRepliedListQueryConfig

用于查询回复消息列表的配置。

Declared in entity/ZIMMessageRepliedListQueryConfig.java

属性

nextFlag

public long nextFlag

分页查询的标识位，首次查询时，将此字段设为0。若 [queryMessageRepliedList] 回调的 "nextFlag" 字段不为0，说明还没结束，需要将其设置到此处以继续下一页的查询。

count

public int count

单次查询的数量。上限为 100，超出 100 会导致错误。

是否必填：必填。

ZIMMessageRevokeConfig

详情

撤回消息的相关配置。

Declared in entity/ZIMConversationDeleteConfig.java

属性

revokeExtendedData

public String revokeExtendedData

撤回附加消息。

是否必填：非必填。

pushConfig

public ZIMPushConfig pushConfig

发送离线推送的相关配置，如果集成了 Android 或 iOS 平台，强烈建议配置该项。

是否必填：非必填。

ZIMMessageRootRepliedCountInfo

回复消息树的回复数量的信息。

Declared in entity/ZIMMessageRootRepliedCountInfo.java

属性

conversationID

public String conversationID

会话 ID。

conversationType

public ZIMConversationType conversationType

会话类型。

messageID

public long messageID

根消息 ID。

count

public int count

回复消息树的回复数量。

ZIMMessageRootRepliedInfo

回复消息树的根消息的描述信息。

Declared in entity/ZIMMessageRootRepliedInfo.java

属性

state

public ZIMMessageRepliedInfoState state

根消息状态。

sentTime

public long sentTime

根消息的发送时间戳。

senderUserID

public String senderUserID

根消息的发送者用户 ID。

repliedCount

public int repliedCount

回复消息树的回复数量。

message

public ZIMMessage message

根消息对象。

ZIMMessageSearchConfig

消息搜索配置。

详情

消息搜索配置。

Declared in entity/ZIMMessageSearchConfig.java

属性

nextMessage

public ZIMMessage nextMessage

分页拉取标志，即指拉取 nextMessage 之后或之前的消息，“之后”或“之前”由 order 值决定。第一次搜索时，nextMessage 为 null。之后搜索时，nextMessage 需传入上次查询到的消息列表的最后一条消息。

是否必填：否。

count

public int count

数量。建议小于 20 条，以降低性能开销。

是否必填：必填。

order

public ZIMMessageOrder order

搜索消息时 "order" 为 "DESCENDING" 时，表示对发送时间比 nextMessage 早的消息进行查询。若是首次查询消息时（即 nextMessage 为 null），则从本地存储的最后一条消息向前查询。"order" 为 "ASCENDING" 时，表示对发送时间比 nextMessage 晚的消息进行查询。若是首次查询消息时（即 nextMessage 为 null），则从本地存储的第一条消息向后查询。默认为 "DESCENDING"。

keywords

public ArrayList\<String> keywords

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

是否必填：否。

messageTypes

public ArrayList<ZIMMessageType> messageTypes

消息类型，可用于指定消息类型。支持传入多个类型。

是否必填：否。

subMessageTypes

public ArrayList\<Integer> subMessageTypes

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

是否必填：否。

senderUserIDs

public ArrayList\<String> senderUserIDs

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

是否必填：否。

startTime

public long startTime

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

是否必填：否。

endTime

public long endTime

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

是否必填：否。

ZIMMessageSendConfig

详情

发送消息的相关配置。

Declared in entity/ZIMMessageSendConfig.java

属性

pushConfig

public ZIMPushConfig pushConfig

发送离线推送的相关配置，如果集成了 Android 或 iOS 平台，强烈建议配置该项。

是否必填：非必填。

priority

public ZIMMessagePriority priority

用于设置消息优先级的枚举值。

是否必填：必填。

hasReceipt

public boolean hasReceipt

发送消息时候，该消息是否带回执。

业务场景：需要为一条消息带上回执时使用。
是否必填：非必填。
默认值：false。

isNotifyMentionedUsers

public boolean isNotifyMentionedUsers

发送消息时候，是否离线推送通知该消息提及到的用户。

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

isRetrySend

public boolean isRetrySend

是否重发发送失败的消息。

是否必填：否。

disableUnreadMessageCount

public boolean disableUnreadMessageCount

标识本次发送的消息是否不计入未读消息数。

业务场景：需要发送一条不计入未读消息数的消息时，需要将该参数置为 true。
是否必填：否。
默认值：false。

ZIMMessageSentStatusChangeInfo

消息状态变更通知。

详情

消息状态变更通知。

Declared in entity/ZIMMessageSentStatusChangeInfo.java

属性

message

public ZIMMessage message

消息详情。

status

public ZIMMessageSentStatus status

消息发送的状态。

reason

public String reason

此字段记录服务端发送前回调拦截消息导致 ZIM 拒绝发送的原因。若您开通了 ZIM 内容审核服务，并需在此字段中获取审核未通过导致的失败原因，请联系 ZEGO 技术支持进行配置。

ZIMMultipleMessage

组合消息对象。

详情

标识一条组合消息。

注意事项：仅支持文本、图片、文件、音频、视频、自定义消息的组合，且数量不超过 20 个。

Declared in entity/ZIMFileMessage.java

属性

messageInfoList

public ArrayList<ZIMMessageLiteInfo> messageInfoList

可包含文本、图片、文件、音频、视频、自定义消息，数组长度不超过 20。

业务场景：可用于发送图文组合消息。

注意事项：总的 item 数量不超过 20，图片最多10个，文件、音频、视频、自定义消息最多各 1 个。其中图片、文件、音频、视频的大小和格式的限制与对应的富媒体消息一致。

type

public ZIMMessageType type

消息类型。

messageID

public long messageID

标识这条消息的唯一 ID。

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

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

timestamp

public long timestamp

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

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

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

senderUserID

public String senderUserID

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

conversationID

public String conversationID

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

direction

public ZIMMessageDirection direction

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

sentStatus

public ZIMMessageSentStatus sentStatus

描述消息的发送状态。

conversationType

public ZIMConversationType conversationType

该消息所属会话的类型。

conversationSeq

public long conversationSeq

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

orderKey

public long orderKey

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

localMessageID

public long localMessageID

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

isUserInserted

public boolean isUserInserted

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

默认值：false。

receiptStatus

public ZIMMessageReceiptStatus receiptStatus

描述该消息的回执状态。

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

extendedData

public String extendedData

消息拓展字段。

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

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

localExtendedData

public String localExtendedData

isBroadcastMessage

public boolean isBroadcastMessage

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

是否必填：SDK内部赋值。

isMentionAll

private boolean isMentionAll

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

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

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

支持版本 : 2.14.0 及以上。

mentionedUserIDs

private ArrayList\<String> mentionedUserIDs

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

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

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

支持版本 : 2.14.0 及以上。

messageSeq

public long messageSeq

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

rootRepliedCount

public int rootRepliedCount

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

repliedInfo

public ZIMMessageRepliedInfo repliedInfo

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

editorUserID

public String editorUserID

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

editedTime

public long editedTime

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

isGroupTargetedMessage

public boolean isGroupTargetedMessage

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

pinnedUserID

public String pinnedUserID

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

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

pinnedTime

public long pinnedTime

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

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

ZIMMultipleMessageLiteInfo

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

详情

标识一条组合消息。

Declared in entity/ZIMAudioMessageLiteInfo.java

属性

messageInfoList

public ArrayList<ZIMMessageLiteInfo> messageInfoList

组合消息的元素列表。

type

public ZIMMessageType type

消息类型。

ZIMOfflinePushPrivateMessageTemplate

离线推送私信模版。

详情

根据 OPUSH私信模版校验能力接入说明,OPPO 在新消息分类的基础上新增了推送私信模版，当您在 OPPO 控制台配置好私信模版后，如需在推送时应用对应模版，可在 ZIMPushConfig 为 privateMessageTemplate 赋值。

Declared in ZIM.java

属性

templateID

public String templateID

OPPO 推送私信模板 ID，下发对应私信模板时必须携带。如果resourceID 中 OPPO 的 category 设置分类为内容与营销，则此字段无效。详细请参见 [OPUSH私信模版校验能力接入说明](https://open.oppomobile.com/documentation/page/info?id=12391

titleParameters

public String titleParameters

json 字符串， OPPO 推送标题模板填充参数。例：私信模板 ID 标题模板为：欢迎来到 $\{city\}$ ， $\{city\}$ 欢迎您。此参数内容为："{"city":"北京"}"。

contentParameters

public String contentParameters

json 字符串，OPPO 推送内容模板填充参数。例：私信模板 ID 对应的内容模板为：欢迎 $\{userName\}$ 来到 $\{city\}$ 。此参数内容为："{"userName":"汤姆"，"city":"深圳市"}"。

ZIMPushConfig

详情描述:离线推送配置。

详情

发送离线推送前的配置。

Declared in entity/ZIMConversationDeleteConfig.java

属性

title

public String title

用于设置推送标题。

是否必填：非必填。

content

public String content

用于设置离线推送的内容。

是否必填：非必填。

payload

public String payload

用于设置离线推送的透传字段。

是否必填：非必填。

resourcesID

public String resourcesID

由开发者自定义，长度不超过 32 个字符的字符串，用于映射多个厂商进阶配置的离线推送字段，将多个厂商的推送配置抽象为一种您自定的推送策略。详细介绍与配置步骤请参考 resourcesID 说明。

默认值：在未设置 resourceID 的情况下，推送类型为普通弹窗推送（APNs 为 Alert，FCM 为 Notification Message）。
是否必填：非必填。

enableBadge

public boolean enableBadge

推送是否携带角标信息开关。

badgeIncrement

public int badgeIncrement

推送携带的增量角标数。

voIPConfig

public ZIMVoIPConfig voIPConfig

如果您使用 Flutter、RN ZPNs, 离线推送接收端设备有 iOS 且使用了 VoIP 推送类型，可以通过该参数来自定义一些 VoIP 的选项。

privateMessageTemplate

public ZIMOfflinePushPrivateMessageTemplate privateMessageTemplate

如果您使用 OPPO 推送，可以通过该结构来应用 OPPO 私信模版，否则可以忽略，默认为空。

ZIMRevokeMessage

撤回消息对象基类。

详情

标识一条撤回消息。

注意事项：该基类是所有撤回消息的基础，包含撤回消息所需要的属性。

Declared in entity/ZIMFileMessage.java

属性

revokeType

public ZIMRevokeType revokeType

撤回类型。

revokeStatus

public ZIMMessageRevokeStatus revokeStatus

撤回状态。

revokeTimestamp

public int revokeTimestamp

撤回时间戳。

operatedUserID

public String operatedUserID

撤回操作者的用户 ID。

revokeExtendedData

public String revokeExtendedData

撤回附带的消息。

originalMessageType

public ZIMMessageType originalMessageType

原始消息类型。

originalTextMessageContent

public String originalTextMessageContent

原始消息内容。

type

public ZIMMessageType type

消息类型。

messageID

public long messageID

标识这条消息的唯一 ID。

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

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

timestamp

public long timestamp

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

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

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

senderUserID

public String senderUserID

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

conversationID

public String conversationID

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

direction

public ZIMMessageDirection direction

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

sentStatus

public ZIMMessageSentStatus sentStatus

描述消息的发送状态。

conversationType

public ZIMConversationType conversationType

该消息所属会话的类型。

conversationSeq

public long conversationSeq

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

orderKey

public long orderKey

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

localMessageID

public long localMessageID

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

isUserInserted

public boolean isUserInserted

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

默认值：false。

receiptStatus

public ZIMMessageReceiptStatus receiptStatus

描述该消息的回执状态。

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

extendedData

public String extendedData

消息拓展字段。

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

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

localExtendedData

public String localExtendedData

isBroadcastMessage

public boolean isBroadcastMessage

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

是否必填：SDK内部赋值。

isMentionAll

private boolean isMentionAll

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

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

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

支持版本 : 2.14.0 及以上。

mentionedUserIDs

private ArrayList\<String> mentionedUserIDs

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

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

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

支持版本 : 2.14.0 及以上。

messageSeq

public long messageSeq

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

rootRepliedCount

public int rootRepliedCount

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

repliedInfo

public ZIMMessageRepliedInfo repliedInfo

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

editorUserID

public String editorUserID

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

editedTime

public long editedTime

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

isGroupTargetedMessage

public boolean isGroupTargetedMessage

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

pinnedUserID

public String pinnedUserID

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

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

pinnedTime

public long pinnedTime

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

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

ZIMRevokeMessageLiteInfo

撤回消息的简要信息对象。

Declared in entity/ZIMRevokeMessageLiteInfo.java

属性

type

public ZIMMessageType type

消息类型。

ZIMRoomAdvancedConfig

房间高级属性配置。

详情

房间的高级属性配置。

Declared in entity/ZIMRoomAdvancedConfig.java

属性

roomAttributes

public public HashMap<String, String> roomAttributes

房间中的房间属性，用户可以自定义

是否必填：是。

roomDestroyDelayTime

public int roomDestroyDelayTime

房间延迟销毁时间，单位为秒。最长房间延迟销毁时间是3小时。

业务场景：房间人数为0时，设置房间时间，保证这段时间内房间的存在。
是否必填：非必填。

ZIMRoomAttributesBatchOperationConfig

房间属性设置的行为属性。

详情

房间属性设置的行为属性。

Declared in entity/ZIMRoomAttributesBatchOperationConfig.java

属性

isDeleteAfterOwnerLeft

public boolean isDeleteAfterOwnerLeft

业务场景：语聊房场景中，麦位上的人被踢出后，自动删除麦位信息。
是否必填：非必填。
默认值：false。

isForce

public boolean isForce

是否可以强制修改其他用户的房间属性。如果为true，则可以修改其他用户的房间属性，如果为false，则不允许修改其他用户的房间属性。

业务场景：语聊房场景中，房主强制修改麦位信息。
是否必填：非必填。
默认值：false。

isUpdateOwner

public boolean isUpdateOwner

是否更新涉及到的房间属性的拥有者。

业务场景：强行变更该房间属性的拥有人为操作者。
是否必填：非必填。
默认值：false。

ZIMRoomAttributesDeleteConfig

房间属性删除的行为属性。

详情

房间属性删除的行为属性。

Declared in entity/ZIMRoomAttributesDeleteConfig.java

属性

isForce

public boolean isForce

是否可以强制删除其他用户的房间属性。如果为true，则可以删除其他用户的房间属性，如果为false，则不允许删除其他用户的房间属性。

业务场景：语聊房场景中，房主强制删除麦位信息。
是否必填：非必填。
默认值：false。

ZIMRoomAttributesSetConfig

房间属性设置的行为属性。

详情

房间属性设置的行为属性。

Declared in entity/ZIMRoomAttributesSetConfig.java

属性

isDeleteAfterOwnerLeft

public boolean isDeleteAfterOwnerLeft

房间属性在拥有者离开房间后自动删除。

业务场景：语聊房场景中，麦位上的人被踢出后，自动删除麦位信息。
是否必填：非必填。
默认值：false。

isForce

public boolean isForce

是否可以强制修改其他用户的房间属性。如果为true，则可以修改其他用户的房间属性，如果为false，则不允许修改其他用户的房间属性。

业务场景：语聊房场景中，房主强制修改麦位信息。
是否必填：非必填。
默认值：false。

isUpdateOwner

public boolean isUpdateOwner

是否更新涉及到的房间属性的拥有者。

业务场景：强行变更该房间属性的拥有人为操作者。
是否必填：非必填。
默认值：false。

ZIMRoomAttributesUpdateInfo

房间属性变更通知。

详情

房间属性变更通知。

Declared in entity/ZIMRoomAttributesUpdateInfo.java

属性

action

public ZIMRoomAttributesUpdateAction action

房间属性变更通知的行为信息。

是否必填：是。

roomAttributes

public HashMap<String, String> roomAttributes

房间属性。

是否必填：否。

ZIMRoomFullInfo

房间详细资料对象。

详情

标识一个房间的详细资料。

Declared in entity/ZIMRoomFullInfo.java

属性

baseInfo

public ZIMRoomInfo baseInfo

房间基类对象。

ZIMRoomInfo

房间资料基础对象。

详情

标识一个唯一房间。

Declared in entity/ZIMRoomInfo.java

属性

roomID

public String roomID

房间 ID，最大 128 字节的字符串，由开发者自定义生成。

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

roomName

public String roomName

房间名，由开发者自定义生成，最大长度不超过 64 字节的字符串。

是否必填：必填。

ZIMRoomMemberAttributesInfo

房间用户属性信息。

详情

描述房间用户属性的类，包含 UserID 以及其对应的属性。

Declared in entity/ZIMRoomMemberAttributesInfo.java

属性

userID

public String userID

用户 ID。

attributes

public HashMap<String, String> attributes

房间用户属性。

ZIMRoomMemberAttributesOperatedInfo

房间用户属性操作信息。

详情

房间用户属性操作信息，包含成功操作的属性与失败的 Key。

Declared in entity/ZIMRoomMemberAttributesOperatedInfo.java

属性

attributesInfo

public ZIMRoomMemberAttributesInfo attributesInfo

房间用户属性信息。

errorKeys

public ArrayList<String> errorKeys

房间用户属性操作失败的 Key。

ZIMRoomMemberAttributesQueryConfig

房间用户属性查询配置。

详情

房间用户属性查询配置。

Declared in entity/ZIMRoomMemberAttributesQueryConfig.java

属性

nextFlag

public String nextFlag

房间用户属性的查询锚点。

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

count

public int count

分页查询的数量。

是否必填：必填。

ZIMRoomMemberAttributesSetConfig

房间用户属性设置配置。

详情

房间用户属性设置配置，包含可配置用户离开后是否保留用户属性等。

业务场景：开发者可以在设置房间用户属性时，根据自身的实际应用场景选择使用。

Declared in entity/ZIMRoomMemberAttributesSetConfig.java

属性

isDeleteAfterOwnerLeft

public boolean isDeleteAfterOwnerLeft

配置房间用户属性在用户离开房间后，是否保存下来。

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

ZIMRoomMemberAttributesUpdateInfo

房间用户属性更新信息。

详情

房间用户属性更新信息。

Declared in entity/ZIMRoomMemberAttributesUpdateInfo.java

属性

attributesInfo

public ZIMRoomMemberAttributesInfo attributesInfo

房间用户属性。

ZIMRoomMemberInfo

房间用户信息。

详情

描述房间用户的类。

Declared in entity/ZIMRoomMemberInfo.java

属性

userID

public String userID

用户 ID，由开发者自定义生成。

是否必填：必填。
取值范围：最大 32 字节的字符串。仅支持数字，英文字符和 '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'。
隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。

注意事项：注意 userID 在同一个 appID 下需唯一，否则会出现互踢的情况。强烈建议 userID 与业务 APP 的用户 ID 一一对应，即一个 userID 与一个真实用户是固定且唯一的，而不应该是以随机的 userID 的方式传给 SDK 的方式。因为唯一且固定的 userID 可以让 ZEGO 技术人员快速定位线上问题。

userName

public String userName

用户 name，由开发者自定义生成。

是否必填：非必填。
取值范围：2.0.0 及以后版本，支持最大 256 字节的字符串。
隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。

userAvatarUrl

public String userAvatarUrl

用户头像，由开发者自定义生成。

是否必填：非必填。
取值范围：特殊字符不受限制，最大长度为500字节。
隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。

支持版本：2.13.0 及以上。
注意事项：房间成员列表需要在 2.18.0 版本后才会返回该值。

userExtendedData

public String userExtendedData

用户的扩展字段信息。

注意事项：仅房间用户时，该属性有值。

ZIMRoomMemberQueryConfig

用于查询房间成员的配置。

详情

查找成员时，需要配置此对象。

Declared in entity/ZIMQueryMemberConfig.java

属性

nextFlag

public String nextFlag

分页查询的标识位，首次查询时，将此字段设为空字符串。若回调的 "nextFlag" 字段不是空字符串，说明还没结束，需要将其设置到此处以继续下一页的查询。

业务场景：开发者可根据该字段进行分页查询成员列表，第一次查询传空。
是否必填：非必填。
默认值：空。

count

public int count

一次获取多少房间成员。

业务场景：开发者可以根据该参数来决定一次需要查询多少房间成员。
是否必填：必填。

注意事项：分页获取房间成员以降低开销，建议单次获取 100 人以内。若该处填写值为 0，SDK 会默认查询 100 人。

ZIMRoomOperatedInfo

房间操作信息。

详情

房间操作信息。

Declared in entity/ZIMRoomOperatedInfo.java

属性

userID

public String userID

操作者的 UserID。

ZIMSelfUserInfo

携带当前用户的用户信息、规则。

详情

携带当前用户的用户信息、规则。

Declared in entity/ZIMUserRule.java

属性

userRule

public ZIMUserRule userRule

当前用户的规则，设置信息。

userFullInfo

public ZIMUserFullInfo userFullInfo

当前用户的个人信息。

ZIMSelfUserRule

用户自身的规则类。

Declared in entity/ZIMSelfUserRule.java

属性

offlinePushRule

public ZIMUserOfflinePushRule offlinePushRule

用户当前的规则信息。

ZIMSendingMessageCancelConfig

详情

（空类）取消发送消息的相关配置。

Declared in entity/ZIMSendingMessageCancelConfig.java

ZIMSubscribedUserStatusQueryConfig

querySubscribedUserStatusList 查询订阅列表接口的配置项。

详情

querySubscribedUserStatusList 查询订阅列表接口的配置项。

Declared in ZIMSubscribedUserStatusQueryConfig.java

属性

userIDs

public ArrayList\<String\> userIDs

如果您需要查询指定的用户是否在当前用户的订阅列表中，请传入该值，否则将会返回订阅表中的所有用户。

ZIMTextMessage

普通文本消息对象。

详情

标识一条普通文本消息。

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

Declared in entity/ZIMTextMessage.java

属性

message

public String message

消息的内容，支持任意数据。如果此消息的类型为 Text 文本消息，则应当为标准 UTF-8 字符串。

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

type

public ZIMMessageType type

消息类型。

messageID

public long messageID

标识这条消息的唯一 ID。

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

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

timestamp

public long timestamp

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

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

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

senderUserID

public String senderUserID

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

conversationID

public String conversationID

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

direction

public ZIMMessageDirection direction

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

sentStatus

public ZIMMessageSentStatus sentStatus

描述消息的发送状态。

conversationType

public ZIMConversationType conversationType

该消息所属会话的类型。

conversationSeq

public long conversationSeq

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

orderKey

public long orderKey

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

localMessageID

public long localMessageID

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

isUserInserted

public boolean isUserInserted

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

默认值：false。

receiptStatus

public ZIMMessageReceiptStatus receiptStatus

描述该消息的回执状态。

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

extendedData

public String extendedData

消息拓展字段。

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

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

localExtendedData

public String localExtendedData

isBroadcastMessage

public boolean isBroadcastMessage

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

是否必填：SDK内部赋值。

isMentionAll

private boolean isMentionAll

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

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

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

支持版本 : 2.14.0 及以上。

mentionedUserIDs

private ArrayList\<String> mentionedUserIDs

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

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

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

支持版本 : 2.14.0 及以上。

messageSeq

public long messageSeq

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

rootRepliedCount

public int rootRepliedCount

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

repliedInfo

public ZIMMessageRepliedInfo repliedInfo

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

editorUserID

public String editorUserID

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

editedTime

public long editedTime

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

isGroupTargetedMessage

public boolean isGroupTargetedMessage

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

pinnedUserID

public String pinnedUserID

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

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

pinnedTime

public long pinnedTime

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

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

方法

ZIMTextMessage

public ZIMTextMessage

Declared in entity/ZIMTextMessage.java

ZIMTextMessageLiteInfo

普通文本消息简要信息对象。

详情

标识一条普通文本消息的简要信息。

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

Declared in entity/ZIMTextMessageLiteInfo.java

属性

message

public String message

消息的内容，支持任意数据。如果此消息的类型为 Text 文本消息，则应当为标准 UTF-8 字符串。

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

type

public ZIMMessageType type

消息类型。

方法

ZIMTextMessageLiteInfo

public ZIMTextMessageLiteInfo

Declared in entity/ZIMTextMessageLiteInfo.java

ZIMTipsMessage

Tips 消息对象。

详情

标识一条 Tips 消息。

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

Declared in entity/ZIMTipsMessage.java

属性

event

public ZIMTipsMessageEvent event

Tips 消息对应的事件。

operatedUser

public ZIMUserInfo operatedUser

Tips 消息对应行为的触发者。

targetUserList

public ArrayList<ZIMUserInfo> targetUserList

Tips 消息对应操作的目标用户列表。

changeInfo

public ZIMTipsMessageChangeInfo changeInfo

Tips 消息对应操作的附加信息。

type

public ZIMMessageType type

消息类型。

messageID

public long messageID

标识这条消息的唯一 ID。

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

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

timestamp

public long timestamp

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

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

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

senderUserID

public String senderUserID

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

conversationID

public String conversationID

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

direction

public ZIMMessageDirection direction

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

sentStatus

public ZIMMessageSentStatus sentStatus

描述消息的发送状态。

conversationType

public ZIMConversationType conversationType

该消息所属会话的类型。

conversationSeq

public long conversationSeq

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

orderKey

public long orderKey

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

localMessageID

public long localMessageID

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

isUserInserted

public boolean isUserInserted

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

默认值：false。

receiptStatus

public ZIMMessageReceiptStatus receiptStatus

描述该消息的回执状态。

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

extendedData

public String extendedData

消息拓展字段。

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

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

localExtendedData

public String localExtendedData

isBroadcastMessage

public boolean isBroadcastMessage

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

是否必填：SDK内部赋值。

isMentionAll

private boolean isMentionAll

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

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

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

支持版本 : 2.14.0 及以上。

mentionedUserIDs

private ArrayList\<String> mentionedUserIDs

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

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

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

支持版本 : 2.14.0 及以上。

messageSeq

public long messageSeq

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

rootRepliedCount

public int rootRepliedCount

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

repliedInfo

public ZIMMessageRepliedInfo repliedInfo

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

editorUserID

public String editorUserID

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

editedTime

public long editedTime

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

isGroupTargetedMessage

public boolean isGroupTargetedMessage

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

pinnedUserID

public String pinnedUserID

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

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

pinnedTime

public long pinnedTime

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

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

ZIMTipsMessageChangeInfo

Tips 消息额外信息。

详情

Tips 消息额外信息。

Declared in entity/ZIMTipsMessageChangeInfo.java

属性

type

public ZIMTipsMessageChangeInfoType type

Tips 消息额外信息类型。

ZIMTipsMessageGroupChangeInfo

Tips 消息群相关变化事件附加信息。

详情

Tips 消息群相关变化事件附加信息。

Declared in entity/ZIMTipsMessageGroupChangeInfo.java

属性

groupDataFlag

public int groupDataFlag

如果群名，群头像，群公告存在复数变更，则需要由该字段的值知道哪些存在变更。其中 0b0001 是群名，0b0010 是群公告，0b0100 是群头像。

groupName

public String groupName

如果群名发生变更，则此处会展示变更后的值。

groupNotice

public String groupNotice

如果群名发生变更，则此处会展示变更后的值。

groupAvatarUrl

public String groupAvatarUrl

如果群头像发生变更，则此处会展示变更后的值。

groupMutedInfo

public ZIMGroupMuteInfo groupMutedInfo

如果群禁言状态发生变更，则此处会展示变更后的值。

type

public ZIMTipsMessageChangeInfoType type

Tips 消息额外信息类型。

ZIMTipsMessageGroupMemberChangeInfo

Tips 消息群成员相关变化事件附加信息。

详情

Tips 消息群成员相关变化事件附加信息。

Declared in entity/ZIMTipsMessageGroupMemberChangeInfo.java

属性

memberRole

public int memberRole

如果群成员角色发生了变化，这里会展示变更后的角色。

muteExpiredTime

public long muteExpiredTime

如果群成员禁言时间发生了变化，这里会展示新的禁言时间。

groupNewOwner

public ZIMGroupMemberSimpleInfo groupNewOwner

当群主离开群，或被服务端踢出群组时，群内新群主的信息。

业务场景：用于当群主离开群，或被服务端踢出群组时业务层做 UI 展示时使用。

type

public ZIMTipsMessageChangeInfoType type

Tips 消息额外信息类型。

ZIMTipsMessagePinStatusChangeInfo

Tips 消息群消息置顶状态变化事件附加信息。

详情

Tips 消息群消息置顶状态变化事件附加信息。

Declared in entity/ZIMTipsMessagePinStatusChangeInfo.java

属性

isPinned

public boolean isPinned

描述本次操作是置顶操作还是取消置顶操作。

type

public ZIMTipsMessageChangeInfoType type

Tips 消息额外信息类型。

ZIMUserFullInfo

用户详细资料对象。

详情

标识一个唯一用户。

注意事项：注意 userID 在同一个 appID 下需唯一，否则会出现互踢的情况。强烈建议 userID 与业务 APP 的用户 ID 一一对应，即一个 userID 与一个真实用户是固定且唯一的，而不应该是以随机的 userID 的方式传给 SDK 的方式。因为唯一且固定的 userID 可以让 ZEGO 技术人员快速定位线上问题。

Declared in entity/ZIMUserInfo.java

属性

baseInfo

public ZIMUserInfo baseInfo

用户基本信息。

是否必填：必填。

userAvatarUrl

deprecated

public String userAvatarUrl

用户头像 URL。

是否必填：非必填。

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

已废弃

废弃于 2.13.0 版本。如需获取用户头像 URL，请查看 baseInfo 的 userAvatarUrl。

extendedData

public String extendedData

用户扩展信息。

是否必填：非必填。
隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。

ZIMUserInfo

用户资料对象。

详情

标识一个唯一用户。

注意事项：注意 userID 在同一个 appID 下需唯一，否则会出现互踢的情况。强烈建议 userID 与业务 APP 的用户 ID 一一对应，即一个 userID 与一个真实用户是固定且唯一的，而不应该是以随机的 userID 的方式传给 SDK 的方式。因为唯一且固定的 userID 可以让 ZEGO 技术人员快速定位线上问题。

Declared in entity/ZIMUserInfo.java

属性

userID

public String userID

用户 ID，由开发者自定义生成。

是否必填：必填。
取值范围：最大 32 字节的字符串。仅支持数字，英文字符和 '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'。
隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。

注意事项：注意 userID 在同一个 appID 下需唯一，否则会出现互踢的情况。强烈建议 userID 与业务 APP 的用户 ID 一一对应，即一个 userID 与一个真实用户是固定且唯一的，而不应该是以随机的 userID 的方式传给 SDK 的方式。因为唯一且固定的 userID 可以让 ZEGO 技术人员快速定位线上问题。

userName

public String userName

用户 name，由开发者自定义生成。

是否必填：非必填。
取值范围：2.0.0 及以后版本，支持最大 256 字节的字符串。
隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。

userAvatarUrl

public String userAvatarUrl

用户头像，由开发者自定义生成。

是否必填：非必填。
取值范围：特殊字符不受限制，最大长度为500字节。
隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。

支持版本：2.13.0 及以上。
注意事项：房间成员列表需要在 2.18.0 版本后才会返回该值。

userExtendedData

public String userExtendedData

用户的扩展字段信息。

注意事项：仅房间用户时，该属性有值。

ZIMUserOfflinePushRule

用户离线推送规则的数据类。

详情

用户离线推送规则的数据类。

Declared in ZIMUserOfflinePushRule.java

属性

onlinePlatforms

public List\<int> onlinePlatforms

与该数据类中的 notToReceiveOfflinePushPlatforms 成员变量搭配使用。onlinePlatforms 指定的平台在线时，notToReceiveOfflinePushPlatforms 指定的平台将不会收到离线推送。

取值范围：请填入 ZIMPlatformType 枚举中平台对应的枚举值。

notToReceiveOfflinePushPlatforms

public List\<int> notToReceiveOfflinePushPlatforms

与该数据类中的 onlinePlatforms 成员变量搭配使用。onlinePlatforms 指定的平台在线时，notToReceiveOfflinePushPlatforms 指定的平台将不会收到离线推送。

取值范围：请填入 ZIMPlatformType 枚举中平台对应的枚举值。

ZIMUserStatus

用户状态相关数据。

详情

包含用户在线状态的相关数据。

Declared in ZIMUserStatus.java

属性

userID

public String userID

单个用户的唯一标识符。

onlineStatus

public ZIMUserOnlineStatus onlineStatus

表示用户当前在线状态的枚举。

onlinePlatforms

public List\<Number> onlinePlatforms

当前用户的在线平台列表，可以用于展示这名用户在哪些平台在线，如 iPhone 在线、电脑端在线。平台取值含义请参考 ZIMPlatform。

lastUpdateTime

public long lastUpdateTime

用户 onlineStatus 或 customStatus 最后一次变更时的时间戳,取两者较大值。

lastOnlineStatusUpdateTime

public long lastOnlineStatusUpdateTime

用户 onlineStatus 最后一次变更时的时间戳，可以用于展示 xxx 分钟前离线/登录。

lastCustomStatusUpdateTime

public long lastCustomStatusUpdateTime

用户 customStatus 最后一次变更时的时间戳，可以用于展示自定义状态的最后变更时间。

customStatus

public String customStatus

ZIMUserStatusSubscribeConfig

subscribeUsersStatus 批量订阅用户在线状态接口的配置项。

详情

批量订阅用户在线状态接口的配置项。

Declared in ZIMUserStatusSubscribeConfig.java

属性

subscriptionDuration

public int subscriptionDuration

用于设置这次订阅的有效时长。

是否必填：必填。
取值范围：1 ～ 43200（30 天），单位为分钟。

注意事项：超过订阅时长后，这名被订阅用户将会从订阅列表中删除，之后这名用户的状态变更，将不会再同步给订阅者。

ZIMUserStatusSubscription

用户态订阅信息。包含用户的在线状态、在线平台列表、订阅过期时间戳等。

详情

用户状态订阅信息。包含用户的在线状态、在线平台列表、订阅过期时间戳等。

支持版本：2.18.0

Declared in ZIMUserStatusSubscription.java

属性

userStatus

public ZIMUserStatus userStatus

这名用户的在线状态有关的数据。

subscribeExpiredTime

public long subscribeExpiredTime

这名用户订阅过期的时间戳。

ZIMUsersInfoQueryConfig

用户信息查询配置。

详情

详细描述：用户信息查询配置，可以选择从本地查询或者从服务端查询。从本地查询无限频约束，从服务端查询有限频约束，10 s 内最多只能查询 10 个用户详细配置。

Declared in ZIMDefines.java

属性

isQueryFromServer

public boolean isQueryFromServer

是否从服务端查询用户详细信息。从本地查询无限频约束，从服务端查询有限频约束，10 s 内最多只能查询 10 个用户详细配置。

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

ZIMVideoMessage

视频消息对象。

详情

标识一条视频消息。

使用限制：仅支持视频编码格式为 H264 和 H265 的视频文件在消息发送成功后获取该视频首帧的宽、高信息。
注意事项：回调时若基类的 Type 参数为 Video，可将基类消息对象强转为此类。

Declared in entity/ZIMVideoMessage.java

属性

videoDuration

public long videoDuration

视频文件的时长。

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

videoFirstFrameLocalPath

public String videoFirstFrameLocalPath

视频文件的首帧图本地路径。

是否必填：发送端不需要填，当调用 [downloadMediaFile] 下载之后， SDK 会生成该值。

videoFirstFrameDownloadUrl

public String videoFirstFrameDownloadUrl

视频文件的缩略图外部下载 URL。当开发者将首帧图上传到自己的服务器上时，可以通过该字段让 SDK 透传到其他用户中。

是否必填：发送端选填，当 fileDownloadUrl 填入后，该字段才生效。

videoFirstFrameWidth

public int videoFirstFrameWidth

视频首帧宽度。在 2.19.0 版本后对于透传图片消息（即该 URL 由客户自行传入的情况）支持传入，ZIM 会做透传处理；对于本地图片消息如果传入，ZIM 会在发送时检查是否正确，如果不正确将会自动纠正。

业务场景：用户需要绘出图片 UI 时，用于确定视频首帧宽度的参数,单位为像素。

videoFirstFrameHeight

public int videoFirstFrameHeight

视频首帧高度。在 2.19.0 版本后对于透传图片消息（即该 URL 由客户自行传入的情况）支持传入，ZIM 会做透传处理；对于本地图片消息如果传入，ZIM 会在发送时检查是否正确，如果不正确将会自动纠正。

业务场景：用户需要绘出图片 UI 时，用于确定视频首帧高度的参数,单位为像素。

fileLocalPath

public String fileLocalPath

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

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

fileDownloadUrl

public String fileDownloadUrl

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

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

fileUID

public String fileUID

媒体文件的唯一 ID。

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

fileName

public String fileName

媒体文件的文件名。

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

fileSize

public long fileSize

媒体文件的大小。

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

type

public ZIMMessageType type

消息类型。

messageID

public long messageID

标识这条消息的唯一 ID。

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

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

timestamp

public long timestamp

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

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

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

senderUserID

public String senderUserID

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

conversationID

public String conversationID

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

direction

public ZIMMessageDirection direction

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

sentStatus

public ZIMMessageSentStatus sentStatus

描述消息的发送状态。

conversationType

public ZIMConversationType conversationType

该消息所属会话的类型。

conversationSeq

public long conversationSeq

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

orderKey

public long orderKey

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

localMessageID

public long localMessageID

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

isUserInserted

public boolean isUserInserted

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

默认值：false。

receiptStatus

public ZIMMessageReceiptStatus receiptStatus

描述该消息的回执状态。

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

extendedData

public String extendedData

消息拓展字段。

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

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

localExtendedData

public String localExtendedData

isBroadcastMessage

public boolean isBroadcastMessage

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

是否必填：SDK内部赋值。

isMentionAll

private boolean isMentionAll

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

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

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

支持版本 : 2.14.0 及以上。

mentionedUserIDs

private ArrayList\<String> mentionedUserIDs

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

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

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

支持版本 : 2.14.0 及以上。

messageSeq

public long messageSeq

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

rootRepliedCount

public int rootRepliedCount

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

repliedInfo

public ZIMMessageRepliedInfo repliedInfo

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

editorUserID

public String editorUserID

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

editedTime

public long editedTime

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

isGroupTargetedMessage

public boolean isGroupTargetedMessage

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

pinnedUserID

public String pinnedUserID

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

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

pinnedTime

public long pinnedTime

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

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

ZIMVideoMessageLiteInfo

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

详情

标识一条视频消息。

使用限制：仅支持视频编码格式为 H264 和 H265 的视频文件在消息发送成功后获取该视频首帧的宽、高信息。

Declared in entity/ZIMVideoMessageLiteInfo.java

属性

videoDuration

public long videoDuration

视频文件的时长。

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

videoFirstFrameLocalPath

public String videoFirstFrameLocalPath

视频文件的首帧图本地路径。

是否必填：发送端不需要填，当调用 [downloadMediaFile] 下载之后， SDK 会生成该值。

videoFirstFrameDownloadUrl

public String videoFirstFrameDownloadUrl

视频文件的缩略图外部下载 URL。当开发者将首帧图上传到自己的服务器上时，可以通过该字段让 SDK 透传到其他用户中。

是否必填：发送端选填，当 fileDownloadUrl 填入后，该字段才生效。

videoFirstFrameWidth

public int videoFirstFrameWidth

视频首帧宽度。

业务场景：用户需要绘出图片 UI 时，用于确定视频首帧宽度的参数,单位为像素。

videoFirstFrameHeight

public int videoFirstFrameHeight

视频首帧高度。

业务场景：用户需要绘出图片 UI 时，用于确定视频首帧高度的参数,单位为像素。

fileLocalPath

public String fileLocalPath

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

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

fileDownloadUrl

public String fileDownloadUrl

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

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

fileName

public String fileName

媒体文件的文件名。

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

fileSize

public long fileSize

媒体文件的大小。

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

type

public ZIMMessageType type

消息类型。

ZIMVoIPConfig

提供发起 iOS VoIP 离线推送类型的信息。

详情

提供发起 iOS VoIP 离线推送类型的信息。

Declared in entity/ZIMVoIPConfig.java

属性

iOSVoIPHandleType

public ZIMCXHandleType iOSVoIPHandleType

VoIP 发起方联系信息类型，默认为不指定类型。

iOSVoIPHandleValue

public String iOSVoIPHandleValue

VoIP 发起方联系信息内容，与 iOSVoIPHandleType 相关。当 iOSVoIPHandleType 为 PhoneNumber 时，Value 为一串数字；当 iOSVoIPHandleType 为 EmailAddress 时，Value 为电子邮箱地址；当联系信息为其他类型时，Value 通常遵循某种特定格式，如用户名、数字 ID 或 URL。

iOSVoIPHasVideo

public boolean iOSVoIPHasVideo

是否为视频通话，默认为音频。

ZPNsConfig

ZPNs 推送配置类。

详情

ZPNs 推送配置类。

业务场景：在该类添加各厂商推送所需的配置项以及是否开启的布尔值。

Declared in ZPNs.java

属性

enableHWPush

public boolean enableHWPush

是否开启华为推送布尔值。

enableMiPush

public boolean enableMiPush

是否开启小米推送的布尔值。

enableVivoPush

public boolean enableVivoPush

是否开启 vivo 推送的布尔值。

miAppID

public String miAppID

小米推送所需 AppID。

miAppKey

public String miAppKey

小米推送所需AppKey。

oppoAppID

public String oppoAppID

oppo 推送所需 AppID。

oppoAppSecret

public String oppoAppSecret

oppo 推送所需的AppSecret。

oppoAppKey

public String oppoAppKey

oppo 推送所需的 AppKey。

vivoAppID

public String vivoAppID

vivo 推送所需的 AppID。

vivoAppKey

public String vivoAppKey

vivo 推送所需的 AppKey。

hwAppID

public String hwAppID

华为推送所需的 AppID。

enableFCMPush

public boolean enableFCMPush

是否开启谷歌推送布尔值。

enableOppoPush

public boolean enableOppoPush

是否开启 oppo 推送的布尔值。

enableHwBadge

public boolean enableHwBadge

当该设备为华为设备，并且做为接收端需要开启角标功能时设置为 true。

业务场景：请在 registerPush 调用前填写，并通过 setPushConfig 接口传入 ZPNs。
是否必填：非必填。
默认值：默认为 false。

apptype

private int apptype

用于指定当前项目对应 ZEGO 控制台的第几套离线推送配置。

业务场景：如需在不同 bundleID / 包名上使用相同的 AppID 时。
是否必填：非必填。
默认值：不设置该值的话，默认为第一套（1）。
建议值：应当与当前 bundle ID/包名相关的离线推送证书在 ZEGO 控制台上配置的 App type 保持一致。比如第二套的话这里填 2 。

方法

enableHWPush

public ZPNsConfig enableHWPush(String hwAppID)

用于启用华为 Push。

Declared in ZPNs.java

参数

名称	类型	描述
hwAppID	String	详情描述：用于开启华为厂商推送，同时传入华为 appID。

详情

用于启用华为 Push。

返回值

返回 ZPNsConfig。

enableMiPush

public ZPNsConfig enableMiPush(String miAppID, String miAppKey)

用于启用小米 Push。

Declared in ZPNs.java

参数

名称	类型	描述
miAppID	String	详情描述：小米 AppID。
miAppKey	String	详情描述：小米 AppKey。

详情

用于启用小米 Push。

返回值

返回 ZPNsConfig。

enableVivoPush

public ZPNsConfig enableVivoPush(String vivoAppID, String vivoAppKey)

用于启用vivo Push。

Declared in ZPNs.java

参数

名称	类型	描述
vivoAppID	String	详情描述：VIVO AppID。
vivoAppKey	String	详情描述：VIVO AppKey。

详情

用于启用vivo Push。

返回值

返回 ZPNsConfig。

enableOppoPush

public ZPNsConfig enableOppoPush(String oppoAppID, String oppoAppKey, String oppoAppSecret)

用于启用 oppo Push。

Declared in ZPNs.java

参数

名称	类型	描述
oppoAppID	String	详情描述：OPPO AppID。
oppoAppKey	String	详情描述：OPPO AppKey。
oppoAppSecret	String	详情描述：OPPO AppSecret。

详情

用于启用 oppo Push。

返回值

返回 ZPNsConfig。

enableFCMPush

public ZPNsConfig enableFCMPush()

用于启用谷歌 FCM Push。

Declared in ZPNs.java

用于启用谷歌 FCM Push。

返回 ZPNsConfig。

disableHWPush

public ZPNsConfig disableHWPush()

用于关闭华为 Push。

Declared in ZPNs.java

用于关闭华为 Push。

返回 ZPNsConfig。

disableMiPush

public ZPNsConfig disableMiPush()

用于关闭小米 Push。

Declared in ZPNs.java

用于关闭小米 Push。

返回 ZPNsConfig。

disableVivoPush

public ZPNsConfig disableVivoPush()

用于关闭 VIVO Push。

Declared in ZPNs.java

用于关闭 VIVO Push。

返回 ZPNsConfig。

disableOppoPush

public ZPNsConfig disableOppoPush()

用于关闭 VIVO Push。

Declared in ZPNs.java

用于关闭 VIVO Push。

返回 ZPNsConfig。

disableFCMPush

public ZPNsConfig disableFCMPush()

用于关闭谷歌 FCM Push。

Declared in ZPNs.java

用于关闭谷歌 FCM Push。

返回 ZPNsConfig。

setAppType

public void setAppType(int apptype)

用于指定当前项目对应 ZEGO 控制台的第几套离线推送配置，默认为第一套。详情请参考 apptype 下的说明。

Declared in ZPNs.java

名称	类型	描述
apptype	int	详情描述: 用于指定当前项目对应 ZEGO 控制台的第几套离线推送配置，默认为第一套。业务场景：如果您的同一个 ZEGO appID 没有用在不同 bundle ID/ 包名上请忽略。是否必填：非必填。默认值：不设置该值的话，默认为第一套。建议值：当前 bundle ID/ 包名在 ZEGO 控制台配置的离线推送配置位于第几套，这里填几，比如第二套的话这里填 2 。

ZPNsMessage

ZPNs 消息类。

详情

ZPNs 消息类。

业务场景：使用此数据类的对象获取推送信息的详细内容。

Declared in ZPNs.java

属性

title

public String title

消息标题, 如果是通知栏消息，则为通知栏标题。

content

public String content

消息内容，如果是通知栏则为消息通知栏内容，如果为透传消息，则为透传消息体。

注意事项：oppo 所有键值大小加起来不超过500个字符(备注：目前是每个值50个字符内，后续调整)。

pushType

public ZPNsType pushType

push 消息类型。

pushSource

public PushSource pushSource

push 来源。

extras

public Object extras

各个平台的传递的源对象, 需要判断进行类型转换。

notifyId

public int notifyId

通知栏ID。

ZPNsRegisterMessage

描述厂商推送 token 信息的消息类。

详情

描述厂商推送 token 信息的消息类。

业务场景：onRegister 被触发时会返回一个该数据类的对象，携带有关厂商推送 token 信息的消息类。

Declared in ZPNs.java

属性

errorCode

public ZPNsErrorCode errorCode

ZPNs 错误码。

msg

public String msg

请求返回的成功与错误信息。

pushID

public String pushID

ZPNs 生成的推送 ID。

commandResult

public String commandResult

命令返回的参数。

extra

public Object extra

各个平台的传递的源对象, 需要判断进行类型转换。

pushCmdType

public PushCmdType pushCmdType

push命令类型。