序列化表格

程序包 com.netease.nimlib.sdk

类com.netease.nimlib.sdk.NimStrings扩展java.lang.Object实现可序列化

序列化字段

status_bar_multi_messages_incoming

java.lang.String status_bar_multi_messages_incoming

状态栏通知，当收到多个联系人的消息时，消息预览字符串.
参数为联系人个数

status_bar_ticker_text

java.lang.String status_bar_ticker_text

收到新消息时，状态栏ticker text。
参数为说话人的昵称

status_bar_image_message

java.lang.String status_bar_image_message

图片消息的状态栏通知预览字符串。
参数为说话人的昵称

status_bar_audio_message

java.lang.String status_bar_audio_message

语音消息的状态栏通知预览字符串。
参数为说话人的昵称

status_bar_video_message

java.lang.String status_bar_video_message

视频消息的状态栏通知预览字符串。
参数为说话人的昵称

status_bar_file_message

java.lang.String status_bar_file_message

文件消息的状态栏通知预览字符串。
参数为说话人的昵称

status_bar_location_message

java.lang.String status_bar_location_message

地理位置消息的状态栏通知预览字符串。
参数为说话人的昵称

status_bar_notification_message

java.lang.String status_bar_notification_message

通知消息的状态栏通知预览字符串。
参数为说话人的昵称

status_bar_avchat_message

java.lang.String status_bar_avchat_message

音视频通话消息的状态栏通知预览字符串。
参数为说话人的昵称

status_bar_tip_message

java.lang.String status_bar_tip_message

通知类消息状态栏通知预览字符串。
参数为说话人的昵称

status_bar_custom_message

java.lang.String status_bar_custom_message

自定义消息的状态栏通知预览字符串。
参数为说话人的昵称

status_bar_unsupported_message

java.lang.String status_bar_unsupported_message

不支持消息类型的状态栏通知预览字符串。
参数为说话人的昵称

status_bar_hidden_message_content

java.lang.String status_bar_hidden_message_content

状态栏通知，当收到单个联系人的消息时，消息预览字符串.
参数为联系人个数

status_bar_hidden_message_title

java.lang.String status_bar_hidden_message_title

类com.netease.nimlib.sdk.SecondTimeoutConfig扩展java.lang.Object实现可序列化

序列化字段

sendMessageSecondTimeout

long sendMessageSecondTimeout

发消息第二超时

类com.netease.nimlib.sdk.ServerAddresses扩展java.lang.Object实现可序列化

序列化字段

module

java.lang.String module

连接云信服务器加密数据通道的公钥参数1 rsaModulus

publicKeyVersion

int publicKeyVersion

连接云信服务器加密数据通道的公钥的版本号（默认0）

lbs

java.lang.String lbs

IM LBS服务器地址，通过它获取IM link 地址信息 填http/https地址

另请参阅:

ServerAddresses.lbsBackup

lbsBackup

java.util.List<E> lbsBackup

备用IM LBS服务器地址，通过它获取IM link 地址信息 填http/https地址

另请参阅:

ServerAddresses.lbs

defaultLink

java.lang.String defaultLink

IM 默认的link服务器地址，当IM LBS不可用时先连接该地址 填"IP/Host:PORT"

defaultLinkBackup

java.util.List<E> defaultLinkBackup

IM 默认的link服务器地址不可用时，连接这些地址 填"IP/Host:PORT"

nosUploadLbs

java.lang.String nosUploadLbs

NOS上传LBS服务器地址 填http/https地址

nosUploadDefaultLink

java.lang.String nosUploadDefaultLink

NOS上传默认的link服务器地址，当NOS LBS不可用时先连接该地址 填http/https地址

nosUpload

java.lang.String nosUpload

NOS上传服务器主机地址（仅nosSupportHttps=true时有效，用作https上传时的域名校验及http header host字段填充） 填host地址

nosSupportHttps

boolean nosSupportHttps

NOS上传是否需要支持https。SDK 3.2版本后默认支持https，同时需要配置 nosUpload!

nosDownloadUrlFormat

java.lang.String nosDownloadUrlFormat

[4.6.0版本新增] NOS下载地址拼接模板，用于拼接最终得到的下载地址。 默认是 {bucket}.nosdn.127.net/{object}，SDK 上传资源后生成的下载地址为 https://bucket.nosdn.127.net/object

nosDownload

java.lang.String nosDownload

NOS下载地址的host，用于拼接最终获得的文件URL地址，也支持该host替换成下载加速域名/地址 nosAccess. 填host地址, 默认是 nos.netease.com

nosAccess

java.lang.String nosAccess

NOS下载加速域名/地址，用于替换NOS下载url中的 nosDownload。 提供两种方式： 1) [4.4.0+开始支持]模板方式：填写云信规定的两种模板：{bucket}.nosdn.127.net/{object} 或者 nosdn.127.net/{bucket}/{object}，其中 {bucket} 和 {object} 作为标识符，必须填写。域名部分可以替换为您申请的加速域名。 2) [所有版本支持]非模板方式：填写用于加速的 http/https地址，例如：http://111.222.111.22:9090

ntServerAddress

java.lang.String ntServerAddress

云信运行时异常统计服务器地址

bdServerAddress

java.lang.String bdServerAddress

云信数据统计服务器地址

test

boolean test

是否是测试服

dedicatedClusteFlag

int dedicatedClusteFlag

是否为专属集群{1(是), 0(否)}

negoKeyNeca

AsymmetricType negoKeyNeca

"交换密钥"协议加密算法 {1(RSA),2(SM2)}, def:1(RSA) 非对称加密

negoKeyEncaKeyVersion

int negoKeyEncaKeyVersion

"交换密钥"协议加密算法密钥版本 version 自定义时则必填

negoKeyEncaKeyParta

java.lang.String negoKeyEncaKeyParta

"交换密钥"协议加密算法密钥 part A 自定义时则必填 BigNumHex string 不含0x RSA: module, SM2: X

negoKeyEncaKeyPartb

java.lang.String negoKeyEncaKeyPartb

"交换密钥"协议加密算法密钥 part B 自定义时则必填 BigNumHex string 不含0x RSA: EXP, SM2: Y

commEnca

SymmetryType commEnca

通信加密算法 {1(RC4), 2(AES128), 4(SM4)} 默认: 1(RC4) 对称加密

linkIpv6

java.lang.String linkIpv6

ipv6的缺省连接地址

ipProtocolVersion

IPVersion ipProtocolVersion

IP协议版本{0(IPV4), 1(IPV6), 2(Auto, SDK测试后自行选择, 存在性能损耗)}。 默认: 0(IPV4) 非对称加密

probeIpv4Url

java.lang.String probeIpv4Url

探测ipv4地址类型使用的url, IPProtVersion == 2 时生效

probeIpv6Url

java.lang.String probeIpv6Url

探测ipv6地址类型使用的url, IPProtVersion == 2 时生效

handshakeType

NimHandshakeType handshakeType

握手协议选择字段

nosCdnEnable

boolean nosCdnEnable

是否优先使用Cdn域名进行NOS下载

nosDownloadSet

java.util.Set<E> nosDownloadSet

每个元素为使用过的NOS下载地址的特征以及桶名是否在host中组成的Pair对象 如new Pair("nim.nos.netease.com", true), new Pair("nos.netease.com/nim", false)等

类com.netease.nimlib.sdk.StatusBarNotificationConfig扩展java.lang.Object实现可序列化

序列化字段

notificationSmallIconId

int notificationSmallIconId

状态栏提醒的小图标的资源ID。
如果不提供，使用app的icon

ring

boolean ring

是否需要响铃提醒。
默认为true

notificationSound

java.lang.String notificationSound

响铃提醒的声音资源，如果不提供，使用系统默认提示音。

vibrate

boolean vibrate

是否需要振动提醒。
默认为true

ledARGB

int ledARGB

呼吸灯的颜色 The color of the led. The hardware will do its best approximation. 建议尽量使用绿色、蓝色、红色等基本颜色，不要去用混合色。

ledOnMs

int ledOnMs

呼吸灯亮时的持续时间（毫秒） The number of milliseconds for the LED to be on while it's flashing. The hardware will do its best approximation.

ledOffMs

int ledOffMs

呼吸灯熄灭时的持续时间（毫秒） The number of milliseconds for the LED to be off while it's flashing. The hardware will do its best approximation.

hideContent

boolean hideContent

不显示消息详情开关, 同时也不再显示消息发送者昵称
默认为false

downTimeToggle

boolean downTimeToggle

免打扰设置开关。默认为关闭。

downTimeBegin

java.lang.String downTimeBegin

免打扰的开始时间, 格式为HH:mm(24小时制)。

downTimeEnd

java.lang.String downTimeEnd

免打扰的结束时间, 格式为HH:mm(24小时制)。
如果结束时间小于开始时间，免打扰时间为开始时间-24:00-结束时间。

downTimeEnableNotification

boolean downTimeEnableNotification

免打扰期间，是否显示通知，默认为显示

notificationEntrance

java.lang.Class<T> notificationEntrance

通知栏提醒的响应intent的activity类型。
可以为null。如果未提供，将使用包的launcher的入口intent的activity。

titleOnlyShowAppName

boolean titleOnlyShowAppName

通知栏提醒的标题是否只显示应用名。默认是 false，当有一个会话发来消息时，显示会话名；当有多个会话发来时，显示应用名。 修改为true，那么无论一个还是多个会话发来消息，标题均显示应用名。 应用名称请在AndroidManifest的application节点下设置android:label。

