Package com.azure.android.communication.calling

Class CallAgent

Object

CommonCallAgent

CallAgent

public final class CallAgent
extends CommonCallAgent

Call agent created by the CallClient factory method createCallAgent It bears the responsibility of managing calls on behalf of the authenticated user

Method Summary

Modifier and Type	Method	Description
void	addOnCallsUpdatedListener(CallsUpdatedListener listener)	Adds the specified listener to receive OnCallsUpdated events.
void	addOnIncomingCallListener(IncomingCallListener listener)	Adds the specified listener to receive OnIncomingCall events.
List<Call>	getCalls()	Returns the list of all active calls.
Call	join(Context context, JoinMeetingLocator meetingLocator, JoinCallOptions joinCallOptions)	Join an existing group conversation with the ability to specify call options for the participant joining.
void	removeOnCallsUpdatedListener(CallsUpdatedListener listener)	Removes the specified listener to receive OnCallsUpdated events.
void	removeOnIncomingCallListener(IncomingCallListener listener)	Removes the specified listener to receive OnIncomingCall events.
Call	startCall(Context context, Iterable<CommunicationIdentifier> participants)	Initiates outgoing call with list of participants with default call options (audio on, video off).
Call	startCall(Context context, Iterable<CommunicationIdentifier> participants, StartCallOptions startCallOptions)	Initiates outgoing call with list of participants with the ability to specify call initiator options.

Methods inherited from class CommonCallAgent

dispose, finalize, getType, handlePushNotification, registerPushNotification, unregisterPushNotification

Methods inherited from class Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getCalls

public List<Call> getCalls()

Returns the list of all active calls.

addOnCallsUpdatedListener

public void addOnCallsUpdatedListener(CallsUpdatedListener listener)

Adds the specified listener to receive OnCallsUpdated events. CallsUpdated event. Occurs when a new call is created, in case of an incoming call or when an existing call is disconnected.

removeOnCallsUpdatedListener

public void removeOnCallsUpdatedListener(CallsUpdatedListener listener)

Removes the specified listener to receive OnCallsUpdated events. CallsUpdated event. Occurs when a new call is created, in case of an incoming call or when an existing call is disconnected.

addOnIncomingCallListener

public void addOnIncomingCallListener(IncomingCallListener listener)

Adds the specified listener to receive OnIncomingCall events. onIncomingCall Event. Occurs when incoming call is recieved from PushNotification or Trouter.

removeOnIncomingCallListener

public void removeOnIncomingCallListener(IncomingCallListener listener)

Removes the specified listener to receive OnIncomingCall events. onIncomingCall Event. Occurs when incoming call is recieved from PushNotification or Trouter.

startCall

public Call startCall(Context context,
                      Iterable<CommunicationIdentifier> participants,
                      StartCallOptions startCallOptions)

Initiates outgoing call with list of participants with the ability to specify call initiator options.

Parameters:

context - Android application context object.

participants - an array containing identifier of participants to call.

startCallOptions - call options for the call initiator (video on/off, audio on/off).

Returns:

The resulting Call object.

startCall

public Call startCall(Context context,
                      Iterable<CommunicationIdentifier> participants)

Initiates outgoing call with list of participants with default call options (audio on, video off).

Parameters:

context - Android application context object.

participants - an array containing identifier of participants to call.

Returns:

The resulting Call object.

join

public Call join(Context context,
                 JoinMeetingLocator meetingLocator,
                 JoinCallOptions joinCallOptions)

Join an existing group conversation with the ability to specify call options for the participant joining.

Parameters:

context - Android application context object.

meetingLocator - information of the conversation to join.

joinCallOptions - call options for the participant joining the call (video on/off, audio on/off).

Returns:

The resulting Call object.