Package com.azure.android.communication.calling

Class CallAgentOptions

Object

CommonCallAgentOptions

CallAgentOptions

public final class CallAgentOptions
extends CommonCallAgentOptions

Options for creating CallAgent

Constructor Summary

Constructors

Constructor	Description
CallAgentOptions()	Creates a new instance with a default options

Method Summary

Modifier and Type	Method	Description
String	getDisplayName()	Specify the display name of the local participant for all new calls
EmergencyCallOptions	getEmergencyCallOptions()	Emergency call options when creating a call agent
Integer	getPushNotificationTtlInSeconds()	Get push notification time-to-live value.
CallAgentOptions	setDisableInternalPushForIncomingCall(boolean value)	Determines whether to disable the internal push mechanism for delivering the push payload of an incoming call.
CallAgentOptions	setDisplayName(String value)	Specify the display name of the local participant for all new calls
CallAgentOptions	setEmergencyCallOptions(EmergencyCallOptions value)	Emergency call options when creating a call agent
CallAgentOptions	setPushNotificationTtlInSeconds(Integer value)	Sets time-to-live value for push notification.
CallAgentOptions	setTelecomManagerOptions(TelecomManagerOptions value)	TelecomManager options

Methods inherited from class CommonCallAgentOptions

finalize, getTelecomManagerOptions, isDisableInternalPushForIncomingCall

Methods inherited from class Object

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

Constructor Detail

CallAgentOptions

public CallAgentOptions()

Creates a new instance with a default options

Method Detail

getDisplayName

public String getDisplayName()

Specify the display name of the local participant for all new calls

setDisplayName

public CallAgentOptions setDisplayName(String value)

Specify the display name of the local participant for all new calls

Parameters:

value - The new value.

getEmergencyCallOptions

public EmergencyCallOptions getEmergencyCallOptions()

Emergency call options when creating a call agent

setEmergencyCallOptions

public CallAgentOptions setEmergencyCallOptions(EmergencyCallOptions value)

Emergency call options when creating a call agent

Parameters:

value - The new value.

setDisableInternalPushForIncomingCall

public CallAgentOptions setDisableInternalPushForIncomingCall(boolean value)

Determines whether to disable the internal push mechanism for delivering the push payload of an incoming call. There are two ways that a push payload of an incoming call can be delivered to the callee: 1. By using Firebase Cloud Messaging (FCM) and registering the device token with the API `registerPushNotification` method on `CallAgent` or `TeamsCallAgent`. 2. When a `CallAgent` or `TeamsCallAgent` is created, the SDK also internally registers with our internal push service to receive the push payload. By default, the internal push is enabled. To exclusively use FCM and disable the internal push, set this parameter to `true`.

Overrides:

setDisableInternalPushForIncomingCall in class CommonCallAgentOptions

Parameters:

value - The new value.

setTelecomManagerOptions

public CallAgentOptions setTelecomManagerOptions(TelecomManagerOptions value)

TelecomManager options

Overrides:

setTelecomManagerOptions in class CommonCallAgentOptions

Parameters:

value - The new value.

getPushNotificationTtlInSeconds

public Integer getPushNotificationTtlInSeconds()

Get push notification time-to-live value.

Returns:

The time-to-live (TTL) value in seconds.

setPushNotificationTtlInSeconds

public CallAgentOptions setPushNotificationTtlInSeconds(Integer value)

Sets time-to-live value for push notification.

Parameters:

value - Time-to-live in seconds.

Returns:

The resulting TeamsCall object.