ISignalMessage Interface
Interface for signals sent by the server to clients.
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 ISignalMessage<TMessage extends TypedMessage = TypedMessage> extends ISignalMessageBase<TMessage>
Extends: ISignalMessageBase<TMessage>
Type Parameters
| Parameter | Constraint | Default | Description |
|---|---|---|---|
| TMessage | TypedMessage | TypedMessage |
Properties
| Property | Alerts | Type | Description |
|---|---|---|---|
| clientId | Beta | string | null | The client ID that submitted the message. For server generated messages the clientId will be null. |
Property Details
clientId
The client ID that submitted the message. For server generated messages the clientId will be null.
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 | null;
Type: string | null