Packages > @fluidframework/protocol-definitions > IClientDetails

IClientDetails Interface

IClient connection / environment metadata.

Signature

export interface IClientDetails

Properties

Property Modifiers Type Description
capabilities ICapabilities Capabilities of a Client. In particular, whether or not the client is interactive.
device optional string
environment optional string
type optional string

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;

device

Signature

device?: string;

environment

Signature

environment?: 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;