Create users

Use CreateUser() to create a new User with a unique User ID.

Requires App Context

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

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

Method signature

Blueprint

C++ / Input parameters

1Chat->CreateUser(
2    FString UserID, 
3    FPubnubChatUserData UserData
4);

* required

Parameter	Description
UserID * Type: FString	Unique user identifier.
UserData * Type: FPubnubChatUserData	Additional user data.

FPubnubChatUserData

* required

Parameter	Description
UserName Type: FString Default: n/a	Display name for the user (must not be empty or consist only of whitespace characters).
ExternalID Type: FString Default: n/a	User's identifier in an external system. You can use it to match id with a similar identifier from an external database.
ProfileUrl Type: FString Default: n/a	URL of the user's profile picture.
Email Type: FString Default: n/a	User's email address.
CustomDataJson Type: FString Default: n/a	JSON providing custom data about the user. Values must be scalar only; arrays or objects are not supported. Filtering App Context data through the custom property is not recommended in SDKs.
Status Type: FString Default: n/a	Tag that lets you categorize your app users by their current state. The tag choice is entirely up to you and depends on your use case. For example, you can use status to mark users in your chat app as invited, active, or archived.
Type Type: FString Default: n/a	Tag that lets you categorize your app users by their functional roles. The tag choice is entirely up to you and depends on your use case. For example, you can use type to group users by their roles in your app, such as moderator, player, or support-agent.

API limits

To learn about the maximum length of parameters used to set user metadata, refer to REST API docs.

Output

Type	Description
UPubnubUser*	Returned object containing the new user data.

Errors

If you try to create a user without providing their ID, you will receive the ID is required error. If you try to create a user that already exists, you will receive the User with this ID already exists error.

Sample code

Create a user with an ID of support_agent_15. Specify their name, avatar, and custom attributes, such as their title and the LinkedIn profile URL.

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 data
10FString UserID = "UniqueUser123";
11

12FPubnubChatUserData UserData;
13UserData.UserName = "JohnDoe";
14UserData.ExternalID = "External123";
15UserData.ProfileUrl = "http://example.com/profile/johndoe.jpg";
16UserData.Email = "johndoe@example.com";
17UserData.CustomDataJson = "{\"key1\": \"value1\", \"key2\": \"value2\"}";
18UserData.Status = "active";
19UserData.Type = "user";
20

21// Create the user and save the reference
22UPubnubUser* User = Chat->CreateUser(UserID, UserData);

show all 22 lines