public enum com.bytedance.im.core.api.enums.BIMBlockStatus
java

禁言状态码

public enum com.bytedance.im.core.api.enums.BIMConnectStatus
java

长连接状态码

public enum com.bytedance.im.core.api.enums.BIMConversationType
java

会话类型

public enum com.bytedance.im.core.api.enums.BIMLogLevel
java

SDK 初始化配置信息，包含日志打印配置

public enum com.bytedance.im.core.api.enums.BIMMemberRole
java

成员角色。

public enum com.bytedance.im.core.api.enums.BIMMessageStatus
java

消息发送状态

com.bytedance.im.core.api.enums.BIMMessageStatus.BIMMessageStatus(
    int value,
    String des)
java

public enum com.bytedance.im.core.api.enums.BIMMessageType
java

消息类型

public enum com.bytedance.im.live.api.enmus.BIMMessagePriority
java

消息优先级

public int com.bytedance.im.live.api.enmus.BIMMessagePriority.getValue()
java

枚举值

public class com.bytedance.im.core.api.model.BIMConversation
java

会话信息。

public long com.bytedance.im.core.api.model.BIMConversation.getConversationShortID()
java

获取会话 ShortId

返回值
会话 ShortId

public BIMConversationType com.bytedance.im.core.api.model.BIMConversation.getConversationType()
java

获取会话类型, 参看 BIMConversationType

返回值
会话 ShortId

public boolean com.bytedance.im.core.api.model.BIMConversation.isDissolved()
java

会话是否解散, 解散返回 true, 反之返回 false。

返回值
会话是否解散, 解散返回 true, 反之返回 false。

public boolean com.bytedance.im.core.api.model.BIMConversation.isMember()
java

获取当前用户是否是会话成员, 当前用户在会话返回 true, 被踢出、主动退出等情况返回 false。

返回值
当前用户是否是会话成员, 当前用户在会话返回 true, 被踢出、主动退出等情况返回 false。

public long com.bytedance.im.core.api.model.BIMConversation.getUnReadCount()
java

获取会话未读数

返回值
会话未读数

public boolean com.bytedance.im.core.api.model.BIMConversation.isStickTop()
java

获取会话是否置顶, 置顶则返回 true, 反之返回 false。

返回值
会话未读数

public int com.bytedance.im.core.api.model.BIMConversation.getMemberCount()
java

获取会话成员个数

返回值
会话成员个数

public long com.bytedance.im.core.api.model.BIMConversation.getUpdatedTime()
java

获取会话更新时间, 如收到消息、发出消息、产生草稿等会更新时间戳

返回值
会话更新时间

public String com.bytedance.im.core.api.model.BIMConversation.getDraftText()
java

获取草稿,可能为 null

返回值
草稿

public long com.bytedance.im.core.api.model.BIMConversation.getDraftTime()
java

获取草稿更新时间戳

返回值
草稿更新时间戳

public BIMMessage com.bytedance.im.core.api.model.BIMConversation.getLastMessage()
java

获取会话最后一条消息

返回值
会话最后一条消息

public long com.bytedance.im.core.api.model.BIMConversation.getSortOrder()
java

获取会话排序 sortOrder

返回值
会话排序 sortOrder

public String com.bytedance.im.core.api.model.BIMConversation.getConversationID()
java

获取会话ID

返回值
会话ID

public boolean com.bytedance.im.core.api.model.BIMConversation.isMute()
java

获取会话是否免打扰

返回值
是否免打扰

public long com.bytedance.im.core.api.model.BIMConversation.getOppositeUserID()
java

public String com.bytedance.im.core.api.model.BIMConversation.getName()
java

获取会话名称

返回值
会话名称

public String com.bytedance.im.core.api.model.BIMConversation.getNotice()
java

获取会话公告

返回值
会话公告

public String com.bytedance.im.core.api.model.BIMConversation.getDescription()
java

获取会话简介

返回值
会话简介

public BIMMember com.bytedance.im.core.api.model.BIMConversation.getCurrentMember()
java

获取当前用户在会话中的信息

返回值
当前用户在会话中的信息

public long com.bytedance.im.core.api.model.BIMConversation.getOwnerId()
java

获取会话群主 id

返回值
会话群主 id

public void com.bytedance.im.core.api.model.BIMConversation.setOwner(
    long id)
