Receive
The Receive
type describes a function that knows how to handle the arrival of a message as part of the synchronization protocol.
(
fromClientId: Id,
requestId: IdOrNull,
message: Message,
body: any,
): void
Type | Description | |
---|---|---|
fromClientId | Id | The |
requestId | IdOrNull | The optional |
message | Message | A number that indicates the type of the message, according to the |
body | any | A message-specific payload. |
returns | void | This has no return value. |
When a message arrives (most likely from another system), the function will be called with parameters that indicate where the message came from, and its meaning and content.
Since
v5.0.0