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

禁言状态码

枚举值
类型说明
BIM_BLOCK_STATUS_UNBLOCK(0)未禁言状态
BIM_BLOCK_STATUS_BLOCK(1)禁言状态
BIMConnectStatus
public enum com.bytedance.im.core.api.enums.BIMConnectStatus
java

长连接状态码

枚举值
类型说明
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
public enum com.bytedance.im.core.api.enums.BIMConversationType
java

会话类型

枚举值
类型说明
BIM_CONVERSATION_TYPE_ONE_CHAT(1)单聊会话
BIM_CONVERSATION_TYPE_GROUP_CHAT(2)群聊会话
BIM_CONVERSATION_TYPE_LIVE_CHAT(100)直播群
BIMLogLevel
public enum com.bytedance.im.core.api.enums.BIMLogLevel
java

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
public enum com.bytedance.im.core.api.enums.BIMMemberRole
java

成员角色。

枚举值
类型说明
BIM_MEMBER_ROLE_NORMAL(0)普通成员。
BIM_MEMBER_ROLE_OWNER(1)群主。
BIM_MEMBER_ROLE_ADMIN(2)管理员。
BIM_MEMBER_ROLE_VISITOR(3)游客。
BIMMessageStatus
public enum com.bytedance.im.core.api.enums.BIMMessageStatus
java

消息发送状态

枚举值
类型说明
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_NORMAL(5,"normal")收到的消息或是拉取到的发送消息
成员函数
返回名称
BIMMessageStatusBIMMessageStatus
函数说明

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

消息类型

枚举值
类型说明
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)自定义消息
BIMConversation
public class com.bytedance.im.core.api.model.BIMConversation
java

会话信息。

成员函数
返回名称
longgetConversationShortID
BIMConversationTypegetConversationType
booleanisDissolved
booleanisMember
longgetUnReadCount
booleanisStickTop
intgetMemberCount
longgetUpdatedTime
StringgetDraftText
longgetDraftTime
BIMMessagegetLastMessage
longgetSortOrder
StringgetConversationID
booleanisMute
longgetOppositeUserID
StringgetName
StringgetNotice
StringgetDescription
BIMMembergetCurrentMember
longgetOwnerId
voidsetOwner
StringgetIntroduction
StringgetPortraitURL
BIMBlockStatusgetBlockStatus
longgetOnLineMemberCount
函数说明

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

获取会话 ShortId

返回值
会话 ShortId

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

获取会话类型, 参看 BIMConversationType

返回值
会话 ShortId

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

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

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

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

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

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

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

获取会话未读数

返回值
会话未读数

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

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

返回值
会话未读数

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

获取会话成员个数

返回值
会话成员个数

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

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

返回值
会话更新时间

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

获取草稿,可能为 null

返回值
草稿

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

获取草稿更新时间戳

返回值
草稿更新时间戳

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

获取会话最后一条消息

返回值
会话最后一条消息

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

获取会话排序 sortOrder

返回值
会话排序 sortOrder

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

获取会话ID

返回值
会话ID

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

获取会话是否免打扰

返回值
是否免打扰

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

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

获取会话名称

返回值
会话名称

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

获取会话公告

返回值
会话公告

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

获取会话简介

返回值
会话简介

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

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

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

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

获取会话群主 id

返回值
会话群主 id

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

设置会话群主。

传入参数

参数名类型说明
idlong会话群主 id

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

获取会话简介

返回值
会话简介

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

获取会话图标

返回值
会话图标

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

获取会话禁言状态

返回值
会话禁言状态

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

获取会话在线人数。

返回值
会话在线人数。

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

会话列表数据分页结果

成员函数
返回名称
longgetNextCursor
booleanisHasMore
ListgetConversationList
函数说明

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

获取会话列表。

返回值
下一页的游标

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

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

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

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

获取当前页会话列表数据

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

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

获取消息选项。

成员函数
返回名称
intgetLimit
BIMMessagegetAnchorMessage
函数说明

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

获取消息数量。

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

获取起点。

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

消息拉取 Option Builder

成员函数
返回名称
Builderlimit
BuilderanchorMessage
BIMGetMessageOptionbuild
函数说明

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

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

传入参数

参数名类型说明
limitint每页消息数据个数限制。

返回值
Builder。

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

