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, String account, String token, boolean 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 第 14 行定义.

构造及析构函数说明

com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.EnterChatRoomData

(

String

roomId

)

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

成员函数说明

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

(

)

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

返回

账号，null表示匿名登录

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

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

(

)

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

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

(

)

获取聊天室appKey

返回

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

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

(

)

获取聊天室展示的头像

返回

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

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

(

)

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

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

(

)

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

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

(

)

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

返回

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

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

(

)

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

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

(

)

获取鉴权方式

返回

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

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

(

)

获取登录自定义字段

返回

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

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

(

)

获取聊天室展示的昵称

返回

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

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

(

)

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

返回

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

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

(

)

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

返回

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

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

(

)

获取聊天室id

返回

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

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

(

)

获取 登录标签

返回

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

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

(

)

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

返回

登录口令

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

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

(

)

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

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

(

)

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

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

(

)

是否是独立登录聊天室

返回

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

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

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

(

)

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

void com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.setAntiSpamConfig

(

AntiSpamConfig

antiSpamConfig

)

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

void com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.setAppKey

(

String

appKey

)

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

参数

appKey

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

void com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.setAvatar

(

String

avatar

)

设置聊天室展示的头像

参数

avatar

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

void com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.setChatRoomAuthProvider

(

ChatRoomAuthProvider

chatRoomAuthProvider

)

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

void com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.setChatRoomSpatialLocation

(

ChatRoomSpatialLocation

chatRoomSpatialLocation

)

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

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

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

void com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.setExtension

(

Map< String, Object >

extension

)

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

参数

extension

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

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

设置聊天室独立模式

参数

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

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

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 第 343 行定义.

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

protected

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

void com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.setLoginAuthType

(

Integer

loginAuthType

)

设置鉴权方式

参数

loginAuthType

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

void com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.setLoginExt

(

String

loginExt

)

设置登录自定义字段

参数

loginExt

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

void com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.setNick

(

String

nick

)

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

参数

nick

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

void com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.setNotifyExtension

(

Map< String, Object >

notifyExtension

)

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

参数

notifyExtension

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

void com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.setNotifyTargetTags

(

String

notifyTargetTags

)

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

参数

notifyTargetTags

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

void com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.setRoomId

(

String

roomId

)

设置聊天室id

参数

roomId

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

void com.netease.nimlib.sdk.chatroom.model.EnterChatRoomData.setTags

(

String

tags

)

设置 登录标签

参数

tags

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

---

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

• plugins/chatroom/src/com/netease/nimlib/sdk/chatroom/model/EnterChatRoomData.java