Interface ICall

The stateful call interface.

Inherited Members

IResource<ICall, Call>.OnUpdated

IResource<ICall, Call>.Client

IResource<ICall, Call>.GraphClient

IResource<ICall, Call>.GraphLogger

IResource<ICall, Call>.Resource

IResource<ICall, Call>.Id

IResource<ICall, Call>.UpdateResource(Call)

Microsoft.Graph.StatefulClient.IResource<Microsoft.Graph.Calls.ICall, Call>.DeleteAsync(CancellationToken)

Namespace: Microsoft.Graph.Calls

Assembly: Microsoft.Graph.Calls.dll

Syntax

public interface ICall : IResource<ICall, Call>, IDisposable

Properties

AudioRoutingGroups

Gets the audio routing groups.

Declaration

IAudioRoutingGroupCollection AudioRoutingGroups { get; }

Property Value

Type	Description
IAudioRoutingGroupCollection	The audio routing groups.

CorrelationId

Gets the correlation identifier.

Declaration

Guid CorrelationId { get; }

Property Value

Type	Description
Guid	The correlation identifier.

MediaSession

Gets the media session.

Declaration

IMediaSession MediaSession { get; }

Property Value

Type	Description
IMediaSession	The media session.

Participants

Gets the Participants.

Declaration

ICallParticipantCollection Participants { get; }

Property Value

Type	Description
ICallParticipantCollection	The participants.

Resource

Gets the call resource.

Declaration

Call Resource { get; }

Property Value

Type	Description
Call	The call resource.

TenantId

Gets the tenant identifier.

Declaration

string TenantId { get; }

Property Value

Type	Description
System.String	The tenant id.

Methods

AnswerAsync(MediaConfig, IEnumerable<Modality>, String, CancellationToken)

Answer an incoming call asynchronously.

Declaration

Task AnswerAsync(MediaConfig mediaConfig, IEnumerable<Modality> acceptedModalities = null, string callbackUri = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
MediaConfig	mediaConfig	The .
IEnumerable<Modality>	acceptedModalities	The accepted .
System.String	callbackUri	The call back uri.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task	See

CancelMediaProcessingAsync(Boolean, CancellationToken)

Performs the CancelMediaProcessing operation.

Declaration

Task CancelMediaProcessingAsync(bool all = true, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.Boolean	all	When true, cancels all the media operations.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task	See

ChangeScreenSharingRoleAsync(ScreenSharingRole, CancellationToken)

Changes own sharing role in a vbss session.

Declaration

Task ChangeScreenSharingRoleAsync(ScreenSharingRole role, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
ScreenSharingRole	role	The role to change to.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task	See

MuteAsync(CancellationToken)

Mutes the self participant asynchronously.

Declaration

Task MuteAsync(CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task	See

PlayPromptAsync(IEnumerable<MediaPrompt>, CancellationToken)

Performs the PlayPrompt operation.

Declaration

Task PlayPromptAsync(IEnumerable<MediaPrompt> prompts, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
IEnumerable<MediaPrompt>	prompts	The list of to play
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task	The .

RecordAsync(Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, IEnumerable<Prompt>, IEnumerable<String>, Action<String>, CancellationToken)

Records the call asynchronously.

Declaration

Task<RecordOperationResult> RecordAsync(int? maxRecordDurationInSeconds = null, int? initialSilenceTimeoutInSeconds = null, int? maxSilenceTimeoutInSeconds = null, bool? bargeInAllowed = null, bool? playBeep = null, IEnumerable<Prompt> prompts = null, IEnumerable<string> stopTones = null, Action<string> recordingStreamFile = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	maxRecordDurationInSeconds	Max duration for a record operation before stopping recording. Default = 5 minutes (300 seconds)
System.Nullable<System.Int32>	initialSilenceTimeoutInSeconds	Time to wait for user to start speaking for the first time before timing out. If the timeout is reached the recorder will abort the operation. Default = 5 sec
System.Nullable<System.Int32>	maxSilenceTimeoutInSeconds	Max duration of a pause by a user before timing out the record operation Default = 5 sec
System.Nullable<System.Boolean>	bargeInAllowed	Optional Boolean flag to determines if the request should be queued up or barge into existing requests. Default = false
System.Nullable<System.Boolean>	playBeep	If true, plays a beep to indicate to the user that they can start recording their message. Default = true
IEnumerable<Prompt>	prompts	Contains info needed to play prompt.
IEnumerable<System.String>	stopTones	DTMF characters that can be specified to indicate record is complete.
Action<System.String>	recordingStreamFile	If not null, calls this function with the link which could be used to retrieve the raw record stream in real-time while record is in progress. If false, gives a link after recording is complete to download the recorded stream.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task<RecordOperationResult>	See

RedirectAsync(IEnumerable<ParticipantInfo>, Nullable<CallDisposition>, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, CancellationToken)

Redirects the incoming call asynchronously.

Declaration

Task RedirectAsync(IEnumerable<ParticipantInfo> targets, CallDisposition? targetDisposition = null, int? timeout = null, bool? maskCallee = null, bool? maskCaller = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
IEnumerable<ParticipantInfo>	targets	The targets.
System.Nullable<CallDisposition>	targetDisposition	The target disposition.
System.Nullable<System.Int32>	timeout	The timeout.
System.Nullable<System.Boolean>	maskCallee	The mask callee.
System.Nullable<System.Boolean>	maskCaller	The mask caller.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task	See

RejectAsync(Nullable<RejectReason>, CancellationToken)

Rejects the incoming call asynchronously.

Declaration

Task RejectAsync(RejectReason? rejectReason = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.Nullable<RejectReason>	rejectReason	The reject reason.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task	See

SubscribeToToneAsync(CancellationToken)

Subscribes to tone.

Declaration

Task SubscribeToToneAsync(CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task	See

TransferAsync(IdentitySet, String, EndpointType, CancellationToken)

Transfer a call.

Declaration

Task TransferAsync(IdentitySet target, string replacesCallId = null, EndpointType endpointType = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
IdentitySet	target	The target to transfer the call to.
System.String	replacesCallId	The Id of the call to be replaced for consultative transfer.
EndpointType	endpointType	The endpoint type of the target, can be default or voicemail
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task	See

TransferAsync(InvitationParticipantInfo, CancellationToken)

Transfer a call.

Declaration

Task TransferAsync(InvitationParticipantInfo target, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
InvitationParticipantInfo	target	The target to transfer the call to.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task	See

UnmuteAsync(CancellationToken)

Unmutes the self participant asynchronously.

Declaration

Task UnmuteAsync(CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task	See

UpdateMetadataAsync(String, CancellationToken)

Updates the self participant metadata asynchronously.

Declaration

Task UpdateMetadataAsync(string metadata, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	metadata	The metadata.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task	See

Extension Methods

CallExtensions.AnswerAsync(ICall, IMediaSession, String, CancellationToken)

CallExtensions.AnswerAsync(ICall, IEnumerable<MediaInfo>, IEnumerable<Modality>, String, CancellationToken)

CallExtensions.AnswerAsync(ICall, String, CancellationToken)