/*
* Jitsi, the OpenSource Java VoIP and Instant Messaging client.
*
* Copyright @ 2015 Atlassian Pty Ltd
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package net.java.sip.communicator.service.protocol;
import org.jivesoftware.smack.packet.*;
/**
* The operation set provides functionality specific to Jitsi Meet WebRTC
* conference and is currently used in the SIP gateway.
*
* @author Pawel Domas
*/
public interface OperationSetJitsiMeetTools
extends OperationSet
{
/**
* Adds given feature to communication protocol capabilities list of parent
* {@link ProtocolProviderService}.
*
* @param featureName feature name to be added to the capabilities list.
*/
public void addSupportedFeature(String featureName);
/**
* Removes given feature from communication protocol capabilities list of
* parent {@link ProtocolProviderService}.
*
* @param featureName feature name to be removed from the capabilities list.
*/
public void removeSupportedFeature(String featureName);
/**
* Includes given PacketExtension in multi user chat presence and
* sends presence update packet to the chat room.
* @param chatRoom the ChatRoom for which the presence will be
* updated.
* @param extension the PacketExtension to be included in MUC
* presence.
*/
public void sendPresenceExtension(ChatRoom chatRoom,
PacketExtension extension);
/**
* Removes given PacketExtension from the multi user chat presence
* and sends presence update packet to the chat room.
* @param chatRoom the ChatRoom for which the presence will be
* updated.
* @param extension the PacketExtension to be removed from the MUC
* presence.
*/
public void removePresenceExtension(ChatRoom chatRoom,
PacketExtension extension);
/**
* Sets the status message of our MUC presence and sends presence status
* update packet to the server.
* @param chatRoom the ChatRoom for which the presence status
* message will be changed.
* @param statusMessage the text that will be used as our presence status
* message in the MUC.
*/
public void setPresenceStatus(ChatRoom chatRoom, String statusMessage);
/**
* Adds given listener to the list of
* {@link JitsiMeetRequestListener}s.
* @param listener the {@link JitsiMeetRequestListener} to be notified about
* future events.
*/
public void addRequestListener(JitsiMeetRequestListener listener);
/**
* Removes given listener from the list of
* {@link JitsiMeetRequestListener}s.
* @param listener the {@link JitsiMeetRequestListener} that will be no
* longer notified about Jitsi Meet events.
*/
public void removeRequestListener(JitsiMeetRequestListener listener);
/**
* Interface used to handle Jitsi Meet conference requests.
*/
interface JitsiMeetRequestListener
{
/**
* Events is fired for an incoming call that contains information about
* Jitsi Meet conference room to be joined.
* @param call the incoming {@link Call} instance.
* @param jitsiMeetRoom the name of multi user chat room that is hosting
* Jitsi Meet conference.
* @param jitsiMeetRoomPass optional password required to join conference
* room(if it is protected)
*/
void onJoinJitsiMeetRequest(
Call call, String jitsiMeetRoom, String jitsiMeetRoomPass);
}
}