java

设置会话群主。

传入参数

public String com.bytedance.im.core.api.model.BIMConversation.getIntroduction()
java

获取会话简介

返回值
会话简介

public String com.bytedance.im.core.api.model.BIMConversation.getPortraitURL()
java

获取会话图标

返回值
会话图标

public BIMBlockStatus com.bytedance.im.core.api.model.BIMConversation.getBlockStatus()
java

获取会话禁言状态

返回值
会话禁言状态

public long com.bytedance.im.core.api.model.BIMConversation.getOnLineMemberCount()
java

获取会话在线人数。

返回值
会话在线人数。

public class com.bytedance.im.core.api.model.BIMConversationListResult
java

会话列表数据分页结果

public long com.bytedance.im.core.api.model.BIMConversationListResult.getNextCursor()
java

获取会话列表。

返回值
下一页的游标

public boolean com.bytedance.im.core.api.model.BIMConversationListResult.isHasMore()
java

获取是否存在更多未拉取数据。存在则返回 true 反之返回 false。

返回值
是否存在更多未拉取数据。存在则返回 true 反之返回 false。

public List<BIMConversation> com.bytedance.im.core.api.model.BIMConversationListResult.getConversationList()
java

获取当前页会话列表数据

返回值
当前页会话列表数据, 参看 BIMConversation

public class com.bytedance.im.core.api.model.BIMGetMessageOption
java

获取消息选项。

public int com.bytedance.im.core.api.model.BIMGetMessageOption.getLimit()
java

获取消息数量。

public BIMMessage com.bytedance.im.core.api.model.BIMGetMessageOption.getEarliestMessage()
java

获取起点。

public static final class com.bytedance.im.core.api.model.BIMGetMessageOption.Builder
java

消息拉取 Option Builder

public com.bytedance.im.core.api.model.BIMGetMessageOption.Builder.Builder()
java

构造函数。

返回值
构造函数。

public Builder com.bytedance.im.core.api.model.BIMGetMessageOption.Builder.limit(
    int)
java

每页消息数据个数限制, 默认 50。

传入参数

返回值
Builder。

public Builder com.bytedance.im.core.api.model.BIMGetMessageOption.Builder.earliestMessage(
    BIMMessage)
java

拉取历史消息锚点，通常传递当前会话最早的历史消息, 首次拉取传 null。

传入参数

返回值
Builder。

public BIMGetMessageOption com.bytedance.im.core.api.model.BIMGetMessageOption.Builder.build()
java

创建消息拉取选项

返回值
BIMGetMessageOption。

public class com.bytedance.im.core.api.model.BIMGroupInfo
java

群组信息。

public String com.bytedance.im.core.api.model.BIMGroupInfo.getName()
java

获取群聊名称。

返回值
群聊名称。

public String com.bytedance.im.core.api.model.BIMGroupInfo.getAvatarUrl()
java

获取群头像。

返回值
群头像。

public String com.bytedance.im.core.api.model.BIMGroupInfo.getDesc()
java

获取群描述。

返回值
群描述。

public Map<String, String> com.bytedance.im.core.api.model.BIMGroupInfo.getMap()
java

获取群组自定义字段。

返回值
群组自定义字段。

public String com.bytedance.im.core.api.model.BIMGroupInfo.getNotice()
java

获取群公告。

返回值
群公告。

public static final class com.bytedance.im.core.api.model.BIMGroupInfo.BIMGroupInfoBuilder
java

创建群组信息 Builder。

public static BIMGroupInfoBuilder com.bytedance.im.core.api.model.BIMGroupInfo.BIMGroupInfoBuilder.aBIMGroupInfo()
java

构造函数。

返回值
构造函数。

public BIMGroupInfoBuilder com.bytedance.im.core.api.model.BIMGroupInfo.BIMGroupInfoBuilder.name(
    String)
java

设置群名称。

传入参数

返回值
群组信息 Builder，参看 BIMGroupInfoBuilder。

public BIMGroupInfoBuilder com.bytedance.im.core.api.model.BIMGroupInfo.BIMGroupInfoBuilder.avatarUrl(
    String)
java

设置群头衔。

传入参数

返回值
群组信息 Builder，参看 BIMGroupInfoBuilder。

