MessageType

Packages > @fluidframework/driver-definitions > MessageType

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

To use, import via @fluidframework/driver-definitions/legacy.

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

Signature 

export declare enum MessageType

Flags

Flag Alerts Description
Accept Alpha Message sent by client accepting proposal
ClientJoin Alpha System message sent to indicate a new client has joined the collaboration.
ClientLeave Alpha System message sent to indicate a client has left the collaboration.
Control Alpha Service specific control messages that are never sequenced.
NoClient Alpha Message to indicate that no active clients are present.
NoOp Alpha Empty operation message. Used to send an updated reference sequence number. Relay service is free to coalesce these messages or fully drop them, if another message was used to update MSN to a number equal or higher than referenced sequence number in Noop.
Operation Alpha Operation (message) produced by container runtime.
Propose Alpha Proposes a new consensus value.
Reject Alpha Message used to reject a pending proposal.
RoundTrip Alpha Message to indicate successful round trip.
Summarize Alpha Summary operation (message).
SummaryAck Alpha Summary operation (message) written.
SummaryNack Alpha Summary operation (message) write failure.

Accept

Message sent by client accepting proposal

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/driver-definitions/alpha.

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

Signature 

Accept = "accept"

ClientJoin

System message sent to indicate a new client has joined the collaboration.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/driver-definitions/alpha.

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

Signature 

ClientJoin = "join"

ClientLeave

System message sent to indicate a client has left the collaboration.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/driver-definitions/alpha.

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

Signature 

ClientLeave = "leave"

Control

Service specific control messages that are never sequenced.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/driver-definitions/alpha.

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

Signature 

Control = "control"

NoClient

Message to indicate that no active clients are present.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/driver-definitions/alpha.

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

Signature 

NoClient = "noClient"

NoOp

Empty operation message. Used to send an updated reference sequence number. Relay service is free to coalesce these messages or fully drop them, if another message was used to update MSN to a number equal or higher than referenced sequence number in Noop.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/driver-definitions/alpha.

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

Signature 

NoOp = "noop"

Operation

Operation (message) produced by container runtime.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/driver-definitions/alpha.

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

Signature 

Operation = "op"

Propose

Proposes a new consensus value.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/driver-definitions/alpha.

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

Signature 

Propose = "propose"

Reject

Message used to reject a pending proposal.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/driver-definitions/alpha.

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

Signature 

Reject = "reject"

RoundTrip

Message to indicate successful round trip.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/driver-definitions/alpha.

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

Signature 

RoundTrip = "tripComplete"

Summarize

Summary operation (message).

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/driver-definitions/alpha.

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

Signature 

Summarize = "summarize"

SummaryAck

Summary operation (message) written.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/driver-definitions/alpha.

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

Signature 

SummaryAck = "summaryAck"

SummaryNack

Summary operation (message) write failure.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/driver-definitions/alpha.

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

Signature 

SummaryNack = "summaryNack"