Skip to main content
Version: v2

IClientDetails Interface

IClient connection / environment metadata.

Signature​

export interface IClientDetails

Properties​

PropertyModifiersTypeDescription
capabilitiesICapabilitiesCapabilities of a Client. In particular, whether or not the client is interactive.
deviceoptionalstring
environmentoptionalstring
typeoptionalstring

The kind of client being described.

undefined indicates that the kind could not be determined.

Property Details​

capabilities​

Capabilities of a Client. In particular, whether or not the client is interactive.

Signature​

capabilities: ICapabilities;

Type: ICapabilities

device​

Signature​

device?: string;

Type: string

environment​

Signature​

environment?: string;

Type: string

Remarks​

If the environment needs to specify multiple properties which gives info about the environment, then it should be in particular format like: "prop1:val1;prop2:val2;prop3:val3"

type​

The kind of client being described.

undefined indicates that the kind could not be determined.

Signature​

type?: string;

Type: string