Pinned messages

Pin messages to channels for easy access. Only one message can be pinned per channel at a time.

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

Use cases:

• Essential announcements and updates
• Action items and reminders
• Polls and persistent questions

Requires App Context and Message Persistence

Enable App Context and Message Persistence in the Admin Portal.

Pin

Pin() and PinMessage() attach a message to a channel. Call Pin() on a message object or PinMessage() on a channel object.

Alternatively, pin thread messages to the thread channel or parent channel.

Method signature

Blueprint

C++ / Input parameters

• Message->Pin()

  1Message->Pin();
  2
  

• Channel->PinMessage()

  1Channel->PinMessage(UPubnubMessage* Message);

Parameter	Required in Pin()	Required in PinMessage()	Description
Message Type: UPubnubMessage* Default: n/a	No	Yes	Message object that you want to pin to the selected channel.

Output

Type	In Pin()	In PinMessage()	Description
void	Yes	No	Method returns no output data.
UPubnubChannel*	No	Yes	Object returning the channel metadata updated with these custom fields: pinnedMessageTimetoken to mark the timetoken when the message was pinned pinnedMessageChannelID to mark the channel on which the message was pinned to the given channel (pinning was performed either directly on the parent channel or on a thread channel).

Sample code

Pin a message on the incident-management channel.

• Pin()

  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("incident-management");
  10
  
  11FString Timetoken = "16200000000000001";
  12
  
  13// Fetch the message
  14UPubnubMessage* Message = Channel->GetMessage(Timetoken);
  15
  
  16Message->Pin();

  show all 16 lines

• PinMessage()

  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("incident-management");
  10
  
  11// Fetch the message
  12UPubnubMessage* Message = Channel->GetMessage(Timetoken);
  13
  
  14Channel->PinMessage(Message);

Get

GetPinnedMessage() retrieves the currently pinned message.

Method signature

Blueprint

C++ / Input parameters

• Channel->GetPinnedMessage()

  1Channel->GetPinnedMessage();

Output

Type	Description
UPubnubMessage*	Object returning either the pinned Message object or null value if no message is currently pinned to the channel.

Sample code

Get the message pinned to the incident-management 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("incident-management");
10

11// Fetch the pinned message
12UPubnubMessage* PinnedMessage = Channel->GetPinnedMessage();

Unpin

UnpinMessage() unpins a message from the channel.

Alternatively, unpin thread messages from the thread channel or parent channel.

Method signature

Blueprint

C++ / Input parameters

1Channel->UnpinMessage();

Output

Type	Description
UPubnubChannel*	Object returning the channel metadata updated with these custom fields: pinnedMessageTimetoken to mark the timetoken when the message was unpinned pinnedMessageChannelID to mark the channel on which the message was unpinned from the given channel (unpinning was performed either directly on the parent channel or on a thread channel).

Sample code

Unpin the message from the incident-management 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("incident-management");
10

11Channel->UnpinMessage();