public interface WhiteboardSession
Modifier and Type | Method and Description |
---|---|
void |
addWhiteboardChangeListener(WhiteboardChangeListener listener)
Adds a whiteboard change listener to this whiteboard so that it could
receive events on new whiteboard participants, theme changes and others.
|
void |
addWhiteboardObjectListener(WhiteboardObjectListener listener)
Registers listener so that it would receive events every time a
new WhiteboardObject is received on this whiteboard.
|
void |
addWhiteboardParticipant(WhiteboardParticipant wbParticipant)
Adds wbParticipant to the list of participants
in this whiteboard.
|
WhiteboardObject |
createWhiteboardObject(java.lang.String name)
Create a WhiteboardObject instance with the specified type.
|
void |
deleteWhiteboardObject(WhiteboardObject obj)
Sends a WhiteboardObject to delete
and delete the local WhiteboardObject
|
ProtocolProviderService |
getProtocolProvider()
Returns a reference to the ProtocolProviderService instance
that created this whiteboard.
|
WhiteboardSessionState |
getState()
Returns the state that this whiteboard is currently in.
|
java.lang.String[] |
getSupportedWhiteboardObjects()
Returns all the type of WhiteboardObject that this whiteboard support.
|
java.lang.String |
getWhiteboardID()
Returns the id of the specified Whiteboard.
|
java.util.Vector<WhiteboardObject> |
getWhiteboardObjects()
Returns the WhiteboardObjects in this whiteboard session.
|
java.util.Iterator<WhiteboardParticipant> |
getWhiteboardParticipants()
Returns an iterator over all whiteboard participants.
|
int |
getWhiteboardParticipantsCount()
Returns the number of participants currently associated
with this whiteboard session.
|
void |
invite(java.lang.String userAddress)
Invites another user to this room.
|
boolean |
isJoined()
Returns true if the local user is currently in the whiteboard session
(after whiteboarding one of the
join() methods). |
void |
join()
Joins this whiteboard with the nickname of the local user so that the
user would start receiving events and WhiteboardObject for it.
|
void |
join(byte[] password)
Joins this whiteboard so that the user would start receiving events and
WhiteboardObject for it.
|
void |
leave()
Leave this whiteboard.
|
void |
moveWhiteboardObject(WhiteboardObject obj)
Sends a WhiteboardObject to modify
and modifies the local WhiteboardObject
|
void |
removeWhiteboardChangeListener(WhiteboardChangeListener listener)
Removes listener to this whiteboard so that it won't receive
further WhiteboardChangeEvents.
|
void |
removeWhiteboardObjectListener(WhiteboardObjectListener listener)
Removes listener so that it won't receive
any further WhiteboardObject events from this room.
|
void |
removeWhiteboardParticipant(WhiteboardParticipant wbParticipant)
Removes whiteboardParticipant from the list of participants in
this whiteboard.
|
void |
sendWhiteboardObject(WhiteboardObject obj)
Resolves obj with the other session participants.
|
void |
setState(WhiteboardSessionState newState)
Sets the state of this whiteboard
|
java.lang.String getWhiteboardID()
java.util.Iterator<WhiteboardParticipant> getWhiteboardParticipants()
int getWhiteboardParticipantsCount()
void addWhiteboardChangeListener(WhiteboardChangeListener listener)
listener
- the listener to registervoid removeWhiteboardChangeListener(WhiteboardChangeListener listener)
listener
- the listener to registerProtocolProviderService getProtocolProvider()
void join() throws OperationFailedException
OperationFailedException
- with the corresponding code if an error
occurs while joining the room.void join(byte[] password) throws OperationFailedException
password
- the password to use when authenticating on the whiteboard
session.OperationFailedException
- with the corresponding code if an error
occurs while joining the room.boolean isJoined()
join()
methods).void leave()
void invite(java.lang.String userAddress)
If the room is password-protected, the invitee will receive a password to use to join the room. If the room is members-only, the the invitee may be added to the member list.
userAddress
- the address of the user to invite to the room.
(one may also invite users not on their contact list).void addWhiteboardObjectListener(WhiteboardObjectListener listener)
listener
- a WhiteboardObjectListener that would be
notified every time a new WhiteboardObject
is received on this whiteboard.void removeWhiteboardObjectListener(WhiteboardObjectListener listener)
listener
- the WhiteboardObjectListener
to remove from this roomWhiteboardObject createWhiteboardObject(java.lang.String name)
name
- the name of the object to create (should be one of the
+ * WhiteboardObjectXXX.NAME fields).void sendWhiteboardObject(WhiteboardObject obj) throws OperationFailedException
obj
- the WhiteboardObject to send.OperationFailedException
- if sending the WhiteboardObject fails
for some reason.void moveWhiteboardObject(WhiteboardObject obj) throws OperationFailedException
obj
- the WhiteboardObject to send and modifyOperationFailedException
- if sending
the WhiteboardObject fails for some reason.void deleteWhiteboardObject(WhiteboardObject obj) throws OperationFailedException
obj
- the WhiteboardObject to send and deleteOperationFailedException
- if sending
the WhiteboardObject fails for some reason.void addWhiteboardParticipant(WhiteboardParticipant wbParticipant)
wbParticipant
- the new WhiteboardParticipantvoid removeWhiteboardParticipant(WhiteboardParticipant wbParticipant)
wbParticipant
- the WhiteboardParticipant leaving the
whiteboard;java.util.Vector<WhiteboardObject> getWhiteboardObjects()
void setState(WhiteboardSessionState newState)
newState
- a reference to the WhiteboardState instance that
the whiteboard is to enter.WhiteboardSessionState getState()
java.lang.String[] getSupportedWhiteboardObjects()
Jitsi, the OpenSource Java VoIP and Instant Messaging client.
Distributable under Apache license.