Manage message updates

Requires Message Persistence

Enable Message Persistence in the Admin Portal.

Edit messages and receive real-time update events.

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.

  1Message->EditTextAsync(NewText, OnEditTextResponseDelegate);

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

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

  1FPubnubChatOperationResult Result = Message->EditText(NewText);

Edit messages

EditText() replaces an existing message's content.

Method signature

Blueprint

C++ / Input parameters

1Message->EditText(FString NewText);

* required

Parameter	Description
NewText * Type: FString Default: n/a	New/updated text that you want to add in place of the existing message.

Output

Type	Description
FPubnubChatOperationResult	Result of the operation. Check Error and ErrorMessage for failure.

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.

Edit message text asynchronously.

C++

Actor.h

1

Actor.cpp

1

Blueprint

Get message updates

Receive real-time updates when messages or reactions change:

• StreamUpdates() - updates for a single Message object
• StreamUpdatesOn() - updates for multiple Message objects

Bind the message's OnUpdated delegate (Blueprint) or OnUpdatedNative delegate (C++) before calling StreamUpdates(). Call StopStreamingUpdates() to stop receiving updates.

Stream update behavior

• StreamUpdates() fires the message's OnUpdated delegate with (FString Timetoken, FPubnubChatMessageData MessageData) on each change.
• StreamUpdatesOn() is a static method that calls StreamUpdates() on each message in the array. Each message fires its own OnUpdated delegate individually.

Method signature

Blueprint

C++ / Input parameters

• StreamUpdates()

  1Message->StreamUpdates();

• StreamUpdatesOn()

  1UPubnubChatMessage::StreamUpdatesOn(TArray<UPubnubChatMessage*> Messages);

• StopStreamingUpdates()

  1Message->StopStreamingUpdates();

Parameter	Required in StreamUpdatesOn()	Description
Messages Type: TArray<UPubnubChatMessage*> Default: n/a	Yes	Array of Message objects for which you want to get updates.

Output

Method	Return type	Description
StreamUpdates()	FPubnubChatOperationResult	Result of the operation. Check Error for failure.
StreamUpdatesOn()	FPubnubChatOperationResult	Result of the operation. Check Error for failure.
StopStreamingUpdates()	FPubnubChatOperationResult	Result of the operation. Check Error for failure.

Sample code

• StreamUpdates()

  Get message and message reaction-related updates for a message published on the support channel.

C++

1

Blueprint

Other examples

Stop listening to updates for a message.

Actor.h

1

Actor.cpp

1