RemoteDiagnostics interface

Package:

@azure/communication-calling

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.

Remote Diagnostics

Methods

getLatest()	Get the latest known Remote diagnostics
off("diagnosticChanged", (args: RemoteParticipantDiagnosticsData) => void)	Unsubscribe function for diagnosticChanged events
on("diagnosticChanged", (args: RemoteParticipantDiagnosticsData) => void)	Subscribe function for diagnosticChanged event

Method Details

getLatest()

Get the latest known Remote diagnostics

function getLatest(): RemoteParticipantDiagnosticsData

Returns

RemoteParticipantDiagnosticsData

off("diagnosticChanged", (args: RemoteParticipantDiagnosticsData) => void)

Unsubscribe function for diagnosticChanged events

function off(event: "diagnosticChanged", listener: (args: RemoteParticipantDiagnosticsData) => void)

Parameters

event

"diagnosticChanged"

event name

listener

(args: RemoteParticipantDiagnosticsData) => void

callback fn that was used to unsubscribe to this event

on("diagnosticChanged", (args: RemoteParticipantDiagnosticsData) => void)

Subscribe function for diagnosticChanged event

function on(event: "diagnosticChanged", listener: (args: RemoteParticipantDiagnosticsData) => void)

Parameters

event

"diagnosticChanged"

event name

listener

(args: RemoteParticipantDiagnosticsData) => void

callback fn that will be called when a diagnostic has changed