NIMSDK-AOS  10.10.13
Public 成员函数 | Protected 成员函数 | 所有成员列表
com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData类 参考

Created by huangjun on 2015/12/28. 更多...

Public 成员函数

String getRoomId ()
 获取聊天室id 更多...
 
void setRoomId (String roomId)
 设置聊天室id 更多...
 
boolean isEnableLbs ()
 
void setEnableLbs (boolean enableLbs)
 
void setEnableLbs (boolean enableLbs, String account, String token, boolean isAnonymousMode)
 兼容旧接口,enableLbs 只控制是否通过 LBS 获取聊天室链路。 account/token/isAnonymousMode 仅在独立模式下才会生效。 更多...
 
String getAppKey ()
 获取聊天室appKey 更多...
 
void setAppKey (String appKey)
 设置聊天室appKey,独立登录模式下,才启用, 不传则使用IM对应的appKey, 需要保证roomId与appKey的对应关系 更多...
 
String getNick ()
 获取聊天室展示的昵称 更多...
 
void setNick (String nick)
 设置聊天室展示的昵称,可选字段,如果不填则直接使用NimUserInfo的数据 更多...
 
String getAvatar ()
 获取聊天室展示的头像 更多...
 
void setAvatar (String avatar)
 设置聊天室展示的头像 更多...
 
Map< String, Object > getExtension ()
 获取进入聊天室后展示的扩展字段 更多...
 
void setExtension (Map< String, Object > extension)
 设置进入聊天室后展示的扩展字段,长度限制4k 更多...
 
Map< String, Object > getNotifyExtension ()
 获取聊天室通知开发者扩展字段 更多...
 
void setNotifyExtension (Map< String, Object > notifyExtension)
 设置聊天室通知开发者扩展字段,长度限制1k 更多...
 
String getTags ()
 获取 登录标签 更多...
 
void setTags (String tags)
 设置 登录标签 更多...
 
String getNotifyTargetTags ()
 获取 登录登出通知的目标标签 更多...
 
void setNotifyTargetTags (String notifyTargetTags)
 设置 登录登出通知的目标标签 更多...
 
boolean isIndependentMode ()
 是否是独立登录聊天室 更多...
 
boolean isAnonymousMode ()
 
String getAccount ()
 获取独立登录模式的用户账号 更多...
 
String getToken ()
 获取独立登录模式的用户密码 更多...
 
Integer getLoginAuthType ()
 获取鉴权方式 更多...
 
void setLoginAuthType (Integer loginAuthType)
 设置鉴权方式 更多...
 
String getLoginExt ()
 获取登录自定义字段 更多...
 
void setLoginExt (String loginExt)
 设置登录自定义字段 更多...
 
ChatRoomSpatialLocation getChatRoomSpatialLocation ()
 
void setChatRoomSpatialLocation (ChatRoomSpatialLocation chatRoomSpatialLocation)
 
ChatRoomAuthProvider getChatRoomAuthProvider ()
 
void setChatRoomAuthProvider (ChatRoomAuthProvider chatRoomAuthProvider)
 
ChatRoomIndependentCallback getIndependentModeCallback ()
 
AntiSpamConfig getAntiSpamConfig ()
 
void setAntiSpamConfig (AntiSpamConfig antiSpamConfig)
 
void setIndependentMode (ChatRoomIndependentCallback cb, String account, String token)
 设置聊天室独立模式 更多...
 
void setIndependentMode (ChatRoomIndependentCallback cb, String account, String token, boolean isAnonymousMode)
 设置聊天室独立模式 更多...
 
 EnterChatRoomData (String roomId)
 
boolean isValid ()
 

Protected 成员函数

void setIndependentModeInternal (String account, String token, boolean isAnonymousMode)
 

详细描述

Created by huangjun on 2015/12/28.

在文件 EnterChatRoomData.java 第 13 行定义.

构造及析构函数说明

com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.EnterChatRoomData ( String  roomId)

在文件 EnterChatRoomData.java 第 364 行定义.

成员函数说明

String com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.getAccount ( )

获取独立登录模式的用户账号

返回
账号,null表示匿名登录

在文件 EnterChatRoomData.java 第 255 行定义.

AntiSpamConfig com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.getAntiSpamConfig ( )

在文件 EnterChatRoomData.java 第 323 行定义.

String com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.getAppKey ( )

获取聊天室appKey

返回

在文件 EnterChatRoomData.java 第 120 行定义.

String com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.getAvatar ( )

获取聊天室展示的头像

返回

在文件 EnterChatRoomData.java 第 156 行定义.

ChatRoomAuthProvider com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.getChatRoomAuthProvider ( )

在文件 EnterChatRoomData.java 第 309 行定义.

ChatRoomSpatialLocation com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.getChatRoomSpatialLocation ( )

在文件 EnterChatRoomData.java 第 300 行定义.

Map<String, Object> com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.getExtension ( )

获取进入聊天室后展示的扩展字段

返回

在文件 EnterChatRoomData.java 第 174 行定义.

ChatRoomIndependentCallback com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.getIndependentModeCallback ( )

在文件 EnterChatRoomData.java 第 319 行定义.

Integer com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.getLoginAuthType ( )

获取鉴权方式

返回

在文件 EnterChatRoomData.java 第 272 行定义.

String com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.getLoginExt ( )

获取登录自定义字段

返回

