IncomingCall interface

Package:

@azure/communication-calling

Represents an incoming call.

Extends

IncomingCallCommon

Properties

info	Get information about this Call.

Inherited Properties

callEndReason	Containing code/subCode indicating how call ended.
callerInfo	Identifier of the caller.
customContext	Options sent as custom context.
id	Get the unique Id for this Call.
kind	Get the kind of incoming call oject.

Methods

accept(AcceptCallOptions)

Accept this incoming Call.

Inherited Methods

off("callEnded", CallEndedEvent)	Unsubscribe function for onCallEnded event.
on("callEnded", CallEndedEvent)	Subscribe function for onCallEnded event.
reject()	Reject this incoming Call.

Property Details

info

Note

This API is in Beta and provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Get information about this Call.

info: CallInfo

Property Value

CallInfo

Inherited Property Details

callEndReason

Containing code/subCode indicating how call ended.

callEndReason?: CallEndReason

Property Value

CallEndReason

Inherited From IncomingCallCommon.callEndReason

callerInfo

Identifier of the caller.

callerInfo: CallerInfo

Property Value

CallerInfo

Inherited From IncomingCallCommon.callerInfo

customContext

Note

This API is in Beta and provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Options sent as custom context.

customContext?: CustomContextOptions

Property Value

CustomContextOptions

Inherited From IncomingCallCommon.customContext

id

Get the unique Id for this Call.

id: string

Property Value

string

Inherited From IncomingCallCommon.id

kind

Get the kind of incoming call oject.

kind: IncomingCallKind

Property Value

IncomingCallKind

Inherited From IncomingCallCommon.kind

Method Details

accept(AcceptCallOptions)

Accept this incoming Call.

function accept(options?: AcceptCallOptions): Promise<Call>

Parameters

options

AcceptCallOptions

accept options.

Returns

Promise<Call>

The Call object associated with the accepted call.

Inherited Method Details

off("callEnded", CallEndedEvent)

Unsubscribe function for onCallEnded event.

function off(event: "callEnded", listener: CallEndedEvent)

Parameters

event

"callEnded"

event name.

listener

CallEndedEvent

callback fn that was used to subscribe to this event.

Inherited From IncomingCallCommon.off

on("callEnded", CallEndedEvent)

Subscribe function for onCallEnded event.

function on(event: "callEnded", listener: CallEndedEvent)

Parameters

event

"callEnded"

event name.

listener

CallEndedEvent

callback fn that was used to subscribe to this event.

Inherited From IncomingCallCommon.on

reject()

Reject this incoming Call.

function reject(): Promise<void>

Returns

Promise<void>

Inherited From IncomingCallCommon.reject