List all users

GetUsers() returns a paginated list of all users with their metadata.

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 App Context

Enable App Context in the Admin Portal to store user data. If using Access Manager, uncheck Disallow Get All User Metadata in the App Context configuration.

Method signature

Blueprint

C++ / Input parameters

1Chat->GetUsers(
2    FString Filter = "", 
3    FString Sort = "", 
4    int Limit = 0, 
5    FPubnubPage Page = FPubnubPage()
6);

* required

Parameter	Description
Filter Type: FString Default: n/a	Expression used to filter the results. Returns only these channels whose properties satisfy the given expression are returned. The filter language is defined here.
Sort Type: FString Default: n/a	Key-value pair of a property to sort by, and a sort direction. Available options are id, name, and updated. Use asc or desc to specify the sorting direction, or specify null to take the default sorting direction (ascending). For example: {name: "asc"}. By default, the items are sorted by the last updated date.
Limit Type: int Default: 100	Number of objects to return in response. The default (and maximum) value is 100.
Page Type: FPubnubPage Default: n/a	Object used for pagination to define which previous or next result page you want to fetch.
→ Next Type: FString Default: n/a	Random string returned from the server, indicating a specific position in a data set. Used for forward pagination, it fetches the next page, allowing you to continue from where you left off.
→ Prev Type: FString Default: n/a	Random string returned from the server, indicating a specific position in a data set. Used for backward pagination, it fetches the previous page, enabling access to earlier data. Ignored if the Next parameter is supplied.

Output

Parameter	Description
FPubnubUsersResponseWrapper Type: struct	Returned object containing three fields: Users, Page, and Total.
→ Users Type: TArray<UPubnubUser*>	Array of all matching users.
→ Page Type: FPubnubPage	String that lets you either fetch the next (Next) or previous (Prev) result page.
→ Next Type: FString	Random string returned from the server, indicating a specific position in a data set. Used for forward pagination, it fetches the next page, allowing you to continue from where you left off.
→ Prev Type: FString	Random string returned from the server, indicating a specific position in a data set. Used for backward pagination, it fetches the previous page, enabling access to earlier data. Ignored if the Next parameter is supplied.
→ Total Type: int	Total number of User objects matching the request query.

Sample code

Fetch all existing user IDs.

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

9FPubnubUsersResponseWrapper Users = Chat->GetUsers();

Other examples

Pagination

Get the total number of 25 users and then specify that you want to fetch the results from the next page using a string that was previously returned from the PubNub server.

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

9FPubnubUsersResponseWrapper Users = Chat->GetUsers();
10// Fetch the first 25 users (result page 1)
11int Limit = 25;
12FPubnubUsersResponseWrapper UsersResponsePage1 = Chat->GetUsers("", "", Limit);
13

14// Process the first page of users
15for (UPubnubUser* User : UsersResponsePage1.Users)
16{
17    FString UserID = User->GetUserID();
18    UE_LOG(LogTemp, Log, TEXT("User ID: %s"), *UserID);
19}
20

21// Fetch the next 25 users if a next page token is available (result page 2)
22if (!UsersResponsePage1.Page.Next.IsEmpty())
23{
24    FPubnubPage NextPage;
25    NextPage.Next = UsersResponsePage1.Page.Next;
26

27    FPubnubUsersResponseWrapper UsersResponsePage2 = Chat->GetUsers("", "", Limit, NextPage);
28

29    // Process the second page of users
30    for (UPubnubUser* User : UsersResponsePage2.Users)
31    {
32        FString UserID = User->GetUserID();
33        UE_LOG(LogTemp, Log, TEXT("User ID: %s"), *UserID);
34    }
35}

show all 35 lines

Archived users

Get all archived users. This request will return all soft-deleted users whose data is still stored in the App Context storage.

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

9FString Filter = "status=='deleted'";
10

11// Fetch all archived users with the filter applied
12FPubnubUsersResponseWrapper ArchivedUsersResponse = Chat->GetUsers(Filter);
13

14// Process and log the archived users
15for (UPubnubUser* User : ArchivedUsersResponse.Users)
16{
17    FString UserId = User->GetUserID();
18    UE_LOG(LogTemp, Log, TEXT("Archived User ID: %s"), *UserId);
19}

show all 19 lines