net.java.sip.communicator.service.protocol
Interface ChatRoomMember

All Known Implementing Classes:

ChatRoomMemberIrcImpl, ChatRoomMemberJabberImpl, MessageHistoryServiceImpl.ChatRoomMemberImpl, MockChatRoomMember

public interface ChatRoomMember

This interface represents chat room participants. Instances are retrieved through implementations of the ChatRoom interface and offer methods that allow querying member properties, such as, moderation permissions, associated chat room and other.

Author:

Emil Ivov

Method Summary

byte[]	getAvatar() Returns the avatar of this member, that can be used when including it in user interface.
ChatRoom	getChatRoom() Returns the chat room that this member is participating in.
Contact	getContact() Returns the protocol contact corresponding to this member in our contact list.
String	getContactAddress() Returns the contact identifier representing this contact.
String	getName() Returns the name of this member as it is known in its containing chatroom (aka a nickname).
ProtocolProviderService	getProtocolProvider() Returns the protocol provider instance that this member has originated in.
ChatRoomMemberRole	getRole() Returns the role of this chat room member in its containing room.
void	setRole(ChatRoomMemberRole role) Sets the role of this chat room member in its containing room.

Method Detail

getChatRoom

ChatRoom getChatRoom()

Returns the chat room that this member is participating in.

Returns:

the ChatRoom instance that this member belongs to.

getProtocolProvider

ProtocolProviderService getProtocolProvider()

Returns the protocol provider instance that this member has originated in.

Returns:

the ProtocolProviderService instance that created this member and its containing cht room

getContactAddress

String getContactAddress()

Returns the contact identifier representing this contact. In protocols like IRC this method would return the same as getName() but in others like Jabber, this method would return a full contact id uri.

Returns:

a String (contact address), uniquely representing the contact over the service the service being used by the associated protocol provider instance/

getName

String getName()

Returns the name of this member as it is known in its containing chatroom (aka a nickname). The name returned by this method, may sometimes match the string returned by getContactID() which is actually the address of a contact in the realm of the corresponding protocol.

Returns:

the name of this member as it is known in the containing chat room (aka a nickname).

getAvatar

byte[] getAvatar()

Returns the avatar of this member, that can be used when including it in user interface.

Returns:

an avatar (e.g. user photo) of this member.

getContact

Contact getContact()

Returns the protocol contact corresponding to this member in our contact list. The contact returned here could be used by the user interface to check if this member is contained in our contact list and in function of this to show additional information add additional functionality.

Returns:

the protocol contact corresponding to this member in our contact list.

getRole

ChatRoomMemberRole getRole()

Returns the role of this chat room member in its containing room.

Returns:

a ChatRoomMemberRole instance indicating the role the this member in its containing chat room.

setRole

void setRole(ChatRoomMemberRole role)

Sets the role of this chat room member in its containing room.

Parameters:

role - ChatRoomMemberRole instance indicating the role to set for this member in its containing chat room.