Skip to content

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.

Usage

ivschat_delete_message(roomIdentifier, id, reason)

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.

Value

A list with the following syntax:

list(
  id = "string"
)

Request syntax

svc$delete_message(
  roomIdentifier = "string",
  id = "string",
  reason = "string"
)