notificationFolded

boolean notificationFolded

已过时。

该字段已废弃

另请参阅:

NotificationFoldStyle

notificationFoldStyle

NotificationFoldStyle notificationFoldStyle

消息通知栏的折叠类型，不配置时，以notificationFolded的值为准, 如果为null，表示默认所有折叠

notificationColor

int notificationColor

消息通知栏颜色，将应用到 NotificationCompat.Builder 的 setColor 方法 对Android 5.0 以后机型会影响到smallIcon

showBadge

boolean showBadge

是否APP图标显示未读数(红点) 仅针对Android 8.0+有效

customTitleWhenTeamNameEmpty

java.lang.String customTitleWhenTeamNameEmpty

如果群名称为null 或者空串，则使用customTitleWhenTeamNameEmpty 作为通知栏title

notificationExtraType

NotificationExtraTypeEnum notificationExtraType

点击通知栏传递的extra类型

notificationFilter

StatusBarNotificationFilter notificationFilter

弹StatusBarNotification之前，SDK通过改接口询问App，根据App返回结果决定是否弹出通知 为空等同于返回DEFAULT

postNotificationsRequester

NimPermissionRequester postNotificationsRequester

Android13 弹出通知之前，SDK通过改接口向App请求权限Manifest.permission#POST_NOTIFICATIONS，根据权限赋予结果决定是否弹出通知

类com.netease.nimlib.sdk.StatusCodeInfo扩展java.lang.Object实现可序列化

序列化字段

status

StatusCode status

desc

java.lang.String desc

程序包 com.netease.nimlib.sdk.antispam.model

类com.netease.nimlib.sdk.antispam.model.AntiSpamConfig扩展java.lang.Object实现可序列化

序列化字段

antiSpamBusinessId

java.lang.String antiSpamBusinessId

用户配置的对某些资料内容另外的反垃圾的业务ID, Json, {"textbid":"","picbid":""}

程序包 com.netease.nimlib.sdk.auth

类com.netease.nimlib.sdk.auth.LoginInfo扩展java.lang.Object实现可序列化

序列化字段

account

java.lang.String account

token

java.lang.String token

authType

int authType

loginExt

java.lang.String loginExt

appKey

java.lang.String appKey

customClientType

int customClientType

程序包 com.netease.nimlib.sdk.avchat.model

类com.netease.nimlib.sdk.avchat.model.AVChatCalleeAckEvent扩展AVChatCommonEvent实现可序列化

类com.netease.nimlib.sdk.avchat.model.AVChatCommonEvent扩展java.lang.Object实现可序列化

序列化字段

event

AVChatEventType event

data

AVChatData data

类com.netease.nimlib.sdk.avchat.model.AVChatControlEvent扩展AVChatCommonEvent实现可序列化

序列化字段

controlCommand

byte controlCommand

另请参阅:

AVChatControlCommand

类com.netease.nimlib.sdk.avchat.model.AVChatNotifyOption扩展java.lang.Object实现可序列化

序列化字段

apnsInuse

boolean apnsInuse

网络通话请求是否附带推送(iOS) 默认为true。将这个字段设为false，网络通话请求将不再有苹果推送通知。

apnsBadge

boolean apnsBadge

推送是否需要角标计数(iOS) 默认为true。将这个字段设为false，网络通话请求将不再对角标计数。

apnsWithPrefix

boolean apnsWithPrefix

推送消息是否需要带前缀(iOS) 默认为true。将这个字段设为false，推送消息将不带有前缀(xx:)。

apnsContent

java.lang.String apnsContent

apns推送文案(iOS) 默认为null，用户可以设置当前通知的推送文案

apnsPayload

java.lang.String apnsPayload

apns推送Payload(iOS) 可以通过这个字段定义自定义通知的推送Payload,支持字段参考苹果技术文档,最多支持2K

pushSound

java.lang.String pushSound

推送声音文件(iOS) 默认为null，用户可以设置当前通知的推送声音。该设置会覆盖apnsPayload中的sound设置

extendMessage

java.lang.String extendMessage

扩展消息 仅在发起网络通话时有效，用于在主被叫之间传递额外信息，被叫收到呼叫时会携带该信息

forceKeepCalling

boolean forceKeepCalling

是否强制持续呼叫 默认为true, 即使对方不在线, 呼叫也不会中断, 会持续呼叫; 如果设为false，对方不在线时，发起呼叫会返回失败

类com.netease.nimlib.sdk.avchat.model.AVChatOnlineAckEvent扩展AVChatCommonEvent实现可序列化

序列化字段

clientType

byte clientType

类com.netease.nimlib.sdk.avchat.model.AVChatParameters.Key扩展java.lang.Object实现可序列化

序列化字段

mKey

<any> mKey

mWritable

boolean mWritable

mRuntime

boolean mRuntime

程序包 com.netease.nimlib.sdk.avsignalling.event

类com.netease.nimlib.sdk.avsignalling.event.CanceledInviteEvent扩展ChannelCommonEvent实现可序列化

序列化字段

toAccount

java.lang.String toAccount

requestId

java.lang.String requestId

类com.netease.nimlib.sdk.avsignalling.event.ChannelCloseEvent扩展ChannelCommonEvent实现可序列化

类com.netease.nimlib.sdk.avsignalling.event.ChannelCommonEvent扩展java.lang.Object实现可序列化

序列化字段

event

SignallingEvent event

类com.netease.nimlib.sdk.avsignalling.event.ControlEvent扩展ChannelCommonEvent实现可序列化

类com.netease.nimlib.sdk.avsignalling.event.InviteAckEvent扩展ChannelCommonEvent实现可序列化

序列化字段

toAccountId

java.lang.String toAccountId

requestId

java.lang.String requestId

ackStatus

InviteAckStatus ackStatus

类com.netease.nimlib.sdk.avsignalling.event.InvitedEvent扩展ChannelCommonEvent实现可序列化

序列化字段

toAccountId

java.lang.String toAccountId

requestId

java.lang.String requestId

pushConfig

SignallingPushConfig pushConfig

类com.netease.nimlib.sdk.avsignalling.event.SyncChannelListEvent扩展java.lang.Object实现可序列化

序列化字段

channelFullInfo

ChannelFullInfo channelFullInfo

类com.netease.nimlib.sdk.avsignalling.event.UserJoinEvent扩展ChannelCommonEvent实现可序列化

序列化字段

joinMember

MemberInfo joinMember

类com.netease.nimlib.sdk.avsignalling.event.UserLeaveEvent扩展ChannelCommonEvent实现可序列化

程序包 com.netease.nimlib.sdk.avsignalling.model

类com.netease.nimlib.sdk.avsignalling.model.ChannelBaseInfo扩展java.lang.Object实现可序列化

序列化字段

channelName

java.lang.String channelName

channelId

java.lang.String channelId

type

ChannelType type

channelExt

java.lang.String channelExt

createTimestamp

long createTimestamp

expireTimestamp

long expireTimestamp

creatorAccountId

java.lang.String creatorAccountId

channelStatus

ChannelStatus channelStatus

nertcTokenTtl

java.lang.Long nertcTokenTtl

nertcToken

java.lang.String nertcToken

nertcJoinRoomResponse

java.lang.String nertcJoinRoomResponse

类com.netease.nimlib.sdk.avsignalling.model.ChannelFullInfo扩展java.lang.Object实现可序列化

序列化字段

channelBaseInfo

ChannelBaseInfo channelBaseInfo

members

java.util.ArrayList<E> members

类com.netease.nimlib.sdk.avsignalling.model.MemberInfo扩展java.lang.Object实现可序列化

序列化字段

accountId

java.lang.String accountId

uid

long uid

joinTime

long joinTime

expireTime

long expireTime

类com.netease.nimlib.sdk.avsignalling.model.SignallingPushConfig扩展java.lang.Object实现可序列化

序列化字段

needPush

boolean needPush

needBadge

boolean needBadge

pushTitle

java.lang.String pushTitle

pushContent

java.lang.String pushContent

pushPayload

java.lang.String pushPayload

程序包 com.netease.nimlib.sdk.chatroom.model

类com.netease.nimlib.sdk.chatroom.model.CdnRequestData扩展java.lang.Object实现可序列化

序列化字段

urlReqData

java.lang.String urlReqData

host: cdn地址的host; success: 成功次数; fail: 失败次数; sr: 成功请求的平均回调耗时; fr: 失败清清的平均回调耗时 sr: 成功请求的最大回调耗时; fr: 失败清清的最大回调耗时 格式： { host1: {success: 5, fail: 4, sr: 150, fr: 500, smr: 1500, fmr: 2000}, host2: {...}, ... }

failFinal

int failFinal

单个轮询周期内重试后最终失败的次数

类com.netease.nimlib.sdk.chatroom.model.ChatRoomCdnInfo扩展java.lang.Object实现可序列化

序列化字段

enable

boolean enable

是否开启CDN轮询，0表示关闭，1表示开启，默认关闭

cdnUrlArray

java.lang.String[] cdnUrlArray

