Links

Encode URLs (www, http, https) as clickable links or create hyperlinks with custom text.

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

Generic referencing

Channel references, user mentions, and links share the same MessageElement structure with different MentionTarget types.

Add links

AddMention() adds a link to a draft message. Use CreateUrlMentionTarget() to create a mention target linking to a specified URL.

Method signature

Call AddMention() with MentionTarget of type Url. See AddMention() for details.

Refer to the AddMention() method for details.

Sample code

Create the Hello Alex! I have sent you this link on the #offtopic channel. message where link is a URL.

// Create a message draft
UPubnubMessageDraft* MyMessageDraft = Channel->CreateMessageDraft();


// Insert the whole text to the message draft
MyMessageDraft->InsertText(0, "Hello Alex! I have sent you this link on the #offtopic channel.");


// Specify the URL to be included in the mention
FString Url = "https://www.example.com";
UPubnubMentionTarget* UrlMentionTarget = UPubnubMentionTarget::CreateUrlMentionTarget(Url);


// Add the mention for the URL starting from where "link" is inserted
MyMessageDraft->AddMention(33, 4, UrlMentionTarget); // 'link' is 4 characters long


// Send the message draft with the mentions
MyMessageDraft->Send();

Remove links

RemoveMention() removes a link from a draft message.

Method signature

Call RemoveMention() at the exact offset where the link starts. See RemoveMention() for details.

Refer to the RemoveMention() method for details.

Offset value

Provide the exact position of the first character; otherwise the element is not removed.

Sample code

Remove the link from the Hello Alex! I have sent you this link on the #offtopic channel. message where link is a URL.

1// Assume the message reads
2// Hello Alex! I have sent you this link on the #offtopic channel.`
3// Remove the link mention
4MessageDraft->RemoveMention(33)

Get link suggestions

The message elements listener returns link suggestions along with user mentions and channel references.

AddChangeListenerWithSuggestions():

• Monitors updates to a message draft's content
• Provides the current state of message elements (TArray<UPubnubMessageElement*>)
• Offers FPubnubSuggestedMention items suggesting user mentions, links, or channel references

Unlike AddChangeListener(), which only tracks content changes, this method includes suggestion data for dynamic draft updates.

Single listener

Method signature

Refer to the Add a message draft listener section for details.

Sample code

Insert the first suggested link whenever the draft is updated and links are detected.

1// Assuming you have a UPubnubMessageDraft pointer named MyMessageDraft
2

3// Define your callback function to handle updates with suggestions
4void AMyActor::OnMessageDraftUpdateWithSuggestions(const TArray<UPubnubMessageElement*>& MessageElements, const TArray<FPubnubSuggestedMention>& SuggestedMentions)
5{
6    // Check if there are any suggested mentions
7    if (SuggestedMentions.Num() == 0)
8    {
9        return;
10    }
11

12    // Insert the first suggested mention into the draft
13    const FPubnubSuggestedMention& FirstMention = SuggestedMentions[0];
14    MyMessageDraft->InsertSuggestedMention(FirstMention, FirstMention.ReplaceTo);
15}
16

17// Set up the delegate to bind your callback
18FOnPubnubDraftUpdatedWithSuggestions DraftUpdateCallbackWithSuggestions;
19DraftUpdateCallbackWithSuggestions.BindDynamic(this, &AMyActor::OnMessageDraftUpdateWithSuggestions);
20

21// Add change listener with suggestions to the message draft
22MyMessageDraft->AddChangeListenerWithSuggestions(DraftUpdateCallbackWithSuggestions);
23

24// Example update to message draft
25MyMessageDraft->Update("Alex, update the link to https://www.pubnub.com ");

show all 25 lines

Get text links

TextLinks() returns all text links in a message.

Method signature

Blueprint

C++ / Input parameters

1Message->TextLinks();

Output

Type	Description
TArray<FPubnubTextLink>	Array of text links included in the message.

Sample code

Get all text links included in the message with the 16200000000000000 timetoken.

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 Timetoken = "16200000000000001";
12

13// Fetch the message
14UPubnubMessage* Message = Channel->GetMessage(Timetoken);
15

16TArray<FPubnubTextLink> Links = Message->TextLinks();

show all 16 lines