# SDKConfig ```cpp class BIM::SDKConfig ``` SDK 初始化配置信息。 `Defined in : bim_client.h` ## 成员变量 | 类型 | 名称 | | --- | --- | | **String** | [sdkDir](#SDKConfig-sdkdir) | ## 变量说明 ### sdkDir ```cpp String BIM::SDKConfig::sdkDir; ``` sdk的文件目录 (UTF-8 编码)。 # Error ```cpp class BIM::Error ``` 错误信息。 `Defined in : bim_common.h` ## 成员变量 | 类型 | 名称 | | --- | --- | | **ErrorCode** | [errorCode](#Error-errorcode) | | **String** | [errorMsg](#Error-errormsg) | ## 变量说明 ### errorCode ```cpp ErrorCode BIM::Error::errorCode; ``` 错误码，参看 [ErrorCode](1263422#errorcode)。 ### errorMsg ```cpp String BIM::Error::errorMsg; ``` 错误码描述 (UTF-8 编码)。 # ConversationType ```cpp enum BIM::ConversationType ``` 会话类型 `Defined in : bim_common.h` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ONE_CHAT | 1 | 单聊会话。 | | GROUP_CHAT | 2 | 群聊会话。 | | LIVE_GROUP_CHAT | 100 | 直播群。 | # BlockStatus ```cpp enum BIM::BlockStatus ``` 禁言状态码 `Defined in : bim_conversation.h` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BLOCK_STATUS_UNBLOCK | 0 | 未禁言状态 | | BLOCK_STATUS_BLOCK | 1 | 禁言状态 | # MemberRole ```cpp enum BIM::MemberRole ``` 成员角色。 `Defined in : bim_conversation.h` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | MEMBER_ROLE_UNKNOWN | -1 | 未知成员。 | | MEMBER_ROLE_NORMAL | 0 | 普通成员。 | | MEMBER_ROLE_OWNER | 1 | 群主。 | | MEMBER_ROLE_ADMIN | 2 | 管理员。 | | MEMBER_ROLE_VISITOR | 3 | 游客。 | # Member ```cpp class BIM::Member ``` 群成员信息。 `Defined in : bim_conversation.h` ## 成员变量 | 类型 | 名称 | | --- | --- | | **MemberRole** | [role](#Member-role) | | **Long** | [userID](#Member-userid) | | **String** | [userIDString](#Member-useridstring) | | **Long** | [sortOrder](#Member-sortorder) | | **Bool** | [isOnline](#Member-isonline) | | **String** | [alias](#Member-alias) | | **String** | [avatarUrl](#Member-avatarurl) | | **StringVector** | [markTypes](#Member-marktypes) | | **StringToStringMap** | [ext](#Member-ext) | ## 变量说明 ### role ```cpp MemberRole BIM::Member::role; ``` 获取群成员角色，参看 [MemberRole](#memberrole)。 ### userID ```cpp Long BIM::Member::userID; ``` 获取群成员 userID。 ### userIDString ```cpp String BIM::Member::userIDString; ``` 获取群成员 String userID。 ### sortOrder ```cpp Long BIM::Member::sortOrder; ``` 服务器排序。服务器以加入时间为排序依据，业务方可自行根据其他字段再次排序。 ### isOnline ```cpp Bool BIM::Member::isOnline; ``` 获取用户是否在线(仅支持直播群)。 ### alias ```cpp String BIM::Member::alias; ``` 获取群成员别名 (UTF-8 编码)。 ### avatarUrl ```cpp String BIM::Member::avatarUrl; ``` 获取用户头像(仅支持直播群) (UTF-8 编码)。 ### markTypes ```cpp StringVector BIM::Member::markTypes; ``` 获取用户标记(仅支持直播群) (UTF-8 编码)，参看 [StringVector](#stringvector)。 ### ext ```cpp StringToStringMap BIM::Member::ext; ``` 获取用户额外信息(仅支持直播群) (UTF-8 编码)，参看[StringToStringMap](#stringtostringmap)。 # Conversation ```cpp struct BIM::Conversation ``` 会话信息。 `Defined in : bim_conversation.h` ## 成员变量 | 类型 | 名称 | | --- | --- | | **Long** | [conversationShortId](#Conversation-conversationshortid) | | **ConversationType** | [conversationType](#Conversation-conversationtype) | | **Bool** | [isDissolved](#Conversation-isdissolved) | | **Bool** | [isMember](#Conversation-ismember) | | **Long** | [unreadCount](#Conversation-unreadcount) | | **Bool** | [isStickTop](#Conversation-issticktop) | | **int** | [memberCount](#Conversation-membercount) | | **Long** | [updateTime](#Conversation-updatetime) | | **String** | [draftText](#Conversation-drafttext) | | **Message** | [lastMessage](#Conversation-lastmessage) | | **Long** | [sortOrder](#Conversation-sortorder) | | **String** | [conversationId](#Conversation-conversationid) | | **Bool** | [isMute](#Conversation-ismute) | | **String** | [name](#Conversation-name) | | **Long** | [onlineMemberCount](#Conversation-onlinemembercount) | | **Member** | [currentMember](#Conversation-currentmember) | | **String** | [introduction](#Conversation-introduction) | | **String** | [notice](#Conversation-notice) | | **String** | [portraitURL](#Conversation-portraiturl) | | **BlockStatus** | [blockStatus](#Conversation-blockstatus) | ## 变量说明 ### conversationShortId ```cpp Long BIM::Conversation::conversationShortId; ``` 会话 ShortId。 ### conversationType ```cpp ConversationType BIM::Conversation::conversationType; ``` 会话类型，参看 [ConversationType](#conversationtype)。 ### isDissolved ```cpp Bool BIM::Conversation::isDissolved; ``` 会话是否解散, 解散为 true, 反之为 false。 ### isMember ```cpp Bool BIM::Conversation::isMember; ``` 当前用户是否是会话成员, 当前用户在会话为 true, 被踢出、主动退出等情况为 false。 ### unreadCount ```cpp Long BIM::Conversation::unreadCount; ``` 会话未读数。 ### isStickTop ```cpp Bool BIM::Conversation::isStickTop; ``` 会话是否置顶, 置顶则为 true, 反之为 false。 ### memberCount ```cpp int BIM::Conversation::memberCount; ``` 会话成员个数。 ### updateTime ```cpp Long BIM::Conversation::updateTime; ``` 会话更新时间, 如收到消息、发出消息、产生草稿等会更新时间戳。 ### draftText ```cpp String BIM::Conversation::draftText; ``` 会话草稿内容 (UTF-8 编码)。 ### lastMessage ```cpp Message BIM::Conversation::lastMessage; ``` 会话最后一条消息，参看 [Message](#message)。 ### sortOrder ```cpp Long BIM::Conversation::sortOrder; ``` 会话排序 sortOrder。 ### conversationId ```cpp String BIM::Conversation::conversationId; ``` 会话ID (UTF-8 编码)。 ### isMute ```cpp Bool BIM::Conversation::isMute; ``` 会话是否免打扰。 ### name ```cpp String BIM::Conversation::name; ``` 会话名称 (UTF-8 编码)。 ### onlineMemberCount ```cpp Long BIM::Conversation::onlineMemberCount; ``` 直播群在线人数。 ### currentMember ```cpp Member BIM::Conversation::currentMember; ``` 当前用户在会话中的信息，参看 [Member](#member)。 ### introduction ```cpp String BIM::Conversation::introduction; ``` 会话简介 (UTF-8 编码)。 ### notice ```cpp String BIM::Conversation::notice; ``` 会话公告 (UTF-8 编码)。 ### portraitURL ```cpp String BIM::Conversation::portraitURL; ``` 会话图标 (UTF-8 编码)。 ### blockStatus ```cpp BlockStatus BIM::Conversation::blockStatus; ``` 会话禁言状态。 # LiveMemberOnlineInfo ```cpp class BIM::LiveMemberOnlineInfo ``` 直播群在线信息。 `Defined in : bim_conversation.h` ## 成员变量 | 类型 | 名称 | | --- | --- | | **Long** | [userId](#LiveMemberOnlineInfo-userid) | | **String** | [userIdString](#LiveMemberOnlineInfo-useridstring) | | **Member** | [member](#LiveMemberOnlineInfo-member) | | **bool** | [isInGroup](#LiveMemberOnlineInfo-isingroup) | | **Long** | [joinTime](#LiveMemberOnlineInfo-jointime) | | **Long** | [lastPingTime](#LiveMemberOnlineInfo-lastpingtime) | | **Long** | [conversationId](#LiveMemberOnlineInfo-conversationid) | ## 变量说明 ### userId ```cpp Long BIM::LiveMemberOnlineInfo::userId; ``` 获取用户 ID。 ### userIdString ```cpp String BIM::LiveMemberOnlineInfo::userIdString; ``` 获取用户字符串ID。 ### member ```cpp Member BIM::LiveMemberOnlineInfo::member; ``` 成员信息。 ### isInGroup ```cpp bool BIM::LiveMemberOnlineInfo::isInGroup; ``` 当前是否在直播群 (在线)。 ### joinTime ```cpp Long BIM::LiveMemberOnlineInfo::joinTime; ``` 入群时间 (单位:ms)。 ### lastPingTime ```cpp Long BIM::LiveMemberOnlineInfo::lastPingTime; ``` 最后一次 ping 成功时间(单位:ms)。 ### conversationId ```cpp Long BIM::LiveMemberOnlineInfo::conversationId; ``` 会话 shortID。 # LiveGroupMarkMemberFailedInfo ```cpp class BIM::LiveGroupMarkMemberFailedInfo ``` 直播群标记用户失败信息 `Defined in : bim_conversation.h` ## 成员变量 | 类型 | 名称 | | --- | --- | | **Long** | [uid](#LiveGroupMarkMemberFailedInfo-uid) | | **String** | [uidString](#LiveGroupMarkMemberFailedInfo-uidstring) | | **Error** | [error](#LiveGroupMarkMemberFailedInfo-error) | ## 变量说明 ### uid ```cpp Long BIM::LiveGroupMarkMemberFailedInfo::uid; ``` 获取标记失败uid。 ### uidString ```cpp String BIM::LiveGroupMarkMemberFailedInfo::uidString; ``` 获取标记是失败的String Uid。 ### error ```cpp Error BIM::LiveGroupMarkMemberFailedInfo::error; ``` 标记失败错误。 # ConnectStatus ```cpp enum BIM::ConnectStatus ``` 长连接状态码 `Defined in : bim_listener.h` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | CONNECT_STATUS_CONNECTING | 2 | 连接中 | | CONNECT_STATUS_FAILED | 4 | 连接失败 | | CONNECT_STATUS_CLOSED | 8 | 连接关闭 | | CONNECT_STATUS_CONNECTED | 16 | 连接成功 | # LiveGroupMarkTypeChangeInfo ```cpp class BIM::LiveGroupMarkTypeChangeInfo ``` 直播群成员标记类型更新信息 `Defined in : bim_listener.h` ## 成员变量 | 类型 | 名称 | | --- | --- | | **Long** | [operatorUid](#LiveGroupMarkTypeChangeInfo-operatoruid) | | **String** | [operatorUidString](#LiveGroupMarkTypeChangeInfo-operatoruidstring) | | **Long** | [conversationShortId](#LiveGroupMarkTypeChangeInfo-conversationshortid) | | **StringVector** | [markTypeList](#LiveGroupMarkTypeChangeInfo-marktypelist) | ## 变量说明 ### operatorUid ```cpp Long BIM::LiveGroupMarkTypeChangeInfo::operatorUid; ``` 变更操作人。 ### operatorUidString ```cpp String BIM::LiveGroupMarkTypeChangeInfo::operatorUidString; ``` 变更操作人 String Uid。 ### conversationShortId ```cpp Long BIM::LiveGroupMarkTypeChangeInfo::conversationShortId; ``` 会话id。 ### markTypeList ```cpp StringVector BIM::LiveGroupMarkTypeChangeInfo::markTypeList; ``` 变更标记列表 (UTF-8 编码)，参看 [StringVector](#stringvector)。 # MessagePriority ```cpp enum BIM::MessagePriority ``` 消息优先级 `Defined in : bim_liveExpandService.h` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | MSG_PRIORITY_LOW | 0 | 低优先级。 | | MSG_PRIORITY_NORMAL | 1 | 普通优先级。 | | MSG_PRIORITY_HIGH | 2 | 高优先先级。 | # LiveGroupMarkTypeAction ```cpp enum BIM::LiveGroupMarkTypeAction ``` 直播群标记变更类型 `Defined in : bim_liveExpandService.h` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | ACTION_ADD | 1 | 添加 | | ACTION_DELETE | 2 | 删除 | # MemberUpdateInfo ```cpp struct BIM::MemberUpdateInfo ``` 直播群成员资料更新信息 `Defined in : bim_liveExpandService.h` ## 成员变量 | 类型 | 名称 | | --- | --- | | **String** | [avatarUrl](#MemberUpdateInfo-avatarurl) | | **String** | [alias](#MemberUpdateInfo-alias) | | **StringVector** | [marks](#MemberUpdateInfo-marks) | | **StringToStringMap** | [ext](#MemberUpdateInfo-ext) | ## 变量说明 ### avatarUrl ```cpp String BIM::MemberUpdateInfo::avatarUrl; ``` 用户头像 URL (UTF-8 编码)。 ### alias ```cpp String BIM::MemberUpdateInfo::alias; ``` 用户群昵称 (UTF-8 编码)。 ### marks ```cpp StringVector BIM::MemberUpdateInfo::marks; ``` 用户标记 (UTF-8 编码)，参看 [StringVector](#stringvector)。 ### ext ```cpp StringToStringMap BIM::MemberUpdateInfo::ext; ``` 用户额外信息 (UTF-8 编码)，参看[StringToStringMap](#stringtostringmap)。 # LiveMemberListResult ```cpp class BIM::LiveMemberListResult ``` 成员列表数据分页结果。 `Defined in : bim_liveExpandService.h` ## 成员变量 | 类型 | 名称 | | --- | --- | | **bool** | [hasMore](#LiveMemberListResult-hasmore) | | **Long** | [nextCursor](#LiveMemberListResult-nextcursor) | | **MemberVector** | [memberList](#LiveMemberListResult-memberlist) | ## 变量说明 ### hasMore ```cpp bool BIM::LiveMemberListResult::hasMore; ``` ### nextCursor ```cpp Long BIM::LiveMemberListResult::nextCursor; ``` ### memberList ```cpp MemberVector BIM::LiveMemberListResult::memberList; ``` # GroupInfo ```cpp struct BIM::GroupInfo ``` 群组信息。 `Defined in : bim_liveExpandService.h` ## 成员变量 | 类型 | 名称 | | --- | --- | | **String** | [name](#GroupInfo-name) | | **String** | [desc](#GroupInfo-desc) | | **String** | [notice](#GroupInfo-notice) | | **String** | [avatarUrl](#GroupInfo-avatarurl) | | **StringToStringMap** | [ext](#GroupInfo-ext) | ## 变量说明 ### name ```cpp String BIM::GroupInfo::name; ``` 群聊名称 (UTF-8 编码)。 ### desc ```cpp String BIM::GroupInfo::desc; ``` 群描述 (UTF-8 编码)。 ### notice ```cpp String BIM::GroupInfo::notice; ``` 群公告内容 (UTF-8 编码)。 ### avatarUrl ```cpp String BIM::GroupInfo::avatarUrl; ``` 群头像 (UTF-8 编码)。 ### ext ```cpp StringToStringMap BIM::GroupInfo::ext; ``` 群组自定义字段 (UTF-8 编码)，参看[StringToStringMap](#stringtostringmap)。 # LiveMessageListResult ```cpp struct BIM::LiveMessageListResult ``` 直播群消息列表结果 `Defined in : bim_liveExpandService.h` ## 成员变量 | 类型 | 名称 | | --- | --- | | **MessageVector** | [messageList](#LiveMessageListResult-messagelist) | | **bool** | [hasMore](#LiveMessageListResult-hasmore) | | **Long** | [cursor](#LiveMessageListResult-cursor) | ## 变量说明 ### messageList ```cpp MessageVector BIM::LiveMessageListResult::messageList; ``` 直播群消息，参看 [Message](#message) [MessageVector](#messagevector)。 ### hasMore ```cpp bool BIM::LiveMessageListResult::hasMore; ``` 是否还有更多消息。 ### cursor ```cpp Long BIM::LiveMessageListResult::cursor; ``` 分页游标。 # LiveGroupJoinResult ```cpp struct BIM::LiveGroupJoinResult ``` 加入直播群返回信息。 `Defined in : bim_liveExpandService.h` ## 成员变量 | 类型 | 名称 | | --- | --- | | **Conversation** | [conversation](#LiveGroupJoinResult-conversation) | | **Long** | [joinMessageCursor](#LiveGroupJoinResult-joinmessagecursor) | ## 变量说明 ### conversation ```cpp Conversation BIM::LiveGroupJoinResult::conversation; ``` 加入的会话, 参看 [Conversation](#conversation)。 ### joinMessageCursor ```cpp Long BIM::LiveGroupJoinResult::joinMessageCursor; ``` 获取加入的会话时最新一条消息 Cursor，通过此游标拉取直播群历史消息。 # LiveGroupListResult ```cpp struct BIM::LiveGroupListResult ``` 会话列表数据分页结果。 `Defined in : bim_liveExpandService.h` ## 成员变量 | 类型 | 名称 | | --- | --- | | **ConversationVector** | [conversationList](#LiveGroupListResult-conversationlist) | | **bool** | [hasMore](#LiveGroupListResult-hasmore) | | **Long** | [cursor](#LiveGroupListResult-cursor) | ## 变量说明 ### conversationList ```cpp ConversationVector BIM::LiveGroupListResult::conversationList; ``` 当前页会话列表数据，参看 BIM[Conversation](#conversation) [ConversationVector](#conversationvector)。 ### hasMore ```cpp bool BIM::LiveGroupListResult::hasMore; ``` 获取是否存在更多未拉取数据。存在则返回 true 反之返回 false。 ### cursor ```cpp Long BIM::LiveGroupListResult::cursor; ``` 下一页的游标。 # MessageType ```cpp enum BIM::MessageType ``` 消息类型 `Defined in : bim_message.h` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | MESSAGE_TYPE_TEXT | 10001 | 文本消息 | | MESSAGE_TYPE_IMAGE | 10003 | 图片消息 | | MESSAGE_TYPE_VIDEO | 10004 | 视频消息 | | MESSAGE_TYPE_FILE | 10005 | 文件消息 | | MESSAGE_TYPE_AUDIO | 10006 | 语音消息 | | MESSAGE_TYPE_CUSTOM | 10012 | 自定义消息 | # MessageStatus ```cpp enum BIM::MessageStatus ``` 消息发送状态 `Defined in : bim_message.h` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | MSG_STATUS_PENDING | 0 | 发送等待, 消息只添加数据库 | | MSG_STATUS_SENDING | 1 | 发送中 | | MSG_STATUS_SUCCESS | 2 | 发送成功 | | MSG_STATUS_FAILED | 3 | 发送失败 | | MSG_STATUS_NORMAL | 5 | 收到的消息或是拉取到的发送消息 | # ReferenceInfo ```cpp struct BIM::ReferenceInfo ``` 消息体。 `Defined in : bim_message.h` ## 成员变量 | 类型 | 名称 | | --- | --- | | **Long** | [serverMessageId](#ReferenceInfo-servermessageid) | | **MessageType** | [messageType](#ReferenceInfo-messagetype) | | **String** | [hint](#ReferenceInfo-hint) | | **MessageStatus** | [status](#ReferenceInfo-status) | ## 变量说明 ### serverMessageId ```cpp Long BIM::ReferenceInfo::serverMessageId; ``` 服务端消息ID。 ### messageType ```cpp MessageType BIM::ReferenceInfo::messageType; ``` 引用消息类型。 ### hint ```cpp String BIM::ReferenceInfo::hint; ``` 获取引用消息 hint (UTF-8 编码)。 ### status ```cpp MessageStatus BIM::ReferenceInfo::status; ``` 获取引用消息状态。 # MessagePropertyItem ```cpp struct BIM::MessagePropertyItem ``` 消息属性。 `Defined in : bim_message.h` ## 成员变量 | 类型 | 名称 | | --- | --- | | **Long** | [sender](#MessagePropertyItem-sender) | | **Long** | [createAt](#MessagePropertyItem-createat) | | **String** | [idempotentId](#MessagePropertyItem-idempotentid) | | **String** | [value](#MessagePropertyItem-value) | ## 变量说明 ### sender ```cpp Long BIM::MessagePropertyItem::sender; ``` 用户id。 ### createAt ```cpp Long BIM::MessagePropertyItem::createAt; ``` 创建时间。 ### idempotentId ```cpp String BIM::MessagePropertyItem::idempotentId; ``` 幂等 ID，用来做去重、取消等；业务方自定义，需确保唯一性，SDK只负责透传 (UTF-8 编码)。 ### value ```cpp String BIM::MessagePropertyItem::value; ``` 属性的value信息，业务方自定义，SDK 只负责透传 (UTF-8 编码)。 # BaseElement ```cpp struct BIM::BaseElement ``` 消息内容 Element 的基类。通过 Message 中的 `element` 获取，并根据 `msgType` 获取的消息类型，强转为以下具体类型使用。 + 文本 Element，参看 [TextElement](#textelement)，对应消息类型参看 [MessageType](#messagetype).TYPE_TEXT。 `Defined in : bim_message.h` # TextElement ```cpp struct BIM_API BIM::TextElement ``` 文本 Element。 `Defined in : bim_message.h` ## 成员变量 | 类型 | 名称 | | --- | --- | | **String** | [text](#TextElement-text) | ## 变量说明 ### text ```cpp String BIM::TextElement::text; ``` 消息文本 (UTF-8 编码)。 # CustomElement ```cpp struct BIM_API BIM::CustomElement ``` 自定义消息 Element。 `Defined in : bim_message.h` ## 成员变量 | 类型 | 名称 | | --- | --- | | **String** | [data](#CustomElement-data) | ## 变量说明 ### data ```cpp String BIM::CustomElement::data; ``` 消息内容 (UTF-8 编码)。 # Message ```cpp struct BIM_API BIM::Message ``` 消息体。 `Defined in : bim_message.h` ## 成员变量 | 类型 | 名称 | | --- | --- | | **Bool** | [isSelf](#Message-isself) | | **Long** | [createdTime](#Message-createdtime) | | **Long** | [orderIndex](#Message-orderindex) | | **MessageType** | [msgType](#Message-msgtype) | | **ReferenceInfo** | [referenceInfo](#Message-referenceinfo) | | **Long** | [senderUid](#Message-senderuid) | | **String** | [senderUidString](#Message-senderuidstring) | | **String** | [uuid](#Message-uuid) | | **String** | [conversationId](#Message-conversationid) | | **Long** | [conversationShortId](#Message-conversationshortid) | | **ConversationType** | [conversationType](#Message-conversationtype) | | **bool** | [isRecalled](#Message-isrecalled) | | **MessageStatus** | [msgStatus](#Message-msgstatus) | | **Long** | [serverMsgId](#Message-servermsgid) | | **StringToMessagePropertyItemVectorMap** | [properties](#Message-properties) | | **BIM::StringToStringMap** | [ext](#Message-ext) | | **BaseElement*** | [element](#Message-element) | ## 变量说明 ### isSelf ```cpp Bool BIM::Message::isSelf; ``` 消息是否是自己发出，自己发出则返回 true,反之返回 false。 ### createdTime ```cpp Long BIM::Message::createdTime; ``` 消息创建时间。 ### orderIndex ```cpp Long BIM::Message::orderIndex; ``` 消息排序 index。 ### msgType ```cpp MessageType BIM::Message::msgType; ``` 消息类型，参看 [MessageType](#messagetype)。 ### referenceInfo ```cpp ReferenceInfo BIM::Message::referenceInfo; ``` 引用消息，参看 [ReferenceInfo](#referenceinfo)。 ### senderUid ```cpp Long BIM::Message::senderUid; ``` 消息发送者userID。 ### senderUidString ```cpp String BIM::Message::senderUidString; ``` 消息发送者String userID。 ### uuid ```cpp String BIM::Message::uuid; ``` 消息客户端 ID (UTF-8 编码)。 ### conversationId ```cpp String BIM::Message::conversationId; ``` 消息所属的会话 ID (UTF-8 编码)。 ### conversationShortId ```cpp Long BIM::Message::conversationShortId; ``` 获取消息所对应的会话 shortID。 ### conversationType ```cpp ConversationType BIM::Message::conversationType; ``` 会话类型。 ### isRecalled ```cpp bool BIM::Message::isRecalled; ``` 该消息是否被撤回 ### msgStatus ```cpp MessageStatus BIM::Message::msgStatus; ``` 当前消息状态，参看 [MessageStatus](#messagestatus)。 ### serverMsgId ```cpp Long BIM::Message::serverMsgId; ``` 获取消息服务端 ID。 ### properties ```cpp StringToMessagePropertyItemVectorMap BIM::Message::properties; ``` 消息属性信息，每个消息可能有多个属性，key 为属性名称，value 是该属性所对应的消息属性列表，消息属性参看 [StringToMessagePropertyItemVectorMap](#stringtomessagepropertyitemvectormap) [MessagePropertyItem](#messagepropertyitem) (UTF-8 编码)。 ### ext ```cpp BIM::StringToStringMap BIM::Message::ext; ``` 同步的拓展信息，该拓展信息跟随消息一并发送，所有接受者能够获取到里面的值 (UTF-8 编码)，参看[StringToStringMap](#stringtostringmap)。 ### element ```cpp BaseElement* BIM::Message::element = nullptr; ``` 获取消息 Element 数据，参看 [BaseElement](#baseelement)。 # BlockStatus ```cpp enum BIM::BlockStatus ``` 禁言状态码 `Defined in : bim_conversation.h` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | BLOCK_STATUS_UNBLOCK | 0 | 未禁言状态 | | BLOCK_STATUS_BLOCK | 1 | 禁言状态 | # MemberRole ```cpp enum BIM::MemberRole ``` 成员角色。 `Defined in : bim_conversation.h` ### 枚举值 | 类型 | 值 | 说明 | | --- | --- | --- | | MEMBER_ROLE_UNKNOWN | -1 | 未知成员。 | | MEMBER_ROLE_NORMAL | 0 | 普通成员。 | | MEMBER_ROLE_OWNER | 1 | 群主。 | | MEMBER_ROLE_ADMIN | 2 | 管理员。 | | MEMBER_ROLE_VISITOR | 3 | 游客。 | # Member ```cpp class BIM_API BIM::Member ``` 群成员信息。 `Defined in : bim_conversation.h` ## 成员变量 | 类型 | 名称 | | --- | --- | | **MemberRole** | [role](#Member-role) | | **Long** | [userID](#Member-userid) | | **String** | [userIDString](#Member-useridstring) | | **Long** | [sortOrder](#Member-sortorder) | | **Bool** | [isOnline](#Member-isonline) | | **String** | [alias](#Member-alias) | | **String** | [avatarUrl](#Member-avatarurl) | | **StringVector** | [markTypes](#Member-marktypes) | | **StringToStringMap** | [ext](#Member-ext) | ## 变量说明 ### role ```cpp MemberRole BIM::Member::role; ``` 获取群成员角色，参看 [MemberRole](#memberrole)。 ### userID ```cpp Long BIM::Member::userID; ``` 获取群成员 userID。 ### userIDString ```cpp String BIM::Member::userIDString; ``` 获取群成员 String userID。 ### sortOrder ```cpp Long BIM::Member::sortOrder; ``` 服务器排序。服务器以加入时间为排序依据，业务方可自行根据其他字段再次排序。 ### isOnline ```cpp Bool BIM::Member::isOnline; ``` 获取用户是否在线(仅支持直播群)。 ### alias ```cpp String BIM::Member::alias; ``` 获取群成员别名 (UTF-8 编码)。 ### avatarUrl ```cpp String BIM::Member::avatarUrl; ``` 获取用户头像(仅支持直播群) (UTF-8 编码)。 ### markTypes ```cpp StringVector BIM::Member::markTypes; ``` 获取用户标记(仅支持直播群) (UTF-8 编码)，参看 [StringVector](#stringvector)。 ### ext ```cpp StringToStringMap BIM::Member::ext; ``` 获取用户额外信息(仅支持直播群) (UTF-8 编码)，参看[StringToStringMap](#stringtostringmap)。 # Conversation ```cpp struct BIM::Conversation ``` 会话信息。 `Defined in : bim_conversation.h` ## 成员变量 | 类型 | 名称 | | --- | --- | | **Long** | [conversationShortId](#Conversation-conversationshortid) | | **ConversationType** | [conversationType](#Conversation-conversationtype) | | **Bool** | [isDissolved](#Conversation-isdissolved) | | **Bool** | [isMember](#Conversation-ismember) | | **Long** | [unreadCount](#Conversation-unreadcount) | | **Bool** | [isStickTop](#Conversation-issticktop) | | **int** | [memberCount](#Conversation-membercount) | | **Long** | [updateTime](#Conversation-updatetime) | | **String** | [draftText](#Conversation-drafttext) | | **Message** | [lastMessage](#Conversation-lastmessage) | | **Long** | [sortOrder](#Conversation-sortorder) | | **String** | [conversationId](#Conversation-conversationid) | | **Bool** | [isMute](#Conversation-ismute) | | **String** | [name](#Conversation-name) | | **Long** | [onlineMemberCount](#Conversation-onlinemembercount) | | **Member** | [currentMember](#Conversation-currentmember) | | **String** | [introduction](#Conversation-introduction) | | **String** | [notice](#Conversation-notice) | | **String** | [portraitURL](#Conversation-portraiturl) | | **BlockStatus** | [blockStatus](#Conversation-blockstatus) | ## 变量说明 ### conversationShortId ```cpp Long BIM::Conversation::conversationShortId; ``` 会话 ShortId。 ### conversationType ```cpp ConversationType BIM::Conversation::conversationType; ``` 会话类型，参看 [ConversationType](#conversationtype)。 ### isDissolved ```cpp Bool BIM::Conversation::isDissolved; ``` 会话是否解散, 解散为 true, 反之为 false。 ### isMember ```cpp Bool BIM::Conversation::isMember; ``` 当前用户是否是会话成员, 当前用户在会话为 true, 被踢出、主动退出等情况为 false。 ### unreadCount ```cpp Long BIM::Conversation::unreadCount; ``` 会话未读数。 ### isStickTop ```cpp Bool BIM::Conversation::isStickTop; ``` 会话是否置顶, 置顶则为 true, 反之为 false。 ### memberCount ```cpp int BIM::Conversation::memberCount; ``` 会话成员个数。 ### updateTime ```cpp Long BIM::Conversation::updateTime; ``` 会话更新时间, 如收到消息、发出消息、产生草稿等会更新时间戳。 ### draftText ```cpp String BIM::Conversation::draftText; ``` 会话草稿内容 (UTF-8 编码)。 ### lastMessage ```cpp Message BIM::Conversation::lastMessage; ``` 会话最后一条消息，参看 [Message](#message)。 ### sortOrder ```cpp Long BIM::Conversation::sortOrder; ``` 会话排序 sortOrder。 ### conversationId ```cpp String BIM::Conversation::conversationId; ``` 会话ID (UTF-8 编码)。 ### isMute ```cpp Bool BIM::Conversation::isMute; ``` 会话是否免打扰。 ### name ```cpp String BIM::Conversation::name; ``` 会话名称 (UTF-8 编码)。 ### onlineMemberCount ```cpp Long BIM::Conversation::onlineMemberCount; ``` 直播群在线人数。 ### currentMember ```cpp Member BIM::Conversation::currentMember; ``` 当前用户在会话中的信息，参看 [Member](#member)。 ### introduction ```cpp String BIM::Conversation::introduction; ``` 会话简介 (UTF-8 编码)。 ### notice ```cpp String BIM::Conversation::notice; ``` 会话公告 (UTF-8 编码)。 ### portraitURL ```cpp String BIM::Conversation::portraitURL; ``` 会话图标 (UTF-8 编码)。 ### blockStatus ```cpp BlockStatus BIM::Conversation::blockStatus; ``` 会话禁言状态。 # LiveMemberOnlineInfo ```cpp class BIM::LiveMemberOnlineInfo ``` 直播群在线信息。 `Defined in : bim_conversation.h` ## 成员变量 | 类型 | 名称 | | --- | --- | | **Long** | [userId](#LiveMemberOnlineInfo-userid) | | **String** | [userIdString](#LiveMemberOnlineInfo-useridstring) | | **Member** | [member](#LiveMemberOnlineInfo-member) | | **bool** | [isInGroup](#LiveMemberOnlineInfo-isingroup) | | **Long** | [joinTime](#LiveMemberOnlineInfo-jointime) | | **Long** | [lastPingTime](#LiveMemberOnlineInfo-lastpingtime) | | **Long** | [conversationId](#LiveMemberOnlineInfo-conversationid) | ## 变量说明 ### userId ```cpp Long BIM::LiveMemberOnlineInfo::userId; ``` 获取用户 ID。 ### userIdString ```cpp String BIM::LiveMemberOnlineInfo::userIdString; ``` 获取用户字符串ID。 ### member ```cpp Member BIM::LiveMemberOnlineInfo::member; ``` 成员信息。 ### isInGroup ```cpp bool BIM::LiveMemberOnlineInfo::isInGroup; ``` 当前是否在直播群 (在线)。 ### joinTime ```cpp Long BIM::LiveMemberOnlineInfo::joinTime; ``` 入群时间 (单位:ms)。 ### lastPingTime ```cpp Long BIM::LiveMemberOnlineInfo::lastPingTime; ``` 最后一次 ping 成功时间(单位:ms)。 ### conversationId ```cpp Long BIM::LiveMemberOnlineInfo::conversationId; ``` 会话 shortID。 # LiveGroupMarkMemberFailedInfo ```cpp class BIM::LiveGroupMarkMemberFailedInfo ``` 直播群标记用户失败信息 `Defined in : bim_conversation.h` ## 成员变量 | 类型 | 名称 | | --- | --- | | **Long** | [uid](#LiveGroupMarkMemberFailedInfo-uid) | | **String** | [uidString](#LiveGroupMarkMemberFailedInfo-uidstring) | | **Error** | [error](#LiveGroupMarkMemberFailedInfo-error) | ## 变量说明 ### uid ```cpp Long BIM::LiveGroupMarkMemberFailedInfo::uid; ``` 获取标记失败uid。 ### uidString ```cpp String BIM::LiveGroupMarkMemberFailedInfo::uidString; ``` 获取标记是失败的String Uid。 ### error ```cpp Error BIM::LiveGroupMarkMemberFailedInfo::error; ``` 标记失败错误。 # String ```cpp class BIM_API BIM::String ``` 字符串类型。 `Defined in : bim_string.h` ## 成员函数 | 返回 | 名称 | | --- | --- | | **** | [~String](#String-~string) | | **** | [String](#String-string) | | **** | [String](#String-string) | | **bool** | [empty](#String-empty) | | **const char*** | [toString](#String-tostring) | ## 函数说明 ### ~String ```cpp BIM::String::~String(); ``` 析构函数。 ### String ```cpp BIM::String::String(); ``` 构造函数。 ### String ```cpp String( const BIM::String::String& other) ``` 拷贝构造函数。 ### empty ```cpp bool BIM::String::empty() const; ``` 判断是否为空。 **返回值** 为空返回true，反之false。 ### toString ```cpp const char* BIM::String::toString() const; ``` 获取字符数组。 **返回值** 字符数组。 # Uid ```cpp typedef String BIM::Uid ``` 字符串类型。 `Defined in : bim_string.h` # LongVector ```cpp class BIM_API BIM::LongVector ``` Long 列表。 `Defined in : bim_types.h` ## 成员函数 | 返回 | 名称 | | --- | --- | | **** | [LongVector](#LongVector-longvector) | | **** | [~LongVector](#LongVector-~longvector) | | **** | [LongVector](#LongVector-longvector) | | **void** | [popBack](#LongVector-popback) | | **void** | [clear](#LongVector-clear) | | **bool** | [empty](#LongVector-empty) | | **** | [size](#LongVector-size) | | **void** | [erase](#LongVector-erase) | | **void** | [pushBack](#LongVector-pushback) | | **Long*** | [operator []](#LongVector-operator []) | | **LongVector&** | [operator =](#LongVector-operator =) | | **LongVector&** | [operator =](#LongVector-operator =) | ## 函数说明 ### LongVector ```cpp BIM::LongVector::LongVector(); ``` 构造函数。 ### ~LongVector ```cpp BIM::LongVector::~LongVector(); ``` 析构函数。 ### LongVector ```cpp LongVector( const BIM::LongVector::LongVector&) ``` 拷贝构造函数。 ### popBack ```cpp void BIM::LongVector::popBack(); ``` 移除尾部元素。 ### clear ```cpp void BIM::LongVector::clear(); ``` 清除所有元素。 ### empty ```cpp bool BIM::LongVector::empty() const; ``` 判断容器是否为空。 **返回值** 容器为空返回true，反之false。 ### size ```cpp size_t BIM::LongVector::size() const; ``` 获取元素数量。 **返回值** 元素数量。 ### erase ```cpp void BIM::LongVector::erase( size_t index) ``` 删除指定位置元素。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | index | **size_t** | 元素下标。 | ### pushBack ```cpp void BIM::LongVector::pushBack( Long const& obj) ``` 添加元素至末尾。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | obj | **Long const&** | 待添加元素。 | ### operator [] ```cpp Long* BIM::LongVector::operator []( size_t index) ``` **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | index | **size_t** | 元素下标。 | **返回值** 指定位置元素，如果不存在，则返回nullptr。 ### operator = ```cpp LongVector& BIM::LongVector::operator =( const LongVector&) ``` 赋值函数。 ### operator = ```cpp LongVector& BIM::LongVector::operator =( LongVector&&) ``` 赋值函数。 # StringVector ```cpp class BIM_API BIM::StringVector ``` String 列表。 `Defined in : bim_types.h` ## 成员函数 | 返回 | 名称 | | --- | --- | | **** | [StringVector](#StringVector-stringvector) | | **** | [~StringVector](#StringVector-~stringvector) | | **** | [StringVector](#StringVector-stringvector) | | **void** | [popBack](#StringVector-popback) | | **void** | [clear](#StringVector-clear) | | **bool** | [empty](#StringVector-empty) | | **** | [size](#StringVector-size) | | **void** | [erase](#StringVector-erase) | | **void** | [pushBack](#StringVector-pushback) | | **String*** | [operator []](#StringVector-operator []) | | **StringVector&** | [operator =](#StringVector-operator =) | | **StringVector&** | [operator =](#StringVector-operator =) | ## 函数说明 ### StringVector ```cpp BIM::StringVector::StringVector(); ``` 构造函数。 ### ~StringVector ```cpp BIM::StringVector::~StringVector(); ``` 析构函数。 ### StringVector ```cpp StringVector( const BIM::StringVector::StringVector&) ``` 拷贝构造函数。 ### popBack ```cpp void BIM::StringVector::popBack(); ``` 移除尾部元素。 ### clear ```cpp void BIM::StringVector::clear(); ``` 清除所有元素。 ### empty ```cpp bool BIM::StringVector::empty() const; ``` 判断容器是否为空。 **返回值** 容器为空返回true，反之false。 ### size ```cpp size_t BIM::StringVector::size() const; ``` 获取元素数量。 **返回值** 元素数量。 ### erase ```cpp void BIM::StringVector::erase( size_t index) ``` 删除指定位置元素。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | index | **size_t** | 元素下标。 | ### pushBack ```cpp void BIM::StringVector::pushBack( String const& obj) ``` 添加元素至末尾。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | obj | **String const&** | 待添加元素。 | ### operator [] ```cpp String* BIM::StringVector::operator []( size_t index) ``` **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | index | **size_t** | 元素下标。 | **返回值** 指定位置元素，如果不存在，则返回nullptr。 ### operator = ```cpp StringVector& BIM::StringVector::operator =( const StringVector&) ``` 赋值函数。 ### operator = ```cpp StringVector& BIM::StringVector::operator =( StringVector&&) ``` 赋值函数。 # MemberVector ```cpp class BIM_API BIM::MemberVector ``` Member 列表。 `Defined in : bim_types.h` ## 成员函数 | 返回 | 名称 | | --- | --- | | **** | [MemberVector](#MemberVector-membervector) | | **** | [~MemberVector](#MemberVector-~membervector) | | **** | [MemberVector](#MemberVector-membervector) | | **void** | [popBack](#MemberVector-popback) | | **void** | [clear](#MemberVector-clear) | | **bool** | [empty](#MemberVector-empty) | | **** | [size](#MemberVector-size) | | **void** | [erase](#MemberVector-erase) | | **void** | [pushBack](#MemberVector-pushback) | | **Member*** | [operator []](#MemberVector-operator []) | | **MemberVector&** | [operator =](#MemberVector-operator =) | | **MemberVector&** | [operator =](#MemberVector-operator =) | ## 函数说明 ### MemberVector ```cpp BIM::MemberVector::MemberVector(); ``` 构造函数。 ### ~MemberVector ```cpp BIM::MemberVector::~MemberVector(); ``` 析构函数。 ### MemberVector ```cpp MemberVector( const BIM::MemberVector::MemberVector&) ``` 拷贝构造函数。 ### popBack ```cpp void BIM::MemberVector::popBack(); ``` 移除尾部元素。 ### clear ```cpp void BIM::MemberVector::clear(); ``` 清除所有元素。 ### empty ```cpp bool BIM::MemberVector::empty() const; ``` 判断容器是否为空。 **返回值** 容器为空返回true，反之false。 ### size ```cpp size_t BIM::MemberVector::size() const; ``` 获取元素数量。 **返回值** 元素数量。 ### erase ```cpp void BIM::MemberVector::erase( size_t index) ``` 删除指定位置元素。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | index | **size_t** | 元素下标。 | ### pushBack ```cpp void BIM::MemberVector::pushBack( Member const& obj) ``` 添加元素至末尾。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | obj | **Member const&** | 待添加元素。 | ### operator [] ```cpp Member* BIM::MemberVector::operator []( size_t index) ``` **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | index | **size_t** | 元素下标。 | **返回值** 指定位置元素，如果不存在，则返回nullptr。 ### operator = ```cpp MemberVector& BIM::MemberVector::operator =( const MemberVector&) ``` 赋值函数。 ### operator = ```cpp MemberVector& BIM::MemberVector::operator =( MemberVector&&) ``` 赋值函数。 # MessageVector ```cpp class BIM_API BIM::MessageVector ``` Message 列表。 `Defined in : bim_types.h` ## 成员函数 | 返回 | 名称 | | --- | --- | | **** | [MessageVector](#MessageVector-messagevector) | | **** | [~MessageVector](#MessageVector-~messagevector) | | **** | [MessageVector](#MessageVector-messagevector) | | **void** | [popBack](#MessageVector-popback) | | **void** | [clear](#MessageVector-clear) | | **bool** | [empty](#MessageVector-empty) | | **** | [size](#MessageVector-size) | | **void** | [erase](#MessageVector-erase) | | **void** | [pushBack](#MessageVector-pushback) | | **Message*** | [operator []](#MessageVector-operator []) | | **MessageVector&** | [operator =](#MessageVector-operator =) | | **MessageVector&** | [operator =](#MessageVector-operator =) | ## 函数说明 ### MessageVector ```cpp BIM::MessageVector::MessageVector(); ``` 构造函数。 ### ~MessageVector ```cpp BIM::MessageVector::~MessageVector(); ``` 析构函数。 ### MessageVector ```cpp MessageVector( const BIM::MessageVector::MessageVector&) ``` 拷贝构造函数。 ### popBack ```cpp void BIM::MessageVector::popBack(); ``` 移除尾部元素。 ### clear ```cpp void BIM::MessageVector::clear(); ``` 清除所有元素。 ### empty ```cpp bool BIM::MessageVector::empty() const; ``` 判断容器是否为空。 **返回值** 容器为空返回true，反之false。 ### size ```cpp size_t BIM::MessageVector::size() const; ``` 获取元素数量。 **返回值** 元素数量。 ### erase ```cpp void BIM::MessageVector::erase( size_t index) ``` 删除指定位置元素。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | index | **size_t** | 元素下标。 | ### pushBack ```cpp void BIM::MessageVector::pushBack( Message const& obj) ``` 添加元素至末尾。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | obj | **Message const&** | 待添加元素。 | ### operator [] ```cpp Message* BIM::MessageVector::operator []( size_t index) ``` **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | index | **size_t** | 元素下标。 | **返回值** 指定位置元素，如果不存在，则返回nullptr。 ### operator = ```cpp MessageVector& BIM::MessageVector::operator =( const MessageVector&) ``` 赋值函数。 ### operator = ```cpp MessageVector& BIM::MessageVector::operator =( MessageVector&&) ``` 赋值函数。 # ConversationVector ```cpp class BIM_API BIM::ConversationVector ``` Conversation 列表。 `Defined in : bim_types.h` ## 成员函数 | 返回 | 名称 | | --- | --- | | **** | [ConversationVector](#ConversationVector-conversationvector) | | **** | [~ConversationVector](#ConversationVector-~conversationvector) | | **** | [ConversationVector](#ConversationVector-conversationvector) | | **void** | [popBack](#ConversationVector-popback) | | **void** | [clear](#ConversationVector-clear) | | **bool** | [empty](#ConversationVector-empty) | | **** | [size](#ConversationVector-size) | | **void** | [erase](#ConversationVector-erase) | | **void** | [pushBack](#ConversationVector-pushback) | | **Conversation*** | [operator []](#ConversationVector-operator []) | | **ConversationVector&** | [operator =](#ConversationVector-operator =) | | **ConversationVector&** | [operator =](#ConversationVector-operator =) | ## 函数说明 ### ConversationVector ```cpp BIM::ConversationVector::ConversationVector(); ``` 构造函数。 ### ~ConversationVector ```cpp BIM::ConversationVector::~ConversationVector(); ``` 析构函数。 ### ConversationVector ```cpp ConversationVector( const BIM::ConversationVector::ConversationVector&) ``` 拷贝构造函数。 ### popBack ```cpp void BIM::ConversationVector::popBack(); ``` 移除尾部元素。 ### clear ```cpp void BIM::ConversationVector::clear(); ``` 清除所有元素。 ### empty ```cpp bool BIM::ConversationVector::empty() const; ``` 判断容器是否为空。 **返回值** 容器为空返回true，反之false。 ### size ```cpp size_t BIM::ConversationVector::size() const; ``` 获取元素数量。 **返回值** 元素数量。 ### erase ```cpp void BIM::ConversationVector::erase( size_t index) ``` 删除指定位置元素。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | index | **size_t** | 元素下标。 | ### pushBack ```cpp void BIM::ConversationVector::pushBack( Conversation const& obj) ``` 添加元素至末尾。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | obj | **Conversation const&** | 待添加元素。 | ### operator [] ```cpp Conversation* BIM::ConversationVector::operator []( size_t index) ``` **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | index | **size_t** | 元素下标。 | **返回值** 指定位置元素，如果不存在，则返回nullptr。 ### operator = ```cpp ConversationVector& BIM::ConversationVector::operator =( const ConversationVector&) ``` 赋值函数。 ### operator = ```cpp ConversationVector& BIM::ConversationVector::operator =( ConversationVector&&) ``` 赋值函数。 # MessagePropertyItemVector ```cpp class BIM_API BIM::MessagePropertyItemVector ``` MessagePropertyItem 列表。 `Defined in : bim_types.h` ## 成员函数 | 返回 | 名称 | | --- | --- | | **** | [MessagePropertyItemVector](#MessagePropertyItemVector-messagepropertyitemvector) | | **** | [~MessagePropertyItemVector](#MessagePropertyItemVector-~messagepropertyitemvector) | | **** | [MessagePropertyItemVector](#MessagePropertyItemVector-messagepropertyitemvector) | | **void** | [popBack](#MessagePropertyItemVector-popback) | | **void** | [clear](#MessagePropertyItemVector-clear) | | **bool** | [empty](#MessagePropertyItemVector-empty) | | **** | [size](#MessagePropertyItemVector-size) | | **void** | [erase](#MessagePropertyItemVector-erase) | | **void** | [pushBack](#MessagePropertyItemVector-pushback) | | **MessagePropertyItem*** | [operator []](#MessagePropertyItemVector-operator []) | | **MessagePropertyItemVector&** | [operator =](#MessagePropertyItemVector-operator =) | | **MessagePropertyItemVector&** | [operator =](#MessagePropertyItemVector-operator =) | ## 函数说明 ### MessagePropertyItemVector ```cpp BIM::MessagePropertyItemVector::MessagePropertyItemVector(); ``` 构造函数。 ### ~MessagePropertyItemVector ```cpp BIM::MessagePropertyItemVector::~MessagePropertyItemVector(); ``` 析构函数。 ### MessagePropertyItemVector ```cpp MessagePropertyItemVector( const BIM::MessagePropertyItemVector::MessagePropertyItemVector&) ``` 拷贝构造函数。 ### popBack ```cpp void BIM::MessagePropertyItemVector::popBack(); ``` 移除尾部元素。 ### clear ```cpp void BIM::MessagePropertyItemVector::clear(); ``` 清除所有元素。 ### empty ```cpp bool BIM::MessagePropertyItemVector::empty() const; ``` 判断容器是否为空。 **返回值** 容器为空返回true，反之false。 ### size ```cpp size_t BIM::MessagePropertyItemVector::size() const; ``` 获取元素数量。 **返回值** 元素数量。 ### erase ```cpp void BIM::MessagePropertyItemVector::erase( size_t index) ``` 删除指定位置元素。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | index | **size_t** | 元素下标。 | ### pushBack ```cpp void BIM::MessagePropertyItemVector::pushBack( MessagePropertyItem const& obj) ``` 添加元素至末尾。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | obj | **MessagePropertyItem const&** | 待添加元素。 | ### operator [] ```cpp MessagePropertyItem* BIM::MessagePropertyItemVector::operator []( size_t index) ``` **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | index | **size_t** | 元素下标。 | **返回值** 指定位置元素，如果不存在，则返回nullptr。 ### operator = ```cpp MessagePropertyItemVector& BIM::MessagePropertyItemVector::operator =( const MessagePropertyItemVector&) ``` 赋值函数。 ### operator = ```cpp MessagePropertyItemVector& BIM::MessagePropertyItemVector::operator =( MessagePropertyItemVector&&) ``` 赋值函数。 # LiveMemberOnlineInfoVector ```cpp class BIM_API BIM::LiveMemberOnlineInfoVector ``` LiveMemberOnlineInfo 列表。 `Defined in : bim_types.h` ## 成员函数 | 返回 | 名称 | | --- | --- | | **** | [LiveMemberOnlineInfoVector](#LiveMemberOnlineInfoVector-livememberonlineinfovector) | | **** | [~LiveMemberOnlineInfoVector](#LiveMemberOnlineInfoVector-~livememberonlineinfovector) | | **** | [LiveMemberOnlineInfoVector](#LiveMemberOnlineInfoVector-livememberonlineinfovector) | | **void** | [popBack](#LiveMemberOnlineInfoVector-popback) | | **void** | [clear](#LiveMemberOnlineInfoVector-clear) | | **bool** | [empty](#LiveMemberOnlineInfoVector-empty) | | **** | [size](#LiveMemberOnlineInfoVector-size) | | **void** | [erase](#LiveMemberOnlineInfoVector-erase) | | **void** | [pushBack](#LiveMemberOnlineInfoVector-pushback) | | **LiveMemberOnlineInfo*** | [operator []](#LiveMemberOnlineInfoVector-operator []) | | **LiveMemberOnlineInfoVector&** | [operator =](#LiveMemberOnlineInfoVector-operator =) | | **LiveMemberOnlineInfoVector&** | [operator =](#LiveMemberOnlineInfoVector-operator =) | ## 函数说明 ### LiveMemberOnlineInfoVector ```cpp BIM::LiveMemberOnlineInfoVector::LiveMemberOnlineInfoVector(); ``` 构造函数。 ### ~LiveMemberOnlineInfoVector ```cpp BIM::LiveMemberOnlineInfoVector::~LiveMemberOnlineInfoVector(); ``` 析构函数。 ### LiveMemberOnlineInfoVector ```cpp LiveMemberOnlineInfoVector( const BIM::LiveMemberOnlineInfoVector::LiveMemberOnlineInfoVector&) ``` 拷贝构造函数。 ### popBack ```cpp void BIM::LiveMemberOnlineInfoVector::popBack(); ``` 移除尾部元素。 ### clear ```cpp void BIM::LiveMemberOnlineInfoVector::clear(); ``` 清除所有元素。 ### empty ```cpp bool BIM::LiveMemberOnlineInfoVector::empty() const; ``` 判断容器是否为空。 **返回值** 容器为空返回true，反之false。 ### size ```cpp size_t BIM::LiveMemberOnlineInfoVector::size() const; ``` 获取元素数量。 **返回值** 元素数量。 ### erase ```cpp void BIM::LiveMemberOnlineInfoVector::erase( size_t index) ``` 删除指定位置元素。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | index | **size_t** | 元素下标。 | ### pushBack ```cpp void BIM::LiveMemberOnlineInfoVector::pushBack( LiveMemberOnlineInfo const& obj) ``` 添加元素至末尾。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | obj | **LiveMemberOnlineInfo const&** | 待添加元素。 | ### operator [] ```cpp LiveMemberOnlineInfo* BIM::LiveMemberOnlineInfoVector::operator []( size_t index) ``` **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | index | **size_t** | 元素下标。 | **返回值** 指定位置元素，如果不存在，则返回nullptr。 ### operator = ```cpp LiveMemberOnlineInfoVector& BIM::LiveMemberOnlineInfoVector::operator =( const LiveMemberOnlineInfoVector&) ``` 赋值函数。 ### operator = ```cpp LiveMemberOnlineInfoVector& BIM::LiveMemberOnlineInfoVector::operator =( LiveMemberOnlineInfoVector&&) ``` 赋值函数。 # LiveGroupMarkMemberFailedInfoVector ```cpp class BIM_API BIM::LiveGroupMarkMemberFailedInfoVector ``` LiveGroupMarkMemberFailedInfo 列表。 `Defined in : bim_types.h` ## 成员函数 | 返回 | 名称 | | --- | --- | | **** | [LiveGroupMarkMemberFailedInfoVector](#LiveGroupMarkMemberFailedInfoVector-livegroupmarkmemberfailedinfovector) | | **** | [~LiveGroupMarkMemberFailedInfoVector](#LiveGroupMarkMemberFailedInfoVector-~livegroupmarkmemberfailedinfovector) | | **** | [LiveGroupMarkMemberFailedInfoVector](#LiveGroupMarkMemberFailedInfoVector-livegroupmarkmemberfailedinfovector) | | **void** | [popBack](#LiveGroupMarkMemberFailedInfoVector-popback) | | **void** | [clear](#LiveGroupMarkMemberFailedInfoVector-clear) | | **bool** | [empty](#LiveGroupMarkMemberFailedInfoVector-empty) | | **** | [size](#LiveGroupMarkMemberFailedInfoVector-size) | | **void** | [erase](#LiveGroupMarkMemberFailedInfoVector-erase) | | **void** | [pushBack](#LiveGroupMarkMemberFailedInfoVector-pushback) | | **LiveGroupMarkMemberFailedInfo*** | [operator []](#LiveGroupMarkMemberFailedInfoVector-operator []) | | **LiveGroupMarkMemberFailedInfoVector&** | [operator =](#LiveGroupMarkMemberFailedInfoVector-operator =) | | **LiveGroupMarkMemberFailedInfoVector&** | [operator =](#LiveGroupMarkMemberFailedInfoVector-operator =) | ## 函数说明 ### LiveGroupMarkMemberFailedInfoVector ```cpp BIM::LiveGroupMarkMemberFailedInfoVector::LiveGroupMarkMemberFailedInfoVector(); ``` 构造函数。 ### ~LiveGroupMarkMemberFailedInfoVector ```cpp BIM::LiveGroupMarkMemberFailedInfoVector::~LiveGroupMarkMemberFailedInfoVector(); ``` 析构函数。 ### LiveGroupMarkMemberFailedInfoVector ```cpp LiveGroupMarkMemberFailedInfoVector( const BIM::LiveGroupMarkMemberFailedInfoVector::LiveGroupMarkMemberFailedInfoVector&) ``` 拷贝构造函数。 ### popBack ```cpp void BIM::LiveGroupMarkMemberFailedInfoVector::popBack(); ``` 移除尾部元素。 ### clear ```cpp void BIM::LiveGroupMarkMemberFailedInfoVector::clear(); ``` 清除所有元素。 ### empty ```cpp bool BIM::LiveGroupMarkMemberFailedInfoVector::empty() const; ``` 判断容器是否为空。 **返回值** 容器为空返回true，反之false。 ### size ```cpp size_t BIM::LiveGroupMarkMemberFailedInfoVector::size() const; ``` 获取元素数量。 **返回值** 元素数量。 ### erase ```cpp void BIM::LiveGroupMarkMemberFailedInfoVector::erase( size_t index) ``` 删除指定位置元素。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | index | **size_t** | 元素下标。 | ### pushBack ```cpp void BIM::LiveGroupMarkMemberFailedInfoVector::pushBack( LiveGroupMarkMemberFailedInfo const& obj) ``` 添加元素至末尾。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | obj | **LiveGroupMarkMemberFailedInfo const&** | 待添加元素。 | ### operator [] ```cpp LiveGroupMarkMemberFailedInfo* BIM::LiveGroupMarkMemberFailedInfoVector::operator []( size_t index) ``` **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | index | **size_t** | 元素下标。 | **返回值** 指定位置元素，如果不存在，则返回nullptr。 ### operator = ```cpp LiveGroupMarkMemberFailedInfoVector& BIM::LiveGroupMarkMemberFailedInfoVector::operator =( const LiveGroupMarkMemberFailedInfoVector&) ``` 赋值函数。 ### operator = ```cpp LiveGroupMarkMemberFailedInfoVector& BIM::LiveGroupMarkMemberFailedInfoVector::operator =( LiveGroupMarkMemberFailedInfoVector&&) ``` 赋值函数。 # StringToMessagePropertyItemVectorMap ```cpp class BIM_API BIM::StringToMessagePropertyItemVectorMap ``` String、MessagePropertyItemVector 字典。 `Defined in : bim_types.h` ## 成员函数 | 返回 | 名称 | | --- | --- | | **** | [StringToMessagePropertyItemVectorMap](#StringToMessagePropertyItemVectorMap-stringtomessagepropertyitemvectormap) | | **** | [~StringToMessagePropertyItemVectorMap](#StringToMessagePropertyItemVectorMap-~stringtomessagepropertyitemvectormap) | | **** | [StringToMessagePropertyItemVectorMap](#StringToMessagePropertyItemVectorMap-stringtomessagepropertyitemvectormap) | | **bool** | [empty](#StringToMessagePropertyItemVectorMap-empty) | | **void** | [erase](#StringToMessagePropertyItemVectorMap-erase) | | **bool** | [insert](#StringToMessagePropertyItemVectorMap-insert) | | **** | [size](#StringToMessagePropertyItemVectorMap-size) | | **bool** | [has](#StringToMessagePropertyItemVectorMap-has) | | **size_t** | [count](#StringToMessagePropertyItemVectorMap-count) | | **MessagePropertyItemVector*** | [get](#StringToMessagePropertyItemVectorMap-get) | | **StringToMessagePropertyItemVectorMap&** | [operator =](#StringToMessagePropertyItemVectorMap-operator =) | ## 函数说明 ### StringToMessagePropertyItemVectorMap ```cpp BIM::StringToMessagePropertyItemVectorMap::StringToMessagePropertyItemVectorMap(); ``` 构造函数。 ### ~StringToMessagePropertyItemVectorMap ```cpp BIM::StringToMessagePropertyItemVectorMap::~StringToMessagePropertyItemVectorMap(); ``` 构造函数。 ### StringToMessagePropertyItemVectorMap ```cpp StringToMessagePropertyItemVectorMap( const BIM::StringToMessagePropertyItemVectorMap::StringToMessagePropertyItemVectorMap& other) ``` 移动构造函数。 ### empty ```cpp bool BIM::StringToMessagePropertyItemVectorMap::empty() const; ``` 判断容器是否为空。 **返回值** 容器为空返回true，反之false。 ### erase ```cpp void BIM::StringToMessagePropertyItemVectorMap::erase( const String& key) ``` 移除指定key及对应数据。 ### insert ```cpp bool BIM::StringToMessagePropertyItemVectorMap::insert( const String& key, const MessagePropertyItemVector& value) ``` 插入元素到容器。 **返回值** 成功返回true，失败返回false。 ### size ```cpp size_t BIM::StringToMessagePropertyItemVectorMap::size() const; ``` 获取容器元素数量。 **返回值** 容器元素数量。 ### has ```cpp bool BIM::StringToMessagePropertyItemVectorMap::has( const String& key) ``` 获取是否含有指定键值。 **返回值** 包含则返回true，反之false。 ### count ```cpp size_t BIM::StringToMessagePropertyItemVectorMap::count( const String& key) ``` 获取指定key对应的数量。 ### get ```cpp MessagePropertyItemVector* BIM::StringToMessagePropertyItemVectorMap::get( const String& key) ``` 获取指定key对应的元素，如果不存在，返回nullptr。 ### operator = ```cpp StringToMessagePropertyItemVectorMap& BIM::StringToMessagePropertyItemVectorMap::operator =( const StringToMessagePropertyItemVectorMap& map) ``` 构造函数。 # StringToStringMap ```cpp class BIM_API BIM::StringToStringMap ``` String、String 字典。 `Defined in : bim_types.h` ## 成员函数 | 返回 | 名称 | | --- | --- | | **** | [StringToStringMap](#StringToStringMap-stringtostringmap) | | **** | [~StringToStringMap](#StringToStringMap-~stringtostringmap) | | **** | [StringToStringMap](#StringToStringMap-stringtostringmap) | | **bool** | [empty](#StringToStringMap-empty) | | **void** | [erase](#StringToStringMap-erase) | | **bool** | [insert](#StringToStringMap-insert) | | **** | [size](#StringToStringMap-size) | | **bool** | [has](#StringToStringMap-has) | | **size_t** | [count](#StringToStringMap-count) | | **String*** | [get](#StringToStringMap-get) | | **StringToStringMap&** | [operator =](#StringToStringMap-operator =) | ## 函数说明 ### StringToStringMap ```cpp BIM::StringToStringMap::StringToStringMap(); ``` 构造函数。 ### ~StringToStringMap ```cpp BIM::StringToStringMap::~StringToStringMap(); ``` 构造函数。 ### StringToStringMap ```cpp StringToStringMap( const BIM::StringToStringMap::StringToStringMap& other) ``` 移动构造函数。 ### empty ```cpp bool BIM::StringToStringMap::empty() const; ``` 判断容器是否为空。 **返回值** 容器为空返回true，反之false。 ### erase ```cpp void BIM::StringToStringMap::erase( const String& key) ``` 移除指定key及对应数据。 ### insert ```cpp bool BIM::StringToStringMap::insert( const String& key, const String& value) ``` 插入元素到容器。 **返回值** 成功返回true，失败返回false。 ### size ```cpp size_t BIM::StringToStringMap::size() const; ``` 获取容器元素数量。 **返回值** 容器元素数量。 ### has ```cpp bool BIM::StringToStringMap::has( const String& key) ``` 获取是否含有指定键值。 **返回值** 包含则返回true，反之false。 ### count ```cpp size_t BIM::StringToStringMap::count( const String& key) ``` 获取指定key对应的数量。 ### get ```cpp String* BIM::StringToStringMap::get( const String& key) ``` 获取指定key对应的元素，如果不存在，返回nullptr。 ### operator = ```cpp StringToStringMap& BIM::StringToStringMap::operator =( const StringToStringMap& map) ``` 构造函数。 # UidVector ```cpp class BIM_API BIM::UidVector ``` Uid 列表。 `Defined in : bim_types.h` ## 成员函数 | 返回 | 名称 | | --- | --- | | **** | [UidVector](#UidVector-uidvector) | | **** | [~UidVector](#UidVector-~uidvector) | | **void** | [popBack](#UidVector-popback) | | **void** | [clear](#UidVector-clear) | | **bool** | [empty](#UidVector-empty) | | **** | [size](#UidVector-size) | | **void** | [erase](#UidVector-erase) | | **void** | [pushBack](#UidVector-pushback) | | **Uid*** | [operator []](#UidVector-operator []) | ## 函数说明 ### UidVector ```cpp BIM::UidVector::UidVector(); ``` 构造函数。 ### ~UidVector ```cpp BIM::UidVector::~UidVector(); ``` 析构函数。 ### popBack ```cpp void BIM::UidVector::popBack(); ``` 移除尾部元素。 ### clear ```cpp void BIM::UidVector::clear(); ``` 清除所有元素。 ### empty ```cpp bool BIM::UidVector::empty() const; ``` 判断容器是否为空。 **返回值** 容器为空返回true，反之false。 ### size ```cpp size_t BIM::UidVector::size() const; ``` 获取元素数量。 **返回值** 元素数量。 ### erase ```cpp void BIM::UidVector::erase( size_t index) ``` 删除指定位置元素。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | index | **size_t** | 元素下标。 | ### pushBack ```cpp void BIM::UidVector::pushBack( Uid const& obj) ``` 添加元素至末尾。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | obj | **Uid const&** | 待添加元素。 | ### operator [] ```cpp Uid* BIM::UidVector::operator []( size_t index) ``` **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | index | **size_t** | 元素下标。 | **返回值** 指定位置元素，如果不存在，则返回nullptr。

实时音视频