锚点消息,拉取的起始位置。拉取旧消息方向时传 null 代表从最新的拉取。拉取新消息方向时不可为 null。

传入参数

参数名类型说明
anchorMessageBIMMessage锚点消息,拉取的起始位置。

返回值
Builder。

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

创建消息拉取选项

返回值
BIMGetMessageOption。

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

群组信息。

成员函数
返回名称
StringgetName
StringgetAvatarUrl
StringgetDesc
Map<String, String>getMap
StringgetNotice
函数说明

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

获取群聊名称。

返回值
群聊名称。

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

获取群头像。

返回值
群头像。

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

获取群描述。

返回值
群描述。

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

获取群组自定义字段。

返回值
群组自定义字段。

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

获取群公告。

返回值
群公告。

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

创建群组信息 Builder。

成员函数
返回名称
BIMGroupInfoBuildername
BIMGroupInfoBuilderavatarUrl
BIMGroupInfoBuilderdescription
BIMGroupInfoBuildermap
BIMGroupInfoBuildernotice
BIMGroupInfobuild
函数说明

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

设置群名称。

传入参数

参数名类型说明
nameString群名称

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

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

设置群头衔。

传入参数

参数名类型说明
avatarUrlString群头像 url

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

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

设置群简介。

传入参数

参数名类型说明
descriptionString群简介

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

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

设置群额外属性。

传入参数

参数名类型说明
mapMap<String, String>群额外属性

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

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

设置群公告。

传入参数

参数名类型说明
noticeString群公告内容。

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

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

生成群信息。

返回值
群信息。

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

群成员信息。

成员函数
返回名称
longgetUserID
longgetSortOrder
BIMMemberRolegetRole
voidsetRole
StringgetAlias
StringgetConversationID
booleanisOnline
StringgetAvatarUrl
Map<String, String>getExt
ListgetMarkTypes
函数说明

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

获取群成员 userID。

返回值
群成员 userID

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

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

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

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

获取群成员角色。

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

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

设置群成员角色。

传入参数

参数名类型说明
roleBIMMemberRole群成员角色,参看 BIMMemberRole。

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

获取群成员别名。

返回值
群成员别名

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

获取群 conversationID。

返回值
conversationID

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

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

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

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

获取用户头像(仅支持直播群)。

返回值
用户头像(仅支持直播群)

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

获取用户额外信息(仅支持直播群)。

返回值
用户额外信息(仅支持直播群)

getMarkTypes
public List<String> com.bytedance.im.core.api.model.BIMMember.getMarkTypes()
java

获取用户标记(仅支持直播群)。

返回值
用户标记(仅支持直播群)

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

消息体。

成员函数
返回名称
StringgetHint
BIMBaseElementgetElement
booleanisSelf
longgetCreatedTime
longgetOrderIndex
BIMMessageTypegetMsgType
BIMReferenceInfogetReferenceInfo
longgetSenderUID
StringgetUuid
StringgetConversationID
longgetConversationShortID
BIMConversationTypegetConversationType
booleanisRecalled
BIMMessageStatusgetMsgStatus
longgetServerMsgId
StringgetUUId
ListgetMentionUIDList
voidsetExtra
Map<String,String >getExtra
函数说明

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

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

返回值
获取消息 hint

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

获取消息 Element 数据。

返回值
消息 Element, 参看 BIMBaseElement

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

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

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

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

消息创建时间。

返回值
消息创建时间。

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

消息排序 index。

返回值
消息排序 index。

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

获取消息类型。

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

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

获取引用信息,参看 BIMReferenceInfo

返回值
引用信息。

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

消息发送者 userID

返回值
消息发送者 userID。

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

消息客户端 ID

返回值
消息客户端 ID

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

消息客户端唯一 ID

返回值
消息客户端唯一 ID

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

获取消息所对应的会话 shortID

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

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

返回值
会话类型

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

获取消息是否被撤回

返回值
是否被撤回

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

获取消息状态

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

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

获取消息服务端 ID

返回值
消息状态服务端 ID

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

获取消息客户端 ID

返回值
消息状态客户端 ID

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

获取消息 at 用户列表

返回值
消息 at 用户列表

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

设置消息额外携带数据

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

获取消息额外携带数据

返回值
消息额外携带数据

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

消息列表信息。

成员函数
返回名称
BIMMessagegetAnchorMessage
booleanisHasMore
ListgetMessageList
StringtoString
BIMMessage[deprecated] getEarliestMessage
函数说明

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

