Class CallingClient

The CallingClient module provides a set of APIs for line registration and calling functionalities within the SDK.

The following code snippet demonstrates how to create an instance of CallingClient using a webex instance and callingConfig:

Example

const callingClient = createClient(webex, callingConfig);

Hierarchy

Eventing<CallingClientEventTypes>
- CallingClient

Implements

ICallingClient

Index

Properties

mediaEngine

mediaEngine: __module

Represents the `mediaEngine for managing media-related operations within the CallingClient. The media engine provides access to audio and video devices such as cameras, microphones, and speakers within the media layer.

Example

const microphones = await callingClient.mediaEngine.Media.getMicrophones();
const speakers = await callingClient.mediaEngine.Media.getSpeakers();
const cameras = await callingClient.mediaEngine.Media.getCameras();

Methods

getLines

getLines(): Record<string, ILine>
Retrieves details of all the Line objects belonging to a User NOTE: currently multiple lines are not supported

Returns Record<string, ILine>

Implementation of ICallingClient.getLines

getDevices

getDevices(userId?: string): Promise<DeviceType[]>
Fetches the list of devices for a given user from Mobius.
Parameters
- Optional userId: string
Returns Promise<DeviceType[]>

Implementation of ICallingClient.getDevices

getActiveCalls

getActiveCalls(): Record<string, ICall[]>
Retrieves call objects for all the active calls present in the client

Returns Record<string, ICall[]>

Implementation of ICallingClient.getActiveCalls

getConnectedCall

getConnectedCall(): undefined | ICall
Retrieves call object for the connected call in the client

Returns undefined | ICall

Implementation of ICallingClient.getConnectedCall

isMobiusSocketConnected

isMobiusSocketConnected(): boolean
Indicates whether the Mobius WebSocket transport is currently connected.

The MOBIUS_SOCKET_CONNECTED event is emitted during init(), so consumers that subscribe afterwards may miss it; this lets them reconcile the current state. Returns false when the WebSocket transport is not enabled.

Returns boolean

Implementation of ICallingClient.isMobiusSocketConnected

uploadLogs

uploadLogs(): Promise<UploadLogsResponse>
Uploads logs to help troubleshoot SDK issues.

This method collects the current SDK logs including network requests, WebSocket messages, and client-side events, then securely submits them to Webex's diagnostics service. The returned tracking ID, feedbackID can be provided to Webex support for faster issue resolution.

Returns
Promise

Throws
Error

Returns Promise<UploadLogsResponse>

Events

emit

emit<E>(event: E, ...args: Parameters<CallingClientEventTypes[E]>): boolean
Type Parameters
- E extends keyof CallingClientEventTypes
Parameters
- event: E
  
  Event that is going ot be emitted.
- Rest ...args: Parameters<CallingClientEventTypes[E]>
  
  Parameters that are emitted with the event.
Returns boolean

Implementation of ICallingClient.emit

Inherited from Eventing.emit

on

on<E>(event: E, listener: CallingClientEventTypes[E]): CallingClient
.
Type Parameters
- E extends keyof CallingClientEventTypes
Parameters
- event: E
  
  Event to listen to.
- listener: CallingClientEventTypes[E]
  
  Callback for event.
Returns CallingClient

Implementation of ICallingClient.on

Inherited from Eventing.on

off

off<E>(event: E, listener: CallingClientEventTypes[E]): CallingClient
.
Type Parameters
- E extends keyof CallingClientEventTypes
Parameters
- event: E
  
  Event to remove listener on.
- listener: CallingClientEventTypes[E]
  
  Callback for event.
Returns CallingClient

Implementation of ICallingClient.off

Inherited from Eventing.off

Class CallingClient

Example

Hierarchy

Implements

Index

Properties

Methods

Events

Properties

mediaEngine

Example

Methods

getLines

Returns Record<string, ILine>

getDevices

Parameters

Optional userId: string

Returns Promise<DeviceType[]>

getActiveCalls

Returns Record<string, ICall[]>

getConnectedCall

Returns undefined | ICall

isMobiusSocketConnected

Returns boolean

uploadLogs

Returns

Throws

Returns Promise<UploadLogsResponse>

Events

emit

Type Parameters

E extends keyof CallingClientEventTypes

Parameters

event: E

Rest ...args: Parameters<CallingClientEventTypes[E]>

Returns boolean

on

Type Parameters

E extends keyof CallingClientEventTypes

Parameters

event: E

listener: CallingClientEventTypes[E]

Returns CallingClient

off

Type Parameters

E extends keyof CallingClientEventTypes

Parameters

event: E

listener: CallingClientEventTypes[E]

Returns CallingClient

Settings

Member Visibility

Theme

`Optional` userId: string

`Rest` ...args: Parameters<CallingClientEventTypes[E]>