ISignalMessageBase Interface
Common interface between incoming and outgoing signals.
WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.
Signature
export interface ISignalMessageBase
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| clientConnectionNumber | Alpha |
optional |
number | Counts the number of signals sent by the sending client. |
| content | Alpha |
unknown | Signal content | |
| referenceSequenceNumber | Alpha |
optional |
number | Sequence number that indicates when the signal was created in relation to the delta stream |
| targetClientId | Alpha |
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 | Alpha |
optional |
string | Signal type |
Property Details
clientConnectionNumber
Counts the number of signals sent by the sending client.
WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.
Signature
clientConnectionNumber?: number;
Type: number
content
Signal content
WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.
Signature
content: unknown;
Type: unknown
referenceSequenceNumber
Sequence number that indicates when the signal was created in relation to the delta stream
WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.
Signature
referenceSequenceNumber?: number;
Type: 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.
WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.
Signature
targetClientId?: string;
Type: string
type
Signal type
WARNING: This API is provided as an alpha preview and may change without notice. Use at your own risk.
Signature
type?: string;
Type: string