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

Get channel

Method signature

Blueprint

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).

Output

Type	Description
UPubnubChannel*	Object returning either the new channel metadata or null value if the channel doesn't exist.

Sample code

Fetch the support channel metadata.

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

9UPubnubChannel* Channel = Chat->GetChannel("support");

Get channel ID

GetChannelID is a getter method that returns the current chat user's ID.

Method signature

Blueprint

C++ / Input parameters

1Channel->GetChannelID();

Output

Type	Description
FString*	Returned channel ID.

Sample code

Return the ID of the channel support.

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

9UPubnubChannel* Channel = Chat->GetChannel("support");
10

11FString ChannelID = Channel->GetChannelID();

Get channel data

GetChannelData is a getter method that returns the current chat user's data.

Method signature

Blueprint

C++ / Input parameters

1Channel->GetChannelData();

Output

Type	Description
FPubnubChatChannelData*	Returned channel data.

Sample code

Return channel data from the support channel.

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

9UPubnubChannel* Channel = Chat->GetChannel("support");
10

11FPubnubChatChannelData* ChannelData = Channel->GetChannelData();