Edit

IncomingCallCommon interface

  • Reference
Package:
@azure/communication-calling

The incoming call common interface.

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

off("callEnded", CallEndedEvent)

Unsubscribe function for onCallEnded event.
on("callEnded", CallEndedEvent)

Subscribe function for onCallEnded event.
reject()

Reject this incoming Call.

Property Details

callEndReason

Containing code/subCode indicating how call ended.

callEndReason?: CallEndReason

Property Value

CallEndReason

callerInfo

Identifier of the caller.

callerInfo: CallerInfo

Property Value

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

id

Get the unique Id for this Call.

id: string

Property Value

string

kind

Get the kind of incoming call oject.

kind: IncomingCallKind

Property Value

IncomingCallKind

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.

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.

reject()

Reject this incoming Call.

function reject(): Promise<void>

Returns

Promise<void>