Delete messages

Delete() either permanently removes a historical message from Message Persistence (DeleteMessageHard()) or marks it as deleted if you use the soft delete option (DeleteMessage()).

You can use PubNub's functionality via Blueprints or directly in C++ code.

• In Blueprints, the whole SDK is managed by a subsystem, so start by initalizing the PubnubChatSubsystem node. Afterwards, you can use the Pubnub Chat object reference.

Blueprint functions

The Blueprints provided in the documentation show how you can structure your application and may contain utility methods and elements like buttons that are not part of the Unreal Chat SDK and are meant to serve as guidance.

• In C++, you can use the PubNub SDK as any other Game Instance Subsystem.

  #include "Kismet/GameplayStatics.h"
  #include "PubnubChatSubsystem.h"
  
  
  UGameInstance* GameInstance = UGameplayStatics::GetGameInstance(this);
  UPubnubChatSubsystem* PubnubChatSubsystem = GameInstance->GetSubsystem<UPubnubChatSubsystem>();
  
  
  UPubnubChat* Chat = PubnubChatSubsystem ->InitChat("demo", "demo", "my_user") // config optional

  Chat now allows you to call all Chat SDK functions, for example:

  Chat->DeleteUser("SomeUserID");

Usage in Blueprints and C++

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.

Mark message as deleted (soft delete)

Method signature

This method applies to the Message object the deleted status so you can still restore/get its data.

Blueprint

C++ / Input parameters

1// soft delete
2Message->DeleteMessage();

Output

Type	Description
UPubnubMessage*	An updated message instance with an added deleted action type.

Sample code

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

1#include "Kismet/GameplayStatics.h"
2#include "PubnubChatSubsystem.h"
3

4UGameInstance* GameInstance = UGameplayStatics::GetGameInstance(this);
5UPubnubChatSubsystem* PubnubChatSubsystem = GameInstance->GetSubsystem<UPubnubChatSubsystem>();
6

7UPubnubChat* Chat = PubnubChatSubsystem ->InitChat("demo", "demo", "my_user");
8

9UPubnubChannel* Channel = Chat->GetChannel("support");
10

11FString Timetoken = "16200000000000001";
12

13// Fetch the message
14UPubnubMessage* Message = Channel->GetMessage(Timetoken);
15

16Message.DeleteMessage();

show all 16 lines

Delete a message (hard delete)

Method signature

This method permanently removes a message from Message Persistence.

Blueprint

C++ / Input parameters

1// hard delete
2Message->DeleteMessageHard();

Output

Type	Description
bool	Whether or not the deletion was successful.

Sample code

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

1#include "Kismet/GameplayStatics.h"
2#include "PubnubChatSubsystem.h"
3

4UGameInstance* GameInstance = UGameplayStatics::GetGameInstance(this);
5UPubnubChatSubsystem* PubnubChatSubsystem = GameInstance->GetSubsystem<UPubnubChatSubsystem>();
6

7UPubnubChat* Chat = PubnubChatSubsystem ->InitChat("demo", "demo", "my_user");
8

9UPubnubChannel* Channel = Chat->GetChannel("support");
10

11FString Timetoken = "16200000000000001";
12

13// Fetch the message
14UPubnubMessage* Message = Channel->GetMessage(Timetoken);
15

16Message.DeleteMessageHard();

show all 16 lines