Skip to main content
Version: v2

IInboundSignalMessage Interface

Represents ISignalMessage with its type.

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/runtime-definitions/legacy.

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

Signature​

export interface IInboundSignalMessage<TMessage extends TypedMessage = TypedMessage> extends ISignalMessage<TMessage>

Extends: ISignalMessage<TMessage>

Type Parameters​

ParameterConstraintDefaultDescription
TMessageTypedMessageTypedMessage

Properties​

PropertyAlertsModifiersTypeDescription
typeBetareadonlyTMessage["type"]

Property Details​

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​

readonly type: TMessage["type"];

Type: TMessage["type"]