com.netease.nimlib.sdk.chatroom.model

Class ChatRoomMember

java.lang.Object

com.netease.nimlib.sdk.chatroom.model.ChatRoomMember

All Implemented Interfaces:

java.io.Serializable

public class ChatRoomMember
extends java.lang.Object
implements java.io.Serializable

Chat room members info

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static <any>	CREATOR

Constructor Summary

Constructors

Modifier	Constructor and Description
	ChatRoomMember()
protected	ChatRoomMember(Parcel in) ********************************** Serialization **********************************

Method Summary

Modifier and Type	Method and Description
int	describeContents()
java.lang.String	getAccount() Get a member account
java.lang.String	getAvatar() get the avatar You can get the avatar from NimUserInfo or submitted by users when joining a chat room
long	getEnterTime() Get the time joining a chat room The field is empty for offline members
java.util.Map<java.lang.String,java.lang.Object>	getExtension() Get the extension field The extension field can contain 4000 characters and is submitted by users when joining a chat room
int	getMemberLevel() Get the member level If the value is greater than or equal to 0, developers can define custom member levels.
MemberType	getMemberType() Get the member types Member types: guest or non guest Non guests include restricted members, members, owner, and administrators.
java.lang.String	getNick() Get the nickname Get the nickname from NimUserInfo or submitted by users when joining a chat room
java.lang.String	getNotifyTargetTags() Query the tags of notification recipients
java.lang.String	getRoomId() Get the chat room ID
java.lang.String	getTags() Get user tags
long	getTempMuteDuration() Get the duration for being temporarily muted in seconds
long	getUpdateTime() Get the record update time for members, used for querying the member list
boolean	isInBlackList() Check if a member is included in a blacklist
boolean	isMuted() Check if a member is muted
boolean	isOnline() Check if a member is online Only special members may be offline, and guests or anonymous users must be online.
boolean	isTempMuted() Check if a member is temporarily muted
boolean	isValid() Check if a setting is valid
void	setAccount(java.lang.String account) Set a user account
void	setAvatar(java.lang.String avatar) Set the avatar of a member
void	setEnterTime(long enterTime) Set the time joining a chat room
void	setExtension(java.util.Map<java.lang.String,java.lang.Object> extension) Set the extension field
void	setInBlackList(boolean inBlackList) Add a member to a blacklist
void	setMemberLevel(int memberLevel) Set the member level
void	setMemberType(MemberType type) Set a member type
void	setMuted(boolean muted) Mute a member
void	setNick(java.lang.String nick) Set the nickname of a member
void	setNotifyTargetTags(java.lang.String notifyTargetTags) Set tags for notification recipients
void	setOnline(boolean online) Set the online status
void	setRoomId(java.lang.String roomId) Set a chat room ID
void	setTags(java.lang.String tags) Set user tags
void	setTempMuted(boolean tempMuted) Temporarily mute a member
void	setTempMuteDuration(long tempMuteDuration) Set the duration for temp mute To mute a member temporarily, see ChatRoomService.markChatRoomTempMute(boolean, long, MemberOption)
void	setUpdateTime(long updateTime) Set the update time of members
void	setValid(boolean valid) Set a valid setting
void	writeToParcel(Parcel dest, int flags)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CREATOR

public static final <any> CREATOR

Constructor Detail

ChatRoomMember

public ChatRoomMember()

ChatRoomMember

protected ChatRoomMember(Parcel in)

********************************** Serialization **********************************

Method Detail

getRoomId

public java.lang.String getRoomId()

Get the chat room ID

Returns:

chat room ID

getAccount

public java.lang.String getAccount()

Get a member account

Returns:

member account

getMemberType

public MemberType getMemberType()

Get the member types Member types: guest or non guest Non guests include restricted members, members, owner, and administrators.

Returns:

member type

getMemberLevel

public int getMemberLevel()