获取下一页锚点消息

返回值
下一页锚点消息

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

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

是否还有更多消息

返回值
是否还有更多消息

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

当前页消息列表

返回值
当前页消息列表

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

消息体。

成员函数
返回名称
longgetServerMessageID
BIMMessageTypegetMessageType
StringgetHint
MessageStatusgetStatus
函数说明

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

获取引用消息 serverMessageID。

返回值
引用消息 serverMessageID。

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

获取引用消息类型。

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

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

获取引用消息 hint。

返回值
引用消息 hint。

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

获取引用消息状态。

返回值
引用消息状态。

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

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

成员函数
返回名称
BIMSDKConfigBIMSDKConfig
voidsetLogListener
BIMLogListenergetLogListener
booleanisEnableAPM
voidsetEnableAPM
booleanisEnableAppLog
voidsetEnableAppLog
StringtoString
函数说明

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

BIMSDKConfig 构造函数。

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

设置日志监听,不设置或者设置为 null 时,可使用兜底 did 日志回捞功能,did 获取 BIMClient.getInstance().getSDKDid() 获取。

传入参数

参数名类型说明
listenerBIMLogListener日志监听方,参看 BIMLogListener。

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

获取日志监听。

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

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

设置日志是否支持回捞,崩溃上报

返回值
日志是否支持回捞,崩溃上报

setEnableAPM
public void com.bytedance.im.core.api.model.BIMSDKConfig.setEnableAPM(
    boolean enableAPM)
java

设置日志是否支持回捞

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

设置是否支持性能监控

返回值
是否支持性能监控

setEnableAppLog
public void com.bytedance.im.core.api.model.BIMSDKConfig.setEnableAppLog(
    boolean enableAppLog)
java

设置是否支持性能监控

返回值
是否支持性能监控

toString
public String com.bytedance.im.core.api.model.BIMSDKConfig.toString()
java
BIMUnReadInfo
public class com.bytedance.im.core.api.model.BIMUnReadInfo
java

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

成员函数
返回名称
intgetUnreadCount
函数说明

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

获取未读计数。

返回值
未读计数。

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

视频消息内容 Element。

成员函数
返回名称
StringgetURL
intgetWidth
intgetHeight
函数说明

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

获取图片 URL

返回值
图片 URL

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

获取图片宽。

返回值
图片宽。

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

获取图片高。

返回值
图片高。

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

视频消息内容 Element。

成员函数
返回名称
intgetWidth
intgetHeight
函数说明

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

获取图片宽

返回值
图片宽

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

获取图片高

返回值
图片高

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

语音消息内容 Element。

成员函数
返回名称
intgetDuration
StringgetURL
StringgetLocalPath
intgetProgress
booleanisExpired
longgetFileSize
函数说明

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

获取录音时长。

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

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

获取录音远端 URL。

返回值
录音远端 URL

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

获取录音远端 URL。

返回值
录音远端 URL

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

获取文件上传进度(0~100)。

返回值
文件上传进度(0~100)

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

获取文件是否过期。

返回值
文件是否过期

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

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

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

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

消息内容 Element 的基类。

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

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

自定义消息内容 Element。

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

文件消息内容 Element。

成员函数
返回名称
longgetFileSize
StringgetFileName
StringgetURL
intgetProgress
booleanisExpired
StringgetLocalPath
UrigetLocalURI
函数说明

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

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

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

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

获取文件名称

返回值
文件名称

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

获取文件服务端 URL

返回值
文件服务端 URL

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

获取上传进度(0~100)

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

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

获取是否过期

返回值
是否过期

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

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

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

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

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

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

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

图片消息内容。

成员函数
返回名称
BIMImagegetThumbImg
BIMImagegetLargeImg
BIMImagegetOriginImg
StringgetLocalPath
intgetProgress
longgetFileSize
booleanisExpired
函数说明

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

获取缩略图信息。

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

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

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

返回值
大图信息,参看 BIMImage

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

获取原图信息。BIMImage

返回值
原图信息

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

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

返回值
原图信息

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

获取上传进度

返回值
上传进度

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

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

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

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

获取是否过期

返回值
是否过期

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

文本消息内容 Element。

成员函数
返回名称
StringgetText
voidsetText
StringgetMsgHint
函数说明

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

