Share via

CallConnectionAsync Class

Package:
com.azure.communication.callautomation
Maven Artifact:
com.azure:azure-communication-callautomation:1.4.2
  • java.lang.Object
    • com.azure.communication.callautomation.CallConnectionAsync

public final class CallConnectionAsync

CallConnectionAsync for mid-call actions

Method Summary

Modifier and Type Method and Description
Mono<AddParticipantResult> addParticipant(CallInvite participant)

Add a participant to the call.
Mono<Response<AddParticipantResult>> addParticipantWithResponse(AddParticipantOptions addParticipantOptions)

Add a participant to the call.
Mono<CancelAddParticipantOperationResult> cancelAddParticipantOperation(String invitationId)

Cancel add participant operation request.
Mono<Response<CancelAddParticipantOperationResult>> cancelAddParticipantOperationWithResponse(CancelAddParticipantOperationOptions cancelAddParticipantOperationOptions)

Cancel add participant operation request.
CallMediaAsync getCallMediaAsync()

Returns an object of CallContentAsync
Mono<CallConnectionProperties> getCallProperties()

Get call connection properties.
Mono<Response<CallConnectionProperties>> getCallPropertiesWithResponse()

Get call connection properties.
Mono<CallParticipant> getParticipant(CommunicationIdentifier targetParticipant)

Get a specific participant.
Mono<Response<CallParticipant>> getParticipantWithResponse(CommunicationIdentifier targetParticipant)

Get a specific participant.
Mono<Void> hangUp(boolean isForEveryone)

Hangup a call.
Mono<Response<Void>> hangUpWithResponse(boolean isForEveryone)

Hangup a call.
PagedFlux<CallParticipant> listParticipants()

Get all participants.
Mono<MuteParticipantResult> muteParticipant(CommunicationIdentifier targetParticipant)

Mutes a participant in the call.
Mono<Response<MuteParticipantResult>> muteParticipantWithResponse(MuteParticipantOptions options)

Mutes a participant in the call.
Mono<RemoveParticipantResult> removeParticipant(CommunicationIdentifier participantToRemove)

Remove a participant from the call.
Mono<Response<RemoveParticipantResult>> removeParticipantWithResponse(RemoveParticipantOptions removeParticipantOptions)

Remove a participant from the call.
Mono<TransferCallResult> transferCallToParticipant(CommunicationIdentifier targetParticipant)

Transfer the call to a participant.
Mono<Response<TransferCallResult>> transferCallToParticipantWithResponse(TransferCallToParticipantOptions transferCallToParticipantOptions)

Transfer the call to a participant.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

addParticipant

public Mono<AddParticipantResult> addParticipant(CallInvite participant)

Add a participant to the call.

Parameters:

participant - participant to invite.

Returns:

Result of adding a participant to the call.

addParticipantWithResponse

public Mono<Response<AddParticipantResult>> addParticipantWithResponse(AddParticipantOptions addParticipantOptions)

Add a participant to the call.

Parameters:

addParticipantOptions - Options bag for addParticipant

Returns:

Response with result of adding a participant to the call.

cancelAddParticipantOperation

public Mono<CancelAddParticipantOperationResult> cancelAddParticipantOperation(String invitationId)

Cancel add participant operation request.

Parameters:

invitationId - invitation ID used to add participant.

Returns:

Result of cancelling add participant request.

cancelAddParticipantOperationWithResponse

public Mono<Response<CancelAddParticipantOperationResult>> cancelAddParticipantOperationWithResponse(CancelAddParticipantOperationOptions cancelAddParticipantOperationOptions)

Cancel add participant operation request.

Parameters:

cancelAddParticipantOperationOptions - Options bag for cancelAddParticipantOperationOptions.

Returns:

Response with result of cancelling add participant request.

getCallMediaAsync

public CallMediaAsync getCallMediaAsync()

Returns an object of CallContentAsync

Returns:

a CallContentAsync.

getCallProperties

public Mono<CallConnectionProperties> getCallProperties()

Get call connection properties.

Returns:

Response payload for a successful get call connection request.

getCallPropertiesWithResponse

public Mono<Response<CallConnectionProperties>> getCallPropertiesWithResponse()

Get call connection properties.

Returns:

Response payload for a successful get call connection request.

getParticipant

public Mono<CallParticipant> getParticipant(CommunicationIdentifier targetParticipant)

Get a specific participant.

Parameters:

targetParticipant - The participant to retrieve.

Returns:

Result of getting a desired participant in the call.

getParticipantWithResponse

public Mono<Response<CallParticipant>> getParticipantWithResponse(CommunicationIdentifier targetParticipant)

Get a specific participant.

Parameters:

targetParticipant - The participant to retrieve.

Returns:

Response with the result of getting a desired participant in the call.

hangUp

public Mono<Void> hangUp(boolean isForEveryone)

Hangup a call.

Parameters:

isForEveryone - determine if the call is handed up for all participants.

Returns:

Void.

hangUpWithResponse

public Mono<Response<Void>> hangUpWithResponse(boolean isForEveryone)

Hangup a call.

Parameters:

isForEveryone - determine if the call is handed up for all participants.

Returns:

Response with Void.

listParticipants

public PagedFlux<CallParticipant> listParticipants()

Get all participants.

Returns:

Response with result of getting all participants in the call.

muteParticipant

public Mono<MuteParticipantResult> muteParticipant(CommunicationIdentifier targetParticipant)

Mutes a participant in the call.

Parameters:

targetParticipant -
  • Participant to be muted. Only ACS Users are currently supported.

Returns:

A MuteParticipantResult object.

muteParticipantWithResponse

public Mono<Response<MuteParticipantResult>> muteParticipantWithResponse(MuteParticipantOptions options)

Mutes a participant in the call.

Parameters:

options -
  • Options for the request.

Returns:

Response containing the MuteParticipantResult object.

removeParticipant

public Mono<RemoveParticipantResult> removeParticipant(CommunicationIdentifier participantToRemove)

Remove a participant from the call.

Parameters:

participantToRemove - participant to remove.

Returns:

Result of removing a participant from the call.

removeParticipantWithResponse

public Mono<Response<RemoveParticipantResult>> removeParticipantWithResponse(RemoveParticipantOptions removeParticipantOptions)

Remove a participant from the call.

Parameters:

removeParticipantOptions - Options bag for removeParticipant

Returns:

Response with result of removing a participant from the call.

transferCallToParticipant

public Mono<TransferCallResult> transferCallToParticipant(CommunicationIdentifier targetParticipant)

Transfer the call to a participant.

Parameters:

targetParticipant - A CommunicationIdentifier representing the targetParticipant participant of this transfer.

Returns:

Result of transferring the call to a designated participant.

transferCallToParticipantWithResponse

public Mono<Response<TransferCallResult>> transferCallToParticipantWithResponse(TransferCallToParticipantOptions transferCallToParticipantOptions)

Transfer the call to a participant.

Parameters:

transferCallToParticipantOptions - Options bag for transferToParticipantCall

Returns:

Response with result of transferring the call to a designated participant.

Applies to