IClient Interface
Represents a client connected to a Fluid service, including associated user details, permissions, and connection mode.
Signature
export interface IClient
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| details | IClientDetails | IClient connection / environment metadata. | |
| mode | ConnectionMode | A client's connection mode - either view-only ("read") or allowing edits ("write"). | |
| permission | string[] | ||
| scopes | string[] | Enumerates actions allowed for the client connection. | |
| timestamp | optional | number | The time the client connected to the service. |
| user | IUser | The user information associated with this client connection. |
Property Details
details
IClient connection / environment metadata.
Signature
details: IClientDetails;
Type: IClientDetails
mode
A client's connection mode - either view-only ("read") or allowing edits ("write").
Signature
mode: ConnectionMode;
Type: ConnectionMode
Remarks
Note: a user's connection mode is dependent on their permissions. E.g. a user with read-only permissions will not be allowed a "write" connection mode.
permission
Signature
permission: string[];
Type: string[]
scopes
Enumerates actions allowed for the client connection.
Signature
scopes: string[];
Type: string[]
timestamp
The time the client connected to the service.
Signature
timestamp?: number;
Type: number
user
The user information associated with this client connection.
Signature
user: IUser;
Type: IUser