获取消息文本

返回值
消息文本

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

设置消息文本

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

获取消息 hint

返回值
hint

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

视频消息内容 Element。

成员函数
返回名称
StringgetURL
BIMImagegetCoverImg
StringgetLocalPath
intgetProgress
longgetFileSize
booleanisExpired
函数说明

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

获取视频

返回值
视频封面图

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

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

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

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

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

返回值
视频封面图路径

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

获取上传进度

返回值
上传进度

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

获取文件大小

返回值
文件大小

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

获取是否过期

返回值
是否过期

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

直播群标记变更类型

枚举值
类型说明
ADD(1)添加
DELETE(2)删除
BIMMessagePriority
public enum com.bytedance.im.live.api.enmus.BIMMessagePriority
java

消息优先级

枚举值
类型说明
UNKNOWN(-1)低优先级
LOW(0)低优先级
NORMAL(1)普通优先级
HIGH(2)高优先先级
BIMLiveGroupListResult
public class com.bytedance.im.live.api.model.BIMLiveGroupListResult
java

会话列表数据分页结果

成员函数
返回名称
ListgetConversationList
longgetNextCursor
booleanisHasMore
函数说明

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

获取当前页会话列表数据

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

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

获取会话列表。

返回值
下一页的游标

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

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

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

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

直播群标记用户失败信息

成员函数
返回名称
longgetUid
BIMErrorCodegetCode
函数说明

getUid
public long com.bytedance.im.live.api.model.BIMLiveGroupMarkMemberFailedInfo.getUid()
java

获取标记失败uid。

返回值
标记失败uid。

getCode
public BIMErrorCode com.bytedance.im.live.api.model.BIMLiveGroupMarkMemberFailedInfo.getCode()
java

获取标记失败错误码。

返回值
标记失败错误码。

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

直播群成员标记类型更新信息

成员函数
返回名称
longgetOperatorUid
ListgetMarkType
longgetConversationShortId
函数说明

getOperatorUid
public long com.bytedance.im.live.api.model.BIMLiveGroupMarkTypeChangeInfo.getOperatorUid()
java

获取操作用户的uid

返回值
操作用户的uid

getMarkType
public List<String> com.bytedance.im.live.api.model.BIMLiveGroupMarkTypeChangeInfo.getMarkType()
java

获取标记类型列表

返回值
标记类型列表

getConversationShortId
public long com.bytedance.im.live.api.model.BIMLiveGroupMarkTypeChangeInfo.getConversationShortId()
java

获取标记变更会话short id

返回值
标记变更会话short id

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

加入直播群返回

成员函数
返回名称
BIMConversationgetConversation
longgetJoinMessageCursor
函数说明

getConversation
public BIMConversation com.bytedance.im.live.api.model.BIMLiveJoinGroupResult.getConversation()
java

获取加入的会话

返回值
获取加入的会话, 参看 BIMConversation

getJoinMessageCursor
public long com.bytedance.im.live.api.model.BIMLiveJoinGroupResult.getJoinMessageCursor()
java

获取加入的会话时最新一条消息 Cursor,通过此游标拉取直播群历史消息

返回值
获取加入的会话时最新一条消息, 参看 BIMConversation

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

成员列表数据分页结果

成员函数
返回名称
ListgetMemberList
booleanisHasMore
longgetNextCursor
函数说明

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

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

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

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

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

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

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

获取会话列表。

返回值
下一页的游标

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

直播群在线信息

成员函数
返回名称
longgetConversationId
longgetUserID
longgetJoinTime
booleanisInGroup
longgetLastPingTime
BIMMembergetMember
StringtoString
函数说明

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

获取会话 shortID

返回值
会话 shortID

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

获取用户 ID

返回值
用户 ID

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

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

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

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

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

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

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

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

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

getMember
public BIMMember com.bytedance.im.live.api.model.BIMLiveMemberOnlineInfo.getMember()
java

返回值
成员信息

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

直播群消息列表结果

成员函数
返回名称
booleanisHasMore
longgetNextCursor
ListgetMessageList
StringtoString
函数说明

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

是否还有更多消息

返回值
是否还有更多消息

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

分页游标

返回值
分页游标

getMessageList
public List<BIMMessage> com.bytedance.im.live.api.model.BIMLiveMessageListResult.getMessageList()
java

直播群消息

返回值
直播群消息

