Skip to content

/AWS1/CL_IVC=>DELETEMESSAGE()

About DeleteMessage

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.

Method Signature

IMPORTING

Required arguments:

IV_ROOMIDENTIFIER TYPE /AWS1/IVCROOMIDENTIFIER /AWS1/IVCROOMIDENTIFIER

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

IV_ID TYPE /AWS1/IVCMESSAGEID /AWS1/IVCMESSAGEID

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

Optional arguments:

IV_REASON TYPE /AWS1/IVCREASON /AWS1/IVCREASON

Reason for deleting the message.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_IVCDELETEMESSAGERSP /AWS1/CL_IVCDELETEMESSAGERSP