# BIMBlockStatus ```java public enum com.bytedance.im.core.api.enums.BIMBlockStatus ``` 禁言状态码 ## 枚举值 | 类型 | 说明 | | --- | --- | | **BIM_BLOCK_STATUS_UNBLOCK(0)** | 未禁言状态 | | **BIM_BLOCK_STATUS_BLOCK(1)** | 禁言状态 | # BIMConnectStatus ```java public enum com.bytedance.im.core.api.enums.BIMConnectStatus ``` 长连接状态码 ## 枚举值 | 类型 | 说明 | | --- | --- | | **BIM_CONNECT_STATUS_CONNECTING(2, "connecting")** | 连接中 | | **BIM_CONNECT_STATUS_FAILED(4, "connect failed")** | 连接失败 | | **BIM_CONNECT_STATUS_CLOSED(8, "connect closed")** | 连接关闭 | | **BIM_CONNECT_STATUS_CONNECTED(16, "connected")** | 连接成功 | # BIMConversationType ```java public enum com.bytedance.im.core.api.enums.BIMConversationType ``` 会话类型 ## 枚举值 | 类型 | 说明 | | --- | --- | | **BIM_CONVERSATION_TYPE_ONE_CHAT(1)** | 单聊会话 | | **BIM_CONVERSATION_TYPE_GROUP_CHAT(2)** | 群聊会话 | | **BIM_CONVERSATION_TYPE_LIVE_CHAT(100)** | 直播群 | # BIMEnv ```java public enum com.bytedance.im.core.api.enums.BIMEnv ``` imsdk 初始化环境 ## 枚举值 | 类型 | 说明 | | --- | --- | | **DEFAULT_ZH(0)** | （默认）国内环境 | | **I18N(5)** | 海外环境 | ## 成员函数 | 返回 | 名称 | | --- | --- | | **int** | [getEnv](#BIMEnv-getenv) | ## 函数说明 ### getEnv ```java public int com.bytedance.im.core.api.enums.BIMEnv.getEnv() ``` # BIMLogLevel ```java public enum com.bytedance.im.core.api.enums.BIMLogLevel ``` SDK 初始化配置信息，包含日志打印配置 ## 枚举值 | 类型 | 说明 | | --- | --- | | **BIM_LOG_DEBUG(1,"debug")** | debug | | **BIM_LOG_INFO(2,"info")** | info | | **BIM_LOG_WARN(3,"warn")** | warn | | **BIM_LOG_ERROR(4,"error")** | error | # BIMMemberRole ```java public enum com.bytedance.im.core.api.enums.BIMMemberRole ``` 成员角色。 ## 枚举值 | 类型 | 说明 | | --- | --- | | **BIM_MEMBER_ROLE_NORMAL(0)** | 普通成员。 | | **BIM_MEMBER_ROLE_OWNER(1)** | 群主。 | | **BIM_MEMBER_ROLE_ADMIN(2)** | 管理员。 | | **BIM_MEMBER_ROLE_VISITOR(3)** | 游客。 | # BIMMessageNewPropertyModifyType ```java public enum com.bytedance.im.core.api.enums.BIMMessageNewPropertyModifyType ``` 属性修改的类型。 ## 枚举值 | 类型 | 说明 | | --- | --- | | **ADD(0)** | 新增。 | | **REMOVE(1)** | 删除。 | ## 成员函数 | 返回 | 名称 | | --- | --- | | **BIMMessageNewPropertyModifyType** | [BIMMessageNewPropertyModifyType](#BIMMessageNewPropertyModifyType-bimmessagenewpropertymodifytype) | ## 函数说明 ### BIMMessageNewPropertyModifyType ```java com.bytedance.im.core.api.enums.BIMMessageNewPropertyModifyType.BIMMessageNewPropertyModifyType( int value) ``` # BIMMessageStatus ```java public enum com.bytedance.im.core.api.enums.BIMMessageStatus ``` 消息发送状态 ## 枚举值 | 类型 | 说明 | | --- | --- | | **BIM_MESSAGE_STATUS_PENDING(0,"pending")** | 发送等待, 消息只添加数据库 | | **BIM_MESSAGE_STATUS_SENDING(1,"sending")** | 发送中 | | **BIM_MESSAGE_STATUS_SUCCESS(2,"success")** | 发送成功 | | **BIM_MESSAGE_STATUS_FAILED(3,"failed")** | 发送失败 | | **BIM_MESSAGE_STATUS_SENDING_FILE_PARTS(4, "sending file")** | 正在上传消息的文件部分。 | | **BIM_MESSAGE_STATUS_NORMAL(5,"normal")** | 收到的消息或是拉取到的发送消息 | ## 成员函数 | 返回 | 名称 | | --- | --- | | **BIMMessageStatus** | [BIMMessageStatus](#BIMMessageStatus-bimmessagestatus) | ## 函数说明 ### BIMMessageStatus ```java com.bytedance.im.core.api.enums.BIMMessageStatus.BIMMessageStatus( int value, String des) ``` # BIMMessageType ```java public enum com.bytedance.im.core.api.enums.BIMMessageType ``` 消息类型 ## 枚举值 | 类型 | 说明 | | --- | --- | | **BIM_MESSAGE_TYPE_TEXT(10001)** | 文本消息 | | **BIM_MESSAGE_TYPE_IMAGE(10003)** | 图片消息 | | **BIM_MESSAGE_TYPE_VIDEO(10004)** | 视频消息 | | **BIM_MESSAGE_TYPE_FILE(10005)** | 文件消息 | | **BIM_MESSAGE_TYPE_AUDIO(10006)** | 语音消息 | | **BIM_MESSAGE_TYPE_CUSTOM(10012)** | 自定义消息 | # BIMPullDirection ```java public enum com.bytedance.im.core.api.enums.BIMPullDirection ``` 拉取数据顺序。 ## 枚举值 | 类型 | 说明 | | --- | --- | | **DESC(0)** | 大到小，降序。 | | **ASC(1)** | 小到大，升序。 | # BIMConversation ```java public class com.bytedance.im.core.api.model.BIMConversation ``` 会话信息。 ## 成员函数 | 返回 | 名称 | | --- | --- | | **long** | [getConversationShortID](#BIMConversation-getconversationshortid) | | **BIMConversationType** | [getConversationType](#BIMConversation-getconversationtype) | | **boolean** | [isDissolved](#BIMConversation-isdissolved) | | **boolean** | [isMember](#BIMConversation-ismember) | | **long** | [getUnReadCount](#BIMConversation-getunreadcount) | | **boolean** | [isStickTop](#BIMConversation-issticktop) | | **int** | [getMemberCount](#BIMConversation-getmembercount) | | **long** | [getUpdatedTime](#BIMConversation-getupdatedtime) | | **String** | [getDraftText](#BIMConversation-getdrafttext) | | **long** | [getDraftTime](#BIMConversation-getdrafttime) | | **BIMMessage** | [getLastMessage](#BIMConversation-getlastmessage) | | **long** | [getSortOrder](#BIMConversation-getsortorder) | | **String** | [getConversationID](#BIMConversation-getconversationid) | | **boolean** | [isMute](#BIMConversation-ismute) | | **long** | [getOppositeUserID](#BIMConversation-getoppositeuserid) | | **String** | [getName](#BIMConversation-getname) | | **String** | [getNotice](#BIMConversation-getnotice) | | **String** | [getDescription](#BIMConversation-getdescription) | | **BIMMember** | [getCurrentMember](#BIMConversation-getcurrentmember) | | **long** | [getOwnerId](#BIMConversation-getownerid) | | **void** | [setOwner](#BIMConversation-setowner) | | **String** | [getIntroduction](#BIMConversation-getintroduction) | | **String** | [getPortraitURL](#BIMConversation-getportraiturl) | | **BIMBlockStatus** | [getBlockStatus](#BIMConversation-getblockstatus) | | **long** | [getOnLineMemberCount](#BIMConversation-getonlinemembercount) | | **Map** | [getLocalExt](#BIMConversation-getlocalext) | | **Map** | [getCoreExt](#BIMConversation-getcoreext) | | **Map** | [getMyExt](#BIMConversation-getmyext) | | **boolean** | [isEnableReadReceipt](#BIMConversation-isenablereadreceipt) | ## 函数说明 ### getConversationShortID ```java public long com.bytedance.im.core.api.model.BIMConversation.getConversationShortID() ``` 获取会话 ShortId **返回值** 会话 ShortId ### getConversationType ```java public BIMConversationType com.bytedance.im.core.api.model.BIMConversation.getConversationType() ``` 获取会话类型, 参看 [BIMConversationType](#bimconversationtype) **返回值** 会话 ShortId ### isDissolved ```java public boolean com.bytedance.im.core.api.model.BIMConversation.isDissolved() ``` 会话是否解散, 解散返回 true, 反之返回 false。 **返回值** 会话是否解散, 解散返回 true, 反之返回 false。 ### isMember ```java public boolean com.bytedance.im.core.api.model.BIMConversation.isMember() ``` 获取当前用户是否是会话成员, 当前用户在会话返回 true, 被踢出、主动退出等情况返回 false。 **返回值** 当前用户是否是会话成员, 当前用户在会话返回 true, 被踢出、主动退出等情况返回 false。 ### getUnReadCount ```java public long com.bytedance.im.core.api.model.BIMConversation.getUnReadCount() ``` 获取会话未读数 **返回值** 会话未读数 ### isStickTop ```java public boolean com.bytedance.im.core.api.model.BIMConversation.isStickTop() ``` 获取会话是否置顶, 置顶则返回 true, 反之返回 false。 **返回值** 会话未读数 ### getMemberCount ```java public int com.bytedance.im.core.api.model.BIMConversation.getMemberCount() ``` 获取会话成员个数 **返回值** 会话成员个数 ### getUpdatedTime ```java public long com.bytedance.im.core.api.model.BIMConversation.getUpdatedTime() ``` 获取会话更新时间, 如收到消息、发出消息、产生草稿等会更新时间戳 **返回值** 会话更新时间 ### getDraftText ```java public String com.bytedance.im.core.api.model.BIMConversation.getDraftText() ``` 获取草稿, 可能为 null **返回值** 草稿 ### getDraftTime ```java public long com.bytedance.im.core.api.model.BIMConversation.getDraftTime() ``` 获取草稿更新时间戳 **返回值** 草稿更新时间戳 ### getLastMessage ```java public BIMMessage com.bytedance.im.core.api.model.BIMConversation.getLastMessage() ``` 获取会话最后一条消息 **返回值** 会话最后一条消息 ### getSortOrder ```java public long com.bytedance.im.core.api.model.BIMConversation.getSortOrder() ``` 获取会话排序 sortOrder **返回值** 会话排序 sortOrder ### getConversationID ```java public String com.bytedance.im.core.api.model.BIMConversation.getConversationID() ``` 获取会话ID **返回值** 会话ID ### isMute ```java public boolean com.bytedance.im.core.api.model.BIMConversation.isMute() ``` 获取会话是否免打扰 **返回值** 是否免打扰 ### getOppositeUserID ```java public long com.bytedance.im.core.api.model.BIMConversation.getOppositeUserID() ``` ### getName ```java public String com.bytedance.im.core.api.model.BIMConversation.getName() ``` 获取会话名称 **返回值** 会话名称 ### getNotice ```java public String com.bytedance.im.core.api.model.BIMConversation.getNotice() ``` 获取会话公告 **返回值** 会话公告 ### getDescription ```java public String com.bytedance.im.core.api.model.BIMConversation.getDescription() ``` 获取会话简介 **返回值** 会话简介 ### getCurrentMember ```java public BIMMember com.bytedance.im.core.api.model.BIMConversation.getCurrentMember() ``` 获取当前用户在会话中的信息 **返回值** 当前用户在会话中的信息 ### getOwnerId ```java public long com.bytedance.im.core.api.model.BIMConversation.getOwnerId() ``` 获取会话群主 id **返回值** 会话群主 id ### setOwner ```java public void com.bytedance.im.core.api.model.BIMConversation.setOwner( long id) ``` 设置会话群主。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | id | **long** | 会话群主 id | ### getIntroduction ```java public String com.bytedance.im.core.api.model.BIMConversation.getIntroduction() ``` 获取会话简介 **返回值** 会话简介 ### getPortraitURL ```java public String com.bytedance.im.core.api.model.BIMConversation.getPortraitURL() ``` 获取会话图标 **返回值** 会话图标 ### getBlockStatus ```java public BIMBlockStatus com.bytedance.im.core.api.model.BIMConversation.getBlockStatus() ``` 获取会话禁言状态 **返回值** 会话禁言状态 ### getOnLineMemberCount ```java public long com.bytedance.im.core.api.model.BIMConversation.getOnLineMemberCount() ``` 获取会话在线人数。 **返回值** 会话在线人数。 ### getLocalExt ```java public Map com.bytedance.im.core.api.model.BIMConversation.getLocalExt() ``` 获取本地额外信息 **返回值** 本地额外信息 ### getCoreExt ```java public Map com.bytedance.im.core.api.model.BIMConversation.getCoreExt() ``` 获取会话公有(成员共享)额外信息 **返回值** 公有额外信息 ### getMyExt ```java public Map com.bytedance.im.core.api.model.BIMConversation.getMyExt() ``` 获取会话私有(仅当前用户生效)额外信息 **返回值** 私有额外信息 ### isEnableReadReceipt ```java public boolean com.bytedance.im.core.api.model.BIMConversation.isEnableReadReceipt() ``` 是否支持已读未读 **返回值** 是否支持已读未读 # BIMConversationListResult ```java public class com.bytedance.im.core.api.model.BIMConversationListResult ``` 会话列表数据分页结果 ## 成员函数 | 返回 | 名称 | | --- | --- | | **long** | [getNextCursor](#BIMConversationListResult-getnextcursor) | | **boolean** | [isHasMore](#BIMConversationListResult-ishasmore) | | **List** | [getConversationList](#BIMConversationListResult-getconversationlist) | ## 函数说明 ### getNextCursor ```java public long com.bytedance.im.core.api.model.BIMConversationListResult.getNextCursor() ``` 获取会话列表。 **返回值** 下一页的游标 ### isHasMore ```java public boolean com.bytedance.im.core.api.model.BIMConversationListResult.isHasMore() ``` 获取是否存在更多未拉取数据。存在则返回 true 反之返回 false。 **返回值** 是否存在更多未拉取数据。存在则返回 true 反之返回 false。 ### getConversationList ```java public List com.bytedance.im.core.api.model.BIMConversationListResult.getConversationList() ``` 获取当前页会话列表数据 **返回值** 当前页会话列表数据, 参看 [BIMConversation](#bimconversation) # BIMGetMessageOption ```java public class com.bytedance.im.core.api.model.BIMGetMessageOption ``` 获取消息选项。 ## 成员函数 | 返回 | 名称 | | --- | --- | | **int** | [getLimit](#BIMGetMessageOption-getlimit) | | **BIMMessage** | [getAnchorMessage](#BIMGetMessageOption-getanchormessage) | ## 函数说明 ### getLimit ```java public int com.bytedance.im.core.api.model.BIMGetMessageOption.getLimit() ``` 获取消息数量。 ### getAnchorMessage ```java public BIMMessage com.bytedance.im.core.api.model.BIMGetMessageOption.getAnchorMessage() ``` 获取起点。 # Builder ```java public static final class com.bytedance.im.core.api.model.BIMGetMessageOption.Builder ``` 消息拉取 Option Builder ## 成员函数 | 返回 | 名称 | | --- | --- | | **Builder** | [limit](#Builder-limit) | | **Builder** | [anchorMessage](#Builder-anchormessage) | | **BIMGetMessageOption** | [build](#Builder-build) | ## 函数说明 ### limit ```java public Builder com.bytedance.im.core.api.model.BIMGetMessageOption.Builder.limit( int) ``` 每页消息数据个数限制, 默认 50。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | limit | **int** | 每页消息数据个数限制。 | **返回值** Builder。 ### anchorMessage ```java public Builder com.bytedance.im.core.api.model.BIMGetMessageOption.Builder.anchorMessage( BIMMessage) ``` 锚点消息，拉取的起始位置。拉取旧消息方向时传 null 代表从最新的拉取。拉取新消息方向时不可为 null。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | anchorMessage | **BIMMessage** | 锚点消息，拉取的起始位置。 | **返回值** Builder。 ### build ```java public BIMGetMessageOption com.bytedance.im.core.api.model.BIMGetMessageOption.Builder.build() ``` 创建消息拉取选项 **返回值** BIMGetMessageOption。 # BIMGroupInfo ```java public class com.bytedance.im.core.api.model.BIMGroupInfo ``` 群组信息。 ## 成员函数 | 返回 | 名称 | | --- | --- | | **String** | [getName](#BIMGroupInfo-getname) | | **String** | [getAvatarUrl](#BIMGroupInfo-getavatarurl) | | **String** | [getDesc](#BIMGroupInfo-getdesc) | | **Map** | [getMap](#BIMGroupInfo-getmap) | | **String** | [getNotice](#BIMGroupInfo-getnotice) | ## 函数说明 ### getName ```java public String com.bytedance.im.core.api.model.BIMGroupInfo.getName() ``` 获取群聊名称。 **返回值** 群聊名称。 ### getAvatarUrl ```java public String com.bytedance.im.core.api.model.BIMGroupInfo.getAvatarUrl() ``` 获取群头像。 **返回值** 群头像。 ### getDesc ```java public String com.bytedance.im.core.api.model.BIMGroupInfo.getDesc() ``` 获取群描述。 **返回值** 群描述。 ### getMap ```java public Map com.bytedance.im.core.api.model.BIMGroupInfo.getMap() ``` 获取群组自定义字段。 **返回值** 群组自定义字段。 ### getNotice ```java public String com.bytedance.im.core.api.model.BIMGroupInfo.getNotice() ``` 获取群公告。 **返回值** 群公告。 # BIMGroupInfoBuilder ```java public static final class com.bytedance.im.core.api.model.BIMGroupInfo.BIMGroupInfoBuilder ``` 创建群组信息 Builder。 ## 成员函数 | 返回 | 名称 | | --- | --- | | **BIMGroupInfoBuilder** | [name](#BIMGroupInfoBuilder-name) | | **BIMGroupInfoBuilder** | [avatarUrl](#BIMGroupInfoBuilder-avatarurl) | | **BIMGroupInfoBuilder** | [description](#BIMGroupInfoBuilder-description) | | **BIMGroupInfoBuilder** | [map](#BIMGroupInfoBuilder-map) | | **BIMGroupInfoBuilder** | [notice](#BIMGroupInfoBuilder-notice) | | **BIMGroupInfo** | [build](#BIMGroupInfoBuilder-build) | ## 函数说明 ### name ```java public BIMGroupInfoBuilder com.bytedance.im.core.api.model.BIMGroupInfo.BIMGroupInfoBuilder.name( String) ``` 设置群名称。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | name | **String** | 群名称 | **返回值** 群组信息 Builder，参看 [BIMGroupInfoBuilder](#bimgroupinfobuilder)。 ### avatarUrl ```java public BIMGroupInfoBuilder com.bytedance.im.core.api.model.BIMGroupInfo.BIMGroupInfoBuilder.avatarUrl( String) ``` 设置群头衔。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | avatarUrl | **String** | 群头像 url | **返回值** 群组信息 Builder，参看 [BIMGroupInfoBuilder](#bimgroupinfobuilder)。 ### description ```java public BIMGroupInfoBuilder com.bytedance.im.core.api.model.BIMGroupInfo.BIMGroupInfoBuilder.description( String) ``` 设置群简介。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | description | **String** | 群简介 | **返回值** 群组信息 Builder，参看 [BIMGroupInfoBuilder](#bimgroupinfobuilder)。 ### map ```java public BIMGroupInfoBuilder com.bytedance.im.core.api.model.BIMGroupInfo.BIMGroupInfoBuilder.map( Map) ``` 设置群额外属性。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | map | **Map** | 群额外属性 | **返回值** 群组信息 Builder，参看 [BIMGroupInfoBuilder](#bimgroupinfobuilder)。 ### notice ```java public BIMGroupInfoBuilder com.bytedance.im.core.api.model.BIMGroupInfo.BIMGroupInfoBuilder.notice( String) ``` 设置群公告。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | notice | **String** | 群公告内容。 | **返回值** 群组信息 Builder，参看 [BIMGroupInfoBuilder](#bimgroupinfobuilder)。 ### build ```java public BIMGroupInfo com.bytedance.im.core.api.model.BIMGroupInfo.BIMGroupInfoBuilder.build() ``` 生成群信息。 **返回值** 群信息。 # BIMMember ```java public class com.bytedance.im.core.api.model.BIMMember ``` 群成员信息。 ## 成员函数 | 返回 | 名称 | | --- | --- | | **long** | [getUserID](#BIMMember-getuserid) | | **long** | [getSortOrder](#BIMMember-getsortorder) | | **BIMMemberRole** | [getRole](#BIMMember-getrole) | | **void** | [setRole](#BIMMember-setrole) | | **String** | [getAlias](#BIMMember-getalias) | | **String** | [getConversationID](#BIMMember-getconversationid) | | **boolean** | [isOnline](#BIMMember-isonline) | | **String** | [getAvatarUrl](#BIMMember-getavatarurl) | | **Map** | [getExt](#BIMMember-getext) | | **List** | [getMarkTypes](#BIMMember-getmarktypes) | ## 函数说明 ### getUserID ```java public long com.bytedance.im.core.api.model.BIMMember.getUserID() ``` 获取群成员 userID。 **返回值** 群成员 userID ### getSortOrder ```java public long com.bytedance.im.core.api.model.BIMMember.getSortOrder() ``` 获取群成员排序 order (按入群时间序)。 **返回值** 群成员排序 order (按入群时间序) ### getRole ```java public BIMMemberRole com.bytedance.im.core.api.model.BIMMember.getRole() ``` 获取群成员角色。 **返回值** 群成员角色，参看 [BIMMemberRole](#bimmemberrole)。 ### setRole ```java public void com.bytedance.im.core.api.model.BIMMember.setRole( BIMMemberRole role) ``` 设置群成员角色。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | role | **BIMMemberRole** | 群成员角色，参看 [BIMMemberRole](#bimmemberrole)。 | ### getAlias ```java public String com.bytedance.im.core.api.model.BIMMember.getAlias() ``` 获取群成员别名。 **返回值** 群成员别名 ### getConversationID ```java public String com.bytedance.im.core.api.model.BIMMember.getConversationID() ``` 获取群 conversationID。 **返回值** conversationID ### isOnline ```java public boolean com.bytedance.im.core.api.model.BIMMember.isOnline() ``` 用户是否在线(仅支持直播群)。 **返回值** 用户是否在线(仅支持直播群) ### getAvatarUrl ```java public String com.bytedance.im.core.api.model.BIMMember.getAvatarUrl() ``` 获取用户头像(仅支持直播群)。 **返回值** 用户头像(仅支持直播群) ### getExt ```java public Map com.bytedance.im.core.api.model.BIMMember.getExt() ``` 获取用户额外信息(仅支持直播群)。 **返回值** 用户额外信息(仅支持直播群) ### getMarkTypes ```java public List com.bytedance.im.core.api.model.BIMMember.getMarkTypes() ``` 获取用户标记(仅支持直播群)。 **返回值** 用户标记(仅支持直播群) # BIMMessage ```java public class com.bytedance.im.core.api.model.BIMMessage ``` 消息体。 ## 成员函数 | 返回 | 名称 | | --- | --- | | **String** | [getHint](#BIMMessage-gethint) | | **BIMBaseElement** | [getElement](#BIMMessage-getelement) | | **boolean** | [isSelf](#BIMMessage-isself) | | **long** | [getCreatedTime](#BIMMessage-getcreatedtime) | | **long** | [getOrderIndex](#BIMMessage-getorderindex) | | **BIMMessageType** | [getMsgType](#BIMMessage-getmsgtype) | | **BIMReferenceInfo** | [getReferenceInfo](#BIMMessage-getreferenceinfo) | | **long** | [getSenderUID](#BIMMessage-getsenderuid) | | **String** | [getUuid](#BIMMessage-getuuid) | | **String** | [getConversationID](#BIMMessage-getconversationid) | | **long** | [getConversationShortID](#BIMMessage-getconversationshortid) | | **BIMConversationType** | [getConversationType](#BIMMessage-getconversationtype) | | **boolean** | [isRecalled](#BIMMessage-isrecalled) | | **BIMMessageStatus** | [getMsgStatus](#BIMMessage-getmsgstatus) | | **long** | [getServerMsgId](#BIMMessage-getservermsgid) | | **String** | [getUUId](#BIMMessage-getuuid) | | **List** | [getMentionUIDList](#BIMMessage-getmentionuidlist) | | **Map>** | [getProperties](#BIMMessage-getproperties) | | **boolean** | [isReadAck](#BIMMessage-isreadack) | | **boolean** | [isSendReadReceipt](#BIMMessage-issendreadreceipt) | | **void** | [setExtra](#BIMMessage-setextra) | | **Map** | [getExtra](#BIMMessage-getextra) | | **Map** | [getLocalExtra](#BIMMessage-getlocalextra) | | **BIMEditInfo** | [getEditInfo](#BIMMessage-geteditinfo) | | **int** | [getReadCount](#BIMMessage-getreadcount) | | **int** | [getUnReadCount](#BIMMessage-getunreadcount) | | **Long** | [getCheckCode](#BIMMessage-getcheckcode) | | **String** | [getCheckMessage](#BIMMessage-getcheckmessage) | ## 函数说明 ### getHint ```java public String com.bytedance.im.core.api.model.BIMMessage.getHint() ``` 获取消息 hint, 通常用户会话列表展示。 **返回值** 获取消息 hint ### getElement ```java public BIMBaseElement com.bytedance.im.core.api.model.BIMMessage.getElement() ``` 获取消息 Element 数据。 **返回值** 消息 Element, 参看 [BIMBaseElement](#bimbaseelement) ### isSelf ```java public boolean com.bytedance.im.core.api.model.BIMMessage.isSelf() ``` 消息是否是自己发出，自己发出则返回 true,反之返回 false。 **返回值** 消息是否是自己发出。 ### getCreatedTime ```java public long com.bytedance.im.core.api.model.BIMMessage.getCreatedTime() ``` 消息创建时间。 **返回值** 消息创建时间。 ### getOrderIndex ```java public long com.bytedance.im.core.api.model.BIMMessage.getOrderIndex() ``` 消息排序 index。 **返回值** 消息排序 index。 ### getMsgType ```java public BIMMessageType com.bytedance.im.core.api.model.BIMMessage.getMsgType() ``` 获取消息类型。 **返回值** 消息类型，参看 [BIMMessageType](#bimmessagetype)。 ### getReferenceInfo ```java public BIMReferenceInfo com.bytedance.im.core.api.model.BIMMessage.getReferenceInfo() ``` 获取引用信息，参看 [BIMReferenceInfo](#bimreferenceinfo) **返回值** 引用信息。 ### getSenderUID ```java public long com.bytedance.im.core.api.model.BIMMessage.getSenderUID() ``` 消息发送者 userID **返回值** 消息发送者 userID。 ### getUuid ```java public String com.bytedance.im.core.api.model.BIMMessage.getUuid() ``` 消息客户端 ID **返回值** 消息客户端 ID ### getConversationID ```java public String com.bytedance.im.core.api.model.BIMMessage.getConversationID() ``` 消息客户端唯一 ID **返回值** 消息客户端唯一 ID ### getConversationShortID ```java public long com.bytedance.im.core.api.model.BIMMessage.getConversationShortID() ``` 获取消息所对应的会话 shortID **返回值** 消息所对应的会话 shortID ### getConversationType ```java public BIMConversationType com.bytedance.im.core.api.model.BIMMessage.getConversationType() ``` **返回值** 会话类型 ### isRecalled ```java public boolean com.bytedance.im.core.api.model.BIMMessage.isRecalled() ``` 获取消息是否被撤回 **返回值** 是否被撤回 ### getMsgStatus ```java public BIMMessageStatus com.bytedance.im.core.api.model.BIMMessage.getMsgStatus() ``` 获取消息状态 **返回值** 消息状态，参看 [BIMMessageStatus](#bimmessagestatus)。 ### getServerMsgId ```java public long com.bytedance.im.core.api.model.BIMMessage.getServerMsgId() ``` 获取消息服务端 ID **返回值** 消息状态服务端 ID ### getUUId ```java public String com.bytedance.im.core.api.model.BIMMessage.getUUId() ``` 获取消息客户端 ID **返回值** 消息状态客户端 ID ### getMentionUIDList ```java public List com.bytedance.im.core.api.model.BIMMessage.getMentionUIDList() ``` 获取消息 at 用户列表 **返回值** 消息 at 用户列表 ### getProperties ```java public Map> com.bytedance.im.core.api.model.BIMMessage.getProperties() ``` 获取消息属性信息。 **返回值** 消息属性信息，每个消息可能有多个属性，key 为属性名称，value 是该属性所对应的消息属性列表，消息属性参看 [BIMMessagePropertyItem](#bimmessagepropertyitem)。 ### isReadAck ```java public boolean com.bytedance.im.core.api.model.BIMMessage.isReadAck() ``` 获取是否（消息接收方）已发送或（消息发送方）已收到消息已读回执, 仅支持单聊, 群聊参看 isSendReadReceipt。 **返回值** 获取是否（消息接收方）已发送或（消息发送方）已收到消息已读回执, 仅支持单聊, 群聊参看 isSendReadReceipt。 ### isSendReadReceipt ```java public boolean com.bytedance.im.core.api.model.BIMMessage.isSendReadReceipt() ``` 是否发送已读回执 **返回值** 是否发送已读回执。 ### setExtra ```java public void com.bytedance.im.core.api.model.BIMMessage.setExtra( Map extra) ``` 设置消息额外携带数据 ### getExtra ```java public Map com.bytedance.im.core.api.model.BIMMessage.getExtra() ``` 获取消息额外携带数据 **返回值** 消息额外携带数据 ### getLocalExtra ```java public Map com.bytedance.im.core.api.model.BIMMessage.getLocalExtra() ``` 本地的扩展信息 **返回值** 本地的扩展信息，仅在当前设备生效 ### getEditInfo ```java public BIMEditInfo com.bytedance.im.core.api.model.BIMMessage.getEditInfo() ``` 获取编辑信息 **返回值** 获取编辑信息,如未被编辑则返回 null ### getReadCount ```java public int com.bytedance.im.core.api.model.BIMMessage.getReadCount() ``` 获取已读人数 **返回值** 已读人数 ### getUnReadCount ```java public int com.bytedance.im.core.api.model.BIMMessage.getUnReadCount() ``` 获取未读人数 **返回值** 获取未读人数 ### getCheckCode ```java public Long com.bytedance.im.core.api.model.BIMMessage.getCheckCode() ``` 获取发消息response中的checkCode **返回值** 发消息response中的checkCode ### getCheckMessage ```java public String com.bytedance.im.core.api.model.BIMMessage.getCheckMessage() ``` 获取发消息response中的checkMessage **返回值** 发消息response中的checkMessage # BIMMessageListResult ```java public class com.bytedance.im.core.api.model.BIMMessageListResult ``` 消息列表信息。 ## 成员函数 | 返回 | 名称 | | --- | --- | | **BIMMessage** | [getAnchorMessage](#BIMMessageListResult-getanchormessage) | | **boolean** | [isHasMore](#BIMMessageListResult-ishasmore) | | **List** | [getMessageList](#BIMMessageListResult-getmessagelist) | | **String** | [toString](#BIMMessageListResult-tostring) | | **BIMMessage** | [[deprecated] getEarliestMessage](#BIMMessageListResult-getearliestmessage) | ## 函数说明 ### getAnchorMessage ```java public BIMMessage com.bytedance.im.core.api.model.BIMMessageListResult.getAnchorMessage() ``` 获取下一页锚点消息 **返回值** 下一页锚点消息 ### getEarliestMessage ```java public BIMMessage com.bytedance.im.core.api.model.BIMMessageListResult.getEarliestMessage() ``` ### isHasMore ```java public boolean com.bytedance.im.core.api.model.BIMMessageListResult.isHasMore() ``` 是否还有更多消息 **返回值** 是否还有更多消息 ### getMessageList ```java public List com.bytedance.im.core.api.model.BIMMessageListResult.getMessageList() ``` 当前页消息列表 **返回值** 当前页消息列表 ### toString ```java public String com.bytedance.im.core.api.model.BIMMessageListResult.toString() ``` # BIMMessageNewPropertyModify ```java public class com.bytedance.im.core.api.model.BIMMessageNewPropertyModify ``` 消息属性修改信息。 ## 成员函数 | 返回 | 名称 | | --- | --- | | **String** | [getKey](#BIMMessageNewPropertyModify-getkey) | | **void** | [setKey](#BIMMessageNewPropertyModify-setkey) | | **String** | [getValue](#BIMMessageNewPropertyModify-getvalue) | | **void** | [setValue](#BIMMessageNewPropertyModify-setvalue) | | **String** | [getIdempotentID](#BIMMessageNewPropertyModify-getidempotentid) | | **void** | [setIdempotentID](#BIMMessageNewPropertyModify-setidempotentid) | | **BIMMessageNewPropertyModifyType** | [getType](#BIMMessageNewPropertyModify-gettype) | | **void** | [setType](#BIMMessageNewPropertyModify-settype) | ## 函数说明 ### getKey ```java public String com.bytedance.im.core.api.model.BIMMessageNewPropertyModify.getKey() ``` 获取属性的key值。 **返回值** 属性的key值。 ### setKey ```java public void com.bytedance.im.core.api.model.BIMMessageNewPropertyModify.setKey( String key) ``` 设置属性的key值。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | key | **String** | 属性的key值。 | ### getValue ```java public String com.bytedance.im.core.api.model.BIMMessageNewPropertyModify.getValue() ``` 获取属性的value信息。 **返回值** 属性的value信息，业务方自定义，SDK内部仅透传。 ### setValue ```java public void com.bytedance.im.core.api.model.BIMMessageNewPropertyModify.setValue( String value) ``` 设置属性的value信息。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | value | **String** | 属性的value信息，业务方自定义，SDK内部仅透传。 | ### getIdempotentID ```java public String com.bytedance.im.core.api.model.BIMMessageNewPropertyModify.getIdempotentID() ``` 获取幂等 ID。 **返回值** 幂等 ID，用来做去重、取消等；业务方自定义，需确保唯一性，SDK内部仅透传。 ### setIdempotentID ```java public void com.bytedance.im.core.api.model.BIMMessageNewPropertyModify.setIdempotentID( String idempotentID) ``` 设置幂等 ID。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | idempotentID | **String** | 幂等 ID，用来做去重、取消等；业务方自定义，需确保唯一性，SDK内部仅透传。 | ### getType ```java public BIMMessageNewPropertyModifyType com.bytedance.im.core.api.model.BIMMessageNewPropertyModify.getType() ``` 获取属性修改类型。 **返回值** 属性修改的类型，参看 [BIMMessageNewPropertyModifyType](#bimmessagenewpropertymodifytype)。 ### setType ```java public void com.bytedance.im.core.api.model.BIMMessageNewPropertyModify.setType( BIMMessageNewPropertyModifyType type) ``` 设置属性修改类型。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | type | **BIMMessageNewPropertyModifyType** | 属性修改的类型，参看 [BIMMessageNewPropertyModifyType](#bimmessagenewpropertymodifytype)。 | # BIMMessagePropertyItem ```java public class com.bytedance.im.core.api.model.BIMMessagePropertyItem ``` 消息属性。 ## 成员函数 | 返回 | 名称 | | --- | --- | | **Long** | [getSender](#BIMMessagePropertyItem-getsender) | | **Long** | [getCreateAt](#BIMMessagePropertyItem-getcreateat) | | **String** | [getIdempotentId](#BIMMessagePropertyItem-getidempotentid) | | **String** | [getValue](#BIMMessagePropertyItem-getvalue) | ## 函数说明 ### getSender ```java public Long com.bytedance.im.core.api.model.BIMMessagePropertyItem.getSender() ``` 获取用户id。 **返回值** 用户id。 ### getCreateAt ```java public Long com.bytedance.im.core.api.model.BIMMessagePropertyItem.getCreateAt() ``` 获取创建时间。 **返回值** 创建时间。 ### getIdempotentId ```java public String com.bytedance.im.core.api.model.BIMMessagePropertyItem.getIdempotentId() ``` 获取幂等 ID。 **返回值** 幂等 ID，用来做去重、取消等；业务方自定义，需确保唯一性，SDK内部仅透传。 ### getValue ```java public String com.bytedance.im.core.api.model.BIMMessagePropertyItem.getValue() ``` 获取property值。 **返回值** property值。 # BIMReferenceInfo ```java public class com.bytedance.im.core.api.model.BIMReferenceInfo ``` 消息体。 ## 成员函数 | 返回 | 名称 | | --- | --- | | **BIMMessage** | [getRefMessage](#BIMReferenceInfo-getrefmessage) | | **long** | [getServerMessageID](#BIMReferenceInfo-getservermessageid) | | **BIMMessageType** | [getMessageType](#BIMReferenceInfo-getmessagetype) | | **String** | [getHint](#BIMReferenceInfo-gethint) | | **MessageStatus** | [getStatus](#BIMReferenceInfo-getstatus) | ## 函数说明 ### getRefMessage ```java public BIMMessage com.bytedance.im.core.api.model.BIMReferenceInfo.getRefMessage() ``` 获取引用消息 **返回值** 引用消息内容 ### getServerMessageID ```java public long com.bytedance.im.core.api.model.BIMReferenceInfo.getServerMessageID() ``` 获取引用消息 serverMessageID。 **返回值** 引用消息 serverMessageID。 ### getMessageType ```java public BIMMessageType com.bytedance.im.core.api.model.BIMReferenceInfo.getMessageType() ``` 获取引用消息类型。 **返回值** 引用消息类型，参看 [BIMMessageType](#bimmessagetype)。 ### getHint ```java public String com.bytedance.im.core.api.model.BIMReferenceInfo.getHint() ``` 获取引用消息 hint。 **返回值** 引用消息 hint。 ### getStatus ```java public MessageStatus com.bytedance.im.core.api.model.BIMReferenceInfo.getStatus() ``` 获取引用消息状态。 **返回值** 引用消息状态。 # BIMSDKConfig ```java public class com.bytedance.im.core.api.model.BIMSDKConfig ``` SDK 初始化配置信息，包含日志打印配置 ## 成员函数 | 返回 | 名称 | | --- | --- | | **BIMSDKConfig** | [BIMSDKConfig](#BIMSDKConfig-bimsdkconfig) | | **void** | [setLogListener](#BIMSDKConfig-setloglistener) | | **BIMLogListener** | [getLogListener](#BIMSDKConfig-getloglistener) | | **boolean** | [isEnableAPM](#BIMSDKConfig-isenableapm) | | **void** | [setEnableAPM](#BIMSDKConfig-setenableapm) | | **boolean** | [isEnableAppLog](#BIMSDKConfig-isenableapplog) | | **void** | [setEnableAppLog](#BIMSDKConfig-setenableapplog) | | **String** | [toString](#BIMSDKConfig-tostring) | ## 函数说明 ### BIMSDKConfig ```java public com.bytedance.im.core.api.model.BIMSDKConfig.BIMSDKConfig() ``` BIMSDKConfig 构造函数。 ### setLogListener ```java public void com.bytedance.im.core.api.model.BIMSDKConfig.setLogListener( BIMLogListener listener) ``` 设置日志监听,不设置或者设置为 null 时，可使用兜底 did 日志回捞功能，did 获取 BIMClient.getInstance().getSDKDid() 获取。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | listener | **BIMLogListener** | 日志监听方，参看 [BIMLogListener](293451#bimloglistener)。 | ### getLogListener ```java public BIMLogListener com.bytedance.im.core.api.model.BIMSDKConfig.getLogListener() ``` 获取日志监听。 **返回值** 日志监听方，参看 [BIMLogListener](293451#bimloglistener)。 ### isEnableAPM ```java public boolean com.bytedance.im.core.api.model.BIMSDKConfig.isEnableAPM() ``` 设置日志是否支持回捞,崩溃上报 **返回值** 日志是否支持回捞,崩溃上报 ### setEnableAPM ```java public void com.bytedance.im.core.api.model.BIMSDKConfig.setEnableAPM( boolean enableAPM) ``` 设置日志是否支持回捞 ### isEnableAppLog ```java public boolean com.bytedance.im.core.api.model.BIMSDKConfig.isEnableAppLog() ``` 设置是否支持性能监控 **返回值** 是否支持性能监控 ### setEnableAppLog ```java public void com.bytedance.im.core.api.model.BIMSDKConfig.setEnableAppLog( boolean enableAppLog) ``` 设置是否支持性能监控 **返回值** 是否支持性能监控 ### toString ```java public String com.bytedance.im.core.api.model.BIMSDKConfig.toString() ``` # BIMUnReadInfo ```java public class com.bytedance.im.core.api.model.BIMUnReadInfo ``` SDK 初始化配置信息，包含日志打印配置 ## 成员函数 | 返回 | 名称 | | --- | --- | | **int** | [getUnreadCount](#BIMUnReadInfo-getunreadcount) | ## 函数说明 ### getUnreadCount ```java public int com.bytedance.im.core.api.model.BIMUnReadInfo.getUnreadCount() ``` 获取未读计数。 **返回值** 未读计数。 # BIMGetMessageByTypeOption ```java public class com.bytedance.im.core.api.model.BIMGetMessageByTypeOption ``` imsdk 按照消息类型拉取消息列表参数。 # Builder ```java public static final class com.bytedance.im.core.api.model.BIMGetMessageByTypeOption.Builder ``` 消息拉取 Option Builder ## 成员函数 | 返回 | 名称 | | --- | --- | | **BIMGetMessageByTypeOption.Builder** | [limit](#Builder-limit) | | **BIMGetMessageByTypeOption.Builder** | [anchorMessage](#Builder-anchormessage) | | **BIMGetMessageByTypeOption.Builder** | [direction](#Builder-direction) | | **BIMGetMessageByTypeOption.Builder** | [messageTypeList](#Builder-messagetypelist) | | **BIMGetMessageByTypeOption** | [build](#Builder-build) | ## 函数说明 ### limit ```java public BIMGetMessageByTypeOption.Builder com.bytedance.im.core.api.model.BIMGetMessageByTypeOption.Builder.limit( int) ``` 每页消息数据个数限制, 默认 50。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | limit | **int** | 每页消息数据个数限制。 | **返回值** Builder。 ### anchorMessage ```java public BIMGetMessageByTypeOption.Builder com.bytedance.im.core.api.model.BIMGetMessageByTypeOption.Builder.anchorMessage( BIMMessage) ``` 锚点消息，拉取的起始位置。如果传 null，则根据 direction 调整起点，如 BIMPullDirection.DESC 则返回逆序(由大到小)，反之返回正序。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | anchorMessage | **BIMMessage** | 锚点消息，拉取的起始位置。 | **返回值** Builder。 ### direction ```java public BIMGetMessageByTypeOption.Builder com.bytedance.im.core.api.model.BIMGetMessageByTypeOption.Builder.direction( BIMPullDirection) ``` 设置拉取顺序，如 BIMPullDirection.DESC 则返回逆序(由大到小)，反之返回正序, 参看 [BIMPullDirection](#bimpulldirection)。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | direction | **BIMPullDirection** | 拉取顺序，默认降序。 | **返回值** Builder。 ### messageTypeList ```java public BIMGetMessageByTypeOption.Builder com.bytedance.im.core.api.model.BIMGetMessageByTypeOption.Builder.messageTypeList( List) ``` 设置需要拉取的消息类型, 参看 [BIMMessageType](#bimmessagetype)。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | messageTypeList | **List** | 需要拉取的消息类型。 | **返回值** Builder。 ### build ```java public BIMGetMessageByTypeOption com.bytedance.im.core.api.model.BIMGetMessageByTypeOption.Builder.build() ``` 创建消息拉取选项 **返回值** BIMGetMessageOption。 # BIMMessageReadReceipt ```java public class com.bytedance.im.core.api.model.BIMMessageReadReceipt ``` 消息已读信息 ## 成员函数 | 返回 | 名称 | | --- | --- | | **BIMMessage** | [getMessage](#BIMMessageReadReceipt-getmessage) | | **List** | [getReadMemberUidList](#BIMMessageReadReceipt-getreadmemberuidlist) | | **List** | [getUnreadMemberUidList](#BIMMessageReadReceipt-getunreadmemberuidlist) | | **String** | [getConversationId](#BIMMessageReadReceipt-getconversationid) | ## 函数说明 ### getMessage ```java public BIMMessage com.bytedance.im.core.api.model.BIMMessageReadReceipt.getMessage() ``` 获取消息。 **返回值** 消息 ### getReadMemberUidList ```java public List com.bytedance.im.core.api.model.BIMMessageReadReceipt.getReadMemberUidList() ``` 获取已读成员id列表。 **返回值** 已读成员id列表 ### getUnreadMemberUidList ```java public List com.bytedance.im.core.api.model.BIMMessageReadReceipt.getUnreadMemberUidList() ``` 获取未读成员id列表。 **返回值** 未读成员id列表 ### getConversationId ```java public String com.bytedance.im.core.api.model.BIMMessageReadReceipt.getConversationId() ``` 获取会话id。 **返回值** 会话id # BIMReadReceipt ```java public class com.bytedance.im.core.api.model.BIMReadReceipt ``` 消息已读信息通知 ## 成员函数 | 返回 | 名称 | | --- | --- | | **BIMMessage** | [getMessage](#BIMReadReceipt-getmessage) | | **long** | [getReadCount](#BIMReadReceipt-getreadcount) | | **long** | [getUnReadCount](#BIMReadReceipt-getunreadcount) | | **void** | [setUnReadCount](#BIMReadReceipt-setunreadcount) | | **long** | [getReadUID](#BIMReadReceipt-getreaduid) | ## 函数说明 ### getMessage ```java public BIMMessage com.bytedance.im.core.api.model.BIMReadReceipt.getMessage() ``` 获取消息。 **返回值** 消息 ### getReadCount ```java public long com.bytedance.im.core.api.model.BIMReadReceipt.getReadCount() ``` 获取已读成员个数。 **返回值** 已读成员个数 ### getUnReadCount ```java public long com.bytedance.im.core.api.model.BIMReadReceipt.getUnReadCount() ``` 获取未读成员id列表。 **返回值** 未读成员id列表 ### setUnReadCount ```java public void com.bytedance.im.core.api.model.BIMReadReceipt.setUnReadCount( int unReadCount) ``` ### getReadUID ```java public long com.bytedance.im.core.api.model.BIMReadReceipt.getReadUID() ``` 获取触发当前已读通知的 uid。 **返回值** 触发当前已读通知的 uid # BIMImage ```java public class com.bytedance.im.core.model.inner.msg.image.BIMImage ``` 视频消息内容 Element。 ## 成员函数 | 返回 | 名称 | | --- | --- | | **String** | [getURL](#BIMImage-geturl) | | **int** | [getWidth](#BIMImage-getwidth) | | **int** | [getHeight](#BIMImage-getheight) | | **String** | [getDownloadPath](#BIMImage-getdownloadpath) | ## 函数说明 ### getURL ```java public String com.bytedance.im.core.model.inner.msg.image.BIMImage.getURL() ``` 获取图片 URL **返回值** 图片 URL ### getWidth ```java public int com.bytedance.im.core.model.inner.msg.image.BIMImage.getWidth() ``` 获取图片宽。 **返回值** 图片宽。 ### getHeight ```java public int com.bytedance.im.core.model.inner.msg.image.BIMImage.getHeight() ``` 获取图片高。 **返回值** 图片高。 ### getDownloadPath ```java public String com.bytedance.im.core.model.inner.msg.image.BIMImage.getDownloadPath() ``` 获取文件下载路径(可能为 null ) **返回值** 文件下载路径(可能为 null ) # Size ```java public class com.bytedance.im.core.model.inner.msg.image.Size ``` 视频消息内容 Element。 ## 成员函数 | 返回 | 名称 | | --- | --- | | **int** | [getWidth](#Size-getwidth) | | **int** | [getHeight](#Size-getheight) | ## 函数说明 ### getWidth ```java public int com.bytedance.im.core.model.inner.msg.image.Size.getWidth() ``` 获取图片宽 **返回值** 图片宽 ### getHeight ```java public int com.bytedance.im.core.model.inner.msg.image.Size.getHeight() ``` 获取图片高 **返回值** 图片高 # BIMAudioElement ```java public class com.bytedance.im.core.model.inner.msg.BIMAudioElement ``` 语音消息内容 Element。 ## 成员函数 | 返回 | 名称 | | --- | --- | | **int** | [getDuration](#BIMAudioElement-getduration) | | **String** | [getURL](#BIMAudioElement-geturl) | | **String** | [getLocalPath](#BIMAudioElement-getlocalpath) | | **int** | [getProgress](#BIMAudioElement-getprogress) | | **boolean** | [isExpired](#BIMAudioElement-isexpired) | | **long** | [getFileSize](#BIMAudioElement-getfilesize) | | **String** | [getDownloadPath](#BIMAudioElement-getdownloadpath) | ## 函数说明 ### getDuration ```java public int com.bytedance.im.core.model.inner.msg.BIMAudioElement.getDuration() ``` 获取录音时长。 **返回值** 录音时长(单位秒) ### getURL ```java public String com.bytedance.im.core.model.inner.msg.BIMAudioElement.getURL() ``` 获取录音远端 URL。 **返回值** 录音远端 URL ### getLocalPath ```java public String com.bytedance.im.core.model.inner.msg.BIMAudioElement.getLocalPath() ``` 获取录音远端 URL。 **返回值** 录音远端 URL ### getProgress ```java public int com.bytedance.im.core.model.inner.msg.BIMAudioElement.getProgress() ``` 获取文件上传进度（0～100）。 **返回值** 文件上传进度（0～100） ### isExpired ```java public boolean com.bytedance.im.core.model.inner.msg.BIMAudioElement.isExpired() ``` 获取文件是否过期。 **返回值** 文件是否过期 ### getFileSize ```java public long com.bytedance.im.core.model.inner.msg.BIMAudioElement.getFileSize() ``` 获取语音文件大小(单位 : B)。 **返回值** 语音文件大小(单位 : B)。 ### getDownloadPath ```java public String com.bytedance.im.core.model.inner.msg.BIMAudioElement.getDownloadPath() ``` 获取文件下载路径(可能为 null ) **返回值** 文件下载路径(可能为 null ) # BIMBaseElement ```java public class com.bytedance.im.core.model.inner.msg.BIMBaseElement ``` 消息内容 Element 的基类。
通过 BIMMessage 中的 [getElement](#BIMMessage-getelement) 方法获取，并根据 [getMsgType](#BIMMessage-getmsgtype) 获取的消息类型，强转为以下具体类型使用。 + 文本 Element，参看 [BIMTextElement](#bimtextelement)，对应消息类型参看 [BIMMessageType](#bimmessagetype).TYPE_TEXT。 + 语音 Element，参看 [BIMAudioElement](#bimaudioelement)，对应消息类型参看 [BIMMessageType](#bimmessagetype).TYPE_AUDIO。 + 图片 Element，参看 [BIMImageElement](#bimimageelement)，对应消息类型参看 [BIMMessageType](#bimmessagetype).TYPE_IMAGE。 + 视频 Element，参看 [BIMVideoElement](#bimvideoelement)，对应消息类型参看 [BIMMessageType](#bimmessagetype).TYPE_VIDEO。 + 文件 Element，参看 [BIMFileElement](#bimfileelement)，对应消息类型参看 [BIMMessageType](#bimmessagetype).TYPE_FILE。 + 自定义 Element，参看 [BIMCustomElement](#bimcustomelement)，对应消息类型参看 [BIMMessageType](#bimmessagetype).TYPE_CUSTOM。 # BIMCustomElement ```java public class com.bytedance.im.core.model.inner.msg.BIMCustomElement ``` 自定义消息内容 Element。 # BIMFileElement ```java public class com.bytedance.im.core.model.inner.msg.BIMFileElement ``` 文件消息内容 Element。 ## 成员函数 | 返回 | 名称 | | --- | --- | | **long** | [getFileSize](#BIMFileElement-getfilesize) | | **String** | [getFileName](#BIMFileElement-getfilename) | | **String** | [getURL](#BIMFileElement-geturl) | | **int** | [getProgress](#BIMFileElement-getprogress) | | **boolean** | [isExpired](#BIMFileElement-isexpired) | | **String** | [getLocalPath](#BIMFileElement-getlocalpath) | | **Uri** | [getLocalURI](#BIMFileElement-getlocaluri) | | **String** | [getDownloadPath](#BIMFileElement-getdownloadpath) | ## 函数说明 ### getFileSize ```java public long com.bytedance.im.core.model.inner.msg.BIMFileElement.getFileSize() ``` 获取文件大小(单位: B) **返回值** 文件大小(单位: B) ### getFileName ```java public String com.bytedance.im.core.model.inner.msg.BIMFileElement.getFileName() ``` 获取文件名称 **返回值** 文件名称 ### getURL ```java public String com.bytedance.im.core.model.inner.msg.BIMFileElement.getURL() ``` 获取文件服务端 URL **返回值** 文件服务端 URL ### getProgress ```java public int com.bytedance.im.core.model.inner.msg.BIMFileElement.getProgress() ``` 获取上传进度(0～100) **返回值** 上传进度(0～100) ### isExpired ```java public boolean com.bytedance.im.core.model.inner.msg.BIMFileElement.isExpired() ``` 获取是否过期 **返回值** 是否过期 ### getLocalPath ```java public String com.bytedance.im.core.model.inner.msg.BIMFileElement.getLocalPath() ``` 获取文件本地路径(可能为 null ) **返回值** 文件本地路径(可能为 null ) ### getLocalURI ```java public Uri com.bytedance.im.core.model.inner.msg.BIMFileElement.getLocalURI() ``` 获取文件本地 URI(可能为 null ) **返回值** 文件 URI(可能为 null ) ### getDownloadPath ```java public String com.bytedance.im.core.model.inner.msg.BIMFileElement.getDownloadPath() ``` 获取文件下载路径(可能为 null ) **返回值** 文件下载路径(可能为 null ) # BIMImageElement ```java public class com.bytedance.im.core.model.inner.msg.BIMImageElement ``` 图片消息内容。 ## 成员函数 | 返回 | 名称 | | --- | --- | | **BIMImage** | [getThumbImg](#BIMImageElement-getthumbimg) | | **BIMImage** | [getLargeImg](#BIMImageElement-getlargeimg) | | **BIMImage** | [getOriginImg](#BIMImageElement-getoriginimg) | | **String** | [getLocalPath](#BIMImageElement-getlocalpath) | | **int** | [getProgress](#BIMImageElement-getprogress) | | **long** | [getFileSize](#BIMImageElement-getfilesize) | | **boolean** | [isExpired](#BIMImageElement-isexpired) | | **String** | [getDownloadPath](#BIMImageElement-getdownloadpath) | ## 函数说明 ### getThumbImg ```java public BIMImage com.bytedance.im.core.model.inner.msg.BIMImageElement.getThumbImg() ``` 获取缩略图信息。 **返回值** 缩略图信息，参看 [BIMImage](#bimimage) ### getLargeImg ```java public BIMImage com.bytedance.im.core.model.inner.msg.BIMImageElement.getLargeImg() ``` 获取大图(预览图)信息。 **返回值** 大图信息，参看 [BIMImage](#bimimage) ### getOriginImg ```java public BIMImage com.bytedance.im.core.model.inner.msg.BIMImageElement.getOriginImg() ``` 获取原图信息。[BIMImage](#bimimage) **返回值** 原图信息 ### getLocalPath ```java public String com.bytedance.im.core.model.inner.msg.BIMImageElement.getLocalPath() ``` 获取本地图片路径,可能为 null。 **返回值** 原图信息 ### getProgress ```java public int com.bytedance.im.core.model.inner.msg.BIMImageElement.getProgress() ``` 获取上传进度 **返回值** 上传进度 ### getFileSize ```java public long com.bytedance.im.core.model.inner.msg.BIMImageElement.getFileSize() ``` 获取文件大小(单位: B) **返回值** 文件大小(单位: B) ### isExpired ```java public boolean com.bytedance.im.core.model.inner.msg.BIMImageElement.isExpired() ``` 获取是否过期 **返回值** 是否过期 ### getDownloadPath ```java public String com.bytedance.im.core.model.inner.msg.BIMImageElement.getDownloadPath() ``` 获取文件下载路径(可能为 null ) **返回值** 文件下载路径(可能为 null ) # BIMTextElement ```java public class com.bytedance.im.core.model.inner.msg.BIMTextElement ``` 文本消息内容 Element。 ## 成员函数 | 返回 | 名称 | | --- | --- | | **String** | [getText](#BIMTextElement-gettext) | | **void** | [setText](#BIMTextElement-settext) | | **String** | [getMsgHint](#BIMTextElement-getmsghint) | ## 函数说明 ### getText ```java public String com.bytedance.im.core.model.inner.msg.BIMTextElement.getText() ``` 获取消息文本 **返回值** 消息文本 ### setText ```java public void com.bytedance.im.core.model.inner.msg.BIMTextElement.setText( String text) ``` 设置消息文本 ### getMsgHint ```java public String com.bytedance.im.core.model.inner.msg.BIMTextElement.getMsgHint() ``` 获取消息 hint **返回值** hint # BIMVideoElement ```java public class com.bytedance.im.core.model.inner.msg.BIMVideoElement ``` 视频消息内容 Element。 ## 成员函数 | 返回 | 名称 | | --- | --- | | **String** | [getURL](#BIMVideoElement-geturl) | | **BIMImage** | [getCoverImg](#BIMVideoElement-getcoverimg) | | **String** | [getLocalPath](#BIMVideoElement-getlocalpath) | | **int** | [getProgress](#BIMVideoElement-getprogress) | | **long** | [getFileSize](#BIMVideoElement-getfilesize) | | **boolean** | [isExpired](#BIMVideoElement-isexpired) | | **String** | [getDownloadPath](#BIMVideoElement-getdownloadpath) | ## 函数说明 ### getURL ```java public String com.bytedance.im.core.model.inner.msg.BIMVideoElement.getURL() ``` 获取视频 **返回值** 视频封面图 ### getCoverImg ```java public BIMImage com.bytedance.im.core.model.inner.msg.BIMVideoElement.getCoverImg() ``` 获取视频封面图(视频首帧） **返回值** 视频封面图，参看 [BIMImage](#bimimage) ### getLocalPath ```java public String com.bytedance.im.core.model.inner.msg.BIMVideoElement.getLocalPath() ``` 获取视频封面图(视频首帧） **返回值** 视频封面图路径 ### getProgress ```java public int com.bytedance.im.core.model.inner.msg.BIMVideoElement.getProgress() ``` 获取上传进度 **返回值** 上传进度 ### getFileSize ```java public long com.bytedance.im.core.model.inner.msg.BIMVideoElement.getFileSize() ``` 获取文件大小 **返回值** 文件大小 ### isExpired ```java public boolean com.bytedance.im.core.model.inner.msg.BIMVideoElement.isExpired() ``` 获取是否过期 **返回值** 是否过期 ### getDownloadPath ```java public String com.bytedance.im.core.model.inner.msg.BIMVideoElement.getDownloadPath() ``` 获取文件下载路径(可能为 null ) **返回值** 文件下载路径(可能为 null ) # BIMLiveGroupMarkTypeAction ```java public enum com.bytedance.im.live.api.enmus.BIMLiveGroupMarkTypeAction ``` 直播群标记变更类型 ## 枚举值 | 类型 | 说明 | | --- | --- | | **ADD(1)** | 添加 | | **DELETE(2)** | 删除 | # BIMMessagePriority ```java public enum com.bytedance.im.live.api.enmus.BIMMessagePriority ``` 消息优先级 ## 枚举值 | 类型 | 说明 | | --- | --- | | **UNKNOWN(-1)** | 低优先级 | | **LOW(0)** | 低优先级 | | **NORMAL(1)** | 普通优先级 | | **HIGH(2)** | 高优先先级 | # BIMLiveGroupListResult ```java public class com.bytedance.im.live.api.model.BIMLiveGroupListResult ``` 会话列表数据分页结果 ## 成员函数 | 返回 | 名称 | | --- | --- | | **List** | [getConversationList](#BIMLiveGroupListResult-getconversationlist) | | **long** | [getNextCursor](#BIMLiveGroupListResult-getnextcursor) | | **boolean** | [isHasMore](#BIMLiveGroupListResult-ishasmore) | ## 函数说明 ### getConversationList ```java public List com.bytedance.im.live.api.model.BIMLiveGroupListResult.getConversationList() ``` 获取当前页会话列表数据 **返回值** 当前页会话列表数据, 参看 [BIMConversation](#bimconversation) ### getNextCursor ```java public long com.bytedance.im.live.api.model.BIMLiveGroupListResult.getNextCursor() ``` 获取会话列表。 **返回值** 下一页的游标 ### isHasMore ```java public boolean com.bytedance.im.live.api.model.BIMLiveGroupListResult.isHasMore() ``` 获取是否存在更多未拉取数据。存在则返回 true 反之返回 false。 **返回值** 是否存在更多未拉取数据。存在则返回 true 反之返回 false。 # BIMLiveGroupMarkMemberFailedInfo ```java public class com.bytedance.im.live.api.model.BIMLiveGroupMarkMemberFailedInfo ``` 直播群标记用户失败信息 ## 成员函数 | 返回 | 名称 | | --- | --- | | **long** | [getUid](#BIMLiveGroupMarkMemberFailedInfo-getuid) | | **BIMErrorCode** | [getCode](#BIMLiveGroupMarkMemberFailedInfo-getcode) | ## 函数说明 ### getUid ```java public long com.bytedance.im.live.api.model.BIMLiveGroupMarkMemberFailedInfo.getUid() ``` 获取标记失败uid。 **返回值** 标记失败uid。 ### getCode ```java public BIMErrorCode com.bytedance.im.live.api.model.BIMLiveGroupMarkMemberFailedInfo.getCode() ``` 获取标记失败错误码。 **返回值** 标记失败错误码。 # BIMLiveGroupMarkTypeChangeInfo ```java public class com.bytedance.im.live.api.model.BIMLiveGroupMarkTypeChangeInfo ``` 直播群成员标记类型更新信息 ## 成员函数 | 返回 | 名称 | | --- | --- | | **long** | [getOperatorUid](#BIMLiveGroupMarkTypeChangeInfo-getoperatoruid) | | **List** | [getMarkType](#BIMLiveGroupMarkTypeChangeInfo-getmarktype) | | **long** | [getConversationShortId](#BIMLiveGroupMarkTypeChangeInfo-getconversationshortid) | ## 函数说明 ### getOperatorUid ```java public long com.bytedance.im.live.api.model.BIMLiveGroupMarkTypeChangeInfo.getOperatorUid() ``` 获取操作用户的uid **返回值** 操作用户的uid ### getMarkType ```java public List com.bytedance.im.live.api.model.BIMLiveGroupMarkTypeChangeInfo.getMarkType() ``` 获取标记类型列表 **返回值** 标记类型列表 ### getConversationShortId ```java public long com.bytedance.im.live.api.model.BIMLiveGroupMarkTypeChangeInfo.getConversationShortId() ``` 获取标记变更会话short id **返回值** 标记变更会话short id # BIMLiveJoinGroupResult ```java public class com.bytedance.im.live.api.model.BIMLiveJoinGroupResult ``` 加入直播群返回 ## 成员函数 | 返回 | 名称 | | --- | --- | | **BIMConversation** | [getConversation](#BIMLiveJoinGroupResult-getconversation) | | **long** | [getJoinMessageCursor](#BIMLiveJoinGroupResult-getjoinmessagecursor) | ## 函数说明 ### getConversation ```java public BIMConversation com.bytedance.im.live.api.model.BIMLiveJoinGroupResult.getConversation() ``` 获取加入的会话 **返回值** 获取加入的会话, 参看 [BIMConversation](#bimconversation) ### getJoinMessageCursor ```java public long com.bytedance.im.live.api.model.BIMLiveJoinGroupResult.getJoinMessageCursor() ``` 获取加入的会话时最新一条消息 Cursor，通过此游标拉取直播群历史消息 **返回值** 获取加入的会话时最新一条消息, 参看 [BIMConversation](#bimconversation) # BIMLiveMemberListResult ```java public class com.bytedance.im.live.api.model.BIMLiveMemberListResult ``` 成员列表数据分页结果 ## 成员函数 | 返回 | 名称 | | --- | --- | | **List** | [getMemberList](#BIMLiveMemberListResult-getmemberlist) | | **boolean** | [isHasMore](#BIMLiveMemberListResult-ishasmore) | | **long** | [getNextCursor](#BIMLiveMemberListResult-getnextcursor) | ## 函数说明 ### getMemberList ```java public List com.bytedance.im.live.api.model.BIMLiveMemberListResult.getMemberList() ``` 获取当前页会话成员列表数据 **返回值** 当前页会话成员列表数据, 参看 [BIMMember](#bimmember) ### isHasMore ```java public boolean com.bytedance.im.live.api.model.BIMLiveMemberListResult.isHasMore() ``` 获取是否存在更多未拉取数据。存在则返回 true 反之返回 false。 **返回值** 是否存在更多未拉取数据。存在则返回 true 反之返回 false。 ### getNextCursor ```java public long com.bytedance.im.live.api.model.BIMLiveMemberListResult.getNextCursor() ``` 获取会话列表。 **返回值** 下一页的游标 # BIMLiveMemberOnlineInfo ```java public class com.bytedance.im.live.api.model.BIMLiveMemberOnlineInfo ``` 直播群在线信息 ## 成员函数 | 返回 | 名称 | | --- | --- | | **long** | [getConversationId](#BIMLiveMemberOnlineInfo-getconversationid) | | **long** | [getUserID](#BIMLiveMemberOnlineInfo-getuserid) | | **long** | [getJoinTime](#BIMLiveMemberOnlineInfo-getjointime) | | **boolean** | [isInGroup](#BIMLiveMemberOnlineInfo-isingroup) | | **long** | [getLastPingTime](#BIMLiveMemberOnlineInfo-getlastpingtime) | | **BIMMember** | [getMember](#BIMLiveMemberOnlineInfo-getmember) | | **String** | [toString](#BIMLiveMemberOnlineInfo-tostring) | ## 函数说明 ### getConversationId ```java public long com.bytedance.im.live.api.model.BIMLiveMemberOnlineInfo.getConversationId() ``` 获取会话 shortID **返回值** 会话 shortID ### getUserID ```java public long com.bytedance.im.live.api.model.BIMLiveMemberOnlineInfo.getUserID() ``` 获取用户 ID **返回值** 用户 ID ### getJoinTime ```java public long com.bytedance.im.live.api.model.BIMLiveMemberOnlineInfo.getJoinTime() ``` 当前是否在直播群 (单位:ms) **返回值** 入群时间 (单位:ms) ### isInGroup ```java public boolean com.bytedance.im.live.api.model.BIMLiveMemberOnlineInfo.isInGroup() ``` 当前是否在直播群 (在线) **返回值** 当前是否在直播群 (在线) ### getLastPingTime ```java public long com.bytedance.im.live.api.model.BIMLiveMemberOnlineInfo.getLastPingTime() ``` 最后一次 ping 成功时间(单位:ms) **返回值** 最后一次 ping 成功时间(单位:ms) ### getMember ```java public BIMMember com.bytedance.im.live.api.model.BIMLiveMemberOnlineInfo.getMember() ``` **返回值** 成员信息 ### toString ```java public String com.bytedance.im.live.api.model.BIMLiveMemberOnlineInfo.toString() ``` # BIMLiveMessageListResult ```java public class com.bytedance.im.live.api.model.BIMLiveMessageListResult ``` 直播群消息列表结果 ## 成员函数 | 返回 | 名称 | | --- | --- | | **boolean** | [isHasMore](#BIMLiveMessageListResult-ishasmore) | | **long** | [getNextCursor](#BIMLiveMessageListResult-getnextcursor) | | **List** | [getMessageList](#BIMLiveMessageListResult-getmessagelist) | | **String** | [toString](#BIMLiveMessageListResult-tostring) | ## 函数说明 ### isHasMore ```java public boolean com.bytedance.im.live.api.model.BIMLiveMessageListResult.isHasMore() ``` 是否还有更多消息 **返回值** 是否还有更多消息 ### getNextCursor ```java public long com.bytedance.im.live.api.model.BIMLiveMessageListResult.getNextCursor() ``` 分页游标 **返回值** 分页游标 ### getMessageList ```java public List com.bytedance.im.live.api.model.BIMLiveMessageListResult.getMessageList() ``` 直播群消息 **返回值** 直播群消息 ### toString ```java public String com.bytedance.im.live.api.model.BIMLiveMessageListResult.toString() ``` # MemberUpdateInfo ```java public class com.bytedance.im.live.api.model.MemberUpdateInfo ``` 成员列表数据分页结果 ## 成员函数 | 返回 | 名称 | | --- | --- | | **long** | [getUid](#MemberUpdateInfo-getuid) | | **String** | [getAvatarUrl](#MemberUpdateInfo-getavatarurl) | | **Map** | [getExt](#MemberUpdateInfo-getext) | | **void** | [setAvatarUrl](#MemberUpdateInfo-setavatarurl) | | **void** | [setExt](#MemberUpdateInfo-setext) | | **String** | [getAlias](#MemberUpdateInfo-getalias) | | **void** | [setAlias](#MemberUpdateInfo-setalias) | | **List** | [getMarks](#MemberUpdateInfo-getmarks) | | **void** | [setMarks](#MemberUpdateInfo-setmarks) | ## 函数说明 ### getUid ```java public long com.bytedance.im.live.api.model.MemberUpdateInfo.getUid() ``` 获取用户 uid。 **返回值** 用户 uid。 ### getAvatarUrl ```java public String com.bytedance.im.live.api.model.MemberUpdateInfo.getAvatarUrl() ``` 获取用户头像 URL。 **返回值** 用户头像 URL。 ### getExt ```java public Map com.bytedance.im.live.api.model.MemberUpdateInfo.getExt() ``` 获取用户额外信息。 **返回值** 用户头额外信息。 ### setAvatarUrl ```java public void com.bytedance.im.live.api.model.MemberUpdateInfo.setAvatarUrl( String avatarUrl) ``` 设置用户头像 URL。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | avatarUrl | **String** | 用户头像 URL。 | ### setExt ```java public void com.bytedance.im.live.api.model.MemberUpdateInfo.setExt( Map ext) ``` 设置用户额外信息。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | ext | **Map** | 用户额外信息。 | ### getAlias ```java public String com.bytedance.im.live.api.model.MemberUpdateInfo.getAlias() ``` 获取用户群昵称。 ### setAlias ```java public void com.bytedance.im.live.api.model.MemberUpdateInfo.setAlias( String alias) ``` 设置用户群昵称。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | alias | **String** | 用户群昵称。 | ### getMarks ```java public List com.bytedance.im.live.api.model.MemberUpdateInfo.getMarks() ``` 设置用户标记。 ### setMarks ```java public void com.bytedance.im.live.api.model.MemberUpdateInfo.setMarks( List marks) ``` 设置用户标记。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | marks | **List** | 用户标记。 | # BIMFriendReplyType ```java public enum com.bytedance.im.user.api.enums.BIMFriendReplyType ``` 好友申请回应状态。 ## 枚举值 | 类型 | 说明 | | --- | --- | | **BIM_FRIEND_REPLY_AGREE(0)** | 接受好友申请。 | | **BIM_FRIEND_REPLY_REFUSE(1)** | 拒绝好友申请。 | # BIMFriendStatus ```java public enum com.bytedance.im.user.api.enums.BIMFriendStatus ``` 好友状态 ## 枚举值 | 类型 | 说明 | | --- | --- | | **BIM_FRIEND_STATUS_APPLY(0)** | 申请状态 | | **BIM_FRIEND_STATUS_AGREE(1)** | 同意状态 | | **BIM_FRIEND_STATUS_REFUSE(2)** | 拒绝状态 | # BIMApplyInfo ```java public class com.bytedance.im.user.api.model.BIMApplyInfo ``` 好友申请信息。 ## 成员函数 | 返回 | 名称 | | --- | --- | | **void** | [setUid](#BIMApplyInfo-setuid) | | **void** | [setExt](#BIMApplyInfo-setext) | ## 函数说明 ### setUid ```java public void com.bytedance.im.user.api.model.BIMApplyInfo.setUid( long uid) ``` 设置用户 ID。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | uid | **long** | 用户 ID。 | ### setExt ```java public void com.bytedance.im.user.api.model.BIMApplyInfo.setExt( Map ext) ``` 设置额外信息。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | ext | **Map** | 额外信息。 | # BIMBlackListFriendInfo ```java public class com.bytedance.im.user.api.model.BIMBlackListFriendInfo ``` 黑名单信息。 ## 成员函数 | 返回 | 名称 | | --- | --- | | **long** | [getUid](#BIMBlackListFriendInfo-getuid) | | **long** | [getModifyTime](#BIMBlackListFriendInfo-getmodifytime) | | **Map** | [getExt](#BIMBlackListFriendInfo-getext) | | **long** | [getCreateTime](#BIMBlackListFriendInfo-getcreatetime) | ## 函数说明 ### getUid ```java public long com.bytedance.im.user.api.model.BIMBlackListFriendInfo.getUid() ``` 获取目标黑名单用户 ID。 **返回值** 获取黑名单用户 ID。 ### getModifyTime ```java public long com.bytedance.im.user.api.model.BIMBlackListFriendInfo.getModifyTime() ``` 获取黑名单信息更新时间。 **返回值** 黑名单信息更新时间。 ### getExt ```java public Map com.bytedance.im.user.api.model.BIMBlackListFriendInfo.getExt() ``` 获取黑名单额外信息。 **返回值** 黑名单额外信息。 ### getCreateTime ```java public long com.bytedance.im.user.api.model.BIMBlackListFriendInfo.getCreateTime() ``` 获取用户拉黑时间。 **返回值** 用户拉黑时间。 # BIMBlackListResult ```java public class com.bytedance.im.user.api.model.BIMBlackListResult ``` 黑名单列表分页信息。 ## 成员函数 | 返回 | 名称 | | --- | --- | | **BIMBlackListResult** | [BIMBlackListResult](#BIMBlackListResult-bimblacklistresult) | | **long** | [getNextCursor](#BIMBlackListResult-getnextcursor) | | **boolean** | [isHasMore](#BIMBlackListResult-ishasmore) | | **List** | [getBlackList](#BIMBlackListResult-getblacklist) | ## 函数说明 ### BIMBlackListResult ```java public com.bytedance.im.user.api.model.BIMBlackListResult.BIMBlackListResult( long nextCursor, boolean hasMore, List blackListInfos) ``` ### getNextCursor ```java public long com.bytedance.im.user.api.model.BIMBlackListResult.getNextCursor() ``` 获取下一页游标。 **返回值** 下一页游标。 ### isHasMore ```java public boolean com.bytedance.im.user.api.model.BIMBlackListResult.isHasMore() ``` 获取是否还有更多。 **返回值** 是否还有更多。 ### getBlackList ```java public List com.bytedance.im.user.api.model.BIMBlackListResult.getBlackList() ``` 获取当前页黑名单数据参看 [BIMBlackListFriendInfo](#bimblacklistfriendinfo) 。 **返回值** 当前页黑名单数据。 # BIMFriendApplyInfo ```java public class com.bytedance.im.user.api.model.BIMFriendApplyInfo ``` 好友申请信息。 ## 成员函数 | 返回 | 名称 | | --- | --- | | **long** | [getFromUid](#BIMFriendApplyInfo-getfromuid) | | **long** | [getToUid](#BIMFriendApplyInfo-gettouid) | | **long** | [getApplyTime](#BIMFriendApplyInfo-getapplytime) | | **BIMFriendStatus** | [getStatus](#BIMFriendApplyInfo-getstatus) | | **void** | [setExt](#BIMFriendApplyInfo-setext) | | **long** | [getAnswerTime](#BIMFriendApplyInfo-getanswertime) | | **String** | [getApplyId](#BIMFriendApplyInfo-getapplyid) | | **boolean** | [isSelf](#BIMFriendApplyInfo-isself) | | **BIMUserFullInfo** | [getUserFullInfo](#BIMFriendApplyInfo-getuserfullinfo) | | **void** | [setUserFullInfo](#BIMFriendApplyInfo-setuserfullinfo) | | **String** | [toString](#BIMFriendApplyInfo-tostring) | ## 函数说明 ### getFromUid ```java public long com.bytedance.im.user.api.model.BIMFriendApplyInfo.getFromUid() ``` 获取申请人 uid。 **返回值** 申请人 uid。 ### getToUid ```java public long com.bytedance.im.user.api.model.BIMFriendApplyInfo.getToUid() ``` 获取申请对象 uid。 **返回值** 申请对象 uid。 ### getApplyTime ```java public long com.bytedance.im.user.api.model.BIMFriendApplyInfo.getApplyTime() ``` 获取申请时间。 **返回值** 申请时间。 ### getStatus ```java public BIMFriendStatus com.bytedance.im.user.api.model.BIMFriendApplyInfo.getStatus() ``` 获取申请状态。 **返回值** 申请状态，参看 [BIMFriendStatus](#bimfriendstatus)。 ### setExt ```java public void com.bytedance.im.user.api.model.BIMFriendApplyInfo.setExt( Map ext) ``` 设置额外信息。 **返回值** 额外信息。 ### getAnswerTime ```java public long com.bytedance.im.user.api.model.BIMFriendApplyInfo.getAnswerTime() ``` 获取拒绝时间。 **返回值** 拒绝时间。 ### getApplyId ```java public String com.bytedance.im.user.api.model.BIMFriendApplyInfo.getApplyId() ``` 获取好友申请 ID (唯一)。 **返回值** 获取好友申请 ID。 ### isSelf ```java public boolean com.bytedance.im.user.api.model.BIMFriendApplyInfo.isSelf() ``` 获取是否是自己发出的好友申请。 **返回值** 是否是自己发出的好友申请。 ### getUserFullInfo ```java public BIMUserFullInfo com.bytedance.im.user.api.model.BIMFriendApplyInfo.getUserFullInfo() ``` 获取用户全量信息。 **返回值** 用户全量信息。 ### setUserFullInfo ```java public void com.bytedance.im.user.api.model.BIMFriendApplyInfo.setUserFullInfo( BIMUserFullInfo userFullInfo) ``` 设置用户全量信息。 ### toString ```java public String com.bytedance.im.user.api.model.BIMFriendApplyInfo.toString() ``` # BIMFriendApplyListResult ```java public class com.bytedance.im.user.api.model.BIMFriendApplyListResult ``` 好友列表分页信息。 ## 成员函数 | 返回 | 名称 | | --- | --- | | **BIMFriendApplyListResult** | [BIMFriendApplyListResult](#BIMFriendApplyListResult-bimfriendapplylistresult) | | **long** | [getNextCursor](#BIMFriendApplyListResult-getnextcursor) | | **boolean** | [isHasMore](#BIMFriendApplyListResult-ishasmore) | | **List** | [getApplyFriendList](#BIMFriendApplyListResult-getapplyfriendlist) | ## 函数说明 ### BIMFriendApplyListResult ```java public com.bytedance.im.user.api.model.BIMFriendApplyListResult.BIMFriendApplyListResult( long nextCursor, boolean hasMore, List applyFriendList) ``` ### getNextCursor ```java public long com.bytedance.im.user.api.model.BIMFriendApplyListResult.getNextCursor() ``` 获取下一页游标。 **返回值** 下一页游标。 ### isHasMore ```java public boolean com.bytedance.im.user.api.model.BIMFriendApplyListResult.isHasMore() ``` 获取是否还有更多。 **返回值** 是否还有更多。 ### getApplyFriendList ```java public List com.bytedance.im.user.api.model.BIMFriendApplyListResult.getApplyFriendList() ``` 获取当前页好友申请数据参看 [BIMFriendInfo](#bimfriendinfo) 。 **返回值** 当前页好友申请数据。 # BIMFriendInfo ```java public class com.bytedance.im.user.api.model.BIMFriendInfo ``` 好友信息。 ## 成员函数 | 返回 | 名称 | | --- | --- | | **long** | [getUid](#BIMFriendInfo-getuid) | | **long** | [getAgreeTime](#BIMFriendInfo-getagreetime) | | **Map** | [getExt](#BIMFriendInfo-getext) | | **String** | [getAlias](#BIMFriendInfo-getalias) | | **long** | [getModifyTime](#BIMFriendInfo-getmodifytime) | | **String** | [toString](#BIMFriendInfo-tostring) | ## 函数说明 ### getUid ```java public long com.bytedance.im.user.api.model.BIMFriendInfo.getUid() ``` 获取申请目标用户 ID。 **返回值** 获取用户 ID。 ### getAgreeTime ```java public long com.bytedance.im.user.api.model.BIMFriendInfo.getAgreeTime() ``` 获取成为好友时间。 **返回值** 获取成为好友时间。 ### getExt ```java public Map com.bytedance.im.user.api.model.BIMFriendInfo.getExt() ``` 获取用户额外信息。 **返回值** 用户额外信息。 ### getAlias ```java public String com.bytedance.im.user.api.model.BIMFriendInfo.getAlias() ``` 获取好友备注 **返回值** 好友备注 ### getModifyTime ```java public long com.bytedance.im.user.api.model.BIMFriendInfo.getModifyTime() ``` 获取好友信息修改时间。 **返回值** 好友信息修改时间。 ### toString ```java public String com.bytedance.im.user.api.model.BIMFriendInfo.toString() ``` # BIMFriendListResult ```java public class com.bytedance.im.user.api.model.BIMFriendListResult ``` 好友列表分页信息。 ## 成员函数 | 返回 | 名称 | | --- | --- | | **BIMFriendListResult** | [BIMFriendListResult](#BIMFriendListResult-bimfriendlistresult) | | **long** | [getNextCursor](#BIMFriendListResult-getnextcursor) | | **boolean** | [isHasMore](#BIMFriendListResult-ishasmore) | | **List** | [getFriendList](#BIMFriendListResult-getfriendlist) | ## 函数说明 ### BIMFriendListResult ```java public com.bytedance.im.user.api.model.BIMFriendListResult.BIMFriendListResult( long nextCursor, boolean hasMore, List friendList) ``` ### getNextCursor ```java public long com.bytedance.im.user.api.model.BIMFriendListResult.getNextCursor() ``` 获取下一页游标。 **返回值** 下一页游标。 ### isHasMore ```java public boolean com.bytedance.im.user.api.model.BIMFriendListResult.isHasMore() ``` 获取是否还有更多。 **返回值** 是否还有更多。 ### getFriendList ```java public List com.bytedance.im.user.api.model.BIMFriendListResult.getFriendList() ``` 获取当前页好友数据参看 [BIMFriendInfo](#bimfriendinfo) 。 **返回值** 当前页好友数据。 # BIMReplyInfo ```java public class com.bytedance.im.user.api.model.BIMReplyInfo ``` 好友申请回应信息。 ## 成员函数 | 返回 | 名称 | | --- | --- | | **void** | [setUid](#BIMReplyInfo-setuid) | | **void** | [setExt](#BIMReplyInfo-setext) | | **void** | [setReplyType](#BIMReplyInfo-setreplytype) | ## 函数说明 ### setUid ```java public void com.bytedance.im.user.api.model.BIMReplyInfo.setUid( long uid) ``` 设置用户 ID。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | uid | **long** | 用户 ID。 | ### setExt ```java public void com.bytedance.im.user.api.model.BIMReplyInfo.setExt( Map ext) ``` 设置额外信息。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | ext | **Map** | 额外信息。 | ### setReplyType ```java public void com.bytedance.im.user.api.model.BIMReplyInfo.setReplyType( BIMFriendReplyType reply) ``` 设置回复状态。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | reply | **BIMFriendReplyType** | 回复状态，参看 [BIMFriendReplyType](#bimfriendreplytype)。 | # BIMUserFullInfo ```java public class com.bytedance.im.user.api.model.BIMUserFullInfo ``` 用户全量信息。 ## 成员函数 | 返回 | 名称 | | --- | --- | | **BIMUserProfile** | [getUserProfile](#BIMUserFullInfo-getuserprofile) | | **BIMFriendInfo** | [getFriendInfo](#BIMUserFullInfo-getfriendinfo) | | **BIMBlackListFriendInfo** | [getBlackListFriendInfo](#BIMUserFullInfo-getblacklistfriendinfo) | | **boolean** | [isFriend](#BIMUserFullInfo-isfriend) | | **boolean** | [isBlock](#BIMUserFullInfo-isblock) | | **String** | [getNickName](#BIMUserFullInfo-getnickname) | | **String** | [getAlias](#BIMUserFullInfo-getalias) | | **long** | [getUid](#BIMUserFullInfo-getuid) | | **String** | [getPortraitUrl](#BIMUserFullInfo-getportraiturl) | ## 函数说明 ### getUserProfile ```java public BIMUserProfile com.bytedance.im.user.api.model.BIMUserFullInfo.getUserProfile() ``` 获取用户基本信息。 **返回值** 用户基本信息。 ### getFriendInfo ```java public BIMFriendInfo com.bytedance.im.user.api.model.BIMUserFullInfo.getFriendInfo() ``` 获取用户好友信息。 **返回值** 用户好友信息。 ### getBlackListFriendInfo ```java public BIMBlackListFriendInfo com.bytedance.im.user.api.model.BIMUserFullInfo.getBlackListFriendInfo() ``` 获取用户黑名单信息。 **返回值** 用户黑名单信息。 ### isFriend ```java public boolean com.bytedance.im.user.api.model.BIMUserFullInfo.isFriend() ``` 获取用户是否是好友。 **返回值** 是否是好友。 ### isBlock ```java public boolean com.bytedance.im.user.api.model.BIMUserFullInfo.isBlock() ``` 获取用户是否在黑名单。 **返回值** 是否是黑名单用户。 ### getNickName ```java public String com.bytedance.im.user.api.model.BIMUserFullInfo.getNickName() ``` 获取用户资料昵称。 **返回值** 用户资料昵称。 ### getAlias ```java public String com.bytedance.im.user.api.model.BIMUserFullInfo.getAlias() ``` 获取好友备注。 **返回值** 好友备注。 ### getUid ```java public long com.bytedance.im.user.api.model.BIMUserFullInfo.getUid() ``` 获取用户 ID。 **返回值** 用户 ID。 ### getPortraitUrl ```java public String com.bytedance.im.user.api.model.BIMUserFullInfo.getPortraitUrl() ``` 获取用户资料头像 URL。 **返回值** 用户资料头像 URL。 # BIMUserInfoListResult ```java public class com.bytedance.im.user.api.model.BIMUserInfoListResult ``` 用户全量信息列表分页结果。 ## 成员函数 | 返回 | 名称 | | --- | --- | | **long** | [getNextCursor](#BIMUserInfoListResult-getnextcursor) | | **boolean** | [isHasMore](#BIMUserInfoListResult-ishasmore) | | **List** | [getFullInfoList](#BIMUserInfoListResult-getfullinfolist) | ## 函数说明 ### getNextCursor ```java public long com.bytedance.im.user.api.model.BIMUserInfoListResult.getNextCursor() ``` 获取下一页游标。 **返回值** 下一页游标。 ### isHasMore ```java public boolean com.bytedance.im.user.api.model.BIMUserInfoListResult.isHasMore() ``` 获取是否还有更多。 **返回值** 是否还有更多。 ### getFullInfoList ```java public List com.bytedance.im.user.api.model.BIMUserInfoListResult.getFullInfoList() ``` 获取当前页用户数据参看 [BIMUserFullInfo](#bimuserfullinfo) 。 **返回值** 当前页用户数据。 # BIMUserProfile ```java public class com.bytedance.im.user.api.model.BIMUserProfile ``` 用户信息。 ## 成员函数 | 返回 | 名称 | | --- | --- | | **String** | [getNickName](#BIMUserProfile-getnickname) | | **String** | [getPortraitUrl](#BIMUserProfile-getportraiturl) | | **long** | [getUid](#BIMUserProfile-getuid) | | **long** | [getUpdateTime](#BIMUserProfile-getupdatetime) | | **long** | [getCreateTime](#BIMUserProfile-getcreatetime) | | **Map** | [getExt](#BIMUserProfile-getext) | | **void** | [setUid](#BIMUserProfile-setuid) | | **void** | [setNickName](#BIMUserProfile-setnickname) | | **void** | [setPortraitUrl](#BIMUserProfile-setportraiturl) | | **void** | [setExt](#BIMUserProfile-setext) | ## 函数说明 ### getNickName ```java public String com.bytedance.im.user.api.model.BIMUserProfile.getNickName() ``` 获取用户昵称。 **返回值** 用户昵称。 ### getPortraitUrl ```java public String com.bytedance.im.user.api.model.BIMUserProfile.getPortraitUrl() ``` 获取用户头像。 **返回值** 用户头像。 ### getUid ```java public long com.bytedance.im.user.api.model.BIMUserProfile.getUid() ``` 获取用户 uid。 **返回值** 用户 uid。 ### getUpdateTime ```java public long com.bytedance.im.user.api.model.BIMUserProfile.getUpdateTime() ``` 获取用户信息变更时间。 **返回值** 用户信息变更时间。 ### getCreateTime ```java public long com.bytedance.im.user.api.model.BIMUserProfile.getCreateTime() ``` **返回值** 获取用户注册时间 ### getExt ```java public Map com.bytedance.im.user.api.model.BIMUserProfile.getExt() ``` **返回值** 获取用户额外信息 ### setUid ```java public void com.bytedance.im.user.api.model.BIMUserProfile.setUid( long uid) ``` 设置 uid。 ### setNickName ```java public void com.bytedance.im.user.api.model.BIMUserProfile.setNickName( String nickName) ``` 设置昵称。 ### setPortraitUrl ```java public void com.bytedance.im.user.api.model.BIMUserProfile.setPortraitUrl( String portraitUrl) ``` 设置用户头像。 ### setExt ```java public void com.bytedance.im.user.api.model.BIMUserProfile.setExt( Map ext) ``` 设置用户额外信息。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | ext | **Map** | 额外信息 key个数不得超过20个，key的长度不得超过50字符，key必须使用"a:"前缀开头，value字段长度不得超过500字节 | # BIMSearchMessageListResult ```java public class com.bytedance.im.search.api.model.BIMSearchMessageListResult ``` 搜索分页结果 ## 成员函数 | 返回 | 名称 | | --- | --- | | **BIMSearchMsgInfo** | [getAnchorSearchMsgInfo](#BIMSearchMessageListResult-getanchorsearchmsginfo) | | **boolean** | [isHasMore](#BIMSearchMessageListResult-ishasmore) | | **List** | [getSearchMsgInfoList](#BIMSearchMessageListResult-getsearchmsginfolist) | ## 函数说明 ### getAnchorSearchMsgInfo ```java public BIMSearchMsgInfo com.bytedance.im.search.api.model.BIMSearchMessageListResult.getAnchorSearchMsgInfo() ``` 获取下一页锚点消息 **返回值** 下一页锚点消息 ### isHasMore ```java public boolean com.bytedance.im.search.api.model.BIMSearchMessageListResult.isHasMore() ``` 是否还有更多消息 **返回值** 是否还有更多消息 ### getSearchMsgInfoList ```java public List com.bytedance.im.search.api.model.BIMSearchMessageListResult.getSearchMsgInfoList() ``` 当前页消息列表 **返回值** 当前页消息列表 # BIMSearchDetail ```java public class com.bytedance.im.search.api.model.BIMSearchDetail ``` 搜索详情 ## 成员函数 | 返回 | 名称 | | --- | --- | | **String** | [getSearchContent](#BIMSearchDetail-getsearchcontent) | | **List** | [getKeyPositions](#BIMSearchDetail-getkeypositions) | | **String** | [getSearchKey](#BIMSearchDetail-getsearchkey) | ## 函数说明 ### getSearchContent ```java public String com.bytedance.im.search.api.model.BIMSearchDetail.getSearchContent() ``` 获取消息搜索内容。 **返回值** 消息搜索内容 ### getKeyPositions ```java public List com.bytedance.im.search.api.model.BIMSearchDetail.getKeyPositions() ``` 获取搜索关键词在 searchContent 的位置。 **返回值** 搜索关键词在 searchContent 位置 ### getSearchKey ```java public String com.bytedance.im.search.api.model.BIMSearchDetail.getSearchKey() ``` 获取搜索关键词 **返回值** 搜索关键词 # BIMSearchMsgInfo ```java public class com.bytedance.im.search.api.model.BIMSearchMsgInfo ``` 消息搜索结果 ## 成员函数 | 返回 | 名称 | | --- | --- | | **BIMMessage** | [getMessage](#BIMSearchMsgInfo-getmessage) | | **BIMSearchDetail** | [getSearchDetail](#BIMSearchMsgInfo-getsearchdetail) | ## 函数说明 ### getMessage ```java public BIMMessage com.bytedance.im.search.api.model.BIMSearchMsgInfo.getMessage() ``` 获取消息发送用户 uid。 **返回值** 消息发送用户 uid。 ### getSearchDetail ```java public BIMSearchDetail com.bytedance.im.search.api.model.BIMSearchMsgInfo.getSearchDetail() ``` 消息搜索详情。 **返回值** 消息搜索详情。 # BIMSearchPosition ```java public class com.bytedance.im.search.api.model.BIMSearchPosition ``` 搜索关键词起始位置,通常用于高亮展示 ## 成员函数 | 返回 | 名称 | | --- | --- | | **BIMSearchPosition** | [BIMSearchPosition](#BIMSearchPosition-bimsearchposition) | | **int** | [getStart](#BIMSearchPosition-getstart) | | **int** | [getEnd](#BIMSearchPosition-getend) | ## 函数说明 ### BIMSearchPosition ```java public com.bytedance.im.search.api.model.BIMSearchPosition.BIMSearchPosition( int start, int end) ``` ### getStart ```java public int com.bytedance.im.search.api.model.BIMSearchPosition.getStart() ``` 获取搜索关键词起始位置。 **返回值** 搜索关键词起始位置。 ### getEnd ```java public int com.bytedance.im.search.api.model.BIMSearchPosition.getEnd() ``` 关键词结束位置。 **返回值** 搜索关键词结束位置。

实时音视频