blob: 82fac370ac7017297552363e3724fc2c4da88ca5 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
|
/*
* Jitsi, the OpenSource Java VoIP and Instant Messaging client.
*
* Distributable under LGPL license.
* See terms of license at gnu.org.
*/
package net.java.sip.communicator.service.protocol;
/**
* This interface represents chat room participants. Instances are retrieved
* through implementations of the <tt>ChatRoom</tt> interface and offer methods
* that allow querying member properties, such as, moderation permissions,
* associated chat room and other.
*
* @author Emil Ivov
* @author Boris Grozev
*/
public interface ChatRoomMember
{
/**
* Returns the chat room that this member is participating in.
*
* @return the <tt>ChatRoom</tt> instance that this member belongs to.
*/
public ChatRoom getChatRoom();
/**
* Returns the protocol provider instance that this member has originated
* in.
*
* @return the <tt>ProtocolProviderService</tt> instance that created this
* member and its containing cht room
*/
public ProtocolProviderService getProtocolProvider();
/**
* 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.
*
* @return a String (contact address), uniquely representing the contact
* over the service the service being used by the associated protocol
* provider instance/
*/
public String getContactAddress();
/**
* 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.
*
* @return the name of this member as it is known in the containing chat
* room (aka a nickname).
*/
public String getName();
/**
* Returns the avatar of this member, that can be used when including it in
* user interface.
*
* @return an avatar (e.g. user photo) of this member.
*/
public byte[] getAvatar();
/**
* 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.
*
* @return the protocol contact corresponding to this member in our contact
* list.
*/
public Contact getContact();
/**
* Returns the role of this chat room member in its containing room.
*
* @return a <tt>ChatRoomMemberRole</tt> instance indicating the role
* the this member in its containing chat room.
*/
public ChatRoomMemberRole getRole();
/**
* Sets the role of this chat room member in its containing room.
*
* @param role <tt>ChatRoomMemberRole</tt> instance indicating the role
* to set for this member in its containing chat room.
*/
public void setRole(ChatRoomMemberRole role);
}
|
