@dialstack/sdk-dev / js/src / ClientInfo

Class: ClientInfo

Defined in: sdk/js/src/core/client-info.ts:21

Internal

Builds the DialStack-Client value for DialStack packages that report without an instance (a standalone softphone, the React Native phone).

Constructors

Constructor

TypeScript

new ClientInfo(app?): ClientInfo;

Defined in: sdk/js/src/core/client-info.ts:27

Parameters

app?

ClientAppInfo

Returns

ClientInfo

Methods

header()

TypeScript

header(): string;

Defined in: sdk/js/src/core/client-info.ts:58

Returns

string

---

registerComponent()

TypeScript

registerComponent(packageName, component): void;

Defined in: sdk/js/src/core/client-info.ts:54

Record that a component was mounted. Never unregistered: the header answers "which components does this integration use", not "which are on screen right now".

Parameters

packageName

string

component

string

Returns

void

---

registerPackage()

TypeScript

registerPackage(name, version): void;

Defined in: sdk/js/src/core/client-info.ts:44

Parameters

name

string

version

string

Returns

void

---

forComponent()

TypeScript

static forComponent(
   pkg, 
   version, 
   component, 
   app?
): string;

Defined in: sdk/js/src/core/client-info.ts:32

The header for a single package reporting a single component.

Parameters

pkg

string

version

string

component

string

app?

ClientAppInfo

Returns

string