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

All Known Implementing Classes:

WhiteboardInvitationJabberImpl

public interface WhiteboardInvitation

This interface represents an invitation, which is send from a whiteboard participant to another user in order to invite this user to join the whiteboard.

Author:

Yana Stamcheva

Method Summary

String	getInviter() Returns the WhiteboardParticipant that sent this invitation.
String	getReason() Returns the reason of this invitation, or null if there is no reason specified.
WhiteboardSession	getTargetWhiteboard() Returns the WhiteboardSession, which is the target of this invitation.
byte[]	getWhiteboardPassword() Returns the password to use when joining the whiteboard.

Method Detail

getTargetWhiteboard

WhiteboardSession getTargetWhiteboard()

Returns the WhiteboardSession, which is the target of this invitation. The whiteboard returned by this method will be the one to which the user is invited to join to.

Returns:

the WhiteboardSession, which is the target of this invitation

getWhiteboardPassword

byte[] getWhiteboardPassword()

Returns the password to use when joining the whiteboard.

Returns:

the password to use when joining the whiteboard

getInviter

String getInviter()

Returns the WhiteboardParticipant that sent this invitation.

Returns:

the WhiteboardParticipant that sent this invitation.

getReason

String getReason()

Returns the reason of this invitation, or null if there is no reason specified.

Returns:

the reason of this invitation, or null if there is no reason specified