public BIMGroupInfoBuilder com.bytedance.im.core.api.model.BIMGroupInfo.BIMGroupInfoBuilder.description(
    String)
java

设置群简介。

传入参数

返回值
群组信息 Builder，参看 BIMGroupInfoBuilder。

public BIMGroupInfoBuilder com.bytedance.im.core.api.model.BIMGroupInfo.BIMGroupInfoBuilder.map(
    Map<String, String>)
java

设置群额外属性。

传入参数

返回值
群组信息 Builder，参看 BIMGroupInfoBuilder。

public BIMGroupInfoBuilder com.bytedance.im.core.api.model.BIMGroupInfo.BIMGroupInfoBuilder.notice(
    String)
java

设置群公告。

传入参数

返回值
群组信息 Builder，参看 BIMGroupInfoBuilder。

public BIMGroupInfo com.bytedance.im.core.api.model.BIMGroupInfo.BIMGroupInfoBuilder.build()
java

生成群信息。

返回值
群信息。

public class com.bytedance.im.core.api.model.BIMMember
java

群成员信息。

public long com.bytedance.im.core.api.model.BIMMember.getUserID()
java

获取群成员 userID。

返回值
群成员 userID

public long com.bytedance.im.core.api.model.BIMMember.getSortOrder()
java

获取群成员排序 order (按入群时间序)。

返回值
群成员排序 order (按入群时间序)

public BIMMemberRole com.bytedance.im.core.api.model.BIMMember.getRole()
java

获取群成员角色。

返回值
群成员角色，参看 BIMMemberRole。

public void com.bytedance.im.core.api.model.BIMMember.setRole(
    BIMMemberRole role)
java

设置群成员角色。

传入参数

public String com.bytedance.im.core.api.model.BIMMember.getAlias()
java

获取群成员别名。

返回值
群成员别名

public String com.bytedance.im.core.api.model.BIMMember.getConversationID()
java

获取群 conversationID。

返回值
conversationID

public boolean com.bytedance.im.core.api.model.BIMMember.isOnline()
java

用户是否在线(仅支持直播群)。

返回值
用户是否在线(仅支持直播群)

public class com.bytedance.im.core.api.model.BIMMessage
java

消息体。

public String com.bytedance.im.core.api.model.BIMMessage.getHint()
java

获取消息 hint, 通常用户会话列表展示。

返回值
获取消息 hint

public BIMBaseElement com.bytedance.im.core.api.model.BIMMessage.getElement()
java

获取消息 Element 数据。

返回值
消息 Element, 参看 BIMBaseElement

public boolean com.bytedance.im.core.api.model.BIMMessage.isSelf()
java

消息是否是自己发出，自己发出则返回 true,反之返回 false。

返回值
消息是否是自己发出。

public long com.bytedance.im.core.api.model.BIMMessage.getCreatedTime()
java

消息创建时间。

返回值
消息创建时间。

public long com.bytedance.im.core.api.model.BIMMessage.getOrderIndex()
java

消息排序 index。

返回值
消息排序 index。

public BIMMessageType com.bytedance.im.core.api.model.BIMMessage.getMsgType()
java

获取消息类型。

返回值
消息类型，参看 BIMMessageType。

public BIMReferenceInfo com.bytedance.im.core.api.model.BIMMessage.getReferenceInfo()
java

获取引用信息，参看 BIMReferenceInfo

返回值
引用信息。

public long com.bytedance.im.core.api.model.BIMMessage.getSenderUID()
java

消息发送者 userID

返回值
消息发送者 userID。

public String com.bytedance.im.core.api.model.BIMMessage.getUuid()
java

消息客户端 ID

返回值
消息客户端 ID

public String com.bytedance.im.core.api.model.BIMMessage.getConversationID()
java

消息客户端唯一 ID

返回值
消息客户端唯一 ID

public long com.bytedance.im.core.api.model.BIMMessage.getConversationShortID()
java

获取消息所对应的会话 shortID

返回值
消息所对应的会话 shortID

public BIMConversationType com.bytedance.im.core.api.model.BIMMessage.getConversationType()
java

返回值
会话类型

public boolean com.bytedance.im.core.api.model.BIMMessage.isRecalled()
java

获取消息是否被撤回

返回值
是否被撤回

public BIMMessageStatus com.bytedance.im.core.api.model.BIMMessage.getMsgStatus()
java

