IRuntimeMessagesContent Interface
Packages > @fluidframework/runtime-definitions > IRuntimeMessagesContent
These are the contents of a runtime message as it is processed throughout the stack.
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
/** @sealed */
export interface IRuntimeMessagesContent
Properties
Property | Alerts | Modifiers | Type | Description |
---|---|---|---|---|
clientSequenceNumber | Alpha |
readonly |
number | The client sequence number of the message |
contents | Alpha |
readonly |
unknown | The contents of the message, i.e., the payload |
localOpMetadata | Alpha |
readonly |
unknown | The local metadata associated with the original message that was submitted |
Property Details
clientSequenceNumber
The client sequence number of the message
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/runtime-definitions/alpha
.
For more information about our API support guarantees, see here .
Signature
readonly clientSequenceNumber: number;
Type: number
contents
The contents of the message, i.e., the payload
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/runtime-definitions/alpha
.
For more information about our API support guarantees, see here .
Signature
readonly contents: unknown;
Type: unknown
localOpMetadata
The local metadata associated with the original message that was submitted
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/runtime-definitions/alpha
.
For more information about our API support guarantees, see here .
Signature
readonly localOpMetadata: unknown;
Type: unknown