Struct
ZIMAppConfig
ZIM 应用配置，包含 AppID 和 AppSign。
Declared in ZIMDefines.cs
属性
appID
public uint appID- 是否必填：必填。
appSign
public string appSign- 是否必填：必填。
ZIMBarrageMessage
弹幕消息类。
详情
弹幕消息类，不会出现在会话中，也不会存入历史消息。
Declared in ZIMDefines.cs
属性
message
public string message弹幕消息内容。
type
messageID
public long messageID标识这条消息的唯一 ID。
- 业务场景：可用于索引其他消息。
- 注意事项：开发者主动创建一条消息时，不需要修改这个参数，此参数仅在回调时有值。
timestamp
public ulong timestamp标识一条消息的发送时间。
- 业务场景：用于呈现一条消息的发送时间，并可用于消息排序。
- 注意事项：此为标准 UNIX 时间戳，单位为毫秒。
message_length
public uint message_length消息的长度。如果此消息的类型为 Text 文本消息，则应当为字符串的长度。
- 是否必填：必填。
senderUserID
public string senderUserID展示本条消息发送者的 userID。
conversationID
public string conversationID会话的 ID，相同会话类型下的 ID 是唯一的。
direction
sentStatus
conversationType
conversationSeq
public ulong conversationSeq表示该消息在会话中的序号。
orderKey
public long orderKeyorderKey 越大消息越新，可用于消息排序。
localMessageID
public long localMessageIDSDK 本地生成的 MessageID,开发者无需关注。
isUserInserted
public bool isUserInserted该消息是否是开发者通过 [insertMessageToLocalDB] 接口插入的消息。
- 默认值：false。
receiptStatus
extendedData
public string extendedData消息拓展字段。
- 业务场景：可为消息附加拓展字段，然后发送给对端。
- 是否必填：否。
- 支持版本：2.6.0 及以上。
- 注意事项：长度为1k，可联系技术支持进行配置。
localExtendedData
public string localExtendedData仅本端可见的消息拓展字段，可附带额外的信息存储到本地，可通过 [updateMessageLocalExtendedData] 修改，目前长度的限制是 128K。如有特殊需求，可联系 ZEGO 技术支持进行配置。
isBroadcastMessage
public bool isBroadcastMessage该消息是否是全员推送消息。
- 是否必填：SDK内部赋值。
isMentionAll
public bool isMentionAll是否需要提醒所有人。业务表现可为“@所有人”。
- 业务场景：例如在群或者房间可使用。
- 是否必填：否。
- 默认值：false。
- 建议值：如果需要提醒所有人，可以设置为 true。
- 注意事项：该值并不会在消息文本上增加 @所有人 的字样，需要开发者自行实现。
支持版本 : 2.14.0 及以上。
mentionedUserIDs
public ArrayList\<String> mentionedUserIDs提醒一批相关的用户。业务表现可为“@某用户”。
- 业务场景：发消息时可以带上
- 是否必填：否。
- 注意事项：该值并不会在消息文本上增加 @某用户 的字样，需要开发者自行实现。
支持版本 : 2.14.0 及以上。
messageSeq
public ulong messageSeq表示该消息在会话中的序号。
rootRepliedCount
public uint rootRepliedCount回复消息树对应的根消息的回复消息数量。
repliedInfo
editorUserID
public string editorUserID本条消息最新的编辑者的 userID。
editedTime
public ulong editedTime本条消息最新的编辑时间戳。
isGroupTargetedMessage
public bool isGroupTargetedMessage标识该消息是否为群定向消息。
ZIMCallInvitationEndedInfo
结束呼叫的操作信息。
详情
结束呼叫的操作信息。
Declared in ZIM.cs
属性
caller
public string caller当前呼叫的主叫。
operatedUserID
public string operatedUserID结束呼叫的操作者。
extendedData
public string extendedData调用结束呼叫时附带的透传字段。
mode
endTime
public long endTime结束呼叫的时间戳，单位毫秒，格式: UTC 时间戳。
ZIMCallInvitationTimeoutInfo
有关超时通知的信息类。
详情
有关超时通知的信息类。
Declared in ZIMDefines.cs
属性
mode
ZIMCallJoinSentInfo
加入呼叫操作的结果信息。
详情
加入呼叫操作的结果信息。
Declared in ZIMDefines.cs
属性
createTime
public long createTime当次呼叫邀请的创建时间的时间戳。
joinTime
public long joinTime本人加入呼叫邀请的时间戳。
extendedData
public string extendedData调用结束呼叫时附带的透传字段。
callUserList
ZIMCallQuitSentInfo
退出呼叫操作的结果信息。
详情
退出呼叫操作的结果信息。
Declared in ZIMDefines.cs
属性
createTime
public long createTime当次呼叫邀请的创建时间的时间戳。
acceptTime
public long acceptTime本人接受呼叫邀请的时间戳。
quitTime
public long quitTime本人退出呼叫的时间戳。
ZIMCallUserStateChangeInfo
呼叫成员状态变化信息。
详情
呼叫成员状态变化信息。
Declared in ZIM.cs
属性
callUserList
ZIMCallingInvitationSentInfo
呼叫中邀请已发送信息。
详情
呼叫中邀请已发送信息。
Declared in ZIMDefines.cs
属性
errorUserList
ZIMConversationsAllDeletedInfo
删除全部会话通知的信息。
详情
删除全部会话通知的信息。
Declared in ZIMDefine.cs
属性
count
public uint count会话被删除的数目。
ZIMErrorUserInfo
失败用户信息类。
详情
用于展示失败的用户以及失败的原因。
Declared in ZIMDefines.cs
属性
userID
public string userIDuserID。
- 取值范围：最大 32 字节的字符串。仅支持数字，英文字符 和 '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'。
reason
public uint reason描述查询失败原因的 reason。
ZIMFileCacheInfo
文件缓存信息。
详情
文件缓存信息。
Declared in ZIMDefines.cs
属性
totalFileSize
public ulong totalFileSize总的文件大小，单位为字节（B）。
ZIMFriendApplicationInfo
好友申请信息。
详情
好友申请信息。
Declared in ZIMDefines.cs
属性
applyUser
wording
public string wording好友申请附言。
createTime
public int createTime好友添加时间。
updateTime
public int updateTime好友申请状态更新时间。
type
state
ZIMFriendInfo
好友信息。
详情
好友信息。
Declared in ZIMDefines.cs
属性
userID
public string userID操作者的 UserID。
friendAlias
public string friendAlias好友备注。
friendAttributes
public Record<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用户的扩展字段信息。
- 注意事项：仅房间用户时，该属性有值。
ZIMFriendRelationInfo
好友关系信息。
详情
好友关系信息。
Declared in ZIMDefines.cs
属性
userID
public string userID用户ID。
type
ZIMGroupApplicationInfo
入群申请信息。
Declared in ZIMDefines.cs
属性
applyUser
wording
public string wording入群申请附言。
createTime
public ulong createTime入群申请创建时间戳，单位为毫秒。
updateTime
public ulong updateTime入群申请状态更新时间，单位为毫秒。
type
public ZIMGroupApplicationType type入群申请类型。
state
public ZIMGroupApplicationState state入群申请状态。
groupInfo
operatedUser
public ZIMGroupMemberSimpleInfo operatedUser同意外部用户加群申请的操作人。
ZIMGroupConversation
群会话对象，继承自ZIMGroupConversation。
详情
群会话对象，继承自ZIMGroupConversation。
Declared in ZIMDefines.cs
属性
mutedExpiredTime
public long long mutedExpiredTime群禁言的过期时间。
isDisabled
public bool isDisabled这个群会话是否为不可用的状态。
conversationID
public string conversationID会话ID。
conversationName
public string conversationNameconversationName,与会话对应的 groupName/userName 值相同。
type
unreadMessageCount
public int unreadMessageCount会话未读数。
lastMessage
orderKey
public long orderKey用于描述消息在会话中的顺序，orderKey 越大越新。
notificationStatus
conversationAvatarUrl
public string conversationAvatarUrl会话头像 URL。单聊会话头像 URL 与用户头像 URL 相同，群聊会话头像 URL 与群头像 URL 相同。
- 使用限制： 最大 500 字节，无特殊字符限制。
isPinned
public bool isPinned会话是否置顶。
- 支持版本：2.8.0。
mentionedInfoList
public ArrayList<ZIMMessageMentionedInfo> mentionedInfoList当在会话的消息中被提醒到或者被提醒所有人时，该数组会有记录。
- 业务场景：比如可以在会话列表根据该数组显示当前会话有多少个提醒，还可以显示是哪个用户的提醒。
conversationAlias
public string conversationAlias会话别名，通过 [updateFriendAlias] 设置好友备注后，对应的单聊会话该参数会同步修改。通过 [updateGroupAlias] 设置群备注后，对应的群聊会话该参数会同步修改。
- 业务场景：为好友或群组设置备注后，渲染会话页时，对应的会话优先选择展示 alias 别名，而不是 conversation name（好友的用户名或群组名）。
marks
public std::vector\<int> marks描述了该会话现有的所有标记。
- 业务场景：业务层可以按照不同会话拥有的不同标记做分组逻辑等。
draft
public string draft会话草稿，当设置会话草稿后，会话中会带有该字段。
ZIMGroupInviteApplicationAcceptConfig
接受邀请入群申请的配置。
Declared in ZIMDefines.cs
属性
pushConfig
ZIMGroupInviteApplicationRejectConfig
拒绝邀请入群申请的配置。
Declared in ZIMDefines.cs
属性
pushConfig
ZIMGroupInviteApplicationSendConfig
发送邀请入群申请的配置。
Declared in ZIMDefines.cs
属性
wording
public string wording申请的附言。
pushConfig
ZIMGroupJoinApplicationAcceptConfig
接受加群申请的配置。
Declared in ZIMDefines.cs
属性
pushConfig
ZIMGroupJoinApplicationRejectConfig
拒绝加群申请的配置。
Declared in ZIMDefines.cs
属性
pushConfig
ZIMGroupJoinApplicationSendConfig
发送加群申请的配置。
Declared in ZIMDefines.cs
属性
wording
public string wording申请的附言。
pushConfig
ZIMMessageDeletedInfo
被删除的消息信息。
Declared in ZIMDefines.cs
属性
conversationID
public string conversationID会话 ID。
conversationType
messageList
isDeleteConversationAllMessage
public bool isDeleteConversationAllMessage是否删除会话当前所有消息。
messageDeleteType
public ZIMMessageDeleteType messageDeleteType[onMessageDeleted] 被触发的原因。
ZIMMessageReaction
表态具体内容。
详情
表态具体内容。
Declared in ZIMDefines.cs
属性
conversationID
public string conversationID会话 ID。
conversationType
messageID
public string messageID表态的消息 ID。
reactionType
public string reactionType表态类型，由您定义，长度上限为 32 字节。
isSelfIncluded
public bool isSelfIncluded已表态用户中是否包含自己。
totalCount
public uint totalCount表态的用户总数。
userList
ZIMMessageReactionUserInfo
表态用户信息。
详情
描述表态用户的类。
Declared in ZIMDefines.cs
属性
userID
public string userID用户 ID
ZIMMessageReceiptInfo
回执信息。
详情
回执信息。
Declared in ZIMDefines.cs
属性
status
messageID
public long messageID消息ID。
- 业务场景：开发者可根据这个ID 匹配已经加载过的消息列表。
- 是否必填：否，SDK填充。
conversationID
public string conversationID会话ID。
- 业务场景：用于表示这是属于哪个会话的回执信息。
- 是否必填：否，SDK填充。
conversationType
readMemberCount
public int readMemberCount表示该回执的已读人数。
- 业务场景：用于查询回执的信息时，可显示该消息已被多少人已读。
- 是否必填：否。
- 默认值：0。
- 注意事项：该值表示有多少人已读过该消息，仅适用于消息已读；如果是非自己发送的消息，该值为0。
unreadMemberCount
public int unreadMemberCount表示该回执的未读人数。
- 业务场景：用于查询回执的信息时，可显示该消息已被多少人未读。
- 是否必填：否。
- 默认值：0。
- 注意事项：该值表示有多少人还没读过该消息，仅适用于消息已读；如果是非自己发送的消息，该值为0。
isSelfOperated
public bool isSelfOperated多端登录场景时，A 设备设置消息回执已读后，其他在线多端设备用于区分是否自己设置的消息回执已读。
readTime
public ulong readTime消息回执已读时的服务端时间戳。
- 默认值：0。
- 注意事项：对应消息发送者，其值为会话成员全部已读时的时间戳，对于消息接收者，其值为设置消息回执已读时的时间戳。
ZIMMessageRepliedInfo
回复消息引用的源消息的描述信息。
Declared in ZIMDefines.cs
属性
state
public ZIMMessageRepliedInfoState state源消息状态。
sentTime
public ulong sentTime源消息的发送服务端时间戳（UTC）。
senderUserID
public string senderUserID源消息的发送者用户 ID。
messageSeq
public ulong messageSeq源消息的seq。
messageInfo
public ZIMMessageLiteInfo messageInfo源消息的简要信息。
messageID
public ulong messageID源消息 ID。
ZIMMessageRootRepliedCountInfo
回复消息树的回复数量的信息。
Declared in ZIMDefines.cs
属性
conversationID
public string conversationID会话 ID。
conversationType
messageID
public ulong messageID根消息 ID。
count
public uint count回复消息树的回复数量。
ZIMMessageRootRepliedInfo
回复消息树的根消息的描述信息。
Declared in ZIMDefines.cs
属性
state
public ZIMMessageRepliedInfoState state根消息状态。
sentTime
public ulong sentTime根消息的发送时间戳。
senderUserID
public string senderUserID根消息的发送者用户 ID。
repliedCount
public uint repliedCount回复消息树的回复数量。
message
ZIMRoomMemberAttributesInfo
房间用户属性信息。
详情
描述房间用户属性的类，包含 UserID 以及其对应的属性。
Declared in ZIMDefines.cs
属性
userID
public string userID用户 ID。
attributes
public Record<string, string> attributes房间用户属性。
ZIMRoomMemberAttributesOperatedInfo
房间用户属性操作信息。
详情
房间用户属性操作信息，包含成功操作的属性与失败的 Key。
Declared in ZIMDefines.cs
属性
attributesInfo
errorKeys
public string[] errorKeys房间用户属性操作失败的 Key。
ZIMRoomMemberAttributesQueryConfig
房间用户属性查询配置。
详情
房间用户属性查询配置。
Declared in ZIMDefines.cs
属性
nextFlag
public string nextFlag房间用户属性的查询锚点。
- 是否必填：非必填，首次默认为空，表示从头开始查询。
count
public uint count分页查询的数量。
- 是否必填：必填。
ZIMRoomMemberAttributesSetConfig
房间用户属性设置配置。
详情
房间用户属性设置配置，包含可配置用户离开后是否保留用户属性等。
- 业务场景：开发者可以在设置房间用户属性时，根据自身的实际应用场景选择使用。
Declared in ZIMDefines.cs
属性
isDeleteAfterOwnerLeft
public bool isDeleteAfterOwnerLeft配置房间用户属性在用户离开房间后，是否保存下来。
- 是否必填：非必填。
- 默认值：true。
ZIMRoomMemberAttributesUpdateInfo
房间用户属性更新信息。
详情
房间用户属性更新信息。
Declared in ZIMDefines.cs
属性
attributesInfo
ZIMRoomMemberInfo
房间用户信息。
详情
描述房间用户的类。
Declared in ZIMDefines.cs
属性
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用户的扩展字段信息。
- 注意事项：仅房间用户时，该属性有值。
ZIMRoomOperatedInfo
房间操作信息。
详情
房间操作信息。
Declared in ZIMDefines.cs
属性
userID
public string userID操作者的 UserID。
ZIMSelfUserInfo
携带当前用户的用户信息、规则。
详情
携带当前用户的用户信息、规则。
Declared in ZIMDefines.cs
属性
userRule
public ZIMUserRule userRule当前用户的规则，设置信息。
userFullInfo
ZIMSelfUserRule
用户自身的规则类。
Declared in ZIMDefines.cs
属性
offlinePushRule
ZIMUserOfflinePushRule
用户离线推送规则的数据类。
详情
用户离线推送规则的数据类。
Declared in ZIMDefines.cs
属性
onlinePlatforms
public List\<int> onlinePlatforms与该数据类中的 notToReceiveOfflinePushPlatforms 成员变量搭配使用。onlinePlatforms 指定的平台在线时，notToReceiveOfflinePushPlatforms 指定的平台将不会收到离线推送。
- 取值范围：请填入 ZIMPlatformType 枚举中平台对应的枚举值。
notToReceiveOfflinePushPlatforms
public List\<int> notToReceiveOfflinePushPlatforms与该数据类中的 onlinePlatforms 成员变量搭配使用。onlinePlatforms 指定的平台在线时，notToReceiveOfflinePushPlatforms 指定的平台将不会收到离线推送。
- 取值范围：请填入 ZIMPlatformType 枚举中平台对应的枚举值。
ZIMVideoMessage
视频消息对象。
详情
标识一条视频消息。
- 使用限制：仅支持视频编码格式为 H264 和 H265 的视频文件在消息发送成功后获取该视频首帧的宽、高信息。
- 注意事项：回调时若基类的 Type 参数为 Video，可将基类消息对象强转为此类。
Declared in ZIMDefines.cs
属性
videoDuration
public ulong videoDuration视频文件的时长。
- 是否必填：发送本地视频时，发送端必填，不填会导致视频消息发送失败。
videoFirstFrameLocalPath
public string videoFirstFrameLocalPath视频文件的首帧图本地路径。
- 是否必填：发送端不需要填，当调用 [downloadMediaFile] 下载之后， SDK 会生成该值。
videoFirstFrameDownloadUrl
public string videoFirstFrameDownloadUrl视频文件的缩略图外部下载 URL。当开发者将首帧图上传到自己的服务器上时，可以通过该字段让 SDK 透传到其他用户中。
- 是否必填：发送端选填，当 fileDownloadUrl 填入后，该字段才生效。
videoFirstFrameWidth
public uint videoFirstFrameWidth视频首帧宽度。在 2.19.0 版本后对于透传图片消息（即该 URL 由客户自行传入的情况）支持传入，ZIM 会做透传处理；对于本地图片消息如果传入，ZIM 会在发送时检查是否正确，如果不正确将会自动纠正。
- 业务场景：用户需要绘出图片 UI 时，用于确定视频首帧宽度的参数,单位为像素。
videoFirstFrameHeight
public uint videoFirstFrameHeight视频首帧高度。在 2.19.0 版本后对于透传图片消息（即该 URL 由客户自行传入的情况）支持传入，ZIM 会做透传处理；对于本地图片消息如果传入，ZIM 会在发送时检查是否正确，如果不正确将会自动纠正。
- 业务场景：用户需要绘出图片 UI 时，用于确定视频首帧高度的参数,单位为像素。
videoFirstFrameSize
public CGSize videoFirstFrameSize视频首帧宽高。在 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 ulong fileSize媒体文件的大小。
- 是否必填：发送端不需要填，该值由 SDK 生成。
type
messageID
public long messageID标识这条消息的唯一 ID。
- 业务场景：可用于索引其他消息。
- 注意事项：开发者主动创建一条消息时，不需要修改这个参数，此参数仅在回调时有值。
timestamp
public ulong timestamp标识一条消息的发送时间。
- 业务场景：用于呈现一条消息的发送时间，并可用于消息排序。
- 注意事项：此为标准 UNIX 时间戳，单位为毫秒。
message_length
public uint message_length消息的长度。如果此消息的类型为 Text 文本消息，则应当为字符串的长度。
- 是否必填：必填。
senderUserID
public string senderUserID展示本条消息发送者的 userID。
conversationID
public string conversationID会话的 ID，相同会话类型下的 ID 是唯一的。
direction
sentStatus
conversationType
conversationSeq
public ulong conversationSeq表示该消息在会话中的序号。
orderKey
public long orderKeyorderKey 越大消息越新，可用于消息排序。
localMessageID
public long localMessageIDSDK 本地生成的 MessageID,开发者无需关注。
isUserInserted
public bool isUserInserted该消息是否是开发者通过 [insertMessageToLocalDB] 接口插入的消息。
- 默认值：false。
receiptStatus
extendedData
public string extendedData消息拓展字段。
- 业务场景：可为消息附加拓展字段，然后发送给对端。
- 是否必填：否。
- 支持版本：2.6.0 及以上。
- 注意事项：长度为1k，可联系技术支持进行配置。
localExtendedData
public string localExtendedData仅本端可见的消息拓展字段，可附带额外的信息存储到本地，可通过 [updateMessageLocalExtendedData] 修改，目前长度的限制是 128K。如有特殊需求，可联系 ZEGO 技术支持进行配置。
isBroadcastMessage
public bool isBroadcastMessage该消息是否是全员推送消息。
- 是否必填：SDK内部赋值。
isMentionAll
public bool isMentionAll是否需要提醒所有人。业务表现可为“@所有人”。
- 业务场景：例如在群或者房间可使用。
- 是否必填：否。
- 默认值：false。
- 建议值：如果需要提醒所有人，可以设置为 true。
- 注意事项：该值并不会在消息文本上增加 @所有人 的字样，需要开发者自行实现。
支持版本 : 2.14.0 及以上。
mentionedUserIDs
public ArrayList\<String> mentionedUserIDs提醒一批相关的用户。业务表现可为“@某用户”。
- 业务场景：发消息时可以带上
- 是否必填：否。
- 注意事项：该值并不会在消息文本上增加 @某用户 的字样，需要开发者自行实现。
支持版本 : 2.14.0 及以上。
messageSeq
public ulong messageSeq表示该消息在会话中的序号。
rootRepliedCount
public uint rootRepliedCount回复消息树对应的根消息的回复消息数量。
repliedInfo
editorUserID
public string editorUserID本条消息最新的编辑者的 userID。
editedTime
public ulong editedTime本条消息最新的编辑时间戳。
isGroupTargetedMessage
public bool isGroupTargetedMessage标识该消息是否为群定向消息。
ZIMVideoMessageLiteInfo
视频消息的简要信息对象。
详情
标识一条视频消息。
- 使用限制：仅支持视频编码格式为 H264 和 H265 的视频文件在消息发送成功后获取该视频首帧的宽、高信息。
Declared in ZIMDefines.cs
属性
videoDuration
public ulong videoDuration视频文件的时长。
- 是否必填：发送本地视频时，发送端必填，不填会导致视频消息发送失败。
videoFirstFrameLocalPath
public string videoFirstFrameLocalPath视频文件的首帧图本地路径。
- 是否必填：发送端不需要填，当调用 [downloadMediaFile] 下载之后， SDK 会生成该值。
videoFirstFrameDownloadUrl
public string videoFirstFrameDownloadUrl视频文件的缩略图外部下载 URL。当开发者将首帧图上传到自己的服务器上时，可以通过该字段让 SDK 透传到其他用户中。
- 是否必填：发送端选填，当 fileDownloadUrl 填入后，该字段才生效。
videoFirstFrameWidth
public uint videoFirstFrameWidth视频首帧宽度。
- 业务场景：用户需要绘出图片 UI 时，用于确定视频首帧宽度的参数,单位为像素。
videoFirstFrameHeight
public uint videoFirstFrameHeight视频首帧高度。
- 业务场景：用户需要绘出图片 UI 时，用于确定视频首帧高度的参数,单位为像素。
fileLocalPath
public string fileLocalPath媒体消息的文件的本地绝对路径。
- 是否必填：如果发送本地文件，则发送端必填，否则消息会发送失败。
fileDownloadUrl
public string fileDownloadUrl媒体消息的外部下载 URL，用于开发者将媒体文件上传到自己的服务器中时，通过填入该 URL 让 SDK 透传到其他用户中。
- 是否必填：如果发送的是外部 URL，发送端必填。
fileName
public string fileName媒体文件的文件名。
- 是否必填：如果发送的是外部 URL，则需要填写该值，且需要包含文件扩展名。如果发送的是本地文件，该值选填。
fileSize
public ulong fileSize媒体文件的大小。
- 是否必填：发送端不需要填，该值由 SDK 生成。
ZIMVoIPConfig
提供发起 iOS VoIP 离线推送类型的信息。
详情
提供发起 iOS VoIP 离线推送类型的信息。
Declared in ZIMDefines.cs
属性
iOSVoIPHandleType
iOSVoIPHandleValue
public string iOSVoIPHandleValueVoIP 发起方联系信息内容，与 iOSVoIPHandleType 相关。当 iOSVoIPHandleType 为 PhoneNumber 时，Value 为一串数字；当 iOSVoIPHandleType 为 EmailAddress 时，Value 为电子邮箱地址；当联系信息为其他类型时，Value 通常遵循某种特定格式，如用户名、数字 ID 或 URL。
iOSVoIPHasVideo
public bool iOSVoIPHasVideo是否为视频通话，默认为音频。