toString
public String com.bytedance.im.live.api.model.BIMLiveMessageListResult.toString()
java
MemberUpdateInfo
public class com.bytedance.im.live.api.model.MemberUpdateInfo
java

成员列表数据分页结果

成员函数
返回名称
longgetUid
StringgetAvatarUrl
Map<String, String>getExt
voidsetUid
voidsetAvatarUrl
voidsetExt
StringgetAlias
voidsetAlias
ListgetMarks
voidsetMarks
函数说明

getUid
public long com.bytedance.im.live.api.model.MemberUpdateInfo.getUid()
java

获取用户 uid。

返回值
用户 uid。

getAvatarUrl
public String com.bytedance.im.live.api.model.MemberUpdateInfo.getAvatarUrl()
java

获取用户头像 URL。

返回值
用户头像 URL。

getExt
public Map<String, String> com.bytedance.im.live.api.model.MemberUpdateInfo.getExt()
java

获取用户额外信息。

返回值
用户头额外信息。

setUid
public void com.bytedance.im.live.api.model.MemberUpdateInfo.setUid(
    long uid)
java

设置用户 uid。

返回值
用户 uid。

setAvatarUrl
public void com.bytedance.im.live.api.model.MemberUpdateInfo.setAvatarUrl(
    String avatarUrl)
java

设置用户头像 URL。

传入参数

参数名类型说明
avatarUrlString用户头像 URL。

setExt
public void com.bytedance.im.live.api.model.MemberUpdateInfo.setExt(
    Map<String, String> ext)
java

设置用户额外信息。

传入参数

参数名类型说明
extMap<String, String>用户额外信息。

getAlias
public String com.bytedance.im.live.api.model.MemberUpdateInfo.getAlias()
java

获取用户群昵称。

setAlias
public void com.bytedance.im.live.api.model.MemberUpdateInfo.setAlias(
    String alias)
java

设置用户群昵称。

传入参数

参数名类型说明
aliasString用户群昵称。

getMarks
public List<String> com.bytedance.im.live.api.model.MemberUpdateInfo.getMarks()
java

设置用户标记。

setMarks
public void com.bytedance.im.live.api.model.MemberUpdateInfo.setMarks(
    List<String> marks)
java

设置用户标记。

传入参数

参数名类型说明
marksList用户标记。
BIMFriendReplyType
public enum com.bytedance.im.user.api.enums.BIMFriendReplyType
java

好友申请回应状态。

枚举值
类型说明
BIM_FRIEND_REPLY_AGREE(0)接受好友申请。
BIM_FRIEND_REPLY_REFUSE(1)拒绝好友申请。
BIMFriendStatus
public enum com.bytedance.im.user.api.enums.BIMFriendStatus
java

好友状态

枚举值
类型说明
BIM_FRIEND_STATUS_APPLY(0)申请状态
BIM_FRIEND_STATUS_AGREE(1)同意状态
BIM_FRIEND_STATUS_REFUSE(2)拒绝状态
BIMApplyInfo
public class com.bytedance.im.user.api.model.BIMApplyInfo
java

好友申请信息。

成员函数
返回名称
voidsetUid
voidsetExt
函数说明

setUid
public void com.bytedance.im.user.api.model.BIMApplyInfo.setUid(
    long uid)
java

设置用户 ID。

传入参数

参数名类型说明
uidlong用户 ID。

setExt
public void com.bytedance.im.user.api.model.BIMApplyInfo.setExt(
    Map<String, String> ext)
java

设置额外信息。

传入参数

参数名类型说明
extMap<String, String>额外信息。
BIMBlackListFriendInfo
public class com.bytedance.im.user.api.model.BIMBlackListFriendInfo
java

黑名单信息。

成员函数
返回名称
longgetUid
longgetModifyTime
Map<String, String>getExt
longgetCreateTime
函数说明

getUid
public long com.bytedance.im.user.api.model.BIMBlackListFriendInfo.getUid()
java

获取目标黑名单用户 ID。

返回值
获取黑名单用户 ID。

getModifyTime
public long com.bytedance.im.user.api.model.BIMBlackListFriendInfo.getModifyTime()
java

获取黑名单信息更新时间。

返回值
黑名单信息更新时间。

getExt
public Map<String, String> com.bytedance.im.user.api.model.BIMBlackListFriendInfo.getExt()
java

