Packages > @fluidframework/protocol-definitions > ISignalMessageBase
ISignalMessageBase Interface
Common interface between incoming and outgoing signals.
Signature
export interface ISignalMessageBase
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| clientConnectionNumber |
optional
|
number | Counts the number of signals sent by the sending client. |
| content | unknown | Signal content | |
| referenceSequenceNumber |
optional
|
number | Sequence number that indicates when the signal was created in relation to the delta stream |
| targetClientId |
optional
|
string | Client ID of the singular client the signal is being (or has been) sent to. May only be specified when IConnect.supportedFeatures['submit_signals_v2'] is true, will throw otherwise. |
| type |
optional
|
string | Signal type |
Property Details
clientConnectionNumber
Counts the number of signals sent by the sending client.
Signature
clientConnectionNumber?: number;
content
Signal content
Signature
content: unknown;
referenceSequenceNumber
Sequence number that indicates when the signal was created in relation to the delta stream
Signature
referenceSequenceNumber?: number;
targetClientId
Client ID of the singular client the signal is being (or has been) sent to. May only be specified when IConnect.supportedFeatures[‘submit_signals_v2’] is true, will throw otherwise.
Signature
targetClientId?: string;
type
Signal type
Signature
type?: string;