IRuntimeMessageCollection Interface
A collection of messages that are processed by the runtime.
To use, import via @fluidframework/runtime-definitions/legacy.
For more information about our API support guarantees, see here.
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
Remarks
Some places which use this interface may have additional constraints on the messages which are collected together, and those cases have special names:
A "grouped batch" requires that all contained messages: - Are contiguous in sequencing order. - Are all from the same client. - Are all based on the same reference sequence number. - Are not interleaved with messages from other clients. - Were actually grouped together into a "grouped batch" by the client when they were submitted: even ops meeting the other requirements arn't considered a grouped batch if they were not send and processed as one.
A "bunch" requires that all contained messages: - Are a contiguous subsequence of messages from the same grouped batch (in order and cannot skip any messages). - Are all for the same DDS in the container.
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| envelope | Beta | readonly | ISequencedMessageEnvelope | The envelope for all the messages in the collection |
| local | Beta | readonly | boolean | Whether these messages were originally generated by the client processing them |
| messagesContent | Beta | readonly | readonly IRuntimeMessagesContent[] | The contents of the messages in the collection |
Property Details
envelope
The envelope for all the messages in the collection
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 them
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
For more information about our API support guarantees, see here.
Signature
readonly messagesContent: readonly IRuntimeMessagesContent[];
Type: readonly IRuntimeMessagesContent[]