CallAgentCommon interface

Package:

@azure/communication-calling

CallAgent common interface.

Properties

connectionState	Get the connection state.
kind	Get the kind of call agent object.

Methods

dispose()	Dispose of this Call Agent
feature<TFeature>(CallAgentFeatureFactory<TFeature>)	Retrieves an initialized and memoized Feature object with extended API. Check the object Features.* for all available extended call agent features in this package.
handlePushNotification(IncomingCallPushNotificationData)	Handles a push notification.

Property Details

connectionState

Get the connection state.

connectionState: ConnectionState

Property Value

ConnectionState

kind

Get the kind of call agent object.

kind: CallAgentKind

Property Value

CallAgentKind

Method Details

dispose()

Dispose of this Call Agent

function dispose(): Promise<void>

Returns

Promise<void>

feature<TFeature>(CallAgentFeatureFactory<TFeature>)

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.

Retrieves an initialized and memoized Feature object with extended API. Check the object Features.* for all available extended call agent features in this package.

function feature<TFeature>(factory: CallAgentFeatureFactory<TFeature>): TFeature

Parameters

factory

CallAgentFeatureFactory<TFeature>

The factory for the call agent feature constructor that provides an extended API.

Returns

TFeature

handlePushNotification(IncomingCallPushNotificationData)

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.

Handles a push notification.

function handlePushNotification(data: IncomingCallPushNotificationData): Promise<void>

Parameters

data

IncomingCallPushNotificationData

Push notification data

Returns

Promise<void>