Message object

Message is an object that refers to 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: EPubnubChatMessageType	The type of the message. EPubnubChatMessageType::PCMT_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: Array<FPubnubMessageAction>	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

  1enum class EPubnubChatMessageType : uint8
  2{
  3    PCMT_TEXT			 UMETA(DisplayName="Text")
  4};

• MessageActions

  1// struct FPubnubMessageAction
  2
  
  3UPROPERTY(BlueprintReadWrite, VisibleAnywhere) EPubnubMessageActionType Type = EPubnubMessageActionType::PMAT_Reaction;
  4UPROPERTY(BlueprintReadWrite, VisibleAnywhere) FString Value = "";
  5UPROPERTY(BlueprintReadWrite, VisibleAnywhere) FString Timetoken = "";
  6UPROPERTY(BlueprintReadWrite, VisibleAnywhere) FString UserID = "";
  7
  
  8// enum EPubnubMessageActionType
  9
  
  10enum class EPubnubMessageActionType : uint8
  11{
  12    PMAT_Reaction			 UMETA(DisplayName="Reaction"),
  13    PMAT_Receipt			 UMETA(DisplayName="Receipt"),
  14    PMAT_Custom				 UMETA(DisplayName="Custom"),
  15    PMAT_Edited				 UMETA(DisplayName="Edited"),
  16    PMAT_Deleted			 UMETA(DisplayName="Deleted")
  17};

  show all 17 lines

A single text message has the EPubnubChatMessageType::PCMT_TEXT type.

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, EPubnubMessageActionType::PMAT_Edited.

Message-related types

Methods

You can call the following methods on the Message object.

Click on each method for more details.

• CreateThread()
• Delete()
• Deleted()
• EditText()
• Forward()
• GetTextLinks()
• GetThread()
• HasUserReaction()
• ToggleReaction()
• Pin()
• QuotedMessage()
• Reactions()
• Report()
• StreamUpdates()
• StreamUpdatesOn()
• Text()
• TextLinks()

Use case

For example, you can use the Message object methods to:

• Let users send, update, and delete messages.
• Forward messages to others.
• Pin messages to channels.
• Quote messages.
• React to messages.
• Report messages to the admin if they are offensive.