Skip to main content

IRuntimeMessageCollection Interface

A collection of messages that are processed by the runtime.

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 IRuntimeMessageCollection

Properties​

Property Alerts Modifiers Type Description
envelope Alpha readonly ISequencedMessageEnvelope The envelope for all the messages in the collection
local Alpha readonly boolean Whether these messages were originally generated by the client processing it
messagesContent Alpha readonly readonly IRuntimeMessagesContent[] The contents of the messages in the collection

Property Details​

envelope​

The envelope for all the messages in the collection

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 envelope: ISequencedMessageEnvelope;

Type: ISequencedMessageEnvelope

local​

Whether these messages were originally generated by the client processing it

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 local: boolean;

Type: boolean

messagesContent​

The contents of the messages in the collection

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 messagesContent: readonly IRuntimeMessagesContent[];

Type: readonly IRuntimeMessagesContent[]