Channel Groups API for Unreal SDK

Channel groups allow PubNub developers to bundle thousands of channels into a group that can be identified by a name. These channel groups can then be subscribed to, receiving data from the many back-end channels the channel group contains.

Channel group operations

You can't publish to a channel group. You can only subscribe to it. To publish within the channel group, you need to publish to each channel individually.

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 calling the Pubnub Subsystem node.

• In a C++ project, you have to add a dependency to PubnubLibrary:

  1. In your IDE, navigate to Source/_{YourProject}_/_{YourProject}_.Build.cs and add a dependency to PubnubLibrary.

     PrivateDependencyModuleNames.AddRange(new string[] { "PubnubLibrary" });

  2. Compile the code and run the project.

• In C++, you can use the PubNub SDK as any other Game Instance Subsystem.

  #include "Kismet/GameplayStatics.h"
  #include "PubnubSubsystem.h"
  
  UGameInstance* GameInstance = UGameplayStatics::GetGameInstance(this);
  UPubnubSubsystem* PubnubSubsystem = GameInstance->GetSubsystem<UPubnubSubsystem>();

  PubnubSubsystem now allows you to call all PubNub SDK functions, for example:

  PubnubSubsystem->SubscribeToChannel("MyChannel");

Usage in Blueprints and C++

Add channels to a channel group - ChannelGroup entity

This method is available to use with the ChannelGroup entity. For more information, refer to ChannelGroup.

Available in entities

ChannelGroup

Requires Stream Controller add-on

This method requires the Stream Controller add-on enabled for your key in the Admin Portal. Read the support page on enabling add-on features.

This function adds a channel to a channel group.

Method(s)

Maximum number of channels

You can add up to 200 channels to a channel group per API call.

UPubnubChannelGroupEntity* ChannelGroupEntity = PubnubSubsystem->CreateChannelGroupEntity("my-channel-group");

ChannelGroupEntity->AddChannelToGroup(
    FString Channel,
    FOnAddChannelToGroupResponse OnAddChannelToGroupResponse
);

* required

Parameter	Description
Channel * Type: FString	The channel to add to the channel group.
OnAddChannelToGroupResponse * Type: FOnAddChannelToGroupResponse	The delegate for the operation's result. You can also use a native callback of the type FOnAddChannelToGroupResponseNative to handle the result using a lambda.

FOnAddChannelToGroupResponse

Field	Type	Description
Result	FPubnubOperationResult	The operation result.

FOnAddChannelToGroupResponseNative

Field	Type	Description
Result	const FPubnubOperationResult&	The operation result.

Sample code

Reference code

Set up your Unreal project and follow the instructions in the lines marked with ACTION REQUIRED before running the code.

C++

Actor.h

Actor.cpp

Returns

This method is void, but the delegate returns the FOnAddChannelToGroupResponse struct.

Other Examples

Reference code

Set up your Unreal project and follow the instructions in the lines marked with ACTION REQUIRED before running the code.

Add channels to a channel group with lambda

Use a lambda function to handle the response:

Actor.h

Actor.cpp

Add channels to a channel group with result struct

Use the result struct to handle the response:

Actor.h

Actor.cpp

Add channels to a channel group - PubNub client

Requires Stream Controller add-on

This method requires the Stream Controller add-on enabled for your key in the Admin Portal. Read the support page on enabling add-on features.

This function adds a channel to a channel group.

Method(s)

Adding Channels is accomplished by using the following method(s) in the Unreal SDK:

Maximum number of channels

You can add up to 200 channels to a channel group per API call.

PubnubSubsystem->AddChannelToGroup(
    FString Channel, 
    FString ChannelGroup, 
    FOnAddChannelToGroupResponse OnAddChannelToGroupResponse
);

* required

Parameter	Description
Channel * Type: FString	The channel to add to the channel group.
ChannelGroup * Type: FString	The channel group to add the channels to.
OnAddChannelToGroupResponse * Type: FOnAddChannelToGroupResponse	The delegate for the operation's result. You can also use a native callback of the type FOnAddChannelToGroupResponseNative to handle the result using a lambda.

FOnAddChannelToGroupResponse

Field	Type	Description
Result	FPubnubOperationResult	The operation result.

FOnAddChannelToGroupResponseNative

Field	Type	Description
Result	const FPubnubOperationResult&	The operation result.

Sample code

Reference code

Set up your Unreal project and follow the instructions in the lines marked with ACTION REQUIRED before running the code.

C++

Actor.h

Actor.cpp

Blueprint

Returns

This method doesn't return a value.

Other Examples

Reference code

Set up your Unreal project and follow the instructions in the lines marked with ACTION REQUIRED before running the code.

Add channels to a channel group with lambda

Use a lambda function to handle the response:

Actor.h

Actor.cpp

Add channels to a channel group with result struct

Use the result struct to handle the response:

Actor.h

Actor.cpp

List channels in a channel group - ChannelGroup entity

This method is available to use with the ChannelGroup entity. For more information, refer to ChannelGroup.

Available in entities