在文件 EnterChatRoomData.java 第 288 行定义.

String com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.getNick ( )

获取聊天室展示的昵称

返回

在文件 EnterChatRoomData.java 第 138 行定义.

Map<String, Object> com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.getNotifyExtension ( )

获取聊天室通知开发者扩展字段

返回

在文件 EnterChatRoomData.java 第 192 行定义.

String com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.getNotifyTargetTags ( )

获取 登录登出通知的目标标签

返回

在文件 EnterChatRoomData.java 第 225 行定义.

String com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.getRoomId ( )

获取聊天室id

返回

在文件 EnterChatRoomData.java 第 77 行定义.

String com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.getTags ( )

获取 登录标签

返回

在文件 EnterChatRoomData.java 第 209 行定义.

String com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.getToken ( )

获取独立登录模式的用户密码

返回
登录口令

在文件 EnterChatRoomData.java 第 264 行定义.

boolean com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.isAnonymousMode ( )

在文件 EnterChatRoomData.java 第 246 行定义.

boolean com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.isEnableLbs ( )

在文件 EnterChatRoomData.java 第 90 行定义.

boolean com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.isIndependentMode ( )

是否是独立登录聊天室

返回
false,需要IM先登录才可以进入聊天室。true,不需要依赖IM,支持匿名登录,实际账号密码登录。

在文件 EnterChatRoomData.java 第 242 行定义.

boolean com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.isValid ( )

在文件 EnterChatRoomData.java 第 368 行定义.

void com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.setAntiSpamConfig ( AntiSpamConfig  antiSpamConfig)

在文件 EnterChatRoomData.java 第 327 行定义.

void com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.setAppKey ( String  appKey)

设置聊天室appKey,独立登录模式下,才启用, 不传则使用IM对应的appKey, 需要保证roomId与appKey的对应关系

参数
appKey

在文件 EnterChatRoomData.java 第 129 行定义.

void com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.setAvatar ( String  avatar)

设置聊天室展示的头像

参数
avatar

在文件 EnterChatRoomData.java 第 165 行定义.

void com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.setChatRoomAuthProvider ( ChatRoomAuthProvider  chatRoomAuthProvider)

在文件 EnterChatRoomData.java 第 314 行定义.

void com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.setChatRoomSpatialLocation ( ChatRoomSpatialLocation  chatRoomSpatialLocation)

在文件 EnterChatRoomData.java 第 304 行定义.

void com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.setEnableLbs ( boolean  enableLbs)

在文件 EnterChatRoomData.java 第 100 行定义.

void com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.setEnableLbs ( boolean  enableLbs,
String  account,
String  token,
boolean  isAnonymousMode 
)

兼容旧接口,enableLbs 只控制是否通过 LBS 获取聊天室链路。 account/token/isAnonymousMode 仅在独立模式下才会生效。

在文件 EnterChatRoomData.java 第 108 行定义.

void com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.setExtension ( Map< String, Object >  extension)

设置进入聊天室后展示的扩展字段,长度限制4k

参数
extension

在文件 EnterChatRoomData.java 第 183 行定义.

void com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.setIndependentMode ( ChatRoomIndependentCallback  cb,
String  account,
String  token 
)

设置聊天室独立模式

参数
cb如果是独立模式,必须提供回调函数,用于SDK向APP获取聊天室地址信息的数据。
account独立登录的账号,可以不填。不填即为匿名登录
token独立登录的密码。

在文件 EnterChatRoomData.java 第 338 行定义.

void com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.setIndependentMode ( ChatRoomIndependentCallback  cb,
String  account,
String  token,
boolean  isAnonymousMode 
)

设置聊天室独立模式

参数
cb如果是独立模式,必须提供回调函数,用于SDK向APP获取聊天室地址信息的数据。
account独立登录的账号,
token独立登录的密码。
isAnonymousMode是否匿名模式,如果为false,account参数不可为空

在文件 EnterChatRoomData.java 第 358 行定义.

void com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.setIndependentModeInternal ( String  account,
String  token,
boolean  isAnonymousMode 
)
protected

在文件 EnterChatRoomData.java 第 344 行定义.

void com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.setLoginAuthType ( Integer  loginAuthType)

设置鉴权方式

参数
loginAuthType

在文件 EnterChatRoomData.java 第 280 行定义.

void com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.setLoginExt ( String  loginExt)

设置登录自定义字段

参数
loginExt

在文件 EnterChatRoomData.java 第 296 行定义.

void com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.setNick ( String  nick)

设置聊天室展示的昵称,可选字段,如果不填则直接使用NimUserInfo的数据

参数
nick

在文件 EnterChatRoomData.java 第 147 行定义.

void com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.setNotifyExtension ( Map< String, Object >  notifyExtension)

设置聊天室通知开发者扩展字段,长度限制1k

参数
notifyExtension

在文件 EnterChatRoomData.java 第 201 行定义.

void com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.setNotifyTargetTags ( String  notifyTargetTags)

设置 登录登出通知的目标标签

参数
notifyTargetTags

在文件 EnterChatRoomData.java 第 233 行定义.

void com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.setRoomId ( String  roomId)

设置聊天室id

参数
roomId

在文件 EnterChatRoomData.java 第 86 行定义.

void com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.setTags ( String  tags)

设置 登录标签

参数
tags

在文件 EnterChatRoomData.java 第 217 行定义.


该类的文档由以下文件生成: