Join channels

Requires App Context

Enable App Context on your keyset in the Admin Portal to manage memberships.

Use Join() to create a channel membership for the user. The user is recorded as a channel member.

Receiving messages after joining

Join() creates the membership but does not subscribe to the channel. To start receiving messages, bind the channel's OnMessageReceived delegate and call Connect() separately after Join() returns.

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.

  1Channel->JoinAsync(MembershipData, OnJoinResponseDelegate);

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

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

  1FPubnubChatJoinResult Result = Channel->Join(MembershipData);

Method signature

C++ / Input parameters

1Channel->Join(
2    FPubnubChatMembershipData MembershipData = FPubnubChatMembershipData()
3);

Blueprint

* required

Parameter	Description
MembershipData Type: FPubnubChatMembershipData Default: FPubnubChatMembershipData()	The object containing all membership data. For more information, refer to FPubnubChatMembershipData.

Output

Type	Description
FPubnubChatJoinResult	Contains Result (FPubnubChatOperationResult with Error/ErrorMessage) and Membership (UPubnubChatMembership*).

Sample code

Join the support channel and mark this membership as premium to add information about your support plan.

C++

1

Blueprint