Skip to main content

ISignalMessageBase Interface

Common interface between incoming and outgoing signals.

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 ISignalMessageBase<TMessage extends TypedMessage = TypedMessage>

Type Parameters

Parameter Constraint Default Description
TMessage TypedMessage TypedMessage

Properties

Property Alerts Modifiers Type Description
clientConnectionNumber Alpha optional number Counts the number of signals sent by the sending client.
content Alpha TMessage["content"] 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 TMessage["type"] Signal type

Property Details

clientConnectionNumber

Counts the number of signals sent by the sending 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

content

Signal content

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
content: TMessage["content"];

Type: TMessage["content"]

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

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.

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
targetClientId?: string;

Type: string

type

Signal type

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
type?: TMessage["type"];

Type: TMessage["type"]