Skip to contents

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

Source: R/ivschat_operations.R
ivschat_delete_message.Rd

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.