Manage user details

Retrieve user details from your app.

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.

  1Chat->GetUserAsync(UserID, OnGetUserResponseDelegate);

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

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

  1FPubnubChatUserResult Result = Chat->GetUser(UserID);

Get user details

GetUser() returns data about a specific user, including all custom metadata by default.

Requires App Context

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

Method signature

C++ / Input parameters

1Chat->GetUser(FString UserID)

* required

Parameter	Description
UserID * Type: FString	Unique user identifier.

Blueprint

Output

Type	Description
FPubnubChatUserResult	Returned object containing Result (FPubnubChatOperationResult) and User (UPubnubChatUser*). The user is nullptr if not found.

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.

Fetch a user by ID asynchronously.

C++

Actor.h

1

Actor.cpp

1

Blueprint

Get current user

GetCurrentUser() returns the current chat user.

Requires App Context

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

Method signature

C++ / Input parameters

1Chat->GetCurrentUser();

Blueprint

Output

Type	Description
UPubnubChatUser*	Returned User object.

Sample code

Return the current chat user.

C++

1

Blueprint

Get user ID

GetUserID() returns the current chat user's ID.

Method signature

C++ / Input parameters

1User->GetUserID();

Blueprint

Output

Type	Description
FString	Returned user ID.

Sample code

Return the current chat user's ID.

C++

1

Blueprint

Get user data

GetUserData() returns the current chat user's data.

Method signature

C++ / Input parameters

1User->GetUserData();

Blueprint

Output

Type	Description
FPubnubChatUserData	Returned user data from the local cache.

Sample code

Return the current chat user's data.

C++

1

Blueprint