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

All Known Implementing Classes:

WhiteboardParticipantJabberImpl

public interface WhiteboardParticipant

The WhiteboardParticipant is an interface that represents participants in a whiteboard.

Author:

Julien Waechter, Emil Ivov

Method Summary

void	addWhiteboardParticipantListener(WhiteboardParticipantListener listener) Allows the user interface to register a listener interested in changes
String	getContactAddress() Returns the contact identifier representing this contact.
String	getName() Returns the name of this member
ProtocolProviderService	getProtocolProvider() Returns the protocol provider instance that this member has originated in.
WhiteboardParticipantState	getState() Returns an object representing the current state of that participant.
WhiteboardSession	getWhiteboardSession() Returns the chat room that this member is participating in.
void	removeWhiteboardParticipantListener(WhiteboardParticipantListener listener) Unregisters the specified listener.

Method Detail

getWhiteboardSession

WhiteboardSession getWhiteboardSession()

Returns the chat room that this member is participating in.

Returns:

the WhiteboardSession 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.

Returns:

a String contact address

getName

String getName()

Returns the name of this member

Returns:

the name of this member in the room (nickname).

getState

WhiteboardParticipantState getState()

Returns an object representing the current state of that participant. WhiteboardParticipantState may vary among CONNECTING, BUSY, CONNECTED...

Returns:

a WhiteboardParticipantState instance representin the participant's state.

addWhiteboardParticipantListener

void addWhiteboardParticipantListener(WhiteboardParticipantListener listener)

Allows the user interface to register a listener interested in changes

Parameters:

listener - a listener instance to register with this participant.

removeWhiteboardParticipantListener

void removeWhiteboardParticipantListener(WhiteboardParticipantListener listener)

Unregisters the specified listener.

Parameters:

listener - the listener to unregister.