Class Message

constructor

• new Message(raw, _peers, isScheduled?): Message

• Parameters

  • raw: TypeMessage
  • _peers: PeersIndex
  • isScheduled: boolean = false

    Whether the message is scheduled. If it is, then its date is set to future.

  Returns Message

Readonly_peers

ReadonlyisScheduled

Readonlyraw

action

• get action(): MessageAction

• Message action. null for non-service messages or for unsupported events.

  For unsupported events, use .raw.action directly.

  Returns MessageAction

canBeForwarded

• get canBeForwarded(): boolean

• Whether this message can be forwarded

  false for service mesasges and private restricted chats/chanenls

  Returns boolean

chat

• get chat(): Chat

• Conversation the message belongs to

  Returns Chat

date

• get date(): Date

• Date when the message was sent

  Returns Date

editDate

• get editDate(): null | Date

• Date when the message was last edited

  Returns null | Date

effectId

• get effectId(): null | Long

• If this message was sent with a message effect, ID of the effect

  Returns null | Long

entities

• get entities(): readonly MessageEntity[]

• Message text/caption entities (may be empty)

  Returns readonly MessageEntity[]

factCheck

• get factCheck(): null | FactCheck

• Information about fact-check added to the message, if any

  Returns null | FactCheck

forward

• get forward(): null | MessageForwardInfo

• If this message is a forward, contains info about it.

  Returns null | MessageForwardInfo

forwards

• get forwards(): null | number

• For channel posts, number of forwards

  null for service messages and non-post messages, or if the current user is not an admin in the channel

  Returns null | number

groupedId

• get groupedId(): null | Long

• Multiple media messages with the same grouped ID indicate an album or media group

  null for service messages and non-grouped messages

  Returns null | Long

groupedIdUnique

• get groupedIdUnique(): null | string

• Same as groupedId, but is globally unique across chats.

  Returns null | string

hasUnreadMedia

• get hasUnreadMedia(): boolean

• Whether there are unread media attachments in this message

  Returns boolean

hideEditMark

• get hideEditMark(): boolean

• Whether the message should be considered unedited, even if editDate ≠ null

  Returns boolean

id

• get id(): number

• Unique message identifier inside this chat

  Returns number

invertMedia

• get invertMedia(): boolean

• If set, any eventual webpage preview should be shown on top of the message instead of at the bottom.

  Returns boolean

isAutomaticForward

• get isAutomaticForward(): boolean

• Whether the message is a channel post that was automatically forwarded to the connected discussion group

  Returns boolean

isChannelPost

• get isChannelPost(): boolean

• Whether this is a broadcast channel post

  Returns boolean

isContentProtected

• get isContentProtected(): boolean

• Whether this message has content protection (i.e. disabled forwards)

  Returns boolean

isForwardedPremiumMedia

• get isForwardedPremiumMedia(): boolean

• Whether this is a premium media (e.g. >2gb file or fullscreen sticker) that was forwarded without author by a non-premium user

  Returns boolean

isFromOffline

• get isFromOffline(): boolean

• Whether the message was sent by an implicit action, for example, as an away or a greeting business message, or as a scheduled message

  Returns boolean

isFromScheduled

• get isFromScheduled(): boolean

• Whether this message was automatically sent from a scheduled message.

  Note: for messages sent by other users, this is always false.

  Returns boolean

isMention

• get isMention(): boolean

• Whether this message contains mention of the current user

  Returns boolean

isOutgoing

• get isOutgoing(): boolean

• Whether the message is incoming or outgoing:

  • Messages received from other chats are incoming (outgoing = false)
  • Messages sent by you to other chats are outgoing (outgoing = true)
  • Messages to yourself (i.e. Saved Messages) are incoming (outgoing = false)

  Returns boolean

isPinned

• get isPinned(): boolean

• Whether the message is pinned in the current chat

  Returns boolean

isService

• get isService(): boolean

• Whether this message is a service message

  Returns boolean

isSilent

• get isSilent(): boolean

• Whether this is a silent message (no notification triggered)

  Returns boolean

isTopicMessage

• get isTopicMessage(): boolean

• Whether this message is in a forum topic

  Returns boolean

link

• get link(): string

• Generated permalink to this message, only for groups and channels

  Returns string

  Throws

  MtArgumentError In case the chat does not support message links

markup

• get markup(): null | ReplyMarkup

• Reply markup provided with this message, if any.

  Returns null | ReplyMarkup

media

• get media(): MessageMedia

• Message media. null for text-only and service messages and for unsupported media types.

  For unsupported media types, use .raw.media directly.

  Returns MessageMedia

quickReplyShortcutId

• get quickReplyShortcutId(): null | number

• If non-null, this message is not actually sent, and is instead inside a group of "quick reply" messages under the given shortcut ID

  Returns null | number

reactions

• get reactions(): null | MessageReactions

• Reactions added to this message, if any

  Returns null | MessageReactions

replies

• get replies(): null | MessageRepliesInfo

• Information about comments (for channels) or replies (for groups)

  Returns null | MessageRepliesInfo

replyToMessage

• get replyToMessage(): null | RepliedMessageInfo

• For replies, information about the that is being replied to.

  Mutually exclusive with replyToStory

  Returns null | RepliedMessageInfo

replyToStory

• get replyToStory(): null | RawMessageReplyStoryHeader

• For replies, information about the story that is being replied to

  Mutually exclusive with replyToMessage

  Returns null | RawMessageReplyStoryHeader

sender

• get sender(): Peer

• Message sender.

  Usually is a User, but can be a Chat in case the message was sent by an anonymous admin, anonymous premium user, or if the message is a forwarded channel post.

  If the message was sent by an anonymous admin, sender will equal to chat.

  If the message is a forwarded channel post, sender is the channel itself.

  Returns Peer

senderBoostCount

• get senderBoostCount(): number

• Number of boosts applied to this chat by the sender

  Returns number

signature

• get signature(): null | string

• For channel posts with signatures enabled, name of the post author

  Returns null | string

text

• get text(): string

• Message text or media caption.

  Empty string for service messages (you should handle i18n yourself)

  Returns string

textWithEntities

• get textWithEntities(): TextWithEntities

• Returns TextWithEntities

ttlPeriod

• get ttlPeriod(): null | number

• TTL period of the message, in seconds.

  Returns null | number

viaBot

• get viaBot(): null | User

• If this message is generated from an inline query, information about the bot which generated it

  Returns null | User

viaBusinessBot

• get viaBusinessBot(): null | User

• If this message was sent by a business bot on behalf of sender, information about the business bot.

  Note: only available to the business account and the bot itself.

  Returns null | User

views

• get views(): null | number

• For channel posts, number of views

  null for service messages and non-post messages.

  Returns null | number