ivschat_delete_message: Sends an event to a specific room which directs clients to...

View source: R/ivschat_operations.R

ivschat_delete_messageR Documentation

Sends an event to a specific room which directs clients to delete a specific message; that is, unrender it from view and delete it from the client’s chat history

Description

Sends an event to a specific room which directs clients to delete a specific message; that is, unrender it from view and delete it from the client’s chat history. This event’s EventName is aws:DELETE_MESSAGE. This replicates the DeleteMessage WebSocket operation in the Amazon IVS Chat Messaging API.

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

Usage

ivschat_delete_message(roomIdentifier, id, reason = NULL)

Arguments

roomIdentifier

[required] Identifier of the room where the message should be deleted. Currently this must be an ARN.

id

[required] ID of the message to be deleted. This is the Id field in the received message (see Message (Subscribe) in the Chat Messaging API).

reason

Reason for deleting the message.


paws.end.user.computing documentation built on April 3, 2025, 8:56 p.m.