AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginDeleteMessage and EndDeleteMessage.

Namespace: Amazon.Ivschat
Assembly: AWSSDK.Ivschat.dll
Version: 3.x.y.z

Syntax

C#
public abstract Task<DeleteMessageResponse> DeleteMessageAsync(
         DeleteMessageRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.Ivschat.Model.DeleteMessageRequest

Container for the necessary parameters to execute the DeleteMessage service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the DeleteMessage service method, as returned by Ivschat.

Exceptions

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer

See Also