Delete messages

Delete() either permanently removes a historical message from Message Persistence or marks it as deleted (if you remove the message with the soft option).

Requires Message Persistence configuration

To manage messages, you must enable Message Persistence for your app's keyset in the Admin Portal. To delete messages from PubNub storage, you must also mark the Enable Delete-From-History option.

Method signature

This method takes the following parameters:

1message.Delete(bool soft = false)

Input

* required

Parameter	Description
soft Type: bool Default: false	Define if you want to permanently remove message data. By default, the message data gets permanently deleted from Message Persistence. If you set this parameter to true, the message's IsDeleted property is set to true, and you can still restore/get its data.

Output

Type	Description
Task<ChatOperationResult>	Returned Task that you can await to get the result of the delete operation.

Sample code

Permanently delete the message with the 16200000000000001 timetoken from the support channel.

1 

Other examples

Archive (soft delete) the message with the 16200000000000001 timetoken from the support channel, keeping its data in Message Persistence.

1