cdn的轮询地址，|分隔，每个表示一个CDN的请求url，每个url是一个匹配串，如下： 如：https://chat-msg-activity.netease.im/abcdefg_#time，端侧需要将#time替换成当前时间戳，时间戳需要跟服务器时间戳对齐，防止本地时间不准的情况 端侧要自己起一个定时器，以下发的服务器时间戳为当前时间，计算轮询时的完整url cdn中的#time计算方法：(timestamp / (pollingIntervalSeconds*1000L)) * (pollingIntervalSeconds*1000L)，即取整的pollingIntervalSeconds秒

timestamp

long timestamp

服务器当前时间戳，单位毫秒

pollingInterval

long pollingInterval

轮询间隔 ms

decryptKey

java.lang.String decryptKey

解密key

timeOut

int timeOut

请求超时 ms

类com.netease.nimlib.sdk.chatroom.model.ChatRoomInfo扩展java.lang.Object实现可序列化

序列化字段

roomId

java.lang.String roomId

name

java.lang.String name

announcement

java.lang.String announcement

broadcastUrl

java.lang.String broadcastUrl

creator

java.lang.String creator

validFlag

int validFlag

onlineUserCount

int onlineUserCount

mute

int mute

extension

java.util.Map<K,V> extension

queueLevel

int queueLevel

类com.netease.nimlib.sdk.chatroom.model.ChatRoomMember扩展java.lang.Object实现可序列化

序列化字段

roomId

java.lang.String roomId

account

java.lang.String account

type

MemberType type

memberLevel

int memberLevel

nick

java.lang.String nick

avatar

java.lang.String avatar

extension

java.util.Map<K,V> extension

isOnline

boolean isOnline

inBlackList

boolean inBlackList

isMuted

boolean isMuted

isValid

boolean isValid

enterTime

long enterTime

updateTime

long updateTime

isTempMuted

boolean isTempMuted

tempMuteDuration

long tempMuteDuration

tags

java.lang.String tags

notifyTargetTags

java.lang.String notifyTargetTags

类com.netease.nimlib.sdk.chatroom.model.ChatRoomMemberUpdate扩展java.lang.Object实现可序列化

序列化字段

nick

java.lang.String nick

avatar

java.lang.String avatar

extension

java.util.Map<K,V> extension

needSave

boolean needSave

类com.netease.nimlib.sdk.chatroom.model.ChatRoomMessageExtension扩展java.lang.Object实现可序列化

序列化字段

roleInfoTimeTag

long roleInfoTimeTag

nick

java.lang.String nick

avatar

java.lang.String avatar

senderExtension

java.util.Map<K,V> senderExtension

类com.netease.nimlib.sdk.chatroom.model.ChatRoomNotificationAttachment扩展NotificationAttachment实现可序列化

序列化字段

targets

java.util.ArrayList<E> targets

被操作的成员帐号列表

targetNicks

java.util.ArrayList<E> targetNicks

被操作的成员昵称列表

operator

java.lang.String operator

操作者

operatorNick

java.lang.String operatorNick

操作者昵称

extension

java.util.Map<K,V> extension

扩展字段

tags

java.util.ArrayList<E> tags

更新后的标签

类com.netease.nimlib.sdk.chatroom.model.ChatRoomPartClearAttachment扩展ChatRoomNotificationAttachment实现可序列化

序列化字段

contentMap

java.util.Map<K,V> contentMap

类com.netease.nimlib.sdk.chatroom.model.ChatRoomQueueBatchAddAttachment扩展ChatRoomNotificationAttachment实现可序列化

序列化字段

chatRoomQueueChangeType

ChatRoomQueueChangeType chatRoomQueueChangeType

contentMapList

java.util.List<E> contentMapList

类com.netease.nimlib.sdk.chatroom.model.ChatRoomQueueChangeAttachment扩展ChatRoomNotificationAttachment实现可序列化

序列化字段

contentMap

java.util.Map<K,V> contentMap

chatRoomQueueChangeType

ChatRoomQueueChangeType chatRoomQueueChangeType

key

java.lang.String key

content

java.lang.String content

类com.netease.nimlib.sdk.chatroom.model.ChatRoomRecallAttachment扩展ChatRoomNotificationAttachment实现可序列化

序列化字段

msgTime

long msgTime

msgUuId

java.lang.String msgUuId

类com.netease.nimlib.sdk.chatroom.model.ChatRoomRoomMemberInAttachment扩展ChatRoomNotificationAttachment实现可序列化

序列化字段

muted

int muted

tempMuted

int tempMuted

muteTtl

long muteTtl

类com.netease.nimlib.sdk.chatroom.model.ChatRoomSpatialLocation扩展java.lang.Object实现可序列化

序列化字段

x

java.lang.Double x

坐标x

y

java.lang.Double y

坐标y

z

java.lang.Double z

坐标z

distance

java.lang.Double distance

订阅的消息的距离

类com.netease.nimlib.sdk.chatroom.model.ChatRoomStatusChangeData扩展java.lang.Object实现可序列化

序列化字段

status

StatusCode status

roomId

java.lang.String roomId

类com.netease.nimlib.sdk.chatroom.model.ChatRoomTagsInfo扩展java.lang.Object实现可序列化

序列化字段

tags

java.lang.String tags

标签，可以设置多个，json_array格式，例子：["tag1", "tag2"]，如果要删除，则null即可，上传空数组代表启用标签功能但是不属于任何标签组

notifyTargetTags

java.lang.String notifyTargetTags

更新标签的通知的目标标签，是一个标签表达式，同时也会改变该连接掉线时的通知对象，传null或空字符串表示允许通知聊天室所有成员，具体见标签表达式

needNotify

java.lang.Boolean needNotify

true表示，如果需要通知，则会产生一条通知，新增NotificationType.ChatRoomTagsUpdate

ext

java.lang.String ext

通知扩展字段

类com.netease.nimlib.sdk.chatroom.model.ChatRoomTempMuteAddAttachment扩展ChatRoomNotificationAttachment实现可序列化

序列化字段

muteDuration

long muteDuration

类com.netease.nimlib.sdk.chatroom.model.ChatRoomTempMuteRemoveAttachment扩展ChatRoomNotificationAttachment实现可序列化

序列化字段

muteDuration

long muteDuration

类com.netease.nimlib.sdk.chatroom.model.ChatRoomUpdateInfo扩展java.lang.Object实现可序列化

序列化字段

name

java.lang.String name

announcement

java.lang.String announcement

broadcastUrl

java.lang.String broadcastUrl

extension

java.util.Map<K,V> extension

queueLevel

int queueLevel

类com.netease.nimlib.sdk.chatroom.model.CustomChatRoomMessageConfig扩展java.lang.Object实现可序列化

序列化字段

skipHistory

boolean skipHistory

该消息是否要保存到服务器，如果为true，通过ChatRoomService.pullMessageHistory(String, long, int)拉取的结果将不包含该条消息。 默认为false。

类com.netease.nimlib.sdk.chatroom.model.EnterChatRoomResultData扩展java.lang.Object实现可序列化

序列化字段

roomId

java.lang.String roomId

resCode

int resCode

status

StatusCode status

roomInfo

ChatRoomInfo roomInfo

member

ChatRoomMember member

account

java.lang.String account

类com.netease.nimlib.sdk.chatroom.model.MemberOption扩展java.lang.Object实现可序列化

序列化字段

roomId

java.lang.String roomId

聊天室id

account

java.lang.String account

成员帐号

notifyExtension

java.util.Map<K,V> notifyExtension

操作产生的通知事件中开发者自定义的扩展字段（可选）

程序包 com.netease.nimlib.sdk.document.model

程序包 com.netease.nimlib.sdk.event.model

类com.netease.nimlib.sdk.event.model.Event扩展java.lang.Object实现可序列化

序列化字段

eventId

java.lang.String eventId

事件ID

eventType

int eventType

事件类型，1-99999 为云信保留类型

eventValue

int eventValue

事件的状态值

config

java.lang.String config

事件的扩展字段，最大长度为 256 字节，由事件发布客户端配置

expiry

long expiry

事件的有效期，范围为 60s 到 7days，数值单位为秒

broadcastOnlineOnly

boolean broadcastOnlineOnly

是否只广播给在线用户，若为 false，事件支持在线广播和登录后同步

syncSelfEnable

boolean syncSelfEnable

是否支持多端同步

publisherAccount

java.lang.String publisherAccount

事件发布者的云信账号

publishTime

long publishTime

事件发布的时间

publisherClientType

int publisherClientType

事件发布者客户端类型 @see ClientType

multiClientConfig

java.lang.String multiClientConfig

多端 config 配置

multiClientConfigMap

java.util.Map<K,V> multiClientConfigMap

解析 multiClientConfig 的多端 config 配置 map

nimConfig

java.lang.String nimConfig

预定义事件中服务端配置项,仅仅对预留事件有效

程序包 com.netease.nimlib.sdk.friend.model

类com.netease.nimlib.sdk.friend.model.AddFriendData扩展java.lang.Object实现可序列化

序列化字段

account

java.lang.String account

verifyType

VerifyType verifyType

msg

java.lang.String msg

类com.netease.nimlib.sdk.friend.model.AddFriendNotify扩展java.lang.Object实现可序列化

序列化字段

account

java.lang.String account

event

AddFriendNotify.Event event

msg

java.lang.String msg

serverExt

java.lang.String serverExt

类com.netease.nimlib.sdk.friend.model.BlackListChangedNotify扩展java.lang.Object实现可序列化

序列化字段

addedAccounts

java.util.List<E> addedAccounts

removedAccounts

java.util.List<E> removedAccounts

