Message object

Message represents a single message published on a chat channel.

Properties

The Message object has the following properties:

Parameter	Description
Timetoken Type: FString	Unique identifier for the message, possibly a timestamp or similar value that helps order messages in a conversation.
MessageData Type: FPubnubChatMessageData	Additional data.
> Type Type: FString	The type of the message. "text" by default.
> Text Type: FString	Original text content of the message.
> ChannelID Type: FString	Unique identifier for the channel or group in which the message was sent.
> UserID Type: FString	Unique ID of the user who sent the message.
> Meta Type: FString	Extra information added to the message giving additional context. This object can be of any type and can consist of a list of key-value pairs. For example, {language: 'English', wordCount: 42}.
> MessageActions Type: TArray<FPubnubChatMessageAction>	Any actions associated with the message, such as reactions, replies, or other interactive elements.

The message and message reaction types defined for the Message object take the following parameters:

• Type

  The message type is represented as an FString. A single text message has the type "text".

• MessageActions

  1// struct FPubnubChatMessageAction
  2
  
  3UPROPERTY(BlueprintReadWrite, VisibleAnywhere) EPubnubChatMessageActionType Type = EPubnubChatMessageActionType::PCMAT_Reaction;
  4UPROPERTY(BlueprintReadWrite, VisibleAnywhere) FString Value = "";
  5UPROPERTY(BlueprintReadWrite, VisibleAnywhere) FString Timetoken = "";
  6UPROPERTY(BlueprintReadWrite, VisibleAnywhere) FString UserID = "";
  7
  
  8// enum EPubnubChatMessageActionType
  9
  
  10enum class EPubnubChatMessageActionType : uint8
  11{
  12    PCMAT_Reaction           UMETA(DisplayName="Reaction"),
  13    PCMAT_Receipt            UMETA(DisplayName="Receipt"),
  14    PCMAT_Custom             UMETA(DisplayName="Custom"),
  15    PCMAT_Edited             UMETA(DisplayName="Edited"),
  16    PCMAT_Deleted            UMETA(DisplayName="Deleted"),
  17    PCMAT_ThreadRootId       UMETA(DisplayName="ThreadRootId")
  18};

  show all 18 lines

Depending on how a message was manipulated (what action was taken on it), it is assigned a different action type (for adding a message reaction to a message, editing, or deleting a message). For example, EPubnubChatMessageActionType::PCMAT_Edited.

Message-related types

Methods

You can call the following methods on the Message object.

Click on each method for more details.

• CreateThread()
• Delete()
• EditText()
• Forward()
• GetCurrentText()
• GetMessageTimetoken()
• GetReactions()
• GetThread()
• GetType()
• HasThread()
• HasUserReaction()
• IsDeleted()
• Pin()
• RemoveThread()
• Report()
• Restore()
• ToggleReaction()
• Unpin()

Streaming

Call these methods to subscribe to or unsubscribe from real-time updates for this Message object.

• StreamUpdates()
• StopStreamingUpdates()
• StreamUpdatesOn()

Use case

Message methods enable:

• Updating and deleting messages
• Forwarding messages to others
• Pinning messages to channels
• Quoting messages
• Reacting to messages
• Reporting offensive messages