List all channels

Get a paginated list of all channels with GetChannels(). Custom channel metadata is included by default.

Requires App Context

Enable App Context for your keyset in the Admin Portal.

With Access Manager enabled, uncheck Disallow Get All Channel Metadata in the App Context configuration to retrieve all channel metadata without defining permissions in the authentication token.

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

To list channels a user belongs to, use GetMemberships() instead.

Method signature

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

* required

Parameter	Description
Limit Type: int Default: 0	Number of objects to return in response.
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: FPubnubGetAllSort 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.
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
FPubnubChatGetChannelsResult Type: struct	Returned object containing these fields: Result, Channels, Page, and Total.
→ Result Type: FPubnubChatOperationResult	Operation result with Error (bool) and ErrorMessage (FString).
→ Channels Type: TArray<UPubnubChatChannel*>	Array of all matching Channel objects.
→ Page Type: FPubnubPage	Struct 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 Channel objects matching the request query.

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.

Retrieve a paginated list of channels asynchronously.

Actor.h

1

Actor.cpp

1

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.

Actor.h

1

Actor.cpp

1

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.

Actor.h

1

Actor.cpp

1