Struct
ZIMError
错误信息。
详情
错误信息。
Declared in ZIMDefines.h
属性
code
ZIMErrorCode code详情描述：错误码枚举值。
message
std::string message详情描述：错误信息描述。
ZIMAppConfig
ZIM 应用配置，包含 AppID 和 AppSign。
Declared in ZIMDefines.h
属性
appID
unsigned int appID详情描述：AppID，请到 ZEGO 官网控制台申请获取。是否必填：必填。
appSign
std::string appSign详情描述：AppSign，请到 ZEGO 官网控制台申请获取。是否必填：必填。
ZIMLogConfig
日志配置。
详情
配置日志文件保存路径和日志文件大小上限。
Declared in ZIMDefines.h
属性
logPath
std::string logPath详情描述：日志文件的存储路径，默认路径参考官网文档。是否必填：非必填。默认值：Android：/storage/Android/data/[packageName]/files/ZIMLogsiOS：/Library/Caches/ZIMLogsmacOS：（沙箱）/Library/Containers/[Bundle ID]/Data/Library/Caches/ZIMLogs / ；（非沙箱）~/Library/Caches/ZIMLogsWindows：C:\Users[Your UserName]\AppData[App Name]ZEGO.SDK\ZIMLogs建议值：建议使用默认值。注意事项：请注意设置的目录是否有读写权限，否则会导致 SDK 无法正确执行。
logSize
unsigned long long logSize详情描述：日志文件大小上限 (Bytes)。是否必填：非必填。默认值：默认大小 5MB (5 * 1024 * 1024 Bytes)。建议值：建议使用默认大小，太大会导致磁盘占用过多，太小会导致日志记录不全。
ZIMCacheConfig
缓存配置。
详情
配置缓存文件（例如聊天记录）的存储路径。
Declared in ZIMDefines.h
属性
cachePath
std::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 无法正确执行。
ZIMUserInfo
用户资料对象。
详情
标识一个唯一用户。
Declared in ZIMDefines.h
属性
userID
std::string userID用户 ID，由开发者自定义生成。取值范围：最大 32 字节的字符串。仅支持数字，英文字符 和 '!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'。注意事项：注意 userID 在同一个 appID 下需唯一，否则会出现互踢的情况。强烈建议 userID 与业务 APP 的用户 ID 一一对应，即一个 userID 与一个真实用户是固定且唯一的，而不应该是以随机的 userID 的方式传给 SDK 的方式。因为唯一且固定的 userID 可以让 ZEGO 技术人员快速定位线上问题。隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。
userName
std::string userName用户 name，由开发者自定义生成。是否必填：非必填。取值范围：2.0.0 及以后版本，支持最大 256 字节的字符串。隐私保护声明：不要传入涉及个人隐私的敏感信息，包括但不限于手机号、身份证号、护照编号、真实姓名等。
userAvatarUrl
std::string userAvatarUrl用户头像。
userExtendedData
std::string userExtendedData用户额外信息。该字段目前仅在房间相关接口中可用。
type
ZIMUserFullInfo
用户详细资料对象。
详情
标识一个唯一用户。
Declared in ZIMDefines.h
属性
baseInfo
ZIMUserOfflinePushRule
用户离线推送规则的数据类。
详情
用户离线推送规则的数据类。
Declared in ZIMDefines.h
属性
onlinePlatforms
std::vector<int> onlinePlatforms与该数据类中的 notToReceiveOfflinePushPlatforms 成员变量搭配使用。onlinePlatforms 指定的平台在线时，notToReceiveOfflinePushPlatforms 指定的平台将不会收到离线推送。
notToReceiveOfflinePushPlatforms
std::vector<int> notToReceiveOfflinePushPlatforms与该数据类中的 onlinePlatforms 成员变量搭配使用。onlinePlatforms 指定的平台在线时，notToReceiveOfflinePushPlatforms 指定的平台将不会收到离线推送。
ZIMUserRule
用户规则配置。
Declared in ZIMDefines.h
属性
offlinePushRule
ZIMUserStatus
用户状态相关数据。
详情
包含用户在线状态的相关数据。
Declared in ZIMDefines.h
属性
userID
std::string userID单个用户的唯一标识符。
onlineStatus
onlinePlatforms
std::vector<int> onlinePlatforms当前用户的在线平台列表，可以用于展示这名用户在哪些平台在线，如 iPhone 在线、电脑端在线。平台取值含义请参考 ZIMPlatform。
customStatus
std::string customStatus用户自定义状态，默认最大值为 64 字节，默认过期时间为 1 天，过期后重置为空字符串。登录时，如果该字段为空字符串（默认为空字符串），那么不会修改当前用户的自定义状态。
customStatusExpiredTime
long long customStatusExpiredTime自定义状态的过期时间。
lastUpdateTime
long long lastUpdateTime用户 onlineStatus 或 customStatus 最后一次变更时的时间戳,取两者较大值。
lastOnlineStatusUpdateTime
long long lastOnlineStatusUpdateTime用户 onlineStatus 最后一次变更时的时间戳，可以用于展示 xxx 分钟前离线/登录。
lastCustomStatusUpdateTime
long long lastCustomStatusUpdateTime用户 customStatus 最后一次变更时的时间戳，可以用于展示自定义状态的最后变更时间。
ZIMUserStatusSubscription
用户态订阅信息。包含用户的在线状态、在线平台列表、订阅过期时间戳等。
详情
用户状态订阅信息。包含用户的在线状态、在线平台列表、订阅过期时间戳等。
Declared in ZIMDefines.h
属性
userStatus
subscribeExpiredTime
long long subscribeExpiredTime这名用户订阅过期的时间戳。
ZIMSelfUserInfo
携带当前用户的用户信息、规则。
详情
携带当前用户的用户信息、规则。
Declared in ZIMDefines.h
属性
userFullInfo
userRule
userStatus
ZIMUserStatusSubscribeConfig
subscribeUsersStatus 批量订阅用户在线状态接口的配置项。
详情
批量订阅用户在线状态接口的配置项。
Declared in ZIMDefines.h
属性
subscriptionDuration
unsigned int subscriptionDuration订阅时长，单位为分钟。
ZIMSubscribedUserStatusQueryConfig
querySubscribedUserStatusList 查询订阅列表接口的配置项。
详情
querySubscribedUserStatusList 查询订阅列表接口的配置项。
Declared in ZIMDefines.h
属性
userIDs
std::vector<std::string> userIDs需要查询的用户 ID 列表。
ZIMUserCustomStatusUpdateConfig
用户自定义状态更新配置。
详情
更新用户自定义状态相关参数。
Declared in ZIMDefines.h
属性
duration
long long duration用户自定义状态持续时间。
ZIMErrorUserInfo
失败用户信息类。
详情
用于展示失败的用户以及失败的原因。
Declared in ZIMDefines.h
属性
userID
std::string userIDuserID。
reason
unsigned int reason描述查询失败原因的 reason。
ZIMLoginConfig
登录相关参数配置。
详情
登录相关参数。
Declared in ZIMDefines.h
- 业务场景：用于登录时设置不同的参数。
属性
userName
std::string userName详情描述：用户昵称。业务场景：用于登录同时修改用户昵称的场景，无需变更时传空。是否必填：否。
token
std::string token详情描述：登录时携带的 token。业务场景：仅在使用 token 鉴权的场景中传入。是否必填：否。
isOfflineLogin
bool isOfflineLogin详情描述：是否是离线登录。业务场景：在离线登录时需要传入 true。是否必填：否。默认值：false。
customStatus
std::string customStatus详情描述：自定义状态。业务场景：仅在需要在登录时自定义用户状态时传入。是否必填：否。默认值：空字符串
customStatusDuration
long long customStatusDuration详情描述：自定义状态的过期时长。
ZIMUsersInfoQueryConfig
用户信息查询配置。
详情
用户信息查询配置，可以选择从本地查询或者从服务端查询。从本地查询无限频约束，从服务端查询有限频约束，10 s 内最多只能查询 10 个用户详细配置。
Declared in ZIMDefines.h
属性
isQueryFromServer
bool isQueryFromServer详情描述: 是否从服务端查询用户详细信息。从本地查询无限频约束，从服务端查询有限频约束，10 s 内最多只能查询 10 个用户详细配置。是否必填：非必填。默认值：false。
ZIMOfflinePushPrivateMessageTemplate
私信模版,目前仅适用于 OPPO 厂商。
详情
根据 OPUSH私信模版校验能力接入说明,OPPO 在新消息分类的基础上新增了推送私信模版，当您在 OPPO 控制台配置好私信模版后，如需在推送时应用对应模版，可在 ZIMPushConfig 为 privateMessageTemplate 赋值。
Declared in ZIMDefines.h
属性
templateID
std::string templateID详情描述：私信模版 ID,目前仅适用于 OPPO 厂商，请填写在 OPPO 开放平台控制台预设好的模版 ID。
titleParameters
std::string titleParameters详情描述：用于替换模版中标题预设字段的内容，需要填写一个 json 字符串，如 "{"user_name":"李华"}"。
contentParameters
std::string contentParameters详情描述：用于替换模版中内容预设字段的内容，需要填写一个 json 字符串，如 "{"city":"深圳"}"。
ZIMVoIPConfig
提供发起 iOS VoIP 离线推送类型的信息。
详情
提供发起 iOS VoIP 离线推送类型的信息。
Declared in ZIMDefines.h
属性
iOSVoIPHandleType
iOSVoIPHandleValue
std::string iOSVoIPHandleValue详情描述：VoIP 发起方联系信息内容，与 iOSVoIPHandleType 相关。当 iOSVoIPHandleType 为 PhoneNumber 时，Value 为一串数字；当 iOSVoIPHandleType 为 EmailAddress 时，Value 为电子邮箱地址；当联系信息为其他类型时，Value 通常遵循某种特定格式，如用户名、数字 ID 或 URL。
iOSVoIPHasVideo
bool iOSVoIPHasVideo详情描述：是否为视频通话，默认为音频。
ZIMPushConfig
详情描述:离线推送配置。
详情
发送离线推送前的配置。
Declared in ZIMDefines.h
属性
title
std::string title详情描述：用于设置推送标题。是否必填：非必填。
content
std::string content详情描述：用于设置离线推送的内容。是否必填：非必填。
payload
std::string payload详情描述：用于设置离线推送的透传字段。是否必填：非必填。
resourcesID
std::string resourcesID详情描述：由开发者自定义，长度不超过 32 个字符的字符串，用于映射多个厂商进阶配置的离线推送字段，将多个厂商的推送配置抽象为一种您自定的推送策略。自定义完成后，请联系 ZEGO 技术支持进行配置，配置完成并填入该 resourceID 字段后，ZPNs 服务端会根据接收端设备厂商的不同，选取合适的厂商配置来完成推送。默认值：在未设置 resourceID 的情况下，推送类型为普通弹窗推送（APNs 为 Alert，FCM 为 Notification Message）。业务场景：1. 配置 小米、华为、OPPO、vivo 离线推送证书的项目实现无限制推送，配置此项时，开发者需要先在各厂商完成私信通道创建后，提供以下内容：小米：channel_id（渠道 ID，必需）、channel_name（渠道名称，可选）、channel_description（渠道描述，可选）；华为：category（推送类别）、target_user_type（用户类型，0 表示正式推送，1 表示测试推送）；OPPO：channel_id（渠道 ID）；vivo：category（推送类别）、classification（分类）、push_mode（推送模式，0 表示正式推送，1 表示测试推送）。2. 配置 APNs（Apple）、FCM（Google）证书的项目实现静默推送。请向 ZEGO 技术支持提供 resourceID，配置静默推送策略。是否必填：非必填。
threadID
std::string threadID详情描述：用于设置离线推送的线程 ID。是否必填：非必填。
enableBadge
bool enableBadge详情描述：推送是否携带角标信息开关。
badgeIncrement
int badgeIncrement详情描述：推送携带的增量角标数。
voIPConfig
ZIMVoIPConfig voIPConfig详情描述：如果您使用 Flutter、RN ZPNs, 离线推送接收端设备有 iOS 且使用了 VoIP 推送类型，可以通过该参数来自定义一些 VoIP 的选项。
privateMessageTemplate
ZIMOfflinePushPrivateMessageTemplate privateMessageTemplate详情描述：如果您使用 OPPO 推送，可以通过该字段来携带推送模版。
ZIMMessageReactionAddConfig
添加消息表态的配置。
详情
添加消息表态的配置类。
Declared in ZIMDefines.h
属性
increaseCount
int increaseCount详情描述：当该值传入大于 0 的值时，表示允许同一个用户对同一个表态类型进行多次表态，并会把多次表态时的计数值进行相加。
ZIMMessageReactionUserInfo
表态用户信息。
详情
描述表态用户的类。
Declared in ZIMDefines.h
属性
userID
std::string userID详情描述：用户 ID
ZIMMessageReaction
消息表态具体内容。
详情
表态具体内容。
Declared in ZIMDefines.h
属性
reactionType
std::string reactionType详情描述：表态类型，由您定义，长度上限为 32 字节。
conversationID
std::string conversationID详情描述：会话 ID。
conversationType
messageID
long long messageID详情描述：表态的消息 ID。
messageSeq
long long messageSeq详情描述：消息序列号
totalCount
unsigned int totalCount详情描述：表态的用户总数。
isSelfIncluded
bool isSelfIncluded详情描述：已表态用户中是否包含自己。
userList
sumCount
unsigned int sumCount详情描述：表态的合计计数
ZIMMessageReactionSimpleInfo
消息表态的简要信息。
详情
表态具体内容。
Declared in ZIMDefines.h
属性
reactionType
std::string reactionType详情描述：表态类型，由您定义，长度上限为 32 字节。
sumCount
unsigned int sumCount详情描述：表态的合计计数
ZIMMessageReactionUserFullInfo
消息表态的用户详细信息。
详情
描述表态用户的类。
Declared in ZIMDefines.h
属性
userID
std::string userID详情描述：用户 ID
reactions
ZIMMessageReactionUserChangeInfo
消息表态的用户操作变更信息。
详情
描述表态变更信息的类。
Declared in ZIMDefines.h
属性
userID
std::string userID详情描述：当前执行表态操作的用户 ID。
reactionType
std::string reactionType详情描述：当前变更的表态类型。
action
sumCount
unsigned int sumCount详情描述：当前表态类型的合计数值。
ZIMMessageLiteInfo
消息简要信息对象的基类。
详情
标识一条消息的基本参数。
Declared in ZIMDefines.h
属性
type
ZIMTextMessageLiteInfo
普通文本消息简要信息对象。
Declared in ZIMDefines.h
属性
message
std::string message详情描述：文本消息内容。
ZIMCustomMessageLiteInfo
自定义消息的简要对象。
Declared in ZIMDefines.h
属性
message
std::string message详情描述：自定义消息内容。
searchedContent
std::string searchedContent详情描述：自定义消息搜索内容。
subType
unsigned int subType详情描述：自定义消息子类型。
ZIMCombineMessageLiteInfo
合并消息的简要信息对象。
Declared in ZIMDefines.h
属性
title
std::string title详情描述：合并消息标题。
summary
std::string summary详情描述：合并消息概要。
ZIMRevokeMessageLiteInfo
撤回消息的简要信息对象。
Declared in ZIMDefines.h
ZIMMediaMessageLiteInfo
媒体消息简要信息对象基类。
Declared in ZIMDefines.h
属性
fileSize
long long fileSize详情描述：媒体文件大小。
fileName
std::string fileName详情描述：媒体文件名称。
fileLocalPath
std::string fileLocalPath详情描述：媒体文件本地路径。
fileDownloadUrl
std::string fileDownloadUrl详情描述：媒体文件下载地址。
ZIMImageMessageLiteInfo
图片消息的简要信息对象。
Declared in ZIMDefines.h
属性
originalImageWidth
unsigned int originalImageWidth详情描述：原图宽度。
originalImageHeight
unsigned int originalImageHeight详情描述：原图高度。
largeImageWidth
unsigned int largeImageWidth详情描述：大图宽度。
largeImageHeight
unsigned int largeImageHeight详情描述：大图高度。
largeImageLocalPath
std::string largeImageLocalPath详情描述：大图本地路径。
largeImageDownloadUrl
std::string largeImageDownloadUrl详情描述：大图下载地址。
thumbnailWidth
unsigned int thumbnailWidth详情描述：缩略图宽度。
thumbnailHeight
unsigned int thumbnailHeight详情描述：缩略图高度。
thumbnailLocalPath
std::string thumbnailLocalPath详情描述：缩略图本地路径。
thumbnailDownloadUrl
std::string thumbnailDownloadUrl详情描述：缩略图下载地址。
ZIMFileMessageLiteInfo
文件消息的简要信息对象。
Declared in ZIMDefines.h
ZIMAudioMessageLiteInfo
音频消息的简要信息对象。
Declared in ZIMDefines.h
属性
audioDuration
unsigned int audioDuration详情描述：音频时长。
ZIMVideoMessageLiteInfo
视频消息的简要信息对象。
Declared in ZIMDefines.h
属性
videoDuration
unsigned int videoDuration详情描述：视频时长。
videoFirstFrameWidth
unsigned int videoFirstFrameWidth详情描述：视频首帧宽度。
videoFirstFrameHeight
unsigned int videoFirstFrameHeight详情描述：视频首帧高度。
videoFirstFrameLocalPath
std::string videoFirstFrameLocalPath详情描述：视频首帧本地路径。
videoFirstFrameDownloadUrl
std::string videoFirstFrameDownloadUrl详情描述：视频首帧下载地址。
ZIMMultipleMessageLiteInfo
组合消息的简要信息对象。
Declared in ZIMDefines.h
属性
messageInfoList
ZIMMessageRepliedInfo
回复消息引用的源消息的描述信息。
Declared in ZIMDefines.h
属性
state
messageInfo
senderUserID
std::string senderUserID详情描述：回复消息的发送者用户ID。
sentTime
unsigned long long sentTime详情描述：回复消息的发送时间。
messageID
long long messageID详情描述：被回复消息的ID。
messageSeq
long long messageSeq详情描述：被回复消息的序列号。
ZIMMessage
消息对象的基类。
详情
标识一条消息的基本参数。
Declared in ZIMDefines.h
属性
type
messageID
long long messageID详情描述：标识这条消息的唯一 ID。业务场景：可用于索引其他消息。注意事项：开发者主动创建一条消息时，不需要修改这个参数，此参数仅在回调时有值。
localMessageID
long long localMessageID详情描述：SDK 本地生成的 MessageID,开发者无需关注。
messageSeq
long long messageSeq详情描述：消息的序列号。
senderUserID
std::string senderUserID详情描述：展示本条消息发送者的 userID。
conversationID
std::string conversationID详情描述：会话的 ID，相同会话类型下的 ID 是唯一的。
conversationType
direction
sentStatus
timestamp
unsigned long long timestamp详情描述：标识一条消息的发送时间。业务场景：用于呈现一条消息的发送时间，并可用于消息排序。注意事项：此为标准 UNIX 时间戳，单位为毫秒。
orderKey
long long orderKey详情描述：orderKey 越大消息越新，可用于消息排序。
isUserInserted
bool isUserInserted详情描述：该消息是否是开发者通过 [insertMessageToLocalDB] 接口插入的消息。默认值：false。
receiptStatus
extendedData
std::string extendedData详情描述：消息拓展字段。业务场景：可为消息附加拓展字段，然后发送给对端。是否必填：否。注意事项：长度为1k，可联系技术支持进行配置。支持版本: 2.6.0 及以上。
localExtendedData
std::string localExtendedData详情描述：仅本端可见的消息拓展字段，可附带额外的信息存储到本地，可通过 [updateMessageLocalExtendedData] 修改，目前长度的限制是 128K。如有特殊需求，可联系 ZEGO 技术支持进行配置。
reactions
isBroadcastMessage
bool isBroadcastMessage详情描述：该消息是否是全员推送消息。是否必填：SDK内部赋值。
mentionedUserIDs
std::vector<std::string> mentionedUserIDs详情描述：提醒一批相关的用户。业务表现可为“@某用户”。业务场景：发消息时可以带上是否必填：否。注意事项：该值并不会在消息文本上增加 @某用户 的字样，需要开发者自行实现。支持版本 : 2.14.0 及以上。
isMentionAll
bool isMentionAll详情描述：是否需要提醒所有人。业务表现可为“@所有人”。业务场景：例如在群或者房间可使用。是否必填：否。默认值：false。建议值：如果需要提醒所有人，可以设置为 true。注意事项：该值并不会在消息文本上增加 @所有人 的字样，需要开发者自行实现。支持版本 : 2.14.0 及以上。
repliedInfo
rootRepliedCount
unsigned int rootRepliedCount详情描述：消息根回复数量。
isServerMessage
bool isServerMessage是否为通过服务端 API 所发送的消息
cbInnerID
std::string cbInnerID标识这条消息是否为合并消息里的子消息，若该值大于 0，则当条消息对象为通过查询合并消息所得到的子消息
editorUserID
std::string editorUserID详情描述：消息编辑者的 userID。
editedTime
long long editedTime详情描述：消息编辑时间。
isGroupTargetedMessage
bool isGroupTargetedMessage标识该消息是否为群定向消息
pinnedUserID
std::string pinnedUserID详情描述：消息置顶者的 userID。
pinnedTime
long long pinnedTime详情描述：消息编辑时间。
ZIMMediaMessage
媒体消息对象基类。
详情
标识一条媒体消息。
Declared in ZIMDefines.h
属性
fileLocalPath
std::string fileLocalPath详情描述：媒体消息的文件的本地绝对路径。是否必填：如果发送本地文件，则发送端必填，否则消息会发送失败。
fileDownloadUrl
std::string fileDownloadUrl详情描述：媒体消息的外部下载 URL，用于开发者将媒体文件上传到自己的服务器中时，通过填入该 URL 让 SDK 透传到其他用户中。是否必填：如果发送的是外部 URL，发送端必填。
fileUID
std::string fileUID详情描述：媒体文件的唯一 ID。是否必填：发送端不需要填，该值由 SDK 生成。
fileName
std::string fileName详情描述：媒体文件的文件名。是否必填：如果发送的是外部 URL，则需要填写该值，且需要包含文件扩展名。如果发送的是本地文件，该值选填。
fileSize
long long fileSize详情描述：媒体文件的大小。是否必填：发送端不需要填，该值由 SDK 生成。
ZIMTextMessage
普通文本消息对象。
详情
标识一条普通文本消息。
Declared in ZIMDefines.h
属性
message
std::string message详情描述：消息的内容，支持任意数据。如果此消息的类型为 Text 文本消息，则应当为标准 UTF-8 字符串。是否必填：发送端必填，否则消息会发送失败。
ZIMCustomMessage
自定义消息对象。
详情
标识一条自定义消息。
Declared in ZIMDefines.h
属性
message
std::string message详情描述：消息的内容，支持任意数据。如果此消息的类型为 Text 文本消息，则应当为标准 UTF-8 字符串。是否必填：发送端必填，否则消息会发送失败。
searchedContent
std::string searchedContent详情描述：消息的搜索内容。
subType
unsigned int subType详情描述：消息的子类型，用于客户自定义不同自定义消息的用法。取值范围为 [0, 200]。是否必填：发送端必填，否则消息会发送失败。
ZIMCommandMessage
自定义二进制消息对象。
详情
标识一条二进制消息。
Declared in ZIMDefines.h
属性
message
std::vector<uint8_t> message详情描述：消息的内容，支持任意数据。是否必填：发送端必填，否则消息会发送失败。
ZIMBarrageMessage
弹幕消息类。
详情
弹幕消息类，不会出现在会话中，也不会存入历史消息。
Declared in ZIMDefines.h
属性
message
std::string message详情描述：弹幕消息内容。
ZIMImageMessage
图片消息对象。
详情
标识一条图片消息。
Declared in ZIMDefines.h
属性
thumbnailDownloadUrl
std::string thumbnailDownloadUrl详情描述：图片文件的缩略图外部下载 URL。当开发者将缩略图上传到自己的服务器上时，可以通过该字段让 SDK 透传到其他用户中。是否必填：发送端选填，当 fileDownloadUrl 填入后，该字段才生效。
thumbnailLocalPath
std::string thumbnailLocalPath详情描述：图片文件的缩略图本地路径。是否必填：发送端不需要填，当调用 [downloadMediaFile] 下载之后， SDK 会生成该值。
largeImageDownloadUrl
std::string largeImageDownloadUrl详情描述：图片文件的大图外部下载 URL。当开发者将大图上传到自己的服务器上时，可以通过该字段让 SDK 透传到其他用户中。是否必填：发送端选填，当 fileDownloadUrl 填入后，该字段才生效。
largeImageLocalPath
std::string largeImageLocalPath详情描述：图片文件的大图本地路径。是否必填：发送端不需要填，当调用 [downloadMediaFile] 下载之后， SDK 会生成该值。
originalImageWidth
unsigned int originalImageWidth详情描述：原图宽度。
originalImageHeight
unsigned int originalImageHeight详情描述：原图高度。
largeImageWidth
unsigned int largeImageWidth详情描述：大图宽度。
largeImageHeight
unsigned int largeImageHeight详情描述：大图高度。
thumbnailWidth
unsigned int thumbnailWidth详情描述：缩略图宽度。
thumbnailHeight
unsigned int thumbnailHeight详情描述：缩略图高度。
ZIMFileMessage
文件消息对象。
详情
标识一条文件消息。
Declared in ZIMDefines.h
ZIMAudioMessage
音频消息对象。
详情
标识一条音频消息。
Declared in ZIMDefines.h
属性
audioDuration
unsigned int audioDuration详情描述：音频文件的时长。是否必填：发送本地音频消息时，发送端必填，不填会导致音频消息发送失败。
ZIMVideoMessage
视频消息对象。
详情
标识一条视频消息。
Declared in ZIMDefines.h
属性
videoDuration
unsigned int videoDuration详情描述：视频文件的时长。是否必填：发送本地视频时，发送端必填，不填会导致视频消息发送失败。
videoFirstFrameDownloadUrl
std::string videoFirstFrameDownloadUrl详情描述：视频文件的缩略图外部下载 URL。当开发者将首帧图上传到自己的服务器上时，可以通过该字段让 SDK 透传到其他用户中。是否必填：发送端选填，当 fileDownloadUrl 填入后，该字段才生效。
videoFirstFrameLocalPath
std::string videoFirstFrameLocalPath详情描述：视频文件的首帧图本地路径。是否必填：发送端不需要填，当调用 [downloadMediaFile] 下载之后， SDK 会生成该值。
videoFirstFrameWidth
unsigned int videoFirstFrameWidth详情描述：视频首帧宽度。
videoFirstFrameHeight
unsigned int videoFirstFrameHeight详情描述：视频首帧高度。
ZIMRevokeMessage
撤回消息对象基类。
详情
标识一条撤回消息。
Declared in ZIMDefines.h
属性
revokeType
revokeTimestamp
unsigned long long revokeTimestamp详情描述：撤回时间戳。
operatedUserID
std::string operatedUserID详情描述：撤回操作者的用户 ID。
originalMessageType
originalTextMessageContent
std::string originalTextMessageContent详情描述：原始文本消息内容，若撤回的是非文本消息，则该字段为空。
revokeExtendedData
std::string revokeExtendedData详情描述：撤回附带的消息。
revokeStatus
ZIMCombineMessage
合并消息对象基类。
详情
标识一条合并消息。
Declared in ZIMDefines.h
属性
title
std::string title详情描述：合并消息标题。
summary
std::string summary详情描述：合并消息的概要。
combineID
std::string combineID详情描述：合并消息 ID，SDK 内部使用。
messageList
ZIMTipsMessage
Tips 消息对象。
详情
标识一条 Tips 消息。
Declared in ZIMDefines.h
属性
event
operatedUser
targetUserList
changeInfo
ZIMMultipleMessage
组合消息对象。
Declared in ZIMDefines.h
属性
messageInfoList
failedIndexList
std::vector<int> failedIndexList详情描述：组合消息中失败的索引列表。
ZIMMessageRootRepliedInfo
回复消息树的根消息的描述信息。
Declared in ZIMDefines.h
属性
state
message
senderUserID
std::string senderUserID详情描述：根消息的发送者用户ID。
sentTime
long long sentTime详情描述：根消息的发送时间。
repliedCount
unsigned int repliedCount详情描述：根消息的回复数量。
ZIMMessageRootRepliedCountInfo
回复消息树的回复数量的信息。
Declared in ZIMDefines.h
属性
messageID
long long messageID详情描述：消息ID。
conversationID
std::string conversationID详情描述：会话ID。
conversationType
count
unsigned int count详情描述：根回复数量。
ZIMMessageMentionedInfo
消息提醒信息。
详情
消息提醒信息。
Declared in ZIMDefines.h
属性
messageID
long long messageID详情描述：消息ID，用于匹配该提醒信息是属于哪一条消息。是否必填： 不需要开发者填写
messageSeq
long long messageSeq详情描述：消息序列号，用于匹配该提醒信息是属于哪一条消息。是否必填： 不需要开发者填写
fromUserID
std::string fromUserID详情描述：来自哪个用户。是否必填：不需要开发者填写。
type
ZIMMessageReceivedInfo
消息接收事件携带相关信息的结构体。
Declared in ZIMDefines.h
属性
conversationID
std::string conversationID详情描述：会话 ID
conversationType
isOfflineMessage
bool isOfflineMessage详情描述：是否是离线消息。
ZIMMessageSendConfig
发送消息的相关配置。
详情
发送消息的相关配置。
Declared in ZIMDefines.h
属性
pushConfig
priority
hasReceipt
bool hasReceipt详情描述：发送消息时候，该消息是否带回执。业务场景：需要为一条消息带上回执时使用。是否必填：非必填。默认值：false。
isNotifyMentionedUsers
bool isNotifyMentionedUsers发送消息时候，是否离线推送通知该消息提及到的用户。
isRetrySend
bool isRetrySend是否重发发送失败的消息。
disableUnreadMessageCount
bool disableUnreadMessageCount详情描述：发送原本会影响对方未读数消息的时候，是否不再计入对方未读。是否必填：非必填。默认值：false。
isAllowMultipleMessagePartialFailed
bool isAllowMultipleMessagePartialFailed详情描述：是否允许发送组合消息时允许部分子消息发送失败。是否必填：非必填。默认值：false。
ZIMMessageQueryConfig
查询消息配置。
详情
查询消息的相关配置。
Declared in ZIMDefines.h
属性
nextMessage
count
unsigned int count详情描述：查询消息的条数。 是否必填：必填。
reverse
bool reverse详情描述：是否反序查询的标志。 是否必填：非必填。 默认值：false。
mode
ZIMMessageQueryMode mode详情描述：设置查询历史消息的模式。由于 SDK 本身具备判断本地数据是否完整从而可以更快速给出历史消息的逻辑，因此建议一般情况下都使用默认值即可。 是否必填：非必填。
ZIMMessageRevokeConfig
撤回消息的相关配置。
详情
撤回消息的相关配置。
Declared in ZIMDefines.h
属性
pushConfig
revokeExtendedData
std::string revokeExtendedData详情描述:撤回附加消息。 是否必填：非必填。
ZIMMessageDeleteConfig
删除消息配置。
详情
删除消息的相关配置。
Declared in ZIMDefines.h
属性
isAlsoDeleteServerMessage
bool isAlsoDeleteServerMessage详情描述:是否删除服务器消息的标志。 是否必填：非必填。 默认值：false。
ZIMMessageDeletedInfo
被删除的消息信息。
详情
被删除消息的信息类。
Declared in ZIMDefines.h
属性
conversationID
std::string conversationID详情描述：会话 ID。
conversationType
messageDeleteType
messageList
std::vector<ZIMMessage> messageList被删除的消息列表。当 [ZIMMessageDeleteType] 为 [ZIMMessageDeleteTypeMessageListDeleted] 时有效。
ZIMMessageAttachedCallback
为传入的消息对象赋予 localMessgeID 并返回。
Declared in ZIMDefines.h
属性
message
ZIMMediaUploadingProgress
媒体文件上传进度的回调。
Declared in ZIMDefines.h
属性
message
currentFileSize
unsigned long long currentFileSize当前文件大小。
totalFileSize
unsigned long long totalFileSize总文件大小。
ZIMMultipleMediaUploadingProgress
多个媒体文件上传进度的回调。
Declared in ZIMDefines.h
属性
message
currentFileSize
unsigned long long currentFileSize当前文件大小。
totalFileSize
unsigned long long totalFileSize总文件大小。
messageInfoIndex
unsigned int messageInfoIndex当前组合消息的内容索引。
currentIndexFileSize
unsigned long long currentIndexFileSize组合消息索引下的文件当前大小。
totalIndexFileSize
unsigned long long totalIndexFileSize组合消息索引下的文件总大小。
ZIMMessageSendNotification
消息发送时的通知回调，可以通过此通知获取消息对象发送前的相关信息
详情
通过该通知，开发者可以获取到消息对象发送前的相关信息，如 localMessageID 等。
Declared in ZIMDefines.h
- 业务场景：当开发者需要记录和缓存消息发送前的相关信息，可以通过监听该通知获取。
属性
onMessageAttached
ZIMMessageAttachedCallback onMessageAttached详情描述：消息在落入本地 DB 后，将要向服务端发送消息之前，会回调该通知。 业务场景：用于开发者需要在发送消息之前，提前获取消息里的相关信息时，可以使用此接口。 是否必填：非必填。若无需监听的情况下，可传空。 默认值：空。
onMediaUploadingProgress
onMultipleMediaUploadingProgress
ZIMMultipleMediaUploadingProgress onMultipleMediaUploadingProgress详情描述：组合消息中的媒体文件上传进度。
ZIMMediaMessageSendNotification
媒体消息发送时的通知回调，可以通过此通知获取消息对象发送前的相关信息
详情
通过该通知，开发者可以获取到消息对象发送前的相关信息，如 localMessageID 等。
Declared in ZIMDefines.h
- 业务场景：当开发者需要记录和缓存消息发送前的相关信息，可以通过监听该通知获取。
属性
onMessageAttached
ZIMMessageAttachedCallback onMessageAttached详情描述：消息在落入本地 DB 后，将要向服务端发送消息之前，会回调该通知。 业务场景：用于开发者需要在发送消息之前，提前获取消息里的相关信息时，可以使用此接口。 是否必填：非必填。若无需监听的情况下，可传 [null]。 默认值：[null]。
onMediaUploadingProgress
ZIMMessageReceiptInfo
回执信息。
详情
回执信息。
Declared in ZIMDefines.h
属性
status
messageID
long long messageID详情描述：消息ID。 业务场景：开发者可根据这个ID 匹配已经加载过的消息列表。 是否必填：否，SDK填充。
conversationID
std::string conversationID会话ID。
conversationType
readMemberCount
unsigned int readMemberCount详情描述：已读成员数。
unreadMemberCount
unsigned int unreadMemberCount详情描述：未读成员数。
isSelfOperated
bool isSelfOperated详情描述：是否为自己多端的操作。
readTime
long long readTime详情描述：接收方全部已读那一刻的时间戳。
ZIMMessageReactionUserQueryConfig
用于查询表态详情成员的配置。
详情
查询表态成员时，需要配置此对象。
Declared in ZIMDefines.h
属性
nextFlag
unsigned long long nextFlag详情描述：分页查询的标识位，首次查询时，将此字段设为空字符串。若 [ZIMMessageReactionUserListQueriedCallback] 回调的 "nextFlag" 字段不是空字符串，说明还没结束，需要将其设置到此处以继续下一页的查询。业务场景：开发者可根据该字段进行分页查询成员列表，第一次查询传空。是否必填：非必填。默认值：空。
count
unsigned int count详情描述：一次获取多少表态的成员。上限为 100。注意事项：分页获取表态成员以降低开销，建议单次获取 20 人以内。若该处填写值为 0，SDK 会默认查询 100 人。业务场景：开发者可以根据该参数来决定一次需要查询多少房间成员。是否必填：必填。
reactionType
std::string reactionType详情描述：表态类型，由您自行定义。
ZIMMessageSentStatusChangeInfo
消息状态变更通知。
详情
消息状态变更通知。
Declared in ZIMDefines.h
属性
status
message
reason
std::string reason此字段记录服务端发送前回调拦截消息导致 ZIM 拒绝发送的原因。若您开通了 ZIM 内容审核服务，并需在此字段中获取审核未通过导致的失败原因，请联系 ZEGO 技术支持进行配置。
ZIMMessageSearchConfig
消息搜索配置。
详情
消息搜索配置。
Declared in ZIMDefines.h
属性
nextMessage
ZIMMessage nextMessage分页拉取标志，即指拉取 nextMessage 之后或之前的消息，“之后”或“之前”由 order 值决定。 第一次搜索时，nextMessage 为 null。 之后搜索时，nextMessage 需传入上次查询到的消息列表的最后一条消息。
count
unsigned int count数量。建议小于 20 条，以降低性能开销。
order
ZIMMessageOrder order搜索消息时 'order' 为 'DESCENDING' 时，表示对发送时间比 nextMessage 早的消息进行查询。若是首次查询消息时（即 nextMessage 为 null），则从本地存储的最后一条消息向前查询。'order' 为 'ASCENDING' 时，表示对发送时间比 nextMessage 晚的消息进行查询。若是首次查询消息时（即 nextMessage 为 null），则从本地存储的第一条消息向后查询。默认为 'DESCENDING'。
keywords
std::vector<std::string> keywords搜索关键字，最多支持 5 个，否则会报错。例如：传入 '1' 和 '2'，则搜索结果只会展示同时包含 '1' 和 '2' 这两个关键字的消息。
messageTypes
subMessageTypes
std::vector<unsigned int> subMessageTypes自定义消息的子类型，取值范围为 [0,200]。开发者可基于此搜索具体的自定义类型。
senderUserIDs
std::vector<std::string> senderUserIDs消息发送用户 ID，最多支持 5 个。例如，传入 'zego2023'，则搜索结果只会展示 'zego2023' 用户在该会话中发送的所有消息。
startTime
long long startTime搜索的起始时间点，单位：毫秒，默认为 0，格式：UTC 时间戳。
endTime
long long endTime搜索的结束时间点，必须大于 startTime，单位：毫秒，默认为 0，格式：UTC 时间戳。
ZIMMessageRepliedListQueryConfig
用于查询回复消息列表的配置。
详情
查询消息回复列表的配置类。
Declared in ZIMDefines.h
属性
nextFlag
long long nextFlag分页查询的标识位，首次查询时，将此字段设为0。若 [queryMessageRepliedList] 回调的 nextFlag 字段不为0，说明还没结束，需要将其设置到此处以继续下一页的查询。
count
unsigned int count单次查询的数量。上限为 100，超出 100 会导致错误。
ZIMMediaDownloadConfig
下载媒体文件的配置。
详情
媒体文件下载的配置类。
Declared in ZIMDefines.h
属性
messageInfoIndex
unsigned int messageInfoIndex下载组合消息里的某个文件所在数组的索引。
ZIMMessageEditConfig
（空类）编辑消息的相关配置。
详情
（空类）编辑消息的相关配置。
Declared in ZIMDefines.h
ZIMSendingMessageCancelConfig
（空类）取消发送消息的相关配置。
详情
（空类）取消发送消息的相关配置。
Declared in ZIMDefines.h
ZIMMessagePinConfig
置顶消息配置。
详情
置顶消息的相关配置。
Declared in ZIMDefines.h
属性
disableAutoReplace
bool disableAutoReplace当置顶消息条数超过限制时，不允许下一次置顶消息时把置顶列表的旧消息进行替换。默认值为 [false]。
ZIMTipsMessageChangeInfo
Tips 消息额外信息。
详情
Tips 消息额外信息。
Declared in ZIMDefines.h
属性
type
ZIMTipsMessageGroupChangeInfo
Tips 消息群相关变化事件附加信息。
详情
Tips 消息群相关变化事件附加信息。
Declared in ZIMDefines.h
属性
groupDataFlag
ZIMGroupDataFlag groupDataFlag如果群名，群头像，群公告存在复数变更，则需要由该字段的值知道哪些存在变更。其中 0b0001 是群名，0b0010 是群公告，0b0100 是群头像。
groupName
std::string groupName如果群名发生变更，则此处会展示变更后的值。
groupNotice
std::string groupNotice如果群名发生变更，则此处会展示变更后的值。
groupAvatarUrl
std::string groupAvatarUrl如果群头像发生变更，则此处会展示变更后的值。
groupMutedInfo
ZIMTipsMessageGroupMemberChangeInfo
Tips 消息群成员相关变化事件附加信息。
详情
Tips 消息群成员相关变化事件附加信息。
Declared in ZIMDefines.h
属性
memberRole
int memberRole如果群成员角色发生了变化，这里会展示变更后的角色。
muteExpiredTime
long long muteExpiredTime如果群成员禁言时间发生了变化，这里会展示新的禁言时间。
groupNewOwner
ZIMGroupMemberSimpleInfo groupNewOwner详情描述：当原群主离开群并导致群主发生变更时产生的 tips 消息，该字段为 true 并且表示新产生的群主。
ZIMTipsMessagePinStatusChangeInfo
Tips 消息群消息置顶状态变化事件附加信息。
详情
Tips 消息群消息置顶状态变化事件附加信息。
Declared in ZIMDefines.h
属性
isPinned
bool isPinned描述本次操作是置顶操作还是取消置顶操作。
ZIMMessagePinStatusChangeInfo
消息置顶状态变更通知。
详情
当会话内一条消息被成功置顶或取消置顶并触发通知时，可以通过该结构获取被操作的消息与当前置顶状态。
Declared in ZIMDefines.h
属性
pinStatus
message
ZIMFileCacheClearConfig
清理缓存配置。
详情
清理缓存配置。
Declared in ZIMDefines.h
属性
endTime
long long endTime缓存清理的截至时间戳。
ZIMFileCacheQueryConfig
查询缓存配置。
详情
查询缓存配置。
Declared in ZIMDefines.h
属性
endTime
long long endTime查询缓存的截至时间戳。
ZIMFileCacheInfo
文件缓存信息。
详情
文件缓存信息。
Declared in ZIMDefines.h
属性
totalFileSize
unsigned long long totalFileSize总的文件大小，单位为字节（B）。
ZIMMessageReactionChangeInfo
消息表态的变更信息。
详情
描述表态变更信息的类。
Declared in ZIMDefines.h
属性
message
userChangeInfoList
std::vector<ZIMMessageReactionUserChangeInfo> userChangeInfoList详情描述：当前消息下的用户表态操作变更的信息列表
ZIMConversation
会话具体内容。
详情
会话的具体内容。
Declared in ZIMDefines.h
属性
conversationID
std::string conversationID会话ID。
type
conversationName
std::string conversationNameconversationName,与会话对应的 groupName/userName 值相同。
conversationAvatarUrl
std::string conversationAvatarUrl会话头像 URL。单聊会话头像 URL 与用户头像 URL 相同，群聊会话头像 URL 与群头像 URL 相同。
conversationAlias
std::string conversationAlias会话别名，通过 [updateFriendAlias] 设置好友备注后，对应的单聊会话该参数会同步修改。通过 [updateGroupAlias] 设置群备注后，对应的群聊会话该参数会同步修改。
notificationStatus
unreadMessageCount
unsigned int unreadMessageCount会话未读数。
lastMessage
orderKey
long long orderKey用于描述消息在会话中的顺序，orderKey 越大越新。
isPinned
bool isPinned会话是否置顶。
pinnedTime
long long pinnedTime详情描述：会话置顶时间戳。
mentionedInfoList
std::vector<ZIMMessageMentionedInfo> mentionedInfoList当在会话的消息中被提醒到或者被提醒所有人时，该数组会有记录。
draft
std::string draft会话草稿，当设置会话草稿后，会话中会带有该字段。
marks
std::vector<int> marks描述了该会话现有的所有标记。
readMessageSeq
long long readMessageSeq详情描述：会话已读到的消息序号。
isConversationDisabled
bool isConversationDisabled这个会话是否为不可用的状态。
selfMutedExpiredTime
long long selfMutedExpiredTime会话禁言的过期时间。
ZIMConversationBaseInfo
会话简要内容。
详情
会话的简要内容。
Declared in ZIMDefines.h
属性
conversationID
std::string conversationID会话 ID。单聊会话 ID 为对方用户 ID，群聊会话 ID 为群组 ID
conversationType
ZIMGroupConversation
群会话对象，继承自ZIMGroupConversation。
详情
群会话对象，继承自ZIMGroupConversation。
Declared in ZIMDefines.h
属性
isDisabled
bool isDisabled这个群会话是否为不可用的状态。
mutedExpiredTime
long long mutedExpiredTime群禁言的过期时间。
ZIMConversationQueryConfig
查询会话的相关配置。
详情
查询会话时可配置的信息。
Declared in ZIMDefines.h
属性
nextConversation
count
unsigned int count需要查询的会话数量。
ZIMConversationFilterOption
查询会话的相关过滤项。
详情
查询会话时可配置的过滤项。
Declared in ZIMDefines.h
属性
conversationTypes
marks
std::vector<int> marks会话标记列表
isOnlyUnreadConversation
bool isOnlyUnreadConversation是否只查询未读会话
pinnedFilter
ZIMConversationTotalUnreadMessageCountQueryConfig
查询会话未读消息总数的相关配置项。
详情
查询会话未读消息总数时可配置的过滤项。
Declared in ZIMDefines.h
属性
conversationTypes
marks
std::vector<int> marks会话标记列表
ZIMConversationDeleteConfig
删除会话配置。
详情
删除会话的相关配置。
Declared in ZIMDefines.h
属性
isAlsoDeleteServerConversation
bool isAlsoDeleteServerConversation是否同时删除服务器会话
ZIMConversationsAllDeletedInfo
删除全部会话通知的信息。
详情
删除全部会话通知的信息。
Declared in ZIMDefines.h
属性
count
unsigned int count会话被删除的数目。
ZIMConversationChangeInfo
会话变更信息。
详情
包含会话变更后的信息。
Declared in ZIMDefines.h
属性
event
ZIMConversationEvent eventaction
conversation
ZIMConversationSearchConfig
会话搜索配置。
详情
会话搜索配置。
Declared in ZIMDefines.h
属性
mode
nextFlag
unsigned int nextFlag分页拉取表示 ，初始时填 0，后续填从 callback 里返回的 nextFlag，以获取下一分页的数据。
totalConversationCount
unsigned int totalConversationCount搜索一次可获取的消息数量。建议小于 20，以降低性能开销。
keywords
std::vector<std::string> keywords搜索关键字，最多支持 5 个，否则会报错。例如：传入 1 和 2，则搜索结果只会展示消息同时包含 1 和 2 这两个关键字的会话。
conversationMessageCount
unsigned int conversationMessageCount搜索一次，可获取单个会话的本地消息数量，建议小于 10，以降低性能开销。
messageTypes
subMessageTypes
std::vector<unsigned int> subMessageTypes自定义消息的子类型，取值范围为 [0,200]。开发者可基于此搜索具体的自定义类型。
senderUserIDs
std::vector<std::string> senderUserIDs发送用户 ID，最多支持 5 个。例如，传入 zego2023，则搜索结果只会展示 zego2023 用户发过消息的会话。
startTime
long long startTime搜索的起始时间点，单位：毫秒，默认为 0，格式：UTC 时间戳。
endTime
long long endTime搜索的结束时间点，必须大于 startTime，单位：毫秒，默认为 0，格式：UTC 时间戳。
ZIMConversationSearchInfo
会话搜索信息。
详情
会话搜索结果信息类。
Declared in ZIMDefines.h
属性
conversationID
std::string conversationID要搜索的本地消息的会话 ID。
conversationType
conversation
totalMessageCount
unsigned int totalMessageCount总消息条数。
messageList
ZIMRoomInfo
房间资料基础对象。
详情
标识一个唯一房间。
Declared in ZIMDefines.h
属性
roomID
std::string roomID房间 ID，最大 128 字节的字符串，由开发者自定义生成。
roomName
std::string roomName房间名，由开发者自定义生成，最大长度不超过 64 字节的字符串。
ZIMRoomFullInfo
房间详细资料对象。
详情
标识一个房间的详细资料。
Declared in ZIMDefines.h
属性
baseInfo
ZIMRoomMemberInfo
房间用户信息。
详情
描述房间用户的类。
Declared in ZIMDefines.h
ZIMRoomMemberQueryConfig
用于查询房间成员的配置。
详情
查找成员时，需要配置此对象。
Declared in ZIMDefines.h
属性
nextFlag
std::string nextFlag分页查询的标识位，首次查询时，将此字段设为空字符串。若回调的 'nextFlag' 字段不是空字符串，说明还没结束，需要将其设置到此处以继续下一页的查询。
count
unsigned int count一次获取多少房间成员。
ZIMRoomAdvancedConfig
房间高级属性配置。
详情
房间的高级属性配置。
Declared in ZIMDefines.h
属性
roomAttributes
std::unordered_map<std::string, std::string> roomAttributes房间中的房间属性，用户可以自定义
roomDestroyDelayTime
unsigned int roomDestroyDelayTime房间延迟销毁时间，单位为秒。最长房间延迟销毁时间是3小时。
ZIMRoomAttributesSetConfig
房间属性设置的行为属性。
详情
房间属性设置的行为属性。
Declared in ZIMDefines.h
属性
isForce
bool isForce是否可以强制修改其他用户的房间属性。如果为true，则可以修改其他用户的房间属性，如果为false，则不允许修改其他用户的房间属性。
isDeleteAfterOwnerLeft
bool isDeleteAfterOwnerLeft房间属性在拥有者离开房间后自动删除。
isUpdateOwner
bool isUpdateOwner是否更新涉及到的房间属性的拥有者。
ZIMRoomAttributesBatchOperationConfig
房间属性设置的行为属性。
详情
房间属性设置的行为属性。
Declared in ZIMDefines.h
属性
isForce
bool isForce是否可以强制修改其他用户的房间属性。如果为true，则可以修改其他用户的房间属性，如果为false，则不允许修改其他用户的房间属性。
isDeleteAfterOwnerLeft
bool isDeleteAfterOwnerLeft房间属性是否在房主离开后自动删除。
isUpdateOwner
bool isUpdateOwner是否更新涉及到的房间属性的拥有者。
ZIMRoomAttributesDeleteConfig
房间属性删除的行为属性。
详情
房间属性删除的行为属性。
Declared in ZIMDefines.h
属性
isForce
bool isForce是否可以强制删除其他用户的房间属性。如果为true，则可以删除其他用户的房间属性，如果为false，则不允许删除其他用户的房间属性。
ZIMRoomAttributesUpdateInfo
房间属性变更通知。
详情
房间属性变更通知。
Declared in ZIMDefines.h
属性
action
roomAttributes
std::unordered_map<std::string, std::string> roomAttributes房间属性。
ZIMRoomMemberAttributesInfo
房间用户属性信息。
详情
描述房间用户属性的类，包含 UserID 以及其对应的属性。
Declared in ZIMDefines.h
属性
userID
std::string userID用户 ID。
attributes
std::unordered_map<std::string, std::string> attributes房间用户属性。
ZIMRoomMemberAttributesOperatedInfo
房间用户属性操作信息。
详情
房间用户属性操作信息，包含成功操作的属性与失败的 Key。
Declared in ZIMDefines.h
属性
attributesInfo
errorKeys
std::vector<std::string> errorKeys房间用户属性操作失败的 Key。
ZIMRoomMemberAttributesUpdateInfo
房间用户属性更新信息。
详情
房间用户属性更新信息。
Declared in ZIMDefines.h
属性
attributesInfo
ZIMRoomMemberAttributesSetConfig
房间用户属性设置配置。
详情
房间用户属性设置配置，包含可配置用户离开后是否保留用户属性等。
Declared in ZIMDefines.h
- 业务场景：开发者可以在设置房间用户属性时，根据自身的实际应用场景选择使用。
属性
isDeleteAfterOwnerLeft
bool isDeleteAfterOwnerLeft配置房间用户属性在用户离开房间后，是否保存下来。
ZIMRoomMemberAttributesQueryConfig
房间用户属性查询配置。
详情
房间用户属性查询配置。
Declared in ZIMDefines.h
属性
nextFlag
std::string nextFlag房间用户属性的查询锚点。
count
unsigned int count分页查询的数量。
ZIMRoomOperatedInfo
房间操作信息。
详情
房间操作信息。
Declared in ZIMDefines.h
属性
userID
std::string userID操作者的 UserID。
ZIMGroupInfo
群组信息。
详情
群组信息。
Declared in ZIMDefines.h
属性
groupID
std::string groupID群组ID。
groupName
std::string groupName群名称。
groupAvatarUrl
std::string groupAvatarUrl群头像 URL。
ZIMGroupMuteInfo
群组禁言信息。
详情
群组禁言信息。
Declared in ZIMDefines.h
属性
mode
expiredTime
long long expiredTime群组禁言过期时间，单位为秒。为 0 时为不禁言，为 -1 时为永久禁言。
roles
ZIMGroupVerifyInfo
入群的验证模式。
详情
群组验证信息类，用于描述群组的进群验证方式。
Declared in ZIMDefines.h
属性
joinMode
inviteMode
beInviteMode
ZIMGroupFullInfo
群组完整的信息。
详情
群组完整的信息。
Declared in ZIMDefines.h
属性
baseInfo
groupNotice
std::string groupNotice群公告。
groupAttributes
std::unordered_map<std::string, std::string> groupAttributes群组属性。
groupAlias
std::string groupAlias群备注
notificationStatus
mutedInfo
createTime
long long createTime群创建时的服务端的时间戳。
maxMemberCount
int maxMemberCount群成员最大数量。
verifyInfo
ZIMGroup
群组列表的完整的信息。
详情
群组列表的完整的信息。
Declared in ZIMDefines.h
属性
baseInfo
groupAlias
std::string groupAlias用户自定的仅该用户可见的群备注。
notificationStatus
ZIMGroupMemberSimpleInfo
群成员简要信息。
详情
群组成员的简要信息类。
Declared in ZIMDefines.h
属性
memberNickname
std::string memberNickname群组成员昵称。
memberRole
ZIMGroupEnterInfo
群成员入群时的信息。
详情
用户进入群组的信息类。
Declared in ZIMDefines.h
属性
enterTime
long long enterTime入群时服务端的时间戳。
enterType
operatedUser
ZIMGroupMemberInfo
群组成员信息。
详情
群组成员信息。
Declared in ZIMDefines.h
属性
memberNickname
std::string memberNickname群组成员昵称。
memberRole
muteExpiredTime
long long muteExpiredTime群成员禁言过期时间。为 0 时即不禁言，为 -1 时即永久禁言。
groupEnterInfo
ZIMGroupOperatedInfo
群组引发事件变化操作者的信息。
详情
群组引发事件变化操作者的信息。
Declared in ZIMDefines.h
属性
userID
std::string userID操作者的用户 ID。
userName
std::string userName操作者的用户名。
memberNickname
std::string memberNickname操作者的群成员昵称。
memberRole
ZIMGroupMemberQueryConfig
群成员查询配置。
详情
群成员查询配置。
Declared in ZIMDefines.h
属性
nextFlag
unsigned int nextFlag下一个标志。
count
unsigned int count数量，上限为 100，超过 100 则按照 100 处理。
ZIMGroupAdvancedConfig
群组高级配置。
详情
群组高级配置。
Declared in ZIMDefines.h
属性
groupNotice
std::string groupNotice群公告。
groupAttributes
std::unordered_map<std::string, std::string> groupAttributes群组属性，最多可配置 10 个。
maxMemberCount
unsigned int maxMemberCount群成员最大数量。
joinMode
inviteMode
beInviteMode
ZIMGroupAttributesUpdateInfo
群属性更新信息。
详情
群属性更新信息。
Declared in ZIMDefines.h
属性
action
groupAttributes
std::unordered_map<std::string, std::string> groupAttributes群属性。
ZIMGroupMessageReceiptMemberQueryConfig
群消息回执已读/未读成员查询配置。
详情
群消息回执已读/未读成员查询配置。
Declared in ZIMDefines.h
属性
nextFlag
unsigned int nextFlag下一个标志。初始填 0，后续从 [ZIMGroupMessageReceiptMemberListQueriedCallback] 回调拿到下一个的 nextFlag。
count
unsigned int count需要查询的群成员数量。
ZIMGroupSearchConfig
群搜索配置。
详情
群搜索配置。
Declared in ZIMDefines.h
属性
nextFlag
unsigned int nextFlag查询的 flag 。
count
unsigned int count搜索一次，可获取的群组数量。建议小于 20，以降低性能开销。
keywords
std::vector<std::string> keywords搜索关键字。例如：传入 '1' 和 '2'，则搜索结果只会展示群名称同时包含 '1' 和 '2' 这两个关键字的群组。
isAlsoMatchGroupMemberUserName
bool isAlsoMatchGroupMemberUserName搜索范围是否包括群成员用户名称，默认为 false。
isAlsoMatchGroupMemberNickname
bool isAlsoMatchGroupMemberNickname搜索范围是否包括群成员用户昵称，默认为 false。
ZIMGroupSearchInfo
群搜索信息。
详情
群组搜索信息。
Declared in ZIMDefines.h
属性
groupInfo
userList
ZIMGroupMemberSearchConfig
群成员搜索配置。
详情
群成员搜索配置。
Declared in ZIMDefines.h
属性
nextFlag
unsigned int nextFlag查询的 flag ，第一次调用接口时填 0。后续再次调用接口时填从 callback 里返回的 nextFlag，以便获取剩余数据。
count
unsigned int count结果的数量。
keywords
std::vector<std::string> keywords搜索关键字，最多支持 5 个，否则会报错。例如：传入 '1' 和 '2'，则搜索结果只会展示名称同时包含 '1' 和 '2' 这两个关键字的群成员。
isAlsoMatchGroupMemberNickname
bool isAlsoMatchGroupMemberNickname搜索范围是否包括群成员用户昵称，默认为 false。
ZIMGroupMuteConfig
群组禁言配置。
详情
群组禁言配置。
Declared in ZIMDefines.h
属性
mode
duration
int duration群组禁言时长，单位是 秒。取值为 -1，即永久禁言。如需实现非永久禁言，取值上限为 604800（即 7 天）。如需上调，请联系 ZEGO 技术支持。
roles
ZIMGroupMemberMuteConfig
群组成员禁言配置。
详情
群组成员禁言配置。
Declared in ZIMDefines.h
属性
duration
int duration群组成员禁言时长，单位是 秒。取值为 -1，即永久禁言。如需实现非永久禁言，取值上限为 604800（即 7 天）。如需上调，请联系 ZEGO 技术支持。
ZIMGroupMemberMutedListQueryConfig
群禁言成员列表查询配置。
详情
群禁言成员列表查询配置。
Declared in ZIMDefines.h
属性
nextFlag
unsigned long long nextFlag下一个标志。
count
unsigned int count数量。
ZIMGroupApplicationInfo
入群申请信息。
详情
群组申请信息类，包含进群或邀请申请的详细信息。
Declared in ZIMDefines.h
属性
type
state
groupInfo
applyUser
createTime
long long createTime入群申请创建时间戳，单位为毫秒。
updateTime
long long updateTime入群申请状态更新时间，单位为毫秒。
wording
std::string wording入群申请附言。
operatedUser
ZIMGroupJoinApplicationSendConfig
发送加群申请的配置。
详情
发送进群申请的配置类。
Declared in ZIMDefines.h
属性
wording
std::string wording申请的附言。
pushConfig
ZIMGroupJoinApplicationAcceptConfig
接受加群申请的配置。
详情
接受进群申请的配置类。
Declared in ZIMDefines.h
属性
pushConfig
ZIMGroupJoinApplicationRejectConfig
拒绝加群申请的配置。
详情
拒绝进群申请的配置类。
Declared in ZIMDefines.h
属性
pushConfig
ZIMGroupInviteApplicationSendConfig
发送邀请入群申请的配置。
详情
发送邀请入群申请的配置类。
Declared in ZIMDefines.h
属性
wording
std::string wording申请的附言。
pushConfig
ZIMGroupInviteApplicationAcceptConfig
接受邀请入群申请的配置。
详情
接受邀请入群申请的配置类。
Declared in ZIMDefines.h
属性
pushConfig
ZIMGroupInviteApplicationRejectConfig
拒绝邀请入群申请的配置。
详情
拒绝邀请入群申请的配置类。
Declared in ZIMDefines.h
属性
pushConfig
ZIMGroupApplicationListQueryConfig
入群申请查询配置。
详情
通过该配置可以设置查询总条数以及分页查询
Declared in ZIMDefines.h
属性
nextFlag
unsigned int nextFlag下一个标志。
count
unsigned int count数量，建议不超过 30。
ZIMGroupListQueryConfig
群组列表查询配置。
详情
查询群组列表的配置类。
Declared in ZIMDefines.h
属性
nextFlag
long long nextFlag下一个标志。
userIDs
std::vector<std::string> userIDs指定用户列表。
ZIMCallUserInfo
呼叫邀请用户信息。
详情
呼叫邀请用户信息。
Declared in ZIMDefines.h
属性
userID
std::string userID用户ID。
state
extendedData
std::string extendedData呼叫邀请用户信息中的附加信息。
ZIMCallInviteConfig
发送呼叫邀请设置的行为属性。
详情
发送呼叫邀请设置的行为属性。
Declared in ZIMDefines.h
属性
timeout
int timeout呼叫邀请的超时时长，单位为秒，范围为 [1, 600]。
mode
extendedData
std::string extendedData扩展字段，邀请者可通过该字段携带信息给被邀请者。
enableNotReceivedCheck
bool enableNotReceivedCheck通过值为 true 的情况下，本次呼叫邀请以及后续呼叫中邀请将会检测邀请是否送达。
pushConfig
ZIMCallingInviteConfig
邀请用户进入当前呼叫设置的行为属性。
详情
邀请用户进入当前呼叫设置的行为属性。
Declared in ZIMDefines.h
属性
pushConfig
ZIMCallJoinConfig
加入呼叫邀请设置的行为属性。
详情
加入呼叫邀请设置的行为属性。
Declared in ZIMDefines.h
属性
extendedData
std::string extendedData扩展字段，邀请者可通过该字段携带信息给被邀请者。
ZIMCallQuitConfig
退出呼叫邀请设置的行为属性。
详情
退出呼叫邀请设置的行为属性。
Declared in ZIMDefines.h
属性
extendedData
std::string extendedData扩展字段，邀请者可通过该字段携带信息给被邀请者。
pushConfig
ZIMCallEndConfig
结束呼叫邀请设置的行为属性。
详情
结束呼叫邀请设置的行为属性。
Declared in ZIMDefines.h
属性
extendedData
std::string extendedData扩展字段，邀请者可通过该字段携带信息给被邀请者。
pushConfig
ZIMCallCancelConfig
取消呼叫邀请设置的行为属性。
详情
取消呼叫邀请设置的行为属性。
Declared in ZIMDefines.h
属性
extendedData
std::string extendedData扩展字段，邀请者可通过该字段携带信息给被邀请者。
pushConfig
ZIMCallAcceptConfig
接受呼叫邀请设置的行为属性。
详情
接受呼叫邀请设置的行为属性。
Declared in ZIMDefines.h
属性
extendedData
std::string extendedData扩展字段，邀请者可通过该字段携带信息给被邀请者。
ZIMCallRejectConfig
用于设置拒绝呼叫邀请的配置项。
详情
用于发送拒绝邀请时自定义呼叫邀请的配置。
Declared in ZIMDefines.h
- 业务场景：用户需要在调用拒绝呼叫邀请时将配置项传入接口。
属性
extendedData
std::string extendedData用于发送拒绝邀请时附加自定义内容的额外字段。
ZIMCallInvitationSentInfo
呼叫邀请已发送信息。
详情
呼叫邀请已发送信息。
Declared in ZIMDefines.h
属性
timeout
int timeout详细描述：呼叫邀请的超时时间设置，单位为秒。
errorUserList
ZIMCallingInvitationSentInfo
呼叫中邀请已发送信息。
详情
呼叫中邀请已发送信息。
Declared in ZIMDefines.h
属性
errorUserList
ZIMCallJoinSentInfo
加入呼叫操作的结果信息。
详情
加入呼叫操作的结果信息。
Declared in ZIMDefines.h
属性
extendedData
std::string extendedData调用结束呼叫时附带的透传字段。
createTime
long long createTime当次呼叫邀请的创建时间的时间戳。
joinTime
long long joinTime本人加入呼叫邀请的时间戳。
callUserList
ZIMCallQuitSentInfo
退出呼叫操作的结果信息。
详情
退出呼叫操作的结果信息。
Declared in ZIMDefines.h
属性
createTime
long long createTime当次呼叫邀请的创建时间的时间戳。
acceptTime
long long acceptTime本人接受呼叫邀请的时间戳。
quitTime
long long quitTime本人退出呼叫的时间戳。
ZIMCallEndedSentInfo
结束呼叫邀请的信息。
详情
结束呼叫邀请发送后的信息类。
Declared in ZIMDefines.h
属性
createTime
long long createTime呼叫邀请创建时的时间戳。
acceptTime
long long acceptTime被邀请者接受呼叫邀请的时间戳。
endTime
long long endTime呼叫邀请结束的时间戳。
ZIMCallInvitationReceivedInfo
接受呼叫邀请的信息。
详情
接受呼叫邀请的信息。
Declared in ZIMDefines.h
属性
mode
timeout
int timeout详细描述：呼叫邀请的超时时间设置，单位为秒。
caller
std::string caller本次呼叫邀请的创建者，与调用 callInvite 的 userID 相同。
inviter
std::string inviter邀请者ID。
createTime
long long createTime本次呼叫邀请在服务端创建时的事件戳，精确到毫秒。
callUserList
extendedData
std::string extendedData扩展字段，邀请者可通过该字段携带信息给被邀请者。
ZIMCallInvitationCreatedInfo
创建呼叫邀请的信息。
详情
创建呼叫邀请的信息。
Declared in ZIMDefines.h
属性
mode
caller
std::string caller本次呼叫邀请的创建者，与调用 callInvite 的 userID 相同。
extendedData
std::string extendedData扩展字段，邀请者可通过该字段携带信息给被邀请者。
timeout
unsigned int timeout详细描述：呼叫邀请的超时时间设置，单位为秒。
createTime
long long createTime本次呼叫邀请在服务端创建时的事件戳，精确到毫秒。
callUserList
ZIMCallInvitationCancelledInfo
取消呼叫邀请信息。
详情
取消呼叫邀请信息。
Declared in ZIMDefines.h
属性
inviter
std::string inviter呼叫邀请的邀请者ID。
mode
extendedData
std::string extendedData扩展字段，邀请者可通过该字段携带信息给被邀请者。
ZIMCallInvitationAcceptedInfo
接受呼叫邀请信息。
详情
接受呼叫邀请信息。
Declared in ZIMDefines.h
属性
invitee
std::string invitee被邀请者ID。
extendedData
std::string extendedData扩展字段，邀请者可通过该字段携带信息给被邀请者。
ZIMCallInvitationRejectedInfo
拒绝呼叫邀请信息。
详情
拒绝呼叫邀请信息。
Declared in ZIMDefines.h
属性
invitee
std::string invitee被邀请者ID。
extendedData
std::string extendedData扩展字段，邀请者可通过该字段携带信息给被邀请者。
ZIMCallInvitationEndedInfo
结束呼叫的操作信息。
详情
结束呼叫的操作信息。
Declared in ZIMDefines.h
属性
caller
std::string caller当前呼叫的主叫。
operatedUserID
std::string operatedUserID结束呼叫的操作者。
extendedData
std::string extendedData调用结束呼叫时附带的透传字段。
mode
endTime
long long endTime结束呼叫的时间戳，单位毫秒，格式: UTC 时间戳。
ZIMCallInvitationTimeoutInfo
有关超时通知的信息类。
详情
有关超时通知的信息类。
Declared in ZIMDefines.h
属性
mode
ZIMCallInvitationQueryConfig
查询呼叫邀请列表的设置属性。
详情
查询呼叫邀请列表的设置属性。
Declared in ZIMDefines.h
属性
count
unsigned int count查询条数，最多限制 100 条。传入数值超过 100，按照 100 处理。
nextFlag
long long nextFlag查询列表的标志位。首次查询时无需填充，查询后 callback 会返回一个 nextFlag,下次查询时填入可以在上一次的基础上继续往后查询。
ZIMCallInfo
呼叫邀请信息。
详情
呼叫邀请信息。
Declared in ZIMDefines.h
属性
callID
std::string callID呼叫邀请 ID。
caller
std::string caller呼叫邀请发起者 ID。
inviter
std::string inviter呼叫邀请的发起者 ID。
createTime
long long createTime呼叫邀请创建时间戳。
endTime
long long endTime呼叫邀请结束时间。
state
mode
extendedData
std::string extendedData创建呼叫邀请附加信息。
callUserList
ZIMCallUserStateChangeInfo
呼叫成员状态变化信息。
详情
呼叫成员状态变化信息。
Declared in ZIMDefines.h
属性
callUserList
ZIMBlacklistQueryConfig
黑名单查询配置。
详情
通过该配置可以设置查询总条数以及分页查询
Declared in ZIMDefines.h
属性
nextFlag
unsigned int nextFlag下一个标志。
count
unsigned int count数量。
ZIMFriendAddConfig
添加好友设置的行为属性。
详情
添加好友设置的行为属性。
Declared in ZIMDefines.h
属性
friendAlias
std::string friendAlias好友备注。
friendAttributes
std::unordered_map<std::string, std::string> friendAttributes好友属性。最多设置 5 个。属性的 key 仅支持从 k0 ～ k4 取值。
wording
std::string wording添加好友附言。
ZIMFriendDeleteConfig
删除好友设置的行为属性。
详情
添加好友设置的行为属性。
Declared in ZIMDefines.h
属性
type
ZIMFriendListQueryConfig
查询好友列表配置。
详情
查询好友列表配置。
Declared in ZIMDefines.h
属性
nextFlag
unsigned int nextFlag当前查询锚点下标。
count
unsigned int count当前查询总数。
ZIMFriendSearchConfig
好友搜索配置。
详情
好友搜索的配置类。
Declared in ZIMDefines.h
属性
nextFlag
unsigned int nextFlag查询下一页的分页标志。
count
unsigned int count每页查询的好友数量。
keywords
std::vector<std::string> keywords搜索关键词，最多支持 5 个。
isAlsoMatchFriendAlias
bool isAlsoMatchFriendAlias是否同时匹配好友备注名称。
ZIMFriendRelationCheckConfig
检查好友关系的行为属性。
详情
检查好友关系的行为属性。
Declared in ZIMDefines.h
属性
type
ZIMFriendRelationInfo
好友关系信息。
详情
好友关系信息。
Declared in ZIMDefines.h
属性
type
userID
std::string userID用户ID。
ZIMFriendInfo
好友信息。
详情
好友信息。
Declared in ZIMDefines.h
属性
friendAlias
std::string friendAlias好友备注。
friendAttributes
std::unordered_map<std::string, std::string> friendAttributes好友属性。最多设置 5 个。属性的 key 仅支持从 k0 ～ k4 取值。
createTime
long long createTime好友添加时间。
wording
std::string wording添加好友时的附言。
ZIMFriendApplicationSendConfig
发起好友申请的行为属性。
详情
发起好友申请的行为属性。
Declared in ZIMDefines.h
属性
wording
std::string wording添加好友附言。
friendAlias
std::string friendAlias好友备注。
friendAttributes
std::unordered_map<std::string, std::string> friendAttributes好友属性。最多设置 5 个。属性的 key 仅支持从 k0 ～ k4 取值。
pushConfig
ZIMFriendApplicationAcceptConfig
接受好友申请的行为属性。
详情
接受好友申请的行为属性。
Declared in ZIMDefines.h
属性
friendAlias
std::string friendAlias好友别名。
friendAttributes
std::unordered_map<std::string, std::string> friendAttributes好友属信
pushConfig
ZIMFriendApplicationRejectConfig
拒绝好友申请的行为属性。
详情
拒绝好友申请的行为属性。
Declared in ZIMDefines.h
属性
pushConfig
ZIMFriendApplicationListQueryConfig
查询好友申请列表配置。
详情
查询好友申请列表配置。
Declared in ZIMDefines.h
属性
nextFlag
unsigned int nextFlag当前查询锚点下标。
count
unsigned int count当前查询总数。
ZIMFriendApplicationInfo
好友申请信息。
详情
好友申请信息。
Declared in ZIMDefines.h
属性
type
state
applyUser
wording
std::string wording好友申请附言。
createTime
long long createTime好友添加时间。
updateTime
long long updateTime好友申请状态更新时间。
ZIMCommunityInfo
社群基本信息。
详情
社群基本信息类。
Declared in ZIMDefines.h
属性
communityID
std::string communityID社群 ID。
communityName
std::string communityName社群名称。
communityAvatarUrl
std::string communityAvatarUrl社群头像 URL。
ZIMCommunity
社群对象。
详情
社群信息类，包含社群的基本属性。
Declared in ZIMDefines.h
属性
baseInfo
totalUnreadMessageCount
unsigned int totalUnreadMessageCount所有频道的总未读消息数。
ZIMCommunityFullInfo
社群完整信息。
详情
社群完整信息类，包含社群的所有属性。
Declared in ZIMDefines.h
属性
baseInfo
communityNotice
std::string communityNotice社群公告。
communityAttributes
std::unordered_map<std::string, std::string> communityAttributes社群属性。
createTime
long long createTime社群创建时间。
creatorUserID
std::string creatorUserID社群创建者的用户 ID。
currentMemberCount
unsigned int currentMemberCount当前社群成员数量。
notificationStatus
ZIMCommunityCreateConfig
创建社群的配置。
详情
创建社群的配置类。
Declared in ZIMDefines.h
属性
communityNotice
std::string communityNotice创建社群时设置的社群公告。
communityAttributes
std::unordered_map<std::string, std::string> communityAttributes创建社群时设置的社群属性。
ZIMCommunityListQueryConfig
查询社群列表的配置。
详情
查询社群列表的配置类。
Declared in ZIMDefines.h
属性
nextFlag
long long nextFlag查询下一页的分页标志。
ZIMCommunityChangeInfo
社群变更信息
详情
社群变更信息类，描述社群属性的变化。
Declared in ZIMDefines.h
属性
action
community
ZIMCommunityMemberListQueryConfig
社群成员列表查询配置
详情
查询社群成员列表的配置类。
Declared in ZIMDefines.h
属性
nextFlag
long long nextFlag分页标记，用于获取下一页列表数据。
channelID
std::string channelID是否指定频道 ID 进行查询
isMutedMember
bool isMutedMember是否指定查询被禁言的成员
ZIMCommunityFullInfoUpdateInfo
社群详细信息的变更信息
详情
社群完整信息更新通知类。
Declared in ZIMDefines.h
属性
communityInfo
ZIMCommunityMemberEnterInfo
社群成员进入信息
详情
社群成员进入社群的信息类。
Declared in ZIMDefines.h
属性
enterTime
long long enterTime社群进入时间
enterType
operatedUserID
std::string operatedUserID社群进入操作者 userID
ZIMCommunityMemberMuteInfo
社群成员禁言信息
详情
社群成员禁言状态信息类。
Declared in ZIMDefines.h
属性
muteType
channelID
std::string channelID禁言所在的频道 ID，为空则为社群层面禁言。
muteExpiredTime
long long muteExpiredTime成员禁言的到期时间。
ZIMCommunityMemberInfo
社群成员信息
详情
社群成员信息类。
Declared in ZIMDefines.h
属性
memberRole
enterInfo
muteInfo
ZIMCommunityMemberSimpleInfo
社群成员简要信息
详情
社群成员简要信息类。
Declared in ZIMDefines.h
属性
memberRole
ZIMCommunityMemberStateChangeInfo
社群成员的状态变更信息
详情
社群成员状态变更信息类。
Declared in ZIMDefines.h
属性
state
action
memberInfo
ZIMCommunityMemberInfoUpdateInfo
社群成员详细信息的变更信息
详情
社群成员信息更新通知类。
Declared in ZIMDefines.h
属性
memberInfo
ZIMCommunityChannelInfo
社群频道基本信息。
详情
社群频道基本信息类。
Declared in ZIMDefines.h
属性
channelID
std::string channelID频道 ID。
channelType
channelName
std::string channelName频道名称。
channelAvatarUrl
std::string channelAvatarUrl频道头像 URL。
communityID
std::string communityID频道所属的社群 ID。
ZIMCommunityChannelMuteInfo
社群频道禁言信息
详情
社群频道禁言状态信息类。
Declared in ZIMDefines.h
属性
mode
expiredTime
long long expiredTime频道禁言的到期时间。
roles
ZIMCommunityChannel
社群频道对象。
详情
社群频道信息类，包含频道的基本属性。
Declared in ZIMDefines.h
属性
baseInfo
conversationID
std::string conversationID社群频道的会话 ID。
channelAttributes
std::unordered_map<std::string, std::string> channelAttributes社群频道属性。
notificationStatus
unreadMessageCount
unsigned int unreadMessageCount社群频道的未读消息数量。
lastMessage
mentionedInfoList
selfMutedExpiredTime
long long selfMutedExpiredTime本端用户在该频道的禁言到期时间。
draft
std::string draft社群频道的草稿消息。
ZIMCommunityChannelFullInfo
社群频道完整信息。
详情
社群频道完整信息类，包含频道的所有属性。
Declared in ZIMDefines.h
属性
baseInfo
createTime
long long createTime频道创建时间。
creatorUserID
std::string creatorUserID频道创建者的用户 ID。
channelNotice
std::string channelNotice频道公告。
channelAttributes
std::unordered_map<std::string, std::string> channelAttributes频道属性。
currentMemberCount
unsigned int currentMemberCount当前频道成员数量。
muteInfo
ZIMCommunityChannelCreateConfig
创建社群频道的配置。
详情
创建社群频道的配置类。
Declared in ZIMDefines.h
属性
channelNotice
std::string channelNotice创建频道时设置的频道公告。
channelAttributes
std::unordered_map<std::string, std::string> channelAttributes创建频道时设置的频道属性。
ZIMCommunityChannelListQueryConfig
查询社群频道列表的配置。
详情
查询社群频道列表的配置类。
Declared in ZIMDefines.h
属性
nextFlag
long long nextFlag查询下一页的分页标志。
ZIMCommunityChannelChangeInfo
社群频道变更信息。
详情
社群频道变更信息类，描述频道属性的变化。
Declared in ZIMDefines.h
属性
action
channel
ZIMCommunityChannelFullInfoUpdateInfo
社群频道详细信息的变更信息
详情
社群频道完整信息更新通知类。
Declared in ZIMDefines.h
属性
channelInfo
ZIMCommunityChannelMuteConfig
社群频道禁言配置
详情
社群频道禁言的配置类。
Declared in ZIMDefines.h
属性
mode
roles
duration
int duration禁言时长（秒），0 表示解除禁言。
ZIMCommunityMemberMuteConfig
社群成员禁言配置
详情
社群成员禁言的配置类。
Declared in ZIMDefines.h
属性
duration
int duration禁言时长（秒），0 表示解除禁言。
channelID
std::string channelID频道 ID，为空则在社群层面禁言。
ZIMMessageReactionsChangedEventResult
收到表态变更的回调。
Declared in ZIMDefines.h
属性
reactions
changeInfoList
ZIMMessageReceivedEventResult
收到消息时触发此事件。
Declared in ZIMDefines.h
属性
messageList
receivedInfo
ZIMCommunityListChangedEventResult
社群列表变更事件
Declared in ZIMDefines.h
属性
changeInfoList
ZIMCommunityInfoUpdatedEventResult
社群详情信息变更事件
Declared in ZIMDefines.h
属性
updateInfoList
ZIMCommunityMemberStateChangedEventResult
社群成员状态变更事件
Declared in ZIMDefines.h
属性
communityID
std::string communityID社群 ID。
changeInfoList
ZIMCommunityMemberInfoUpdatedEventResult
社群成员详细信息变更事件
Declared in ZIMDefines.h
属性
communityID
std::string communityID社群 ID。
updateInfoList
ZIMCommunityChannelListChangedEventResult
社群频道列表变更事件
Declared in ZIMDefines.h
属性
communityID
std::string communityID社群 ID。
changeInfoList
ZIMCommunityChannelInfoUpdatedEventResult
社群频道详情信息变更事件
Declared in ZIMDefines.h
属性
communityID
std::string communityID社群 ID。