List all channels

GetChannels() returns a paginated list of all existing channels.

By default, this method returns all custom channel metadata without the need to explicitly define that during the call.

Usage in Blueprints and C++

Requires App Context

To store data about channels, you must enable App Context for your app's keyset in the Admin Portal.

If you have Access Manager enabled in your app, uncheck the Disallow Get All Channel Metadata option in the App Context configuration in the Admin Portal – this way you can get metadata of all channels without the need to define that in the permissions schema included in the authentication token.

To get a list of all channels a user is a member of, use the GetMemberships() method.

Method signature

Blueprint

C++ / Input parameters

Chat->GetChannels(
    FString Filter = "", 
    FString Sort = "", 
    int Limit = 0, 
    FPubnubPage Page = FPubnubPage()
);

Parameter	Type	Required	Default	Description
Filter	FString	No	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	FString	No	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	int	No	100	Number of objects to return in response. The default (and maximum) value is 100.
Page	FPubnubPage	No	n/a	Object used for pagination to define which previous or next result page you want to fetch.
→ Next	FString	No	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	FString	No	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	Type	Description
FPubnubChannelsResponseWrapper	struct	Returned object containing three fields: Channels, Page, and Total.
→ Channels	TArray<UPubnubChannel*>	Array of all matching Channel objects.
→ Page	FPubnubPage	Struct that lets you either fetch the next (next) or previous (prev) result page.
→ Next	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	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	int	Total number of Channel objects matching the request query.

Basic usage

Fetch all existing channel IDs.

#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");

FPubnubChannelsResponseWrapper Channels = Chat->GetChannels("", "", 100);

Other examples

Pagination

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

#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");

// Fetch first 25 channels (result page 1)
FPubnubChannelsResponseWrapper Channels = Chat->GetChannels("", "", 25);

// Handle the channels retrieved from first request
for (auto& Channel : Channels.Channels) {
    FString ChannelID = Channel->GetChannelID();
    // Process the ChannelID

show all 28 lines

Archived channels

Get all archived channels. This request will return all channels removed with the soft option set to true, whose data is still stored in the App Context storage.

#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");

// Fetch all archived channels
FPubnubChannelsResponseWrapper Channels = Chat->GetChannels("status=='deleted'", "", 100);

for (auto& Channel : Channels.Channels) {
    FString ChannelID = Channel->GetChannelID();
    // Process the ChannelID
}

show all 23 lines