AddParticipantOptions 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.AddParticipantOptions

public final class AddParticipantOptions

The options for adding participants.

Constructor Summary

Constructor	Description
AddParticipantOptions(CallInvite targetParticipant)	Constructor

Method Summary

Modifier and Type	Method and Description
Duration	getInvitationTimeout() Get the invitationTimeoutInSeconds.
String	getOperationCallbackUrl() Get the overridden call back URL override for operation.
String	getOperationContext() Get the operationContext.
CallInvite	getTargetParticipant() Get Information for participant to add
AddParticipantOptions	setInvitationTimeout(Duration invitationTimeout) Set the invitationTimeoutInSeconds.
AddParticipantOptions	setOperationCallbackUrl(String operationCallbackUrl) Set a callback URI that overrides the default callback URI set by CreateCall/AnswerCall for this operation.
AddParticipantOptions	setOperationContext(String operationContext) Set the operationContext.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

AddParticipantOptions

public AddParticipantOptions(CallInvite targetParticipant)

Constructor

Parameters:

targetParticipant - target callinvite

Method Details

getInvitationTimeout

public Duration getInvitationTimeout()

Get the invitationTimeoutInSeconds.

Returns:

the Invitation Timeout In Seconds

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

getTargetParticipant

public CallInvite getTargetParticipant()

Get Information for participant to add

Returns:

target callInvite

setInvitationTimeout

public AddParticipantOptions setInvitationTimeout(Duration invitationTimeout)

Set the invitationTimeoutInSeconds.

Parameters:

invitationTimeout - Set the timeout to wait for the invited participant to pickup. The maximum value of this is 180 seconds.

Returns:

the AddParticipantOptions object itself.

setOperationCallbackUrl

public AddParticipantOptions 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 AddParticipantOptions object itself.

setOperationContext

public AddParticipantOptions setOperationContext(String operationContext)

Set the operationContext.

Parameters:

operationContext - the operationContext to set

Returns:

the AddParticipantOptions object itself.