类com.netease.nimlib.sdk.friend.model.FriendChangedNotify扩展java.lang.Object实现可序列化

序列化字段

updatedFriends

java.util.List<E> updatedFriends

deletedFriends

java.util.List<E> deletedFriends

类com.netease.nimlib.sdk.friend.model.TeamInviteNotify扩展java.lang.Object实现可序列化

序列化字段

team

Team team

extension

java.util.Map<K,V> extension

程序包 com.netease.nimlib.sdk.generic.result

类com.netease.nimlib.sdk.generic.result.GenericTypeAPICallResult扩展java.lang.Object实现可序列化

序列化字段

sn

long sn

调用序列号,调用方产生,在执行结果中带回

data

java.lang.Object data

调用上下文数据,调用方产生,在执行结果中带回

name

java.lang.String name

api 名称

result

java.lang.String result

api响应，json format

程序包 com.netease.nimlib.sdk.mixpush

类com.netease.nimlib.sdk.mixpush.MixPushConfig扩展java.lang.Object实现可序列化

序列化字段

xmAppId

java.lang.String xmAppId

小米推送 appId

xmAppKey

java.lang.String xmAppKey

小米推送 appKey

xmCertificateName

java.lang.String xmCertificateName

小米推送证书，请在云信管理后台申请

hwAppId

java.lang.String hwAppId

华为推送 hwAppId

hwCertificateName

java.lang.String hwCertificateName

华为推送证书，请在云信管理后台申请

mzAppId

java.lang.String mzAppId

魅族推送 appId

mzAppKey

java.lang.String mzAppKey

魅族推送 appKey

mzCertificateName

java.lang.String mzCertificateName

魅族推送证书，请在云信管理后台申请

fcmCertificateName

java.lang.String fcmCertificateName

FCM 推送证书，请在云信管理后台申请 海外客户使用

vivoCertificateName

java.lang.String vivoCertificateName

VIVO推送 appId apiKey请在 AndroidManifest.xml 文件中配置 VIVO推送证书，请在云信管理后台申请

oppoAppId

java.lang.String oppoAppId

oppo 推送appId

oppoAppKey

java.lang.String oppoAppKey

oppo 推送appKey

oppoAppSercet

java.lang.String oppoAppSercet

oppo 推送AppSecret

oppoCertificateName

java.lang.String oppoCertificateName

OPPO推送证书，请在云信管理后台申请

honorCertificateName

java.lang.String honorCertificateName

荣耀推送 appId请在 AndroidManifest.xml 文件中配置 荣耀推送证书，请在云信管理后台申请

autoSelectPushType

boolean autoSelectPushType

是否根据token自动选择推送类型

程序包 com.netease.nimlib.sdk.msg

类com.netease.nimlib.sdk.msg.MessageNotifierCustomizationCompat扩展java.lang.Object实现可序列化

程序包 com.netease.nimlib.sdk.msg.attachment

类com.netease.nimlib.sdk.msg.attachment.AudioAttachment扩展FileAttachment实现可序列化

序列化字段

duration

long duration

autoTransform

boolean autoTransform

text

java.lang.String text

类com.netease.nimlib.sdk.msg.attachment.FileAttachment扩展java.lang.Object实现可序列化

序列化字段

path

java.lang.String path

文件路径

size

long size

文件大小

md5

java.lang.String md5

文件内容的MD5

url

java.lang.String url

文件下载地址

displayName

java.lang.String displayName

文件显示名

extension

java.lang.String extension

文件后缀名

expire

long expire

过期时间（仅对文件类型有效）

nosTokenSceneKey

java.lang.String nosTokenSceneKey

上传文件时用的对token对应的场景，默认NimNosSceneKeyConstant#NIM_DEFAULT_IM

forceUpload

boolean forceUpload

如果服务器存在相同的附件文件，是否强制重新上传 ， 默认false

isUri

boolean isUri

是否是uri

类com.netease.nimlib.sdk.msg.attachment.ImageAttachment扩展FileAttachment实现可序列化

序列化字段

width

int width

图片的宽度

height

int height

图片的高度

类com.netease.nimlib.sdk.msg.attachment.LocationAttachment扩展java.lang.Object实现可序列化

序列化字段

latitude

double latitude

longitude

double longitude

address

java.lang.String address

类com.netease.nimlib.sdk.msg.attachment.NetCallAttachment扩展java.lang.Object实现可序列化

序列化字段

type

int type

channelId

long channelId

status

int status

durations

java.util.List<E> durations

类com.netease.nimlib.sdk.msg.attachment.NetCallAttachment.Duration扩展java.lang.Object实现可序列化

序列化字段

accid

java.lang.String accid

duration

int duration

类com.netease.nimlib.sdk.msg.attachment.NotificationAttachment扩展java.lang.Object实现可序列化

序列化字段

type

NotificationType type

类com.netease.nimlib.sdk.msg.attachment.NotificationAttachmentWithExtension扩展NotificationAttachment实现可序列化

序列化字段

extension

java.util.Map<K,V> extension

扩展字段

类com.netease.nimlib.sdk.msg.attachment.VideoAttachment扩展FileAttachment实现可序列化

序列化字段

width

int width

height

int height

duration

long duration

程序包 com.netease.nimlib.sdk.msg.model

类com.netease.nimlib.sdk.msg.model.AttachmentProgress扩展java.lang.Object实现可序列化

序列化字段

uuid

java.lang.String uuid

transferred

long transferred

total

long total

类com.netease.nimlib.sdk.msg.model.BroadcastMessage扩展java.lang.Object实现可序列化

序列化字段

id

long id

广播id

fromAccount

java.lang.String fromAccount

广播发送者账号

time

long time

广播消息时间戳

content

java.lang.String content

广播消息内容

类com.netease.nimlib.sdk.msg.model.CaptureDeviceInfoConfig扩展java.lang.Object实现可序列化

序列化字段

captureModel

boolean captureModel

captureManufacturer

boolean captureManufacturer

captureBrand

boolean captureBrand

类com.netease.nimlib.sdk.msg.model.CustomMessageConfig扩展java.lang.Object实现可序列化

序列化字段

enableHistory

boolean enableHistory

该消息是否要保存到服务器，如果为false，通过MsgService.pullMessageHistory(IMMessage, int, boolean)拉取的结果将不包含该条消息。
默认为true。

enableRoaming

boolean enableRoaming

该消息是否需要漫游。如果为false，一旦某一个客户端收取过该条消息，其他端将不会再漫游到该条消息。
默认为true

enableSelfSync

boolean enableSelfSync

多端同时登录时，发送一条自定义消息后，是否要同步到其他同时登录的客户端。
默认为true

enablePush

boolean enablePush

该消息是否要消息提醒，如果为true，那么对方收到消息后，系统通知栏会有提醒。 默认为true

enablePushNick

boolean enablePushNick

该消息是否需要推送昵称（针对iOS客户端有效），如果为true，那么对方收到消息后，iOS端将显示推送昵称。 默认为true

enableUnreadCount

boolean enableUnreadCount

该消息是否要计入未读数，如果为true，那么对方收到消息后，最近联系人列表中未读数加1。 默认为true

enableRoute

boolean enableRoute

该消息是否支持路由，如果为true，默认按照app的路由开关（如果有配置抄送地址则将抄送该消息） 默认为true

enablePersist

boolean enablePersist

该消息是否要存离线 默认为true

类com.netease.nimlib.sdk.msg.model.CustomNotification扩展java.lang.Object实现可序列化

序列化字段

sessionId

java.lang.String sessionId

sessionType

SessionTypeEnum sessionType

fromAccount

java.lang.String fromAccount

time

long time

content

java.lang.String content

sendToOnlineUserOnly

boolean sendToOnlineUserOnly

apnsText

java.lang.String apnsText

pushPayload

java.util.Map<K,V> pushPayload

config

CustomNotificationConfig config

antiSpamOption

NIMAntiSpamOption antiSpamOption

env

java.lang.String env

类com.netease.nimlib.sdk.msg.model.CustomNotificationConfig扩展java.lang.Object实现可序列化

序列化字段

enablePush

boolean enablePush

该通知是否要消息提醒，如果为true，那么对方收到通知后，系统通知栏会有提醒。 默认为true

enablePushNick

boolean enablePushNick

该通知是否需要推送昵称（针对iOS客户端有效），如果为false，那么对方收到通知后，iOS端将不显示推送昵称。 默认为false

enableUnreadCount

boolean enableUnreadCount

该通知是否要计入未读数，如果为true，那么对方收到通知后，可以通过读取此配置项决定自己业务的未读计数变更。 默认为true

类com.netease.nimlib.sdk.msg.model.GetMessagesDynamicallyParam扩展java.lang.Object实现可序列化

序列化字段

sessionId

java.lang.String sessionId

会话ID

sessionType

SessionTypeEnum sessionType

会话类型

fromTime

long fromTime

开始时间（时间戳小）

toTime

long toTime

结束时间（时间戳大）

anchorServerId

long anchorServerId

要排除的最后一条消息的服务器ID，用于翻页。 要从A页翻到B页时，传A页中最接近B页的消息 设置此参数，需要同时传GetMessagesDynamicallyParam.anchorClientId

anchorClientId

java.lang.String anchorClientId

要排除的最后一条消息的客户端ID，用于翻页。 要从A页翻到B页时，传A页中最接近B页的消息

limit

int limit

条数限制 限制0~100，否则414。其中0会被转化为100

