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.

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

Type: ISequencedMessageEnvelope

local

Whether these messages were originally generated by the client processing them

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

Type: boolean

messagesContent

The contents of the messages in the collection

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

Type: readonly IRuntimeMessagesContent[]