ivschat_send_event: Sends an event to a room

View source: R/ivschat_operations.R

ivschat_send_eventR 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.

See https://www.paws-r-sdk.com/docs/ivschat_send_event/ for full documentation.

Usage

ivschat_send_event(attributes = NULL, eventName, roomIdentifier)

Arguments

attributes

Application-defined metadata to attach to the event sent to clients. The maximum length of the metadata is 1 KB total.

eventName

[required] Application-defined name of the event to send to clients.

roomIdentifier

[required] Identifier of the room to which the event will be sent. Currently this must be an ARN.


paws.end.user.computing documentation built on Sept. 12, 2023, 1:17 a.m.