Send Event
ivschat_send_event | R Documentation |
Sends an event to a room¶
Description¶
Sends an event to a room. Use this within your application’s business logic to send events to clients of a room; e.g., to notify clients to change the way the chat UI is rendered.
Usage¶
ivschat_send_event(roomIdentifier, eventName, attributes)
Arguments¶
roomIdentifier |
[required] Identifier of the room to which the event will be sent. Currently this must be an ARN. |
eventName |
[required] Application-defined name of the event to send to clients. |
attributes |
Application-defined metadata to attach to the event sent to clients. The maximum length of the metadata is 1 KB total. |
Value¶
A list with the following syntax:
list(
id = "string"
)
Request syntax¶
svc$send_event(
roomIdentifier = "string",
eventName = "string",
attributes = list(
"string"
)
)