获取黑名单额外信息。

返回值
黑名单额外信息。

getCreateTime
public long com.bytedance.im.user.api.model.BIMBlackListFriendInfo.getCreateTime()
java

获取用户拉黑时间。

返回值
用户拉黑时间。

BIMBlackListResult
public class com.bytedance.im.user.api.model.BIMBlackListResult
java

黑名单列表分页信息。

成员函数
返回名称
BIMBlackListResultBIMBlackListResult
longgetNextCursor
booleanisHasMore
ListgetBlackList
函数说明

BIMBlackListResult
public com.bytedance.im.user.api.model.BIMBlackListResult.BIMBlackListResult(
    long nextCursor,
    boolean hasMore,
    List<BIMBlackListFriendInfo> blackListInfos)
java

getNextCursor
public long com.bytedance.im.user.api.model.BIMBlackListResult.getNextCursor()
java

获取下一页游标。

返回值
下一页游标。

isHasMore
public boolean com.bytedance.im.user.api.model.BIMBlackListResult.isHasMore()
java

获取是否还有更多。

返回值
是否还有更多。

getBlackList
public List<BIMBlackListFriendInfo> com.bytedance.im.user.api.model.BIMBlackListResult.getBlackList()
java

获取当前页黑名单数据 参看 BIMBlackListFriendInfo 。

返回值
当前页黑名单数据。

BIMFriendApplyInfo
public class com.bytedance.im.user.api.model.BIMFriendApplyInfo
java

好友申请信息。

成员函数
返回名称
longgetFromUid
longgetToUid
longgetApplyTime
BIMFriendStatusgetStatus
voidsetExt
longgetAnswerTime
StringgetApplyId
booleanisSelf
BIMUserFullInfogetUserFullInfo
voidsetUserFullInfo
StringtoString
函数说明

getFromUid
public long com.bytedance.im.user.api.model.BIMFriendApplyInfo.getFromUid()
java

获取申请人 uid。

返回值
申请人 uid。

getToUid
public long com.bytedance.im.user.api.model.BIMFriendApplyInfo.getToUid()
java

获取申请对象 uid。

返回值
申请对象 uid。

getApplyTime
public long com.bytedance.im.user.api.model.BIMFriendApplyInfo.getApplyTime()
java

获取申请时间。

返回值
申请时间。

getStatus
public BIMFriendStatus com.bytedance.im.user.api.model.BIMFriendApplyInfo.getStatus()
java

获取申请状态。

返回值
申请状态,参看 BIMFriendStatus。

setExt
public void com.bytedance.im.user.api.model.BIMFriendApplyInfo.setExt(
    Map<String, String> ext)
java

设置额外信息。

返回值
额外信息。

getAnswerTime
public long com.bytedance.im.user.api.model.BIMFriendApplyInfo.getAnswerTime()
java

获取拒绝时间。

返回值
拒绝时间。

getApplyId
public String com.bytedance.im.user.api.model.BIMFriendApplyInfo.getApplyId()
java

获取好友申请 ID (唯一)。

返回值
获取好友申请 ID。

isSelf
public boolean com.bytedance.im.user.api.model.BIMFriendApplyInfo.isSelf()
java

获取是否是自己发出的好友申请。

返回值
是否是自己发出的好友申请。

getUserFullInfo
public BIMUserFullInfo com.bytedance.im.user.api.model.BIMFriendApplyInfo.getUserFullInfo()
java

获取用户全量信息。

返回值
用户全量信息。

setUserFullInfo
public void com.bytedance.im.user.api.model.BIMFriendApplyInfo.setUserFullInfo(
    BIMUserFullInfo userFullInfo)
java

设置用户全量信息。

toString
public String com.bytedance.im.user.api.model.BIMFriendApplyInfo.toString()
java
BIMFriendApplyListResult
public class com.bytedance.im.user.api.model.BIMFriendApplyListResult
java

好友列表分页信息。

成员函数
返回名称
BIMFriendApplyListResultBIMFriendApplyListResult
longgetNextCursor
booleanisHasMore
ListgetApplyFriendList
函数说明

BIMFriendApplyListResult
public com.bytedance.im.user.api.model.BIMFriendApplyListResult.BIMFriendApplyListResult(
    long nextCursor,
    boolean hasMore,
    List<BIMFriendApplyInfo> applyFriendList)
java

