TransferCallToParticipantOptions Class

Package:

com.azure.communication.callautomation.models

Maven Artifact:

com.azure:azure-communication-callautomation:1.6.1

• java.lang.Object
• • com.azure.communication.callautomation.models.TransferCallToParticipantOptions

public final class TransferCallToParticipantOptions

The options for adding participants.

Constructor Summary

Constructor	Description
TransferCallToParticipantOptions(CommunicationIdentifier targetParticipant)	Constructor
TransferCallToParticipantOptions(CommunicationUserIdentifier targetParticipant)	Constructor
TransferCallToParticipantOptions(MicrosoftTeamsAppIdentifier targetParticipant)	Constructor
TransferCallToParticipantOptions(MicrosoftTeamsUserIdentifier targetParticipant)	Constructor
TransferCallToParticipantOptions(PhoneNumberIdentifier targetParticipant)	Constructor
TransferCallToParticipantOptions(TeamsExtensionUserIdentifier targetParticipant)	Constructor

Method Summary

Modifier and Type	Method and Description
CustomCallingContext	getCustomCallingContext() get custom context
String	getOperationCallbackUrl() Get the overridden call back URL override for operation.
String	getOperationContext() Get the operationContext.
PhoneNumberIdentifier	getSourceCallerIdNumber() Get the sourceCallerIdNumber.
CommunicationIdentifier	getTargetParticipant() Get the transfer target to whom the call is transferred
CommunicationIdentifier	getTransferee() Get the participant who is being transferred away.
TransferCallToParticipantOptions	setOperationCallbackUrl(String operationCallbackUrl) Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation.
TransferCallToParticipantOptions	setOperationContext(String operationContext) Set the operationContext.
TransferCallToParticipantOptions	setSourceCallerIdNumber(PhoneNumberIdentifier sourceCallerIdNumber) Set the sourceCallerIdNumber.
TransferCallToParticipantOptions	setTransferee(CommunicationIdentifier transferee) Set the participant who is being transferred away.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

TransferCallToParticipantOptions

public TransferCallToParticipantOptions(CommunicationIdentifier targetParticipant)

Constructor

Parameters:

targetParticipant - CommunicationIdentifier contains information for TransferTarget(to whom the call is transferred).

TransferCallToParticipantOptions

public TransferCallToParticipantOptions(CommunicationUserIdentifier targetParticipant)

Constructor

Parameters:

targetParticipant - CommunicationUserIdentifier contains information for TransferTarget(to whom the call is transferred).

TransferCallToParticipantOptions

public TransferCallToParticipantOptions(MicrosoftTeamsAppIdentifier targetParticipant)

Constructor

Parameters:

targetParticipant - MicrosoftTeamsAppIdentifier contains information for TransferTarget(to whom the call is transferred).

TransferCallToParticipantOptions

public TransferCallToParticipantOptions(MicrosoftTeamsUserIdentifier targetParticipant)

Constructor

Parameters:

targetParticipant - MicrosoftTeamsUserIdentifier contains information for TransferTarget(to whom the call is transferred).

TransferCallToParticipantOptions

public TransferCallToParticipantOptions(PhoneNumberIdentifier targetParticipant)

Constructor

Parameters:

targetParticipant - PhoneNumberIdentifier contains information for TransferTarget(to whom the call is transferred).

TransferCallToParticipantOptions

public TransferCallToParticipantOptions(TeamsExtensionUserIdentifier targetParticipant)

Constructor

Parameters:

targetParticipant - TeamsExtensionUserIdentifier contains information for TransferTarget(to whom the call is transferred).

Method Details

getCustomCallingContext

public CustomCallingContext getCustomCallingContext()

get custom context

Returns:

custom context

getOperationCallbackUrl

public String getOperationCallbackUrl()

Get the overridden call back URL override for operation.

Returns:

the operationCallbackUrl

getOperationContext

public String getOperationContext()

Get the operationContext.

Returns:

the operationContext

getSourceCallerIdNumber

public PhoneNumberIdentifier getSourceCallerIdNumber()

Get the sourceCallerIdNumber.

Returns:

the sourceCallerIdNumber

getTargetParticipant

public CommunicationIdentifier getTargetParticipant()

Get the transfer target to whom the call is transferred

Returns:

a CommunicationIdentifier with information to transfer target

getTransferee

public CommunicationIdentifier getTransferee()

Get the participant who is being transferred away.

Returns:

the transferee

setOperationCallbackUrl

public TransferCallToParticipantOptions setOperationCallbackUrl(String operationCallbackUrl)

Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation. This setup is per-action. If this is not set, the default callback URI set by CreateCall/AnswerCall will be used.

Parameters:

operationCallbackUrl - the operationCallbackUrl to set

Returns:

the TransferCallToParticipantOptions object itself.

setOperationContext

public TransferCallToParticipantOptions setOperationContext(String operationContext)

Set the operationContext.

Parameters:

operationContext - the operationContext to set

Returns:

the TransferCallToParticipantOptions object itself.

setSourceCallerIdNumber

public TransferCallToParticipantOptions setSourceCallerIdNumber(PhoneNumberIdentifier sourceCallerIdNumber)

Set the sourceCallerIdNumber.

Parameters:

sourceCallerIdNumber - the sourceCallerIdNumber to set

Returns:

the TransferCallToParticipantOptions object itself.

setTransferee

public TransferCallToParticipantOptions setTransferee(CommunicationIdentifier transferee)

Set the participant who is being transferred away.

Parameters:

transferee - the participant who is being transferred away

Returns:

the TransferCallToParticipantOptions object itself.