ChannelGroup

Requires Stream Controller add-on

This method requires the Stream Controller add-on enabled for your key in the Admin Portal. Read the support page on enabling add-on features.

This function lists all channels in the channel group.

Method(s)

UPubnubChannelGroupEntity* ChannelGroupEntity = PubnubSubsystem->CreateChannelGroupEntity("my-channel-group");

ChannelGroupEntity->ListChannelsFromGroup(
    FOnListChannelsFromGroupResponse OnListChannelsResponse
);

* required

Parameter	Description
OnListChannelsResponse * Type: FOnListChannelsFromGroupResponse	The operation result delegate. You can also use FOnListChannelsFromGroupResponseNative with a lambda.

FOnListChannelsFromGroupResponse

Field	Type	Description
Result	FPubnubOperationResult	The operation result.
Channels	TArray<FString>&	Channel names in the group.

FOnListChannelsFromGroupResponseNative

Field	Type	Description
Result	const FPubnubOperationResult&	The operation result.
Channels	const TArray<FString>&	Channel names in the group.

Sample code

Reference code

Set up your Unreal project and follow the instructions in the lines marked with ACTION REQUIRED before running the code.

C++

Actor.h

Actor.cpp

Returns

This function is void, but the delegate returns the FOnListChannelsFromGroupResponse struct.

Other Examples

Reference code

Set up your Unreal project and follow the instructions in the lines marked with ACTION REQUIRED before running the code.

List channels from a channel group with lambda

Use a lambda function to handle the response:

Actor.h

Actor.cpp

List channels from a channel group with result struct

Use the result struct to handle the response:

Actor.h

Actor.cpp

List channels in a channel group - PubNub client

Requires Stream Controller add-on

This method requires the Stream Controller add-on enabled for your key in the Admin Portal. Read the support page on enabling add-on features.

This function lists all channels in the channel group.

Method(s)

PubnubSubsystem->ListChannelsFromGroup(
    FString ChannelGroup, 
    FOnListChannelsFromGroupResponse OnListChannelsResponse
);

* required

Parameter	Description
ChannelGroup * Type: FString	The channel group to list channels of.
OnListChannelsResponse * Type: FOnListChannelsFromGroupResponse	The operation result delegate. You can also use FOnListChannelsFromGroupResponseNative with a lambda.

FOnListChannelsFromGroupResponse

Field	Type	Description
Result	FPubnubOperationResult	The operation result.
Channels	TArray<FString>&	Channel names in the group.

FOnListChannelsFromGroupResponseNative

Field	Type	Description
Result	const FPubnubOperationResult&	The operation result.
Channels	const TArray<FString>&	Channel names in the group.

Sample code

Reference code

Set up your Unreal project and follow the instructions in the lines marked with ACTION REQUIRED before running the code.

C++

Actor.h

Actor.cpp

Blueprint

Returns

This function is void, but the delegate returns the FOnListChannelsFromGroupResponse struct.

FOnListChannelsFromGroupResponse

Field	Type	Description
Result	FPubnubOperationResult	The operation result.
Channels	TArray<FString>&	Channel names in the group.

Other Examples

Reference code

Set up your Unreal project and follow the instructions in the lines marked with ACTION REQUIRED before running the code.

List channels from a channel group with lambda

Use a lambda function to handle the response:

Actor.h

Actor.cpp

Remove channels from a channel group - ChannelGroup entity

This method is available to use with the ChannelGroup entity. For more information, refer to ChannelGroup.

Available in entities

ChannelGroup

Requires Stream Controller add-on

This method requires the Stream Controller add-on enabled for your key in the Admin Portal. Read the support page on enabling add-on features.

This function removes channels from the channel group.

Method(s)

UPubnubChannelGroupEntity* ChannelGroupEntity = PubnubSubsystem->CreateChannelGroupEntity("my-channel-group");

ChannelGroupEntity->RemoveChannelFromGroup(
    FString Channel,
    FOnRemoveChannelFromGroupResponse OnRemoveChannelFromGroupResponse
);

* required

Parameter	Description
Channel * Type: FString	The channel to remove from the channel group.
OnRemoveChannelFromGroupResponse * Type: FOnRemoveChannelFromGroupResponse	The operation result delegate. You can also use FOnRemoveChannelFromGroupResponseNative with a lambda.

FOnRemoveChannelFromGroupResponse

Field	Type	Description
Result	FPubnubOperationResult	The operation result.

FOnRemoveChannelFromGroupResponseNative

Field	Type	Description
Result	const FPubnubOperationResult&	The operation result.

Sample code

Reference code

Set up your Unreal project and follow the instructions in the lines marked with ACTION REQUIRED before running the code.

C++

Actor.h

Actor.cpp

Returns

This method is void, but the delegate returns the FOnRemoveChannelFromGroupResponse struct.

Other Examples

Reference code

Set up your Unreal project and follow the instructions in the lines marked with ACTION REQUIRED before running the code.

Remove channels from a channel group with lambda

Use a lambda function to handle the response:

Actor.h

Actor.cpp

