public interface OperationSetMultiUserChat extends OperationSet
Modifier and Type | Method and Description |
---|---|
void |
addInvitationListener(ChatRoomInvitationListener listener)
Adds a listener to invitation notifications.
|
void |
addInvitationRejectionListener(ChatRoomInvitationRejectionListener listener)
Adds a listener to invitation notifications.
|
void |
addPresenceListener(LocalUserChatRoomPresenceListener listener)
Adds a listener that will be notified of changes in our participation in
a chat room such as us being kicked, joined, left.
|
ChatRoom |
createChatRoom(java.lang.String roomName,
java.util.Map<java.lang.String,java.lang.Object> roomProperties)
Creates a room with the named roomName and according to the
specified roomProperties on the server that this protocol
provider is currently connected to.
|
ChatRoom |
findRoom(java.lang.String roomName)
Returns a reference to a chatRoom named roomName or null
if no room with the given name exist on the server.
|
java.util.List<ChatRoom> |
getCurrentlyJoinedChatRooms()
Returns a list of the chat rooms that we have joined and are currently
active in.
|
java.util.List<java.lang.String> |
getCurrentlyJoinedChatRooms(ChatRoomMember chatRoomMember)
Returns a list of the chat rooms that chatRoomMember has joined
and is currently active in.
|
java.util.List<java.lang.String> |
getExistingChatRooms()
Returns the List of Strings indicating chat rooms
currently available on the server that this protocol provider is
connected to.
|
boolean |
isMultiChatSupportedByContact(Contact contact)
Returns true if contact supports multi-user chat sessions.
|
boolean |
isPrivateMessagingContact(java.lang.String contactAddress)
Checks if the contact address is associated with private messaging
contact or not.
|
void |
rejectInvitation(ChatRoomInvitation invitation,
java.lang.String rejectReason)
Informs the sender of an invitation that we decline their invitation.
|
void |
removeInvitationListener(ChatRoomInvitationListener listener)
Removes listener from the list of invitation listeners
registered to receive invitation events.
|
void |
removeInvitationRejectionListener(ChatRoomInvitationRejectionListener listener)
Removes the given listener from the list of invitation listeners
registered to receive events every time an invitation has been rejected.
|
void |
removePresenceListener(LocalUserChatRoomPresenceListener 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<java.lang.String> getExistingChatRooms() throws OperationFailedException, OperationNotSupportedException
OperationFailedException
- if we failed retrieving this list from
the server.OperationNotSupportedException
- if the server does not support
multi-user chatjava.util.List<ChatRoom> getCurrentlyJoinedChatRooms()
java.util.List<java.lang.String> getCurrentlyJoinedChatRooms(ChatRoomMember chatRoomMember) throws OperationFailedException, OperationNotSupportedException
chatRoomMember
- the chatRoomMember whose current ChatRooms we will
be querying.OperationFailedException
- if an error occurs while trying to
discover the room on the server.OperationNotSupportedException
- if the server does not support
multi-user chatChatRoom createChatRoom(java.lang.String roomName, java.util.Map<java.lang.String,java.lang.Object> roomProperties) throws OperationFailedException, OperationNotSupportedException
roomName
- the name of the ChatRoom to create.roomProperties
- properties specifying how the room should be created;
null for no properties just like an empty
Map
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 serverChatRoom findRoom(java.lang.String roomName) throws OperationFailedException, OperationNotSupportedException
roomName
- the name of the ChatRoom that we're looking for.OperationFailedException
- if an error occurs while trying to
discover the room on the server.OperationNotSupportedException
- if the server does not support
multi-user chatvoid rejectInvitation(ChatRoomInvitation invitation, java.lang.String rejectReason)
invitation
- the invitation we are rejecting.rejectReason
- the reason to reject the invitation (optional)void addInvitationListener(ChatRoomInvitationListener listener)
listener
- an invitation listener.void removeInvitationListener(ChatRoomInvitationListener listener)
listener
- the invitation listener to remove.void addInvitationRejectionListener(ChatRoomInvitationRejectionListener listener)
listener
- an invitation listener.void removeInvitationRejectionListener(ChatRoomInvitationRejectionListener listener)
listener
- the invitation listener to remove.boolean isMultiChatSupportedByContact(Contact contact)
contact
- reference to the contact whose support for chat rooms
we are currently querying.boolean isPrivateMessagingContact(java.lang.String contactAddress)
void addPresenceListener(LocalUserChatRoomPresenceListener listener)
listener
- a local user participation listener.void removePresenceListener(LocalUserChatRoomPresenceListener listener)
listener
- a local user participation listener.
Jitsi, the OpenSource Java VoIP and Instant Messaging client.
Distributable under Apache license.