Skip to main content

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 extends ISignalMessageBase

Extends: ISignalMessageBase

Properties

Property Alerts Type Description
clientId Alpha 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 as an alpha preview and may change without notice.

To use, import via @fluidframework/driver-definitions/alpha.

For more information about our API support guarantees, see here.

Signature

clientId: string | null;

Type: string | null