public interface OperationSetWhiteboarding extends OperationSet
Modifier and Type | Method and Description |
---|---|
void |
addInvitationListener(WhiteboardInvitationListener listener)
Adds a listener to invitation notifications.
|
void |
addInvitationRejectionListener(WhiteboardInvitationRejectionListener listener)
Adds a listener to invitation notifications.
|
void |
addPresenceListener(WhiteboardSessionPresenceListener listener)
Adds a listener that will be notified of changes in our participation in
a white-board session such as us being joined, left, dropped.
|
WhiteboardSession |
createWhiteboardSession(java.lang.String sessionName,
java.util.Hashtable<java.lang.Object,java.lang.Object> sessionProperties)
Creates a WhiteboardSession with the name sessionName
and according to the specified sessionProperties.
|
WhiteboardSession |
findWhiteboardSession(java.lang.String sessionName)
Returns a reference to a WhiteboardSession named
sessionName or null if no such session exists.
|
java.util.List<WhiteboardSession> |
getCurrentlyJoinedWhiteboards()
Returns a list of the WhiteboardSessions that we have joined and
are currently active in.
|
java.util.List<WhiteboardSession> |
getCurrentlyJoinedWhiteboards(WhiteboardParticipant participant)
Returns a list of the WhiteboardSessions that
WhiteboardParticipant has joined and is currently active in.
|
boolean |
isWhiteboardingSupportedByContact(Contact contact)
Returns true if contact supports white-board sessions.
|
void |
rejectInvitation(WhiteboardInvitation invitation,
java.lang.String rejectReason)
Informs the sender of an invitation that we decline their invitation.
|
void |
removeInvitationListener(WhiteboardInvitationListener listener)
Removes listener from the list of invitation listeners
registered to receive invitation events.
|
void |
removeInvitationRejectionListener(WhiteboardInvitationRejectionListener listener)
Removes the given listener from the list of invitation listeners
registered to receive events every time an invitation has been rejected.
|
void |
removePresenceListener(WhiteboardSessionPresenceListener listener)
Removes a listener that was being notified of changes in our
participation in a room such as us being kicked, joined, left.
|
java.util.List<WhiteboardSession> getCurrentlyJoinedWhiteboards()
java.util.List<WhiteboardSession> getCurrentlyJoinedWhiteboards(WhiteboardParticipant participant) throws OperationFailedException, OperationNotSupportedException
participant
- the participant whose current
WhiteboardSessions we will be querying.OperationFailedException
- if an error occurs while trying to
discover the session.OperationNotSupportedException
- if the server does not support
white-boardingWhiteboardSession createWhiteboardSession(java.lang.String sessionName, java.util.Hashtable<java.lang.Object,java.lang.Object> sessionProperties) throws OperationFailedException, OperationNotSupportedException
sessionName
- the name of the WhiteboardSession to create.sessionProperties
- properties specifying how the session should be
created.OperationFailedException
- if the room couldn't be created for some
reason (e.g. room already exists; user already joined to an existent
room or user has no permissions to create a chat room).OperationNotSupportedException
- if chat room creation is not
supported by this serverWhiteboardSession findWhiteboardSession(java.lang.String sessionName) throws OperationFailedException, OperationNotSupportedException
sessionName
- the name of the WhiteboardSession that we're
looking for.OperationFailedException
- if an error occurs while trying to
discover the white-board session on the server.OperationNotSupportedException
- if the server does not support
white-boardingvoid rejectInvitation(WhiteboardInvitation invitation, java.lang.String rejectReason)
invitation
- the invitation we are rejecting.rejectReason
- the reason to reject the invitation (optional)void addInvitationListener(WhiteboardInvitationListener listener)
listener
- an invitation listener.void removeInvitationListener(WhiteboardInvitationListener listener)
listener
- the invitation listener to remove.void addInvitationRejectionListener(WhiteboardInvitationRejectionListener listener)
listener
- an invitation listener.void removeInvitationRejectionListener(WhiteboardInvitationRejectionListener listener)
listener
- the invitation listener to remove.boolean isWhiteboardingSupportedByContact(Contact contact)
contact
- reference to the contact whose support for white-boards
we are currently querying.void addPresenceListener(WhiteboardSessionPresenceListener listener)
listener
- a local user participation listener.void removePresenceListener(WhiteboardSessionPresenceListener listener)
listener
- a local user participation listener.
Jitsi, the OpenSource Java VoIP and Instant Messaging client.
Distributable under Apache license.