获取消息状态

返回值
消息状态，参看 BIMMessageStatus。

public long com.bytedance.im.core.api.model.BIMMessage.getServerMsgId()
java

获取消息服务端 ID

返回值
消息状态服务端 ID

public List<Long> com.bytedance.im.core.api.model.BIMMessage.getMentionUIDList()
java

获取消息 at 用户列表

返回值
消息 at 用户列表

public void com.bytedance.im.core.api.model.BIMMessage.setExtra(
    Map<String, String> extra)
java

设置消息额外携带数据

public Map<String,String > com.bytedance.im.core.api.model.BIMMessage.getExtra()
java

获取消息额外携带数据

返回值
消息额外携带数据

public class com.bytedance.im.core.api.model.BIMMessageListResult
java

消息列表信息。

public BIMMessage com.bytedance.im.core.api.model.BIMMessageListResult.getEarliestMessage()
java

获取最旧消息

返回值
最旧消息

public boolean com.bytedance.im.core.api.model.BIMMessageListResult.isHasMore()
java

是否还有更多消息

返回值
是否还有更多消息

public List<BIMMessage> com.bytedance.im.core.api.model.BIMMessageListResult.getMessageList()
java

当前页消息列表

返回值
当前页消息列表

public String com.bytedance.im.core.api.model.BIMMessageListResult.toString()
java

public class com.bytedance.im.core.api.model.BIMReferenceInfo
java

消息体。

public long com.bytedance.im.core.api.model.BIMReferenceInfo.getServerMessageID()
java

获取引用消息 serverMessageID。

返回值
引用消息 serverMessageID。

public BIMMessageType com.bytedance.im.core.api.model.BIMReferenceInfo.getMessageType()
java

获取引用消息类型。

返回值
引用消息类型，参看 BIMMessageType。

public String com.bytedance.im.core.api.model.BIMReferenceInfo.getHint()
java

获取引用消息 hint。

返回值
引用消息 hint。

public MessageStatus com.bytedance.im.core.api.model.BIMReferenceInfo.getStatus()
java

获取引用消息状态。

返回值
引用消息状态。

public class com.bytedance.im.core.api.model.BIMSDKConfig
java

SDK 初始化配置信息，包含日志打印配置

public static BIMSDKConfig com.bytedance.im.core.api.model.BIMSDKConfig.creteDefault()
java

创建 BIMSDKConfig 的默认实现,在默认实现中日志输出到 logCat, 日志打印级别为所有。

返回值
BIMSDKConfig 默认实现。

public com.bytedance.im.core.api.model.BIMSDKConfig.BIMSDKConfig()
java

BIMSDKConfig 构造函数。

public void com.bytedance.im.core.api.model.BIMSDKConfig.setLogListener(
    BIMLogListener listener)
java

设置日志监听。

传入参数

public BIMLogListener com.bytedance.im.core.api.model.BIMSDKConfig.getLogListener()
java

获取日志监听。

返回值
日志监听方，参看 BIMLogListener。

public class com.bytedance.im.core.api.model.BIMUnReadInfo
java

SDK 初始化配置信息，包含日志打印配置

public int com.bytedance.im.core.api.model.BIMUnReadInfo.getUnreadCount()
java

获取未读计数。

返回值
未读计数。

public class com.bytedance.im.core.model.inner.msg.image.BIMImage
java

视频消息内容 Element。

public String com.bytedance.im.core.model.inner.msg.image.BIMImage.getURL()
java

获取图片 URL

返回值
图片 URL

public int com.bytedance.im.core.model.inner.msg.image.BIMImage.getWidth()
java

获取图片宽。

返回值
图片宽。

public int com.bytedance.im.core.model.inner.msg.image.BIMImage.getHeight()
java

获取图片高。

返回值
图片高。

public class com.bytedance.im.core.model.inner.msg.image.Size
java

视频消息内容 Element。

public int com.bytedance.im.core.model.inner.msg.image.Size.getWidth()
java

获取图片宽

返回值
图片宽

public int com.bytedance.im.core.model.inner.msg.image.Size.getHeight()
java

获取图片高

返回值
图片高

public class com.bytedance.im.core.model.inner.msg.BIMAudioElement
java

语音消息内容 Element。

public int com.bytedance.im.core.model.inner.msg.BIMAudioElement.getDuration()
java

