Message object

Message represents a single message published on a chat channel.

Properties

Message has the following properties:

1public class Message : UniqueChatEntity {
2    public string Id { get; protected set; }
3    public string MessageText { get; }
4    public string OriginalMessageText { get; }
5    public string TimeToken { get; }
6    public string ChannelId { get; }
7    public string UserId { get; }
8    public Dictionary<string, object> Meta { get; }
9    public bool IsDeleted { get; }
10    public List<MentionedUser> MentionedUsers { get; }
11    public List<ReferencedChannel> ReferencedChannels { get; }
12    public List<TextLink> TextLinks { get; }
13    public List<MessageAction> MessageActions { get; }
14    public List<MessageAction> Reactions { get; }
15    public List<ChatFile> Files { get; }
16}

show all 16 lines

Id#

type: Type: string

Unique identifier for the message which is a message timetoken.

MessageText#

type: Type: string

Text content of the message. This is the main content sent by the user.

OriginalMessageText#

type: Type: string

Original text content of the message, before any edits.

TimeToken#

type: Type: string

A timestamp that helps order messages in a conversation.

ChannelId#

type: Type: string

Unique identifier for the channel or group in which the message was sent.

UserId#

type: Type: string

Unique ID of the user who sent the message. Do not confuse this with the username of the user.

Meta#

type: Type: Dictionary<string, object>

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.

IsDeleted#

type: Type: bool

Indicates whether the message has been deleted. If the message has been deleted, this property will be true.

MentionedUsers#

type: Type: List<MentionedUser>

List of users mentioned in the message.

ReferencedChannels#

type: Type: List<ReferencedChannel>

List of channels referenced in the message.

TextLinks#

type: Type: List<TextLink>

List of links included in the message.

MessageActions#

type: Type: List<MessageAction>

Any action associated with the message (like edited or deleted).

Reactions#

type: Type: List<MessageAction>

All message reactions added to the message by other users.

Files#

type: Type: List<ChatFile>

List of files attached to the message. Refer to Files for more details.

The message reaction takes the following properties:

1public struct MessageAction
2{
3    public PubnubMessageActionType Type;
4    public string Value;
5    public string TimeToken;
6    public string UserId;
7}

Depending on how a message was manipulated (what action was taken on it), it is assigned a different action type.

1public enum PubnubMessageActionType
2{
3    Reaction,
4    Receipt,
5    Custom,
6    Edited,
7    Deleted,
8    ThreadRootId
9}

Message-related types

Events

The Message object has the following event:

1// Event triggered when a message is updated — enabled by StreamUpdates()
2public event Action<Message> OnUpdated;

Example

An event that is triggered when a message is updated by the server.

1

Methods

You can call the following methods on the Message object.

Click on each method for more details.

Standard methods

• CreateThread()
• Delete()
• EditMessageText()
• Forward()
• GetMessageElements()
• GetQuotedMessage()
• GetThread()
• HasThread()
• HasUserReaction()
• MessageReactions()
• Pin()
• RemoveThread()
• Report()
• Restore()
• ToggleReaction()

Streaming methods

These methods register or unregister real-time event subscriptions. Each streaming method activates one or more of the events listed in the Events section above.

• StreamUpdates()
• 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