getNextCursor
public long com.bytedance.im.user.api.model.BIMFriendApplyListResult.getNextCursor()
java

获取下一页游标。

返回值
下一页游标。

isHasMore
public boolean com.bytedance.im.user.api.model.BIMFriendApplyListResult.isHasMore()
java

获取是否还有更多。

返回值
是否还有更多。

getApplyFriendList
public List<BIMFriendApplyInfo> com.bytedance.im.user.api.model.BIMFriendApplyListResult.getApplyFriendList()
java

获取当前页好友申请数据 参看 BIMFriendInfo 。

返回值
当前页好友申请数据。

BIMFriendInfo
public class com.bytedance.im.user.api.model.BIMFriendInfo
java

好友信息。

成员函数
返回名称
longgetUid
longgetAgreeTime
Map<String, String>getExt
StringgetAlias
longgetModifyTime
StringtoString
函数说明

getUid
public long com.bytedance.im.user.api.model.BIMFriendInfo.getUid()
java

获取申请目标用户 ID。

返回值
获取用户 ID。

getAgreeTime
public long com.bytedance.im.user.api.model.BIMFriendInfo.getAgreeTime()
java

获取成为好友时间。

返回值
获取成为好友时间。

getExt
public Map<String, String> com.bytedance.im.user.api.model.BIMFriendInfo.getExt()
java

获取用户额外信息。

返回值
用户额外信息。

getAlias
public String com.bytedance.im.user.api.model.BIMFriendInfo.getAlias()
java

获取好友备注

返回值
好友备注

getModifyTime
public long com.bytedance.im.user.api.model.BIMFriendInfo.getModifyTime()
java

获取好友信息修改时间。

返回值
好友信息修改时间。

toString
public String com.bytedance.im.user.api.model.BIMFriendInfo.toString()
java
BIMFriendListResult
public class com.bytedance.im.user.api.model.BIMFriendListResult
java

好友列表分页信息。

成员函数
返回名称
BIMFriendListResultBIMFriendListResult
longgetNextCursor
booleanisHasMore
ListgetFriendList
函数说明

BIMFriendListResult
public com.bytedance.im.user.api.model.BIMFriendListResult.BIMFriendListResult(
    long nextCursor,
    boolean hasMore,
    List<BIMFriendInfo> friendList)
java

getNextCursor
public long com.bytedance.im.user.api.model.BIMFriendListResult.getNextCursor()
java

获取下一页游标。

返回值
下一页游标。

isHasMore
public boolean com.bytedance.im.user.api.model.BIMFriendListResult.isHasMore()
java

获取是否还有更多。

返回值
是否还有更多。

getFriendList
public List<BIMFriendInfo> com.bytedance.im.user.api.model.BIMFriendListResult.getFriendList()
java

获取当前页好友数据 参看 BIMFriendInfo 。

返回值
当前页好友数据。

BIMReplyInfo
public class com.bytedance.im.user.api.model.BIMReplyInfo
java

好友申请回应信息。

成员函数
返回名称
voidsetUid
voidsetExt
voidsetReplyType
函数说明

setUid
public void com.bytedance.im.user.api.model.BIMReplyInfo.setUid(
    long uid)
java

设置用户 ID。

传入参数

参数名类型说明
uidlong用户 ID。

setExt
public void com.bytedance.im.user.api.model.BIMReplyInfo.setExt(
    Map<String, String> ext)
java

设置额外信息。

传入参数

参数名类型说明
extMap<String, String>额外信息。

setReplyType
public void com.bytedance.im.user.api.model.BIMReplyInfo.setReplyType(
    BIMFriendReplyType reply)
java

设置回复状态。

传入参数

参数名类型说明
replyBIMFriendReplyType回复状态,参看 BIMFriendReplyType。
BIMUserFullInfo
public class com.bytedance.im.user.api.model.BIMUserFullInfo
java

用户全量信息。

成员函数
返回名称
BIMUserProfilegetUserProfile
BIMFriendInfogetFriendInfo
BIMBlackListFriendInfogetBlackListFriendInfo
booleanisFriend
booleanisBlock
StringgetNickName
StringgetAlias
longgetUid
StringgetPortraitUrl
函数说明

getUserProfile
public BIMUserProfile com.bytedance.im.user.api.model.BIMUserFullInfo.getUserProfile()
java

获取用户基本信息。

返回值
用户基本信息。

getFriendInfo
public BIMFriendInfo com.bytedance.im.user.api.model.BIMUserFullInfo.getFriendInfo()
java

获取用户好友信息。

返回值
用户好友信息。

getBlackListFriendInfo
public BIMBlackListFriendInfo com.bytedance.im.user.api.model.BIMUserFullInfo.getBlackListFriendInfo()
java

获取用户黑名单信息。

返回值
用户黑名单信息。

isFriend
public boolean com.bytedance.im.user.api.model.BIMUserFullInfo.isFriend()
java

获取用户是否是好友。

返回值
是否是好友。

isBlock
public boolean com.bytedance.im.user.api.model.BIMUserFullInfo.isBlock()
java

获取用户是否在黑名单。

返回值
是否是黑名单用户。

getNickName
public String com.bytedance.im.user.api.model.BIMUserFullInfo.getNickName()
java

获取用户资料昵称。

返回值
用户资料昵称。

getAlias
public String com.bytedance.im.user.api.model.BIMUserFullInfo.getAlias()
java

获取好友备注。

返回值
好友备注。

getUid
public long com.bytedance.im.user.api.model.BIMUserFullInfo.getUid()
java

获取用户 ID。

返回值
用户 ID。

getPortraitUrl
public String com.bytedance.im.user.api.model.BIMUserFullInfo.getPortraitUrl()
java

获取用户资料头像 URL。

返回值
用户资料头像 URL。

BIMUserInfoListResult
public class com.bytedance.im.user.api.model.BIMUserInfoListResult
java

用户全量信息列表分页结果。

成员函数
返回名称
longgetNextCursor
booleanisHasMore
ListgetFullInfoList
函数说明

getNextCursor
public long com.bytedance.im.user.api.model.BIMUserInfoListResult.getNextCursor()
java

获取下一页游标。

返回值
下一页游标。

isHasMore
public boolean com.bytedance.im.user.api.model.BIMUserInfoListResult.isHasMore()
java

获取是否还有更多。

返回值
是否还有更多。

getFullInfoList
public List<BIMUserFullInfo> com.bytedance.im.user.api.model.BIMUserInfoListResult.getFullInfoList()
java

获取当前页用户数据 参看 BIMUserFullInfo 。

返回值
当前页用户数据。

BIMUserProfile
public class com.bytedance.im.user.api.model.BIMUserProfile
java

用户信息。

成员函数
返回名称
StringgetNickName
StringgetPortraitUrl
longgetUid
longgetUpdateTime
longgetCreateTime
Map<String, String>getExt
voidsetUid
voidsetNickName
voidsetPortraitUrl
voidsetExt
函数说明

getNickName
public String com.bytedance.im.user.api.model.BIMUserProfile.getNickName()
java

获取用户昵称。

返回值
用户昵称。

getPortraitUrl
public String com.bytedance.im.user.api.model.BIMUserProfile.getPortraitUrl()
java

获取用户头像。

返回值
用户头像。

getUid
public long com.bytedance.im.user.api.model.BIMUserProfile.getUid()
java

获取用户 uid。

返回值
用户 uid。

getUpdateTime
public long com.bytedance.im.user.api.model.BIMUserProfile.getUpdateTime()
java

获取用户信息变更时间。

返回值
用户信息变更时间。

getCreateTime
public long com.bytedance.im.user.api.model.BIMUserProfile.getCreateTime()
java

返回值
获取用户注册时间

getExt
public Map<String, String> com.bytedance.im.user.api.model.BIMUserProfile.getExt()
java

返回值
获取用户额外信息

setUid
public void com.bytedance.im.user.api.model.BIMUserProfile.setUid(
    long uid)
java

设置 uid。

setNickName
public void com.bytedance.im.user.api.model.BIMUserProfile.setNickName(
    String nickName)
java

设置昵称。

setPortraitUrl
public void com.bytedance.im.user.api.model.BIMUserProfile.setPortraitUrl(
    String portraitUrl)
java

设置用户头像。

setExt
public void com.bytedance.im.user.api.model.BIMUserProfile.setExt(
    Map<String, String> ext)
java

设置用户额外信息。

传入参数

参数名类型说明
extMap<String, String>额外信息 key个数不得超过20个,key的长度不得超过50字符,key必须使用"a:"前缀开头,value字段长度不得超过500字节