获取录音时长。

返回值
录音时长(单位 秒)

public String com.bytedance.im.core.model.inner.msg.BIMAudioElement.getURL()
java

获取录音远端 URL。

返回值
录音远端 URL

public String com.bytedance.im.core.model.inner.msg.BIMAudioElement.getLocalPath()
java

获取录音远端 URL。

返回值
录音远端 URL

public int com.bytedance.im.core.model.inner.msg.BIMAudioElement.getProgress()
java

获取文件上传进度（0～100）。

返回值
文件上传进度（0～100）

public boolean com.bytedance.im.core.model.inner.msg.BIMAudioElement.isExpired()
java

获取文件是否过期。

返回值
文件是否过期

public long com.bytedance.im.core.model.inner.msg.BIMAudioElement.getFileSize()
java

获取语音文件大小(单位 : B)。

返回值
语音文件大小(单位 : B)。

public class com.bytedance.im.core.model.inner.msg.BIMBaseElement
java

消息内容 Element 的基类。

通过 BIMMessage 中的 getElement 方法获取，并根据 getMsgType 获取的消息类型，强转为以下具体类型使用。

• 文本 Element，参看 BIMTextElement，对应消息类型参看 BIMMessageType.TYPE_TEXT。
• 语音 Element，参看 BIMAudioElement，对应消息类型参看 BIMMessageType.TYPE_AUDIO。
• 图片 Element，参看 BIMImageElement，对应消息类型参看 BIMMessageType.TYPE_IMAGE。
• 视频 Element，参看 BIMVideoElement，对应消息类型参看 BIMMessageType.TYPE_VIDEO。
• 文件 Element，参看 BIMFileElement，对应消息类型参看 BIMMessageType.TYPE_FILE。
• 自定义 Element，参看 BIMCustomElement，对应消息类型参看 BIMMessageType.TYPE_CUSTOM。

public class com.bytedance.im.core.model.inner.msg.BIMCustomElement
java

自定义消息内容 Element。

public class com.bytedance.im.core.model.inner.msg.BIMFileElement
java

文件消息内容 Element。

public long com.bytedance.im.core.model.inner.msg.BIMFileElement.getFileSize()
java

获取文件大小(单位: B)

返回值
文件大小(单位: B)

public String com.bytedance.im.core.model.inner.msg.BIMFileElement.getFileName()
java

获取文件名称

返回值
文件名称

public String com.bytedance.im.core.model.inner.msg.BIMFileElement.getURL()
java

获取文件服务端 URL

返回值
文件服务端 URL

public int com.bytedance.im.core.model.inner.msg.BIMFileElement.getProgress()
java

获取上传进度(0～100)

返回值
上传进度(0～100)

public boolean com.bytedance.im.core.model.inner.msg.BIMFileElement.isExpired()
java

获取是否过期

返回值
是否过期

public String com.bytedance.im.core.model.inner.msg.BIMFileElement.getLocalPath()
java

获取文件本地路径(可能为 null )

返回值
文件本地路径(可能为 null )

public Uri com.bytedance.im.core.model.inner.msg.BIMFileElement.getLocalURI()
java

获取文件本地 URI(可能为 null )

返回值
文件 URI(可能为 null )

public class com.bytedance.im.core.model.inner.msg.BIMImageElement
java

图片消息内容。

public BIMImage com.bytedance.im.core.model.inner.msg.BIMImageElement.getThumbImg()
java

获取缩略图信息。

返回值
缩略图信息，参看 BIMImage

public BIMImage com.bytedance.im.core.model.inner.msg.BIMImageElement.getLargeImg()
java

获取大图(预览图)信息。

返回值
大图信息，参看 BIMImage

public BIMImage com.bytedance.im.core.model.inner.msg.BIMImageElement.getOriginImg()
java

获取原图信息。BIMImage

返回值
原图信息

public String com.bytedance.im.core.model.inner.msg.BIMImageElement.getLocalPath()
java

获取本地图片路径,可能为 null。

返回值
原图信息

public int com.bytedance.im.core.model.inner.msg.BIMImageElement.getProgress()
java

获取上传进度

返回值
上传进度

public long com.bytedance.im.core.model.inner.msg.BIMImageElement.getFileSize()
java

获取文件大小(单位: B)

