Edit

Share via

DebugInfoCallClientFeature interface

  • Reference
Package:
@azure/communication-calling

Feature for call debug info.

Extends
CallClientFeature

Properties

isCallClientActiveInAnotherTab

Whether the CallClient is active in multiple tabs of a browser
lastCallId

Get the CallId of the last Call undefined if no call happened
lastLocalParticipantId

Get the LocalParticipantId of the last Call undefined if no call happened

Inherited Properties

name

The feature name.

Methods

dumpDebugInfo()

A zipped log dump with its unique identifier and hash
getEnvironmentInfo()

Provides environment details and tells if it is supported by ACS. A supported environment is a combination of an operating system, a browser, and the minimum version required for that browser.
off("isCallClientActiveInAnotherTabChanged", PropertyChangedEvent)

Unsubscribe function for isCallClientActiveInAnotherTabChanged event
on("isCallClientActiveInAnotherTabChanged", PropertyChangedEvent)

Subscribe function for isCallClientActiveInAnotherTabChanged event

Inherited Methods

dispose()

Property Details

isCallClientActiveInAnotherTab

Whether the CallClient is active in multiple tabs of a browser

isCallClientActiveInAnotherTab: boolean

Property Value

boolean

lastCallId

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 the CallId of the last Call undefined if no call happened

lastCallId: undefined | string

Property Value

undefined | string

lastLocalParticipantId

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 the LocalParticipantId of the last Call undefined if no call happened

lastLocalParticipantId: undefined | string

Property Value

undefined | string

Inherited Property Details

name

The feature name.

name: string

Property Value

string

Inherited From CallClientFeature.name

Method Details

dumpDebugInfo()

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.

A zipped log dump with its unique identifier and hash

function dumpDebugInfo(): DebugInfoDump

Returns

DebugInfoDump

getEnvironmentInfo()

Provides environment details and tells if it is supported by ACS. A supported environment is a combination of an operating system, a browser, and the minimum version required for that browser.

function getEnvironmentInfo(): Promise<EnvironmentInfo>

Returns

Promise<EnvironmentInfo>

off("isCallClientActiveInAnotherTabChanged", PropertyChangedEvent)

Unsubscribe function for isCallClientActiveInAnotherTabChanged event

function off(event: "isCallClientActiveInAnotherTabChanged", listener: PropertyChangedEvent)

Parameters

event

"isCallClientActiveInAnotherTabChanged"

event name

listener
PropertyChangedEvent

callback fn that was used to subscribe to this event

on("isCallClientActiveInAnotherTabChanged", PropertyChangedEvent)

Subscribe function for isCallClientActiveInAnotherTabChanged event

function on(event: "isCallClientActiveInAnotherTabChanged", listener: PropertyChangedEvent)

Parameters

event

"isCallClientActiveInAnotherTabChanged"

event name

listener
PropertyChangedEvent

callback fn that was used to subscribe to this event

Inherited Method Details

dispose() 

function dispose()

Inherited From CallClientFeature.dispose