IRuntimeMessagesContent Interface

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.

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

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 for existing users, but is not recommended for new users.

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

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature

readonly clientSequenceNumber: number;

Type: number

contents

The contents of the message, i.e., the payload

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

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

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature

readonly contents: unknown;

Type: unknown

localOpMetadata

The local metadata associated with the original message that was submitted

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

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

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature

readonly localOpMetadata: unknown;

Type: unknown