返回值
文件大小(单位: B)

public boolean com.bytedance.im.core.model.inner.msg.BIMImageElement.isExpired()
java

获取是否过期

返回值
是否过期

public class com.bytedance.im.core.model.inner.msg.BIMTextElement
java

文本消息内容 Element。

public String com.bytedance.im.core.model.inner.msg.BIMTextElement.getText()
java

获取消息文本

返回值
消息文本

public void com.bytedance.im.core.model.inner.msg.BIMTextElement.setText(
    String text)
java

设置消息文本

public String com.bytedance.im.core.model.inner.msg.BIMTextElement.getMsgHint()
java

获取消息 hint

返回值
hint

public class com.bytedance.im.core.model.inner.msg.BIMVideoElement
java

视频消息内容 Element。

public String com.bytedance.im.core.model.inner.msg.BIMVideoElement.getURL()
java

获取视频

返回值
视频封面图

public BIMImage com.bytedance.im.core.model.inner.msg.BIMVideoElement.getCoverImg()
java

获取视频封面图(视频首帧）

返回值
视频封面图，参看 BIMImage

public String com.bytedance.im.core.model.inner.msg.BIMVideoElement.getLocalPath()
java

获取视频封面图(视频首帧）

返回值
视频封面图路径

public int com.bytedance.im.core.model.inner.msg.BIMVideoElement.getProgress()
java

获取上传进度

返回值
上传进度

public long com.bytedance.im.core.model.inner.msg.BIMVideoElement.getFileSize()
java

获取文件大小

返回值
文件大小

public boolean com.bytedance.im.core.model.inner.msg.BIMVideoElement.isExpired()
java

获取是否过期

返回值
是否过期

public class com.bytedance.im.live.api.model.BIMLiveGroupListResult
java

会话列表数据分页结果

public List<BIMConversation> com.bytedance.im.live.api.model.BIMLiveGroupListResult.getConversationList()
java

获取当前页会话列表数据

返回值
当前页会话列表数据, 参看 BIMConversation

public long com.bytedance.im.live.api.model.BIMLiveGroupListResult.getNextCursor()
java

获取会话列表。

返回值
下一页的游标

public boolean com.bytedance.im.live.api.model.BIMLiveGroupListResult.isHasMore()
java

获取是否存在更多未拉取数据。存在则返回 true 反之返回 false。

返回值
是否存在更多未拉取数据。存在则返回 true 反之返回 false。

public class com.bytedance.im.live.api.model.BIMLiveMemberListResult
java

成员列表数据分页结果

public List<BIMMember> com.bytedance.im.live.api.model.BIMLiveMemberListResult.getMemberList()
java

获取当前页会话成员列表数据

返回值
当前页会话成员列表数据, 参看 BIMMember

public boolean com.bytedance.im.live.api.model.BIMLiveMemberListResult.isHasMore()
java

获取是否存在更多未拉取数据。存在则返回 true 反之返回 false。

返回值
是否存在更多未拉取数据。存在则返回 true 反之返回 false。

public long com.bytedance.im.live.api.model.BIMLiveMemberListResult.getNextCursor()
java

获取会话列表。

返回值
下一页的游标

public class com.bytedance.im.live.api.model.BIMLiveMemberOnlineInfo
java

直播群在线信息

public long com.bytedance.im.live.api.model.BIMLiveMemberOnlineInfo.getConversationId()
java

获取会话 shortID

返回值
会话 shortID

public long com.bytedance.im.live.api.model.BIMLiveMemberOnlineInfo.getUserID()
java

获取用户 ID

返回值
用户 ID

public long com.bytedance.im.live.api.model.BIMLiveMemberOnlineInfo.getJoinTime()
java

当前是否在直播群 (单位:ms)

返回值
入群时间 (单位:ms)

public boolean com.bytedance.im.live.api.model.BIMLiveMemberOnlineInfo.isInGroup()
java

当前是否在直播群 (在线)

返回值
当前是否在直播群 (在线)

public long com.bytedance.im.live.api.model.BIMLiveMemberOnlineInfo.getLastPingTime()
java

最后一次 ping 成功时间(单位:ms)

返回值
最后一次 ping 成功时间(单位:ms)

public String com.bytedance.im.live.api.model.BIMLiveMemberOnlineInfo.toString()
java