Remove channels from a channel group with result struct

Use the result struct to handle the response:

Actor.h

Actor.cpp

Remove channels from a channel group - PubNub client

Requires Stream Controller add-on

This method requires the Stream Controller add-on enabled for your key in the Admin Portal. Read the support page on enabling add-on features.

This function removes channels from the channel group.

Method(s)

PubnubSubsystem->RemoveChannelFromGroup(
    FString Channel, 
    FString ChannelGroup, 
    FOnRemoveChannelFromGroupResponse OnRemoveChannelFromGroupResponse
);

* required

Parameter	Description
ChannelGroup * Type: FString	The channel group to remove the channel from.
Channel * Type: FString	The channel to remove from the channel group.
OnRemoveChannelFromGroupResponse * Type: FOnRemoveChannelFromGroupResponse	The operation result delegate. You can also use FOnRemoveChannelFromGroupResponseNative with a lambda.

FOnRemoveChannelFromGroupResponse

Field	Type	Description
Result	FPubnubOperationResult	The operation result.

FOnRemoveChannelFromGroupResponseNative

Field	Type	Description
Result	const FPubnubOperationResult&	The operation result.

Sample code

Reference code

Set up your Unreal project and follow the instructions in the lines marked with ACTION REQUIRED before running the code.

C++

Actor.h

Actor.cpp

Blueprint

Returns

This method doesn't return a value.

Other Examples

Reference code

Set up your Unreal project and follow the instructions in the lines marked with ACTION REQUIRED before running the code.

Remove channels from a channel group with lambda

Use a lambda function to handle the response:

Actor.h

Actor.cpp

Remove channels from a channel group with result struct

Use the result struct to handle the response:

Actor.h

Actor.cpp

Delete a channel group - ChannelGroup entity

This method is available to use with the ChannelGroup entity. For more information, refer to ChannelGroup.

Available in entities

ChannelGroup

Requires Stream Controller add-on

This method requires the Stream Controller add-on enabled for your key in the Admin Portal. Read the support page on enabling add-on features.

This function removes a channel group.

Method(s)

UPubnubChannelGroupEntity* ChannelGroupEntity = PubnubSubsystem->CreateChannelGroupEntity("my-channel-group");

ChannelGroupEntity->RemoveChannelGroup(
    FOnRemoveChannelGroupResponse OnRemoveChannelGroupResponse
);

* required

Parameter	Description
OnRemoveChannelGroupResponse * Type: FOnRemoveChannelGroupResponse	The operation result delegate. You can also use FOnRemoveChannelGroupResponseNative with a lambda.

FOnRemoveChannelGroupResponse

Field	Type	Description
Result	FPubnubOperationResult	The operation result.

FOnRemoveChannelGroupResponseNative

Field	Type	Description
Result	const FPubnubOperationResult&	The operation result.

Sample code

Reference code

Set up your Unreal project and follow the instructions in the lines marked with ACTION REQUIRED before running the code.

C++

Actor.h

Actor.cpp

Returns

This method is void, but the delegate returns the FOnRemoveChannelGroupResponse struct.

Other Examples

Reference code

Set up your Unreal project and follow the instructions in the lines marked with ACTION REQUIRED before running the code.

Delete a channel group with lambda

Use a lambda function to handle the response:

Actor.h

Actor.cpp

Delete a channel group with result struct

Use the result struct to handle the response:

Actor.h

Actor.cpp

Delete a channel group - PubNub client

Requires Stream Controller add-on

This method requires the Stream Controller add-on enabled for your key in the Admin Portal. Read the support page on enabling add-on features.

This function removes a channel group.

Method(s)

PubnubSubsystem->RemoveChannelGroup(
    FString ChannelGroup, 
    FOnRemoveChannelGroupResponse OnRemoveChannelGroupResponse
);

* required

Parameter	Description
ChannelGroup * Type: FString	The channel group to remove.
OnRemoveChannelGroupResponse * Type: FOnRemoveChannelGroupResponse	The operation result delegate. You can also use FOnRemoveChannelGroupResponseNative with a lambda.

FOnRemoveChannelGroupResponse

Field	Type	Description
Result	FPubnubOperationResult	The operation result.

FOnRemoveChannelGroupResponseNative

Field	Type	Description
Result	const FPubnubOperationResult&	The operation result.

Sample code

Reference code

Set up your Unreal project and follow the instructions in the lines marked with ACTION REQUIRED before running the code.

C++

Actor.h

Actor.cpp

Blueprint

Returns

This method doesn't return a value.

Other Examples

Reference code

Set up your Unreal project and follow the instructions in the lines marked with ACTION REQUIRED before running the code.

Delete a channel group with lambda

Use a lambda function to handle the response:

Actor.h

Actor.cpp

Delete a channel group with result struct

Use the result struct to handle the response:

Actor.h

Actor.cpp

Complete example

Reference code

Set up your Unreal project and follow the instructions in the lines marked with ACTION REQUIRED before running the code.

ASample_GroupsFull.h

ASample_GroupsFull.cpp