Delete users

Remove users with Delete().

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

• In Blueprints, you can access PubNub from any Widget or Actor. Start by initializing chat using InitChat on UPubnubChatSubsystem. Afterwards, you can use the returned UPubnubChat object reference to call all Chat SDK functions.

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 UPubnubChatSubsystem as any other Game Instance Subsystem.

  1
  

  Chat now allows you to call all Chat SDK functions, for example, Chat->GetChannel("my_channel").

Usage in Blueprints and C++

Asynchronous and synchronous method execution

Most PubNub Unreal SDK methods are available in both asynchronous and synchronous variants.

• Asynchronous methods (Async suffix) return void and take an optional delegate parameter that fires when the operation completes.

  1User->DeleteAsync(OnOperationResponseDelegate);

  You can also use native callbacks that accept lambdas instead of dynamic delegates. Native callback types have the Native suffix (for example, FOnPubnubChatOperationResponseNative).

• Synchronous methods (no suffix) block the main game thread until the operation completes and return a result struct directly.

  1FPubnubChatOperationResult Result = User->Delete();

• User->Delete() - call on a User object (no ID needed)
• Chat->DeleteUser() - call on a Chat object (requires user ID)

Requires App Context

Enable App Context in the Admin Portal to store user data.

Delete a user (hard delete)

Method signature

C++ / Input parameters

• User->Delete()

  1User->Delete();

• Chat->DeleteUser()

  1Chat->DeleteUser(FString UserID);

Parameter	Required in User->Delete()	Required in Chat->DeleteUser()	Description
UserID Type: FString Default: n/a	No	Yes	Unique user identifier (up to 92 UTF-8 characters).

Blueprint

Output

Type	Description
FPubnubChatOperationResult	Returned object containing Error (bool) and ErrorMessage (FString).

Sample code

Reference code

This example is a self-contained code snippet ready to be run. Set up your Unreal project and follow the instructions in the lines marked with ACTION REQUIRED before running the code. Use it as a reference when working with other examples in this document.

Delete a user asynchronously.

C++

Actor.h

1

Actor.cpp

1

Blueprint

• Chat->DeleteUser()

C++

1

Blueprint