ISignalClient Interface
This API is provided for existing users, but is not recommended for new users.
To use, import via @fluidframework/driver-definitions/legacy.
For more information about our API support guarantees, see here.
Signature
export interface ISignalClient
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| client | Beta | IClient | The underlying client details. | |
| clientConnectionNumber | Beta | optional | number | Counts the number of signals sent by the client. |
| clientId | Beta | string | The client's unique ID. | |
| referenceSequenceNumber | Beta | optional | number | Sequence number that indicates when the signal was created in relation to the delta stream. |
Property Details
client
The underlying client details.
This API is provided for existing users, but is not recommended for new users.
For more information about our API support guarantees, see here.
Signature
client: IClient;
Type: IClient
clientConnectionNumber
Counts the number of signals sent by the client.
This API is provided for existing users, but is not recommended for new users.
For more information about our API support guarantees, see here.
Signature
clientConnectionNumber?: number;
Type: number
clientId
The client's unique ID.
This API is provided for existing users, but is not recommended for new users.
For more information about our API support guarantees, see here.
Signature
clientId: string;
Type: string
referenceSequenceNumber
Sequence number that indicates when the signal was created in relation to the delta stream.
This API is provided for existing users, but is not recommended for new users.
For more information about our API support guarantees, see here.
Signature
referenceSequenceNumber?: number;
Type: number