HoldOptions Class

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

public final class HoldOptions

Options for the Hold operation.

Constructor Summary

Constructor Description
HoldOptions(CommunicationIdentifier targetParticipant)

Create a new HoldOptions object.

Method Summary

Modifier and Type Method and Description
String getOperationCallbackUrl()

Get the operationCallbackUrl.

String getOperationContext()

Get the operation context.

PlaySource getPlaySource()

Get PlaySourceInfo

CommunicationIdentifier getTargetParticipant()

Get Participant to be put on hold.

HoldOptions setOperationCallbackUrl(String operationCallbackUrl)

Sets the operationCallbackUrl.

HoldOptions setOperationContext(String operationContext)

Sets the operation context.

HoldOptions setPlaySource(PlaySource playSource)

Sets the playSource.

Methods inherited from java.lang.Object

Constructor Details

HoldOptions

public HoldOptions(CommunicationIdentifier targetParticipant)

Create a new HoldOptions object.

Parameters:

targetParticipant - Participant to be put on hold.

Method Details

getOperationCallbackUrl

public String getOperationCallbackUrl()

Get the operationCallbackUrl.

Returns:

operationCallbackUrl.

getOperationContext

public String getOperationContext()

Get the operation context.

Returns:

operation context.

getPlaySource

public PlaySource getPlaySource()

Get PlaySourceInfo

Returns:

the playSourceInfo.

getTargetParticipant

public CommunicationIdentifier getTargetParticipant()

Get Participant to be put on hold.

Returns:

participant.

setOperationCallbackUrl

public HoldOptions setOperationCallbackUrl(String operationCallbackUrl)

Sets the operationCallbackUrl.

Parameters:

operationCallbackUrl - operationCallbackUrl

Returns:

The HoldOptions object.

setOperationContext

public HoldOptions setOperationContext(String operationContext)

Sets the operation context.

Parameters:

operationContext - Operation Context

Returns:

The HoldOptions object.

setPlaySource

public HoldOptions setPlaySource(PlaySource playSource)

Sets the playSource.

Parameters:

playSource - playSource

Returns:

The HoldOptions object.

Applies to