Get the member level If the value is greater than or equal to 0, developers can define custom member levels.

Returns:

member level

getNick

public java.lang.String getNick()

Get the nickname Get the nickname from NimUserInfo or submitted by users when joining a chat room

Returns:

nickname

getAvatar

public java.lang.String getAvatar()

get the avatar You can get the avatar from NimUserInfo or submitted by users when joining a chat room

Returns:

avatar

getExtension

public java.util.Map<java.lang.String,java.lang.Object> getExtension()

Get the extension field The extension field can contain 4000 characters and is submitted by users when joining a chat room

Returns:

extension field

getEnterTime

public long getEnterTime()

Get the time joining a chat room The field is empty for offline members

Returns:

time joining a chat room

isOnline

public boolean isOnline()

Check if a member is online Only special members may be offline, and guests or anonymous users must be online.

Returns:

result

isInBlackList

public boolean isInBlackList()

Check if a member is included in a blacklist

Returns:

result

isMuted

public boolean isMuted()

Check if a member is muted

Returns:

result

isValid

public boolean isValid()

Check if a setting is valid

Returns:

the result of the operation.

setRoomId

public void setRoomId(java.lang.String roomId)

Set a chat room ID

Parameters:

roomId - The ID of a chat room

setAccount

public void setAccount(java.lang.String account)

Set a user account

Parameters:

account - User account

setMemberType

public void setMemberType(MemberType type)

Set a member type

Parameters:

type - member type

setMemberLevel

public void setMemberLevel(int memberLevel)

Set the member level

Parameters:

memberLevel - member level

setNick

public void setNick(java.lang.String nick)

Set the nickname of a member

Parameters:

nick - nickname

setAvatar

public void setAvatar(java.lang.String avatar)

Set the avatar of a member

Parameters:

avatar - avatar

setExtension

public void setExtension(java.util.Map<java.lang.String,java.lang.Object> extension)

Set the extension field

Parameters:

extension - extension field

setOnline

public void setOnline(boolean online)

Set the online status

Parameters:

online - online status

setEnterTime

public void setEnterTime(long enterTime)

Set the time joining a chat room

Parameters:

enterTime - time when a member join a chat room

setInBlackList

public void setInBlackList(boolean inBlackList)

Add a member to a blacklist

Parameters:

inBlackList - Add a member to a blacklist

setMuted

public void setMuted(boolean muted)

Mute a member

Parameters:

muted - Mute or unmute a member

setValid

public void setValid(boolean valid)

Set a valid setting

Parameters:

valid - valid setting

getUpdateTime

public long getUpdateTime()

Get the record update time for members, used for querying the member list

Returns:

the update time

setUpdateTime

public void setUpdateTime(long updateTime)

Set the update time of members

Parameters:

updateTime - update time

isTempMuted

public boolean isTempMuted()

Check if a member is temporarily muted

Returns:

result

setTempMuted

public void setTempMuted(boolean tempMuted)

Temporarily mute a member

Parameters:

tempMuted - mute or unmute a member temporarily

getTempMuteDuration

public long getTempMuteDuration()

Get the duration for being temporarily muted in seconds

Returns:

duration in seconds

setTempMuteDuration

public void setTempMuteDuration(long tempMuteDuration)

Set the duration for temp mute To mute a member temporarily, see ChatRoomService.markChatRoomTempMute(boolean, long, MemberOption)

Parameters:

tempMuteDuration - Duration for temp mute in seconds

getTags

public java.lang.String getTags()

Get user tags

setTags

public void setTags(java.lang.String tags)

Set user tags

getNotifyTargetTags

public java.lang.String getNotifyTargetTags()

Query the tags of notification recipients

setNotifyTargetTags

public void setNotifyTargetTags(java.lang.String notifyTargetTags)

Set tags for notification recipients

describeContents

public int describeContents()

writeToParcel

public void writeToParcel(Parcel dest,
                          int flags)