Delete users

Remove users with DeleteUser().

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++

• User->DeleteUser() - 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

Blueprint

C++ / Input parameters

• User->DeleteUser()

  1User->DeleteUser()

• Chat->DeleteUser()

  1Chat->DeleteUser(FString UserID)

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

Output

These methods don't return any value.

Sample code

Delete user support_agent_15.

• User->DeleteUser()

  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
  
  9// Define user ID
  10FString UserID = "support_agent_15";
  11
  
  12// Get the user and save the reference
  13UPubnubUser* User = Chat->GetUser(UserID);
  14
  
  15User->DeleteUser();

• Chat->DeleteUser()

  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
  
  9Chat->DeleteUser("support-agent-15");