Get channel details

Fetch a specific channel's metadata with GetChannel().

Requires App Context

Enable App Context for your keyset in the Admin Portal.

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->GetChannelAsync("support", OnGetChannelResponseDelegate);

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

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

  1FPubnubChatChannelResult Result = Chat->GetChannel("support");

Get channel

Method signature

C++ / Input parameters

1Chat->GetChannel(FString ChannelID)

* required

Parameter	Description
ChannelID * Type: FString Default: n/a	Unique channel identifier (up to 92 UTF-8 byte sequences).

Blueprint

Output

Parameter	Description
FPubnubChatChannelResult Type: struct	Returned object containing Result and Channel.
→ Result Type: FPubnubChatOperationResult	Operation result with Error (bool) and ErrorMessage (FString).
→ Channel Type: UPubnubChatChannel*	The requested channel object, or nullptr if the channel doesn't exist.

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 channel by ID asynchronously.

C++

Actor.h

1

Actor.cpp

1

Blueprint

Get channel ID

GetChannelID is a getter method that returns the channel's ID.

Method signature

C++ / Input parameters

1Channel->GetChannelID();

Blueprint

Output

Type	Description
FString	Returned channel ID.

Sample code

Return the ID of the channel support.

C++

1

Blueprint

Get channel data

GetChannelData is a getter method that returns the channel's data.

Method signature

C++ / Input parameters

1Channel->GetChannelData();

Blueprint

Output

Type	Description
FPubnubChatChannelData	Returned channel data.

Sample code

Return channel data from the support channel.

C++

1

Blueprint