direction

GetMessageDirectionEnum direction

查询方向

类com.netease.nimlib.sdk.msg.model.HandleQuickCommentOption扩展java.lang.Object实现可序列化

序列化字段

key

MessageKey key

commentOption

QuickCommentOption commentOption

类com.netease.nimlib.sdk.msg.model.MemberPushOption扩展java.lang.Object实现可序列化

序列化字段

forcePushList

java.util.List<E> forcePushList

forcePushContent

java.lang.String forcePushContent

isForcePush

boolean isForcePush

类com.netease.nimlib.sdk.msg.model.MessageKey扩展java.lang.Object实现可序列化

序列化字段

sessionType

SessionTypeEnum sessionType

fromAccount

java.lang.String fromAccount

toAccount

java.lang.String toAccount

time

long time

serverId

long serverId

uuid

java.lang.String uuid

类com.netease.nimlib.sdk.msg.model.MessageRobotInfo扩展java.lang.Object实现可序列化

序列化字段

function

java.lang.String function

topic

java.lang.String topic

customContent

java.lang.String customContent

account

java.lang.String account

类com.netease.nimlib.sdk.msg.model.MsgPinDbOption扩展java.lang.Object实现可序列化

序列化字段

uuid

java.lang.String uuid

sessionId

java.lang.String sessionId

pinOption

MsgPinOption pinOption

类com.netease.nimlib.sdk.msg.model.MsgPinNotifyOption扩展java.lang.Object实现可序列化

序列化字段

key

MessageKey key

pin

MsgPinOption pin

类com.netease.nimlib.sdk.msg.model.MsgThreadOption扩展java.lang.Object实现可序列化

序列化字段

replyMsgFromAccount

java.lang.String replyMsgFromAccount

被回复消息的消息发送者

replyMsgToAccount

java.lang.String replyMsgToAccount

被回复消息的消息接受者，群的话是tid

replyMsgTime

long replyMsgTime

被回复消息的消息发送时间

replyMsgIdServer

long replyMsgIdServer

被回复消息的消息ServerID

replyMsgIdClient

java.lang.String replyMsgIdClient

被回复消息的UUID

threadMsgFromAccount

java.lang.String threadMsgFromAccount

thread消息的消息发送者

threadMsgToAccount

java.lang.String threadMsgToAccount

thread消息的消息接受者，群的话是tid

threadMsgTime

long threadMsgTime

thread消息的消息发送时间

threadMsgIdServer

long threadMsgIdServer

thread消息的消息ServerID

threadMsgIdClient

java.lang.String threadMsgIdClient

thread消息的UUID

类com.netease.nimlib.sdk.msg.model.NIMAntiSpamOption扩展java.lang.Object实现可序列化

序列化字段

enable

boolean enable

是否过易盾反垃圾，对于已开通易盾的用户有效，默认为true 如果应用已经开了易盾，默认消息都会走易盾，如果对单条消息设置 enable 为false，则此消息不会走易盾反垃圾，而是走通用反垃圾

content

java.lang.String content

开发者自定义的反垃圾字段， content 必须是 json 格式，仅适用于自定义消息类型 长度不超过 5000 字节，格式如下 { "type": 1, //1:文本，2：图片，3视频 "data": "" //文本内容or图片地址or视频地址 }

antiSpamConfigId

java.lang.String antiSpamConfigId

易盾反垃圾配置id，指定此消息选择过哪一个反垃圾配置

类com.netease.nimlib.sdk.msg.model.QueryMySessionOption扩展java.lang.Object实现可序列化

序列化字段

minTimestamp

long minTimestamp

最小时间戳，作为请求参数时表示增量获取Session列表 默认0，0表示客户端一点数据都没有，其他表示返回[大于等于]这个时间戳的session列表

maxTimestamp

long maxTimestamp

最大时间戳，翻页时使用 默认0，0表示请求的是最近的N条，翻页时选上一次列表中Session的updateTime的最小值，会返回[小于等于]这个时间戳的session列表,所以翻页时可能会重复返回上一页的session

needLastMsg

boolean needLastMsg

是否需要lastMsg 默认true

limit

int limit

结果集limit 默认100，最大100

类com.netease.nimlib.sdk.msg.model.QuickCommentOption扩展java.lang.Object实现可序列化

序列化字段

fromAccount

java.lang.String fromAccount

replyType

long replyType

time

long time

ext

java.lang.String ext

needPush

boolean needPush

needBadge

boolean needBadge

pushTitle

java.lang.String pushTitle

pushContent

java.lang.String pushContent

pushPayload

java.util.Map<K,V> pushPayload

类com.netease.nimlib.sdk.msg.model.QuickCommentOptionWrapper扩展java.lang.Object实现可序列化

序列化字段

key

MessageKey key

quickCommentList

java.util.ArrayList<E> quickCommentList

modify

boolean modify

time

long time

类com.netease.nimlib.sdk.msg.model.RevokeMsgNotification扩展java.lang.Object实现可序列化

序列化字段

message

IMMessage message

被撤回的消息

attach

java.lang.String attach

附件信息

revokeAccount

java.lang.String revokeAccount

消息撤回者账号

customInfo

java.lang.String customInfo

获取消息撤回时设置的msg 字段（eg: 通过服务端API撤回）。

notificationType

int notificationType

通知类型： 1表示是离线，2表示是漫游 ， 默认 0

revokeType

RevokeType revokeType

撤回类型, 点对点双向，单向，群双向，单向

callbackExt

java.lang.String callbackExt

扩展字段

类com.netease.nimlib.sdk.msg.model.RoamMsgHasMoreOption扩展java.lang.Object实现可序列化

序列化字段

sessionId

java.lang.String sessionId

会话ID

sessionType

SessionTypeEnum sessionType

会话类型

time

long time

has more标记的消息的时间

serverId

long serverId

has more标记的消息的服务ID

类com.netease.nimlib.sdk.msg.model.SystemMessage扩展java.lang.Object实现可序列化

序列化字段

messageId

long messageId

type

SystemMessageType type

fromAccount

java.lang.String fromAccount

targetId

java.lang.String targetId

time

long time

status

SystemMessageStatus status

content

java.lang.String content

attach

java.lang.String attach

attachObject

java.lang.Object attachObject

unread

boolean unread

customInfo

java.lang.String customInfo

程序包 com.netease.nimlib.sdk.nos.model

类com.netease.nimlib.sdk.nos.model.NosThumbParam扩展java.lang.Object实现可序列化

序列化字段

thumb

NosThumbParam.ThumbType thumb

width

int width

height

int height

类com.netease.nimlib.sdk.nos.model.NosTransferInfo扩展java.lang.Object实现可序列化

序列化字段

transferType

NosTransferInfo.TransferType transferType

上传or下载

path

java.lang.String path

文件路径

size

long size

文件大小

md5

java.lang.String md5

文件内容的MD5

url

java.lang.String url

文件下载地址

extension

java.lang.String extension

文件后缀名

status

NosTransferStatus status

文件传输状态

类com.netease.nimlib.sdk.nos.model.NosTransferProgress扩展java.lang.Object实现可序列化

序列化字段

key

java.lang.String key

transferred

long transferred

total

long total

程序包 com.netease.nimlib.sdk.passthrough.model

类com.netease.nimlib.sdk.passthrough.model.PassthroughNotifyData扩展java.lang.Object实现可序列化

序列化字段

fromAccid

java.lang.String fromAccid

发送方accid

body

java.lang.String body

透传内容

time

long time

发送时间时间戳

类com.netease.nimlib.sdk.passthrough.model.PassthroughProxyData扩展java.lang.Object实现可序列化

序列化字段

zone

java.lang.String zone

映射一个视频云upstream host，不传用默认配置

path

java.lang.String path

url中除了host的path

method

int method

选填，数字常量(1-get, 2-post, 3-put, 4-delete)，默认post，

header

java.lang.String header

json格式

body

java.lang.String body

格式自定，透传， post时，body不能为空

程序包 com.netease.nimlib.sdk.qchat.event

程序包 com.netease.nimlib.sdk.qchat.model

类com.netease.nimlib.sdk.qchat.model.QChatAntiSpamConfig扩展AntiSpamConfig实现可序列化

类com.netease.nimlib.sdk.qchat.model.QChatChannelCategoryIdInfo扩展java.lang.Object实现可序列化

序列化字段

serverId

java.lang.Long serverId

服务器id

categoryId

java.lang.Long categoryId

频道分组id

类com.netease.nimlib.sdk.qchat.model.QChatChannelIdInfo扩展java.lang.Object实现可序列化

序列化字段

serverId

java.lang.Long serverId

服务器id

channelId

java.lang.Long channelId

频道id

类com.netease.nimlib.sdk.qchat.model.QChatMessageAntiSpamOption扩展java.lang.Object实现可序列化

序列化字段

isCustomAntiSpamEnable

java.lang.Boolean isCustomAntiSpamEnable

是否使用自定义反垃圾字段(customAntiSpamContent)

customAntiSpamContent

java.lang.String customAntiSpamContent

开发者自定义的反垃圾字段

antiSpamBusinessId

java.lang.String antiSpamBusinessId

用户配置的对某些单条消息另外的反垃圾的业务ID

isAntiSpamUsingYidun

java.lang.Boolean isAntiSpamUsingYidun

单条消息是否使用易盾反垃圾

yidunCallback

java.lang.String yidunCallback

易盾check的回调URL, 目前仅支持Audio类型的消息, 最长256个字符, 如果不合法则忽略该参数

yidunAntiCheating

java.lang.String yidunAntiCheating

易盾反垃圾增强反作弊专属字段, 限制json, 长度限制1024

yidunAntiSpamExt

java.lang.String yidunAntiSpamExt

易盾反垃圾扩展字段, 限制json, 长度限制1024

类com.netease.nimlib.sdk.qchat.model.QChatMessageAntiSpamResult扩展java.lang.Object实现可序列化

序列化字段

isAntiSpam

boolean isAntiSpam

消息是否被反垃圾了

yidunAntiSpamRes

java.lang.String yidunAntiSpamRes

易盾反垃圾结果

类com.netease.nimlib.sdk.qchat.model.QChatMessageQueryOption扩展java.lang.Object实现可序列化

序列化字段

fromTime

java.lang.Long fromTime

起始时间

toTime

java.lang.Long toTime

结束时间

excludeMessageId

java.lang.Long excludeMessageId

excludeMsgId，排除消息id

limit

java.lang.Integer limit

limit，条数限制，默认100

reverse

java.lang.Boolean reverse

reverse，是否反向

类com.netease.nimlib.sdk.qchat.model.QChatMessageRefer扩展java.lang.Object实现可序列化

序列化字段

fromAccount

java.lang.String fromAccount

消息发送者

time

long time

消息发送时间

msgIdServer

long msgIdServer

服务端消息id

uuid

java.lang.String uuid

消息的uuid

类com.netease.nimlib.sdk.qchat.model.QChatRTCChannelInfo扩展java.lang.Object实现可序列化

序列化字段

limit

java.lang.Integer limit

int, 房间配置下的roleConfigs的人数限制

audio

java.lang.String audio

json object, 房间配置下的roleConfigs的音频质量 {"profile":"DEFAULT","scenario":"DEFAULT"}

video

java.lang.String video

json object, 房间配置下的roleConfigs的视频质量 {"width":640,"height":480,"fps":15}

类com.netease.nimlib.sdk.qchat.model.QChatUpdatedMyMemberInfoImpl扩展java.lang.Object实现可序列化

序列化字段

serverId

long serverId

nick

java.lang.String nick

nickChanged

boolean nickChanged

avatar

java.lang.String avatar

avatarChanged

boolean avatarChanged

程序包 com.netease.nimlib.sdk.qchat.model.inviteapplyrecord

程序包 com.netease.nimlib.sdk.qchat.model.systemnotification

程序包 com.netease.nimlib.sdk.qchat.result

类com.netease.nimlib.sdk.qchat.result.QChatAddChannelCategoryMemberRoleResult扩展java.lang.Object实现可序列化

序列化字段

role

QChatChannelCategoryMemberRole role

频道分组中的用户身份组

类com.netease.nimlib.sdk.qchat.result.QChatAddChannelCategoryRoleResult扩展java.lang.Object实现可序列化

序列化字段

role

QChatChannelCategoryRole role

频道分组身份组

类com.netease.nimlib.sdk.qchat.result.QChatAddChannelRoleResult扩展java.lang.Object实现可序列化

序列化字段

role

QChatChannelRole role

频道身份组

类com.netease.nimlib.sdk.qchat.result.QChatAddMemberRoleResult扩展java.lang.Object实现可序列化

序列化字段

role

QChatMemberRole role

用户所在身份组

类com.netease.nimlib.sdk.qchat.result.QChatAddMembersToServerRoleResult扩展java.lang.Object实现可序列化

序列化字段

successAccids

java.util.List<E> successAccids

failedAccids

java.util.List<E> failedAccids

类com.netease.nimlib.sdk.qchat.result.QChatApplyServerJoinResult扩展java.lang.Object实现可序列化

序列化字段

applyServerMemberInfo

QChatInviteApplyServerMemberInfo applyServerMemberInfo

申请信息

类com.netease.nimlib.sdk.qchat.result.QChatAreMentionedMeMessagesResult扩展java.lang.Object实现可序列化

序列化字段

result

java.util.Map<K,V> result

消息是否@当前用户的结果，key为uuid

类com.netease.nimlib.sdk.qchat.result.QChatCheckPermissionResult扩展java.lang.Object实现可序列化

序列化字段

hasPermission

boolean hasPermission

频道身份组

类com.netease.nimlib.sdk.qchat.result.QChatCheckPermissionsResult扩展java.lang.Object实现可序列化

序列化字段

permissions

java.util.Map<K,V> permissions

权限结果

类com.netease.nimlib.sdk.qchat.result.QChatCreateChannelCategoryResult扩展java.lang.Object实现可序列化

序列化字段

category

QChatChannelCategory category

创建的频道分组

类com.netease.nimlib.sdk.qchat.result.QChatCreateChannelResult扩展java.lang.Object实现可序列化

序列化字段

channel

QChatChannel channel

创建的频道

类com.netease.nimlib.sdk.qchat.result.QChatCreateServerResult扩展java.lang.Object实现可序列化

序列化字段

server

QChatServer server

创建成功的服务器

类com.netease.nimlib.sdk.qchat.result.QChatCreateServerRoleResult扩展java.lang.Object实现可序列化

序列化字段

role

QChatServerRole role

Server身份组

类com.netease.nimlib.sdk.qchat.result.QChatDeleteMessageResult扩展java.lang.Object实现可序列化

序列化字段

message

QChatMessage message

更新成功的消息

类com.netease.nimlib.sdk.qchat.result.QChatEnterServerAsVisitorResult扩展java.lang.Object实现可序列化

序列化字段

failedList

java.util.List<E> failedList

类com.netease.nimlib.sdk.qchat.result.QChatGenerateInviteCodeResult扩展java.lang.Object实现可序列化

序列化字段

serverId

long serverId

服务器ID

requestId

long requestId

唯一标识

inviteCode

java.lang.String inviteCode

邀请码

expireTime

long expireTime

过期时间戳ms

类com.netease.nimlib.sdk.qchat.result.QChatGetBannedServerMembersByPageResult扩展QChatGetByPageResult实现可序列化

序列化字段

serverMemberBanInfoList

java.util.List<E> serverMemberBanInfoList

服务器成员封禁列表

类com.netease.nimlib.sdk.qchat.result.QChatGetChannelBlackWhiteMembersByPageResult扩展QChatGetByPageResult实现可序列化

序列化字段

memberList

java.util.List<E> memberList

查询到的成员列表

类com.netease.nimlib.sdk.qchat.result.QChatGetChannelBlackWhiteRolesByPageResult扩展QChatGetByPageResult实现可序列化

序列化字段

roleList

java.util.List<E> roleList

查询到的身份组列表

类com.netease.nimlib.sdk.qchat.result.QChatGetChannelCategoriesByPageResult扩展QChatGetByPageResult实现可序列化

序列化字段

categories

java.util.List<E> categories

查询到的频道分组列表

类com.netease.nimlib.sdk.qchat.result.QChatGetChannelCategoriesResult扩展java.lang.Object实现可序列化

序列化字段

categories

java.util.List<E> categories

查询到的频道分组列表

类com.netease.nimlib.sdk.qchat.result.QChatGetChannelCategoryBlackWhiteMembersByPageResult扩展QChatGetByPageResult实现可序列化

序列化字段

memberList

java.util.List<E> memberList

查询到的成员列表

类com.netease.nimlib.sdk.qchat.result.QChatGetChannelCategoryBlackWhiteRolesByPageResult扩展QChatGetByPageResult实现可序列化

序列化字段

roleList

java.util.List<E> roleList

查询到的身份组列表

类com.netease.nimlib.sdk.qchat.result.QChatGetChannelCategoryMemberRolesResult扩展java.lang.Object实现可序列化

序列化字段

roleList

java.util.List<E> roleList

分组下的用户身份组列表

类com.netease.nimlib.sdk.qchat.result.QChatGetChannelCategoryRolesResult扩展java.lang.Object实现可序列化

序列化字段

roleList

java.util.List<E> roleList

频道身份组列表

类com.netease.nimlib.sdk.qchat.result.QChatGetChannelMembersByPageResult扩展QChatGetByPageResult实现可序列化

序列化字段

members

java.util.List<E> members

查询到的频道成员

类com.netease.nimlib.sdk.qchat.result.QChatGetChannelRolesResult扩展java.lang.Object实现可序列化

序列化字段

roleList

java.util.List<E> roleList

频道身份组列表

类com.netease.nimlib.sdk.qchat.result.QChatGetChannelsByPageResult扩展QChatGetByPageResult实现可序列化

序列化字段

channels

java.util.List<E> channels

查询到的频道列表

类com.netease.nimlib.sdk.qchat.result.QChatGetChannelsInCategoryByPageResult扩展QChatGetByPageResult实现可序列化

序列化字段

channels

java.util.List<E> channels

查询到的频道列表

类com.netease.nimlib.sdk.qchat.result.QChatGetChannelsResult扩展java.lang.Object实现可序列化

序列化字段

channels

java.util.List<E> channels

类com.netease.nimlib.sdk.qchat.result.QChatGetChannelUnreadInfosResult扩展java.lang.Object实现可序列化

序列化字段

unreadInfoList

java.util.List<E> unreadInfoList

类com.netease.nimlib.sdk.qchat.result.QChatGetExistingAccidsInServerRoleResult扩展java.lang.Object实现可序列化

序列化字段

accidList

java.util.List<E> accidList

指定服务器身份组下存在的成员列表

类com.netease.nimlib.sdk.qchat.result.QChatGetExistingAccidsOfMemberRolesResult扩展java.lang.Object实现可序列化

序列化字段

accidList

java.util.List<E> accidList

accid列表，代表已经在频道定制过个人权限的用户

类com.netease.nimlib.sdk.qchat.result.QChatGetExistingChannelBlackWhiteMembersResult扩展java.lang.Object实现可序列化

序列化字段

memberList

java.util.List<E> memberList

查询到的成员列表

类com.netease.nimlib.sdk.qchat.result.QChatGetExistingChannelBlackWhiteRolesResult扩展java.lang.Object实现可序列化

序列化字段

roleList

java.util.List<E> roleList

查询到的身份组列表

类com.netease.nimlib.sdk.qchat.result.QChatGetExistingChannelCategoryBlackWhiteMembersResult扩展java.lang.Object实现可序列化

序列化字段

memberList

java.util.List<E> memberList

查询到的成员列表

类com.netease.nimlib.sdk.qchat.result.QChatGetExistingChannelCategoryBlackWhiteRolesResult扩展java.lang.Object实现可序列化

序列化字段

roleList

java.util.List<E> roleList

查询到的身份组列表

类com.netease.nimlib.sdk.qchat.result.QChatGetExistingChannelRolesByServerRoleIdsResult扩展java.lang.Object实现可序列化

序列化字段

roleList

java.util.List<E> roleList

频道身份组列表

类com.netease.nimlib.sdk.qchat.result.QChatGetExistingServerRolesByAccidsResult扩展java.lang.Object实现可序列化

序列化字段

accidServerRolesMap

java.util.Map<K,V> accidServerRolesMap

服务器自定义身份组Map

类com.netease.nimlib.sdk.qchat.result.QChatGetInviteApplyRecordOfSelfResult扩展java.lang.Object实现可序列化

序列化字段

records

java.util.List<E> records

申请邀请记录

类com.netease.nimlib.sdk.qchat.result.QChatGetInviteApplyRecordOfServerResult扩展java.lang.Object实现可序列化

序列化字段

records

java.util.List<E> records

申请邀请记录

类com.netease.nimlib.sdk.qchat.result.QChatGetLastMessageOfChannelsResult扩展java.lang.Object实现可序列化

序列化字段

channelMsgMap

java.util.Map<K,V> channelMsgMap

查询到的消息map,key为channelId

类com.netease.nimlib.sdk.qchat.result.QChatGetMemberRolesResult扩展java.lang.Object实现可序列化

序列化字段

roleList

java.util.List<E> roleList

用户所在身份组列表

类com.netease.nimlib.sdk.qchat.result.QChatGetMembersFromServerRoleResult扩展java.lang.Object实现可序列化

序列化字段

roleMemberList

java.util.List<E> roleMemberList

指定服务器身份组下的成员列表

类com.netease.nimlib.sdk.qchat.result.QChatGetMentionedMeMessagesResult扩展QChatGetByPageResult实现可序列化

序列化字段

messages

java.util.List<E> messages

查询到的消息列表

类com.netease.nimlib.sdk.qchat.result.QChatGetMessageHistoryResult扩展java.lang.Object实现可序列化

序列化字段

messages

java.util.List<E> messages

查询到的历史消息

类com.netease.nimlib.sdk.qchat.result.QChatGetMessageThreadInfosResult扩展java.lang.Object实现可序列化

序列化字段

messageThreadInfoMap

java.util.Map<K,V> messageThreadInfoMap

消息Thread聊天信息Map，key为uuid

类com.netease.nimlib.sdk.qchat.result.QChatGetQuickCommentsResult扩展java.lang.Object实现可序列化

序列化字段

messageQuickCommentDetailMap

java.util.Map<K,V> messageQuickCommentDetailMap

消息快捷评论详情Map，key为MsgIdServer

类com.netease.nimlib.sdk.qchat.result.QChatGetReferMessagesResult扩展java.lang.Object实现可序列化

序列化字段

replyMessage

QChatMessage replyMessage

被回复的消息

threadMessage

QChatMessage threadMessage

根消息

类com.netease.nimlib.sdk.qchat.result.QChatGetServerMembersByPageResult扩展QChatGetByPageResult实现可序列化

序列化字段

serverMembers

java.util.List<E> serverMembers

查询到的频道成员

类com.netease.nimlib.sdk.qchat.result.QChatGetServerMembersResult扩展java.lang.Object实现可序列化

序列化字段

serverMembers

java.util.List<E> serverMembers

查询到的频道成员

类com.netease.nimlib.sdk.qchat.result.QChatGetServerRolesByAccidResult扩展java.lang.Object实现可序列化

序列化字段

roleList

java.util.List<E> roleList

用户自定义身份组列表

类com.netease.nimlib.sdk.qchat.result.QChatGetServerRolesResult扩展java.lang.Object实现可序列化

序列化字段

roleList

java.util.List<E> roleList

服务器身份组列表

isMemberSet

java.util.Set<E> isMemberSet

我所在的服务器身份组Id集合 从请求到的服务器身份组列表里，筛选出我所在的身份组的roleId组成的Set集合

类com.netease.nimlib.sdk.qchat.result.QChatGetServersByPageResult扩展QChatGetByPageResult实现可序列化

序列化字段

servers

java.util.List<E> servers

查询到的服务器列表

类com.netease.nimlib.sdk.qchat.result.QChatGetServersResult扩展java.lang.Object实现可序列化

序列化字段

servers

java.util.List<E> servers

查询到的服务器列表

类com.netease.nimlib.sdk.qchat.result.QChatGetThreadMessagesResult扩展java.lang.Object实现可序列化

序列化字段

threadMessage

QChatMessage threadMessage

thread消息

threadInfo

QChatMessageThreadInfo threadInfo

thread聊天信息

messages

java.util.List<E> messages

查询到的thread历史消息

类com.netease.nimlib.sdk.qchat.result.QChatGetUserPushConfigsResult扩展java.lang.Object实现可序列化

序列化字段

userPushConfigs

java.util.List<E> userPushConfigs

查询到的用户推送配置

类com.netease.nimlib.sdk.qchat.result.QChatInviteServerMembersResult扩展java.lang.Object实现可序列化

序列化字段

failedAccids

java.util.List<E> failedAccids

因为用户服务器数量超限导致失败的accid列表

bannedAccids

java.util.List<E> bannedAccids

因为用户被服务器封禁导致失败的accid列表

inviteServerMemberInfo

QChatInviteApplyServerMemberInfo inviteServerMemberInfo

邀请信息

类com.netease.nimlib.sdk.qchat.result.QChatKickOtherClientsResult扩展java.lang.Object实现可序列化

序列化字段

clientIds

java.util.List<E> clientIds

被成功踢掉的客户端的deviceId列表

类com.netease.nimlib.sdk.qchat.result.QChatLeaveServerAsVisitorResult扩展java.lang.Object实现可序列化

序列化字段

failedList

java.util.List<E> failedList

类com.netease.nimlib.sdk.qchat.result.QChatLoginResult扩展java.lang.Object实现可序列化

序列化字段

currentClient

QChatClient currentClient

当前登录客户端信息

otherClients

java.util.List<E> otherClients

其他登录客户端信息

类com.netease.nimlib.sdk.qchat.result.QChatRemoveMembersFromServerRoleResult扩展java.lang.Object实现可序列化

序列化字段

successAccids

java.util.List<E> successAccids

failedAccids

java.util.List<E> failedAccids

类com.netease.nimlib.sdk.qchat.result.QChatRevokeMessageResult扩展java.lang.Object实现可序列化

序列化字段

message

QChatMessage message

更新成功的消息

类com.netease.nimlib.sdk.qchat.result.QChatSearchChannelByPageResult扩展QChatGetByPageWithCursorResult实现可序列化

序列化字段

channels

java.util.List<E> channels

查询到的频道

类com.netease.nimlib.sdk.qchat.result.QChatSearchChannelMembersResult扩展java.lang.Object实现可序列化

序列化字段

members

java.util.List<E> members

搜索到的频道成员

类com.netease.nimlib.sdk.qchat.result.QChatSearchMsgByPageResult扩展QChatGetByPageWithCursorResult实现可序列化

序列化字段

messages

java.util.List<E> messages

查询到的消息列表

类com.netease.nimlib.sdk.qchat.result.QChatSearchServerByPageResult扩展QChatGetByPageWithCursorResult实现可序列化

序列化字段

servers

java.util.List<E> servers

查询到的服务器

类com.netease.nimlib.sdk.qchat.result.QChatSearchServerMemberByPageResult扩展java.lang.Object实现可序列化

序列化字段

members

java.util.List<E> members

查询到的服务器成员

类com.netease.nimlib.sdk.qchat.result.QChatSendMessageResult扩展java.lang.Object实现可序列化

序列化字段

sentMessage

QChatMessage sentMessage

发送成功的消息

类com.netease.nimlib.sdk.qchat.result.QChatSendSystemNotificationResult扩展java.lang.Object实现可序列化

序列化字段

sentCustomNotification

QChatSystemNotification sentCustomNotification

发送成功的自定义系统通知

类com.netease.nimlib.sdk.qchat.result.QChatSendTypingEventResult扩展java.lang.Object实现可序列化

序列化字段

typingEvent

QChatTypingEvent typingEvent

正在输入事件

类com.netease.nimlib.sdk.qchat.result.QChatServerMarkReadResult扩展java.lang.Object实现可序列化

序列化字段

successServerIds

java.util.List<E> successServerIds

failedServerIds

java.util.List<E> failedServerIds

timestamp

long timestamp

类com.netease.nimlib.sdk.qchat.result.QChatSubscribeAllChannelResult扩展java.lang.Object实现可序列化

序列化字段

unreadInfoList

java.util.List<E> unreadInfoList

failedList

java.util.List<E> failedList

类com.netease.nimlib.sdk.qchat.result.QChatSubscribeChannelAsVisitorResult扩展java.lang.Object实现可序列化

序列化字段

failedList

java.util.List<E> failedList

类com.netease.nimlib.sdk.qchat.result.QChatSubscribeChannelResult扩展java.lang.Object实现可序列化

序列化字段

unreadInfoList

java.util.List<E> unreadInfoList

failedList

java.util.List<E> failedList

类com.netease.nimlib.sdk.qchat.result.QChatSubscribeServerAsVisitorResult扩展java.lang.Object实现可序列化

序列化字段

failedList

java.util.List<E> failedList

类com.netease.nimlib.sdk.qchat.result.QChatSubscribeServerResult扩展java.lang.Object实现可序列化

序列化字段

failedList

java.util.List<E> failedList

类com.netease.nimlib.sdk.qchat.result.QChatUpdateCategoryInfoOfChannelResult扩展java.lang.Object实现可序列化

序列化字段

channel

QChatChannel channel

频道信息

类com.netease.nimlib.sdk.qchat.result.QChatUpdateChannelCategoryMemberRoleResult扩展java.lang.Object实现可序列化

序列化字段

role

QChatChannelCategoryMemberRole role

更新后的分组用户身份组

类com.netease.nimlib.sdk.qchat.result.QChatUpdateChannelCategoryResult扩展java.lang.Object实现可序列化

序列化字段

category

QChatChannelCategory category

更新后的频道分组

类com.netease.nimlib.sdk.qchat.result.QChatUpdateChannelCategoryRoleResult扩展java.lang.Object实现可序列化

序列化字段

role

QChatChannelCategoryRole role

频道分组身份组

类com.netease.nimlib.sdk.qchat.result.QChatUpdateChannelResult扩展java.lang.Object实现可序列化

序列化字段

channel

QChatChannel channel

更新后的频道

类com.netease.nimlib.sdk.qchat.result.QChatUpdateChannelRoleResult扩展java.lang.Object实现可序列化

序列化字段

role

QChatChannelRole role

频道身份组

类com.netease.nimlib.sdk.qchat.result.QChatUpdateMemberRoleResult扩展java.lang.Object实现可序列化

序列化字段

role

QChatMemberRole role

更新后的用户身份组

类com.netease.nimlib.sdk.qchat.result.QChatUpdateMessageResult扩展java.lang.Object实现可序列化

序列化字段

message

QChatMessage message

更新成功的消息

类com.netease.nimlib.sdk.qchat.result.QChatUpdateMyMemberInfoResult扩展java.lang.Object实现可序列化

序列化字段

member

QChatServerMember member

类com.netease.nimlib.sdk.qchat.result.QChatUpdateServerMemberInfoResult扩展java.lang.Object实现可序列化

序列化字段

member

QChatServerMember member

类com.netease.nimlib.sdk.qchat.result.QChatUpdateServerResult扩展java.lang.Object实现可序列化

序列化字段

server

QChatServer server

创建成功的服务器

类com.netease.nimlib.sdk.qchat.result.QChatUpdateServerRolePrioritiesResult扩展java.lang.Object实现可序列化

序列化字段

roleIdPriorityMap

java.util.Map<K,V> roleIdPriorityMap

服务器身份组Id和服务器身份组权限构成的Map

类com.netease.nimlib.sdk.qchat.result.QChatUpdateServerRoleResult扩展java.lang.Object实现可序列化

序列化字段

role

QChatServerRole role

频道身份组

类com.netease.nimlib.sdk.qchat.result.QChatUpdateSystemNotificationResult扩展java.lang.Object实现可序列化

序列化字段

sentCustomNotification

QChatSystemNotification sentCustomNotification

修改成功的系统通知

程序包 com.netease.nimlib.sdk.qcmedia.model

类com.netease.nimlib.sdk.qcmedia.model.QChatMediaRTCChannelInfo扩展java.lang.Object实现可序列化

序列化字段

limit

java.lang.Integer limit

RTC频道限制人数

audio

QChatMediaAudioQuality audio

RTC频道音频质量

video

QChatMediaVideoParams video

RTC频道视频质量

程序包 com.netease.nimlib.sdk.robot.model

类com.netease.nimlib.sdk.robot.model.RobotAttachment扩展java.lang.Object实现可序列化

序列化字段

isRobotSend

boolean isRobotSend

fromRobotAccount

java.lang.String fromRobotAccount

responseForMessageId

java.lang.String responseForMessageId

response

java.lang.String response

requestType

java.lang.String requestType

requestContent

java.lang.String requestContent

requestTarget

java.lang.String requestTarget

requestParams

java.lang.String requestParams

类com.netease.nimlib.sdk.robot.model.RobotChangedNotify扩展java.lang.Object实现可序列化

序列化字段

updatedRobots

java.util.List<E> updatedRobots

deletedRobots

java.util.List<E> deletedRobots

程序包 com.netease.nimlib.sdk.rts.model

类com.netease.nimlib.sdk.rts.model.RTSCalleeAckEvent扩展RTSCommonEvent实现可序列化

序列化字段

isTunReady

boolean isTunReady

类com.netease.nimlib.sdk.rts.model.RTSCommonEvent扩展java.lang.Object实现可序列化

序列化字段

event

RTSEventType event

data

RTSDataImpl data

类com.netease.nimlib.sdk.rts.model.RTSControlEvent扩展RTSCommonEvent实现可序列化

序列化字段

command

byte command

commandInfo

java.lang.String commandInfo

类com.netease.nimlib.sdk.rts.model.RTSNotifyOption扩展java.lang.Object实现可序列化

序列化字段

apnsInuse

boolean apnsInuse

网络通话请求是否附带推送 默认为true。将这个字段设为false，网络通话请求将不再有苹果推送通知。

apnsBadge

boolean apnsBadge

推送是否需要角标计数 默认为true。将这个字段设为false，网络通话请求将不再对角标计数。

apnsWithPrefix

boolean apnsWithPrefix

推送消息是否需要带前缀(一般为昵称) 默认为true。将这个字段设为false，推送消息将不带有前缀(xx:)。

apnsContent

java.lang.String apnsContent

apns推送文案 默认为null，用户可以设置当前通知的推送文案

extendMessage

java.lang.String extendMessage

扩展消息 仅在发起网络通话时有效，用于在主被叫之间传递额外信息，被叫收到呼叫时会携带该信息

apnsPayload

java.lang.String apnsPayload

apns推送Payload 可以通过这个字段定义自定义通知的推送Payload,支持字段参考苹果技术文档,最多支持2K

apnsSound

java.lang.String apnsSound

apns推送声音文件 默认为null，用户可以设置当前通知的推送声音。该设置会覆盖apnsPayload中的sound设置

forceKeepCalling

boolean forceKeepCalling

是否强制持续呼叫 默认为true, 即使对方不在线，呼叫也不会中断

类com.netease.nimlib.sdk.rts.model.RTSOnlineAckEvent扩展RTSCommonEvent实现可序列化

序列化字段

clientType

byte clientType

类com.netease.nimlib.sdk.rts.model.RTSTunData扩展java.lang.Object实现可序列化

序列化字段

sessionId

java.lang.String sessionId

toAccount

java.lang.String toAccount

data

byte[] data

length

int length

程序包 com.netease.nimlib.sdk.settings.model

程序包 com.netease.nimlib.sdk.superteam

程序包 com.netease.nimlib.sdk.team.model

类com.netease.nimlib.sdk.team.model.CreateTeamResult扩展java.lang.Object实现可序列化

序列化字段

team

Team team

调用者创建的Team

failedInviteAccounts

java.util.ArrayList<E> failedInviteAccounts

邀请成员群数量超限的账号列表

类com.netease.nimlib.sdk.team.model.DismissAttachment扩展NotificationAttachmentWithExtension实现可序列化

类com.netease.nimlib.sdk.team.model.LeaveTeamAttachment扩展NotificationAttachmentWithExtension实现可序列化

类com.netease.nimlib.sdk.team.model.MemberChangeAttachment扩展NotificationAttachmentWithExtension实现可序列化

序列化字段

targets

java.util.ArrayList<E> targets

被操作的成员帐号列表

类com.netease.nimlib.sdk.team.model.MuteMemberAttachment扩展MemberChangeAttachment实现可序列化

序列化字段

mute

boolean mute

类com.netease.nimlib.sdk.team.model.UpdateTeamAttachment扩展NotificationAttachmentWithExtension实现可序列化

序列化字段

updatedFields

java.util.HashMap<K,V> updatedFields

程序包 com.netease.nimlib.sdk.uinfo.model

程序包 com.netease.nimlib.sdk.util

类com.netease.nimlib.sdk.util.Entry扩展java.lang.Object实现可序列化

序列化字段

key

java.io.Serializable key

value

java.io.Serializable value