Class MessageContext

Context of a message-related update.

This is a subclass of Message, so all fields of the message are available.

For message groups, own fields are related to the last message in the group. To access all messages, use MessageContext#messages.

Hierarchy (view full)

Message
- MessageContext

Implements

UpdateContext<Message>

Index

Constructors

constructor

Properties

_name _peers client isMessageGroup isScheduled messages raw

Constructors

constructor

new MessageContext(client, message): MessageContext
Parameters
- client: TelegramClient
- message: Message | Message[]
Returns MessageContext
Overrides Message.constructor
- Defined in packages/dispatcher/src/context/message.ts:36

Properties

`Readonly`_name

_name: "new_message" = ...

`Readonly`_peers

_peers: PeersIndex

`Readonly`client

client: TelegramClient

`Readonly`isMessageGroup

isMessageGroup: boolean

Whether this update is about a message group

`Readonly`isScheduled

isScheduled: boolean = false

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

`Readonly`messages

messages: MessageContext[]

List of messages in the message group.

For other updates, this is a list with a single element (this).

`Readonly`raw

raw: RawMessage | RawMessageService

Raw TL object.

Accessors

action

get action(): MessageAction
Message action. null for non-service messages or for unsupported events.

For unsupported events, use .raw.action directly.

Returns MessageAction
Implementation of UpdateContext.action
Inherited from Message.action
- Defined in packages/core/src/highlevel/types/messages/message.ts:384

canBeForwarded

get canBeForwarded(): boolean
Whether this message can be forwarded

false for service mesasges and private restricted chats/chanenls

Returns boolean
Implementation of UpdateContext.canBeForwarded
Inherited from Message.canBeForwarded
- Defined in packages/core/src/highlevel/types/messages/message.ts:467

chat

get chat(): Chat
Conversation the message belongs to

Returns Chat
Implementation of UpdateContext.chat
Inherited from Message.chat
- Defined in packages/core/src/highlevel/types/messages/message.ts:214

date

get date(): Date
Date when the message was sent

Returns Date
Implementation of UpdateContext.date
Inherited from Message.date
- Defined in packages/core/src/highlevel/types/messages/message.ts:221

editDate

get editDate(): null | Date
Date when the message was last edited

Returns null | Date
Implementation of UpdateContext.editDate
Inherited from Message.editDate
- Defined in packages/core/src/highlevel/types/messages/message.ts:228

effectId

get effectId(): null | Long
If this message was sent with a message effect, ID of the effect

Returns null | Long
Implementation of UpdateContext.effectId
Inherited from Message.effectId
- Defined in packages/core/src/highlevel/types/messages/message.ts:495

entities

get entities(): readonly MessageEntity[]
Message text/caption entities (may be empty)

Returns readonly MessageEntity[]
Implementation of UpdateContext.entities
Inherited from Message.entities
- Defined in packages/core/src/highlevel/types/messages/message.ts:357

factCheck

get factCheck(): null | FactCheck
Information about fact-check added to the message, if any

Returns null | FactCheck
Implementation of UpdateContext.factCheck
Inherited from Message.factCheck
- Defined in packages/core/src/highlevel/types/messages/message.ts:485

forward

get forward(): null | MessageForwardInfo
If this message is a forward, contains info about it.

Returns null | MessageForwardInfo
Implementation of UpdateContext.forward
Inherited from Message.forward
- Defined in packages/core/src/highlevel/types/messages/message.ts:237

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
Implementation of UpdateContext.forwards
Inherited from Message.forwards
- Defined in packages/core/src/highlevel/types/messages/message.ts:72

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
Implementation of UpdateContext.groupedId
Inherited from Message.groupedId
- Defined in packages/core/src/highlevel/types/messages/message.ts:161

groupedIdUnique

get groupedIdUnique(): null | string
Same as groupedId, but is globally unique across chats.

Returns null | string
Implementation of UpdateContext.groupedIdUnique
Inherited from Message.groupedIdUnique
- Defined in packages/core/src/highlevel/types/messages/message.ts:168

hasUnreadMedia

get hasUnreadMedia(): boolean
Whether there are unread media attachments in this message

Returns boolean
Implementation of UpdateContext.hasUnreadMedia
Inherited from Message.hasUnreadMedia
- Defined in packages/core/src/highlevel/types/messages/message.ts:119

hideEditMark

get hideEditMark(): boolean
Whether the message should be considered unedited, even if editDate ≠ null

Returns boolean
Implementation of UpdateContext.hideEditMark
Inherited from Message.hideEditMark
- Defined in packages/core/src/highlevel/types/messages/message.ts:143

id

get id(): number
Unique message identifier inside this chat

Returns number
Implementation of UpdateContext.id
Inherited from Message.id
- Defined in packages/core/src/highlevel/types/messages/message.ts:53

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
Implementation of UpdateContext.invertMedia
Inherited from Message.invertMedia
- Defined in packages/core/src/highlevel/types/messages/message.ts:151

isAutomaticForward

get isAutomaticForward(): boolean
Whether the message is a channel post that was automatically forwarded to the connected discussion group

Returns boolean
Implementation of UpdateContext.isAutomaticForward
Inherited from Message.isAutomaticForward
- Defined in packages/core/src/highlevel/types/messages/message.ts:249

isChannelPost

get isChannelPost(): boolean
Whether this is a broadcast channel post

Returns boolean
Implementation of UpdateContext.isChannelPost
Inherited from Message.isChannelPost
- Defined in packages/core/src/highlevel/types/messages/message.ts:124

isContentProtected

get isContentProtected(): boolean
Whether this message has content protection (i.e. disabled forwards)

Returns boolean
Implementation of UpdateContext.isContentProtected
Inherited from Message.isContentProtected
- Defined in packages/core/src/highlevel/types/messages/message.ts:101

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
Implementation of UpdateContext.isForwardedPremiumMedia
Inherited from Message.isForwardedPremiumMedia
- Defined in packages/core/src/highlevel/types/messages/message.ts:411

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
Implementation of UpdateContext.isFromOffline
Inherited from Message.isFromOffline
- Defined in packages/core/src/highlevel/types/messages/message.ts:109

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
Implementation of UpdateContext.isFromScheduled
Inherited from Message.isFromScheduled
- Defined in packages/core/src/highlevel/types/messages/message.ts:133

isMention

get isMention(): boolean
Whether this message contains mention of the current user

Returns boolean
Implementation of UpdateContext.isMention
Inherited from Message.isMention
- Defined in packages/core/src/highlevel/types/messages/message.ts:303

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
Implementation of UpdateContext.isOutgoing
Inherited from Message.isOutgoing
- Defined in packages/core/src/highlevel/types/messages/message.ts:89

isPinned

get isPinned(): boolean
Whether the message is pinned in the current chat

Returns boolean
Implementation of UpdateContext.isPinned
Inherited from Message.isPinned
- Defined in packages/core/src/highlevel/types/messages/message.ts:138

isService

get isService(): boolean
Whether this message is a service message

Returns boolean
Implementation of UpdateContext.isService
Inherited from Message.isService
- Defined in packages/core/src/highlevel/types/messages/message.ts:96

isSilent

get isSilent(): boolean
Whether this is a silent message (no notification triggered)

Returns boolean
Implementation of UpdateContext.isSilent
Inherited from Message.isSilent
- Defined in packages/core/src/highlevel/types/messages/message.ts:114

isTopicMessage

get isTopicMessage(): boolean
Whether this message is in a forum topic

Returns boolean
Implementation of UpdateContext.isTopicMessage
Inherited from Message.isTopicMessage
- Defined in packages/core/src/highlevel/types/messages/message.ts:294

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
Implementation of UpdateContext.link
Inherited from Message.link
- Defined in packages/core/src/highlevel/types/messages/message.ts:506

markup

get markup(): null | ReplyMarkup
Reply markup provided with this message, if any.

Returns null | ReplyMarkup
Implementation of UpdateContext.markup
Inherited from Message.markup
- Defined in packages/core/src/highlevel/types/messages/message.ts:425

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
Implementation of UpdateContext.media
Inherited from Message.media
- Defined in packages/core/src/highlevel/types/messages/message.ts:398

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
Implementation of UpdateContext.quickReplyShortcutId
Inherited from Message.quickReplyShortcutId
- Defined in packages/core/src/highlevel/types/messages/message.ts:312

reactions

get reactions(): null | MessageReactions
Reactions added to this message, if any

Returns null | MessageReactions
Implementation of UpdateContext.reactions
Inherited from Message.reactions
- Defined in packages/core/src/highlevel/types/messages/message.ts:474

replies

get replies(): null | MessageRepliesInfo
Information about comments (for channels) or replies (for groups)

Returns null | MessageRepliesInfo
Implementation of UpdateContext.replies
Inherited from Message.replies
- Defined in packages/core/src/highlevel/types/messages/message.ts:265

replyToMessage

get replyToMessage(): null | RepliedMessageInfo
For replies, information about the that is being replied to.

Mutually exclusive with replyToStory

Returns null | RepliedMessageInfo
Implementation of UpdateContext.replyToMessage
Inherited from Message.replyToMessage
- Defined in packages/core/src/highlevel/types/messages/message.ts:276

replyToStory

get replyToStory(): null | RawMessageReplyStoryHeader
For replies, information about the story that is being replied to

Mutually exclusive with replyToMessage

Returns null | RawMessageReplyStoryHeader
Implementation of UpdateContext.replyToStory
Inherited from Message.replyToStory
- Defined in packages/core/src/highlevel/types/messages/message.ts:287

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
Implementation of UpdateContext.sender
Inherited from Message.sender
- Defined in packages/core/src/highlevel/types/messages/message.ts:187

senderBoostCount

get senderBoostCount(): number
Number of boosts applied to this chat by the sender

Returns number
Implementation of UpdateContext.senderBoostCount
Inherited from Message.senderBoostCount
- Defined in packages/core/src/highlevel/types/messages/message.ts:205

signature

get signature(): null | string
For channel posts with signatures enabled, name of the post author

Returns null | string
Implementation of UpdateContext.signature
Inherited from Message.signature
- Defined in packages/core/src/highlevel/types/messages/message.ts:79

text

get text(): string
Message text or media caption.

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

Returns string
Implementation of UpdateContext.text
Inherited from Message.text
- Defined in packages/core/src/highlevel/types/messages/message.ts:350

textWithEntities

get textWithEntities(): TextWithEntities
Returns TextWithEntities
Implementation of UpdateContext.textWithEntities
Inherited from Message.textWithEntities
- Defined in packages/core/src/highlevel/types/messages/message.ts:369

ttlPeriod

get ttlPeriod(): null | number
TTL period of the message, in seconds.

Returns null | number
Implementation of UpdateContext.ttlPeriod
Inherited from Message.ttlPeriod
- Defined in packages/core/src/highlevel/types/messages/message.ts:418

viaBot

get viaBot(): null | User
If this message is generated from an inline query, information about the bot which generated it

Returns null | User
Implementation of UpdateContext.viaBot
Inherited from Message.viaBot
- Defined in packages/core/src/highlevel/types/messages/message.ts:322

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
Implementation of UpdateContext.viaBusinessBot
Inherited from Message.viaBusinessBot
- Defined in packages/core/src/highlevel/types/messages/message.ts:336

views

get views(): null | number
For channel posts, number of views

null for service messages and non-post messages.

Returns null | number
Implementation of UpdateContext.views
Inherited from Message.views
- Defined in packages/core/src/highlevel/types/messages/message.ts:62

Methods

answerMedia

answerMedia(...params): Promise<Message>
Send a media to the same chat (and topic, if applicable) as a given message
Parameters
- Rest...params: [media: string | InputMediaLike, params?: CommonSendParams & {
      caption?: InputText;
      invert?: boolean;
      progressCallback?: ((uploaded: number, total: number) => void);
      replyMarkup?: ReplyMarkup;
  }]
Returns Promise<Message>
- Defined in packages/dispatcher/src/context/message.ts:108

answerMediaGroup

answerMediaGroup(...params): Promise<Message[]>
Send a media group to the same chat (and topic, if applicable) as a given message
Parameters
- Rest...params: [medias: (string | InputMediaLike)[], params?: CommonSendParams & {
  invertMedia?: boolean;
  progressCallback?: ((index: number, uploaded: number, total: number) => void);
  }]
Returns Promise<Message[]>
- Defined in packages/dispatcher/src/context/message.ts:113

answerText

answerText(...params): Promise<Message>
Send a text message to the same chat (and topic, if applicable) as a given message
Parameters
- Rest...params: [text: InputText, params?: CommonSendParams & {
      disableWebPreview?: boolean;
      invertMedia?: boolean;
      replyMarkup?: ReplyMarkup;
  }]
Returns Promise<Message>
- Defined in packages/dispatcher/src/context/message.ts:103

commentMedia

commentMedia(...params): Promise<Message>
Send a media as a comment to this message
Parameters
- Rest...params: [media: string | InputMediaLike, params?: CommonSendParams & {
      caption?: InputText;
      invert?: boolean;
      progressCallback?: ((uploaded: number, total: number) => void);
      replyMarkup?: ReplyMarkup;
  }]
Returns Promise<Message>
- Defined in packages/dispatcher/src/context/message.ts:153

commentMediaGroup

commentMediaGroup(...params): Promise<Message[]>
Send a media group as a comment to this message
Parameters
- Rest...params: [medias: (string | InputMediaLike)[], params?: CommonSendParams & {
  invertMedia?: boolean;
  progressCallback?: ((index: number, uploaded: number, total: number) => void);
  }]
Returns Promise<Message[]>
- Defined in packages/dispatcher/src/context/message.ts:158

commentText

commentText(...params): Promise<Message>
Send a text as a comment to this message
Parameters
- Rest...params: [text: InputText, params?: CommonSendParams & {
      disableWebPreview?: boolean;
      invertMedia?: boolean;
      replyMarkup?: ReplyMarkup;
  }]
Returns Promise<Message>
- Defined in packages/dispatcher/src/context/message.ts:148

copy

copy(params): Promise<Message> | Promise<Message[]>
Send a copy of this message (message group)
Parameters
- params: SendCopyParams & SendCopyGroupParams
Returns Promise<Message> | Promise<Message[]>
- Defined in packages/dispatcher/src/context/message.ts:207

delete

delete(params?): Promise<void>
Delete this message (message group)
Parameters
- Optionalparams: DeleteMessagesParams
Returns Promise<void>
- Defined in packages/dispatcher/src/context/message.ts:163

edit

edit(params): Promise<Message>
Edit this message
Parameters
- params: OmitInputMessageId<InputMessageId & {
      businessConnectionId?: string;
      disableWebPreview?: boolean;
      invertMedia?: boolean;
      media?: InputMediaLike | undefined;
      progressCallback?: ((uploaded: number, total: number) => void);
      replyMarkup?: ReplyMarkup | undefined;
      scheduleDate?: number | Date;
      shouldDispatch?: true;
      text?: InputText | undefined;
  }>
Returns Promise<Message>
- Defined in packages/dispatcher/src/context/message.ts:189

forwardTo

forwardTo(params): Promise<Message[]>
Forward this message (message group)
Parameters
- params: ForwardMessageOptions
Returns Promise<Message[]>
- Defined in packages/dispatcher/src/context/message.ts:198

getCompleteChat

getCompleteChat(): Promise<Chat>
Get complete information about chat

Learn more: Incomplete peers

Returns Promise<Chat>
- Defined in packages/dispatcher/src/context/message.ts:75

getCompleteSender

getCompleteSender(): Promise<Peer>
Get complete information about sender

Learn more: Incomplete peers

Returns Promise<Peer>
- Defined in packages/dispatcher/src/context/message.ts:52

getCustomEmojis

getCustomEmojis(): Promise<Sticker[]>
Get all custom emojis contained in this message (message group), if any

Returns Promise<Sticker[]>
- Defined in packages/dispatcher/src/context/message.ts:98

getDiscussionMessage

getDiscussionMessage(): Promise<null | Message>
If this is a channel post, get its automatic forward in the discussion group

Returns Promise<null | Message>
- Defined in packages/dispatcher/src/context/message.ts:93

getReplyTo

getReplyTo(): Promise<null | Message>
Get a message that this message is a reply to

Returns Promise<null | Message>
- Defined in packages/dispatcher/src/context/message.ts:88

pin(params?): Promise<null | Message>
Pin this message
Parameters
- Optionalparams: OmitInputMessageId<InputMessageId & {
      bothSides?: boolean;
      notify?: boolean;
      shouldDispatch?: true;
  }>
Returns Promise<null | Message>
- Defined in packages/dispatcher/src/context/message.ts:172

quoteWithMedia

quoteWithMedia(params): Promise<Message>
Send a media in reply to this message
Parameters
- params: Omit<CommonSendParams & {
      caption?: InputText;
      invert?: boolean;
      progressCallback?: ((uploaded: number, total: number) => void);
      replyMarkup?: ReplyMarkup;
  }, "quoteText" | "quoteEntities"> & {
      end: number;
      start: number;
      toChatId?: InputPeerLike;
  } & {
      media: string | InputMediaLike;
  }
Returns Promise<Message>
- Defined in packages/dispatcher/src/context/message.ts:138

quoteWithMediaGroup

quoteWithMediaGroup(params): Promise<Message[]>
Send a media group in reply to this message
Parameters
- params: Omit<CommonSendParams & {
      invertMedia?: boolean;
      progressCallback?: ((index: number, uploaded: number, total: number) => void);
  }, "quoteText" | "quoteEntities"> & {
      end: number;
      start: number;
      toChatId?: InputPeerLike;
  } & {
      medias: (string | InputMediaLike)[];
  }
Returns Promise<Message[]>
- Defined in packages/dispatcher/src/context/message.ts:143

quoteWithText

quoteWithText(params): Promise<Message>
Send a text message in reply to this message
Parameters
- params: Omit<CommonSendParams & {
      disableWebPreview?: boolean;
      invertMedia?: boolean;
      replyMarkup?: ReplyMarkup;
  }, "quoteText" | "quoteEntities"> & {
      end: number;
      start: number;
      toChatId?: InputPeerLike;
  } & {
      text: InputText;
  }
Returns Promise<Message>
- Defined in packages/dispatcher/src/context/message.ts:133

react

react(params): Promise<null | Message>
React to this message
Parameters
- params: OmitInputMessageId<InputMessageId & {
      big?: boolean;
      emoji?: MaybeArray<InputReaction> | null | undefined;
      shouldDispatch?: true;
  }>
Returns Promise<null | Message>
- Defined in packages/dispatcher/src/context/message.ts:222

replyMedia

replyMedia(...params): Promise<Message>
Send a media in reply to this message
Parameters
- Rest...params: [media: string | InputMediaLike, params?: CommonSendParams & {
      caption?: InputText;
      invert?: boolean;
      progressCallback?: ((uploaded: number, total: number) => void);
      replyMarkup?: ReplyMarkup;
  }]
Returns Promise<Message>
- Defined in packages/dispatcher/src/context/message.ts:123

replyMediaGroup

replyMediaGroup(...params): Promise<Message[]>
Send a media group in reply to this message
Parameters
- Rest...params: [medias: (string | InputMediaLike)[], params?: CommonSendParams & {
  invertMedia?: boolean;
  progressCallback?: ((index: number, uploaded: number, total: number) => void);
  }]
Returns Promise<Message[]>
- Defined in packages/dispatcher/src/context/message.ts:128

replyText

replyText(...params): Promise<Message>
Send a text message in reply to this message
Parameters
- Rest...params: [text: InputText, params?: CommonSendParams & {
      disableWebPreview?: boolean;
      invertMedia?: boolean;
      replyMarkup?: ReplyMarkup;
  }]
Returns Promise<Message>
- Defined in packages/dispatcher/src/context/message.ts:118

unpin

unpin(): Promise<void>
Unpin this message

Returns Promise<void>
- Defined in packages/dispatcher/src/context/message.ts:181

Class MessageContext

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns MessageContext

Properties

Readonly_name

Readonly_peers

Readonlyclient

ReadonlyisMessageGroup

ReadonlyisScheduled

Readonlymessages

Readonlyraw

Accessors

action

Returns MessageAction

canBeForwarded

Returns boolean

chat

Returns Chat

date

Returns Date

editDate

Returns null | Date

effectId

Returns null | Long

entities

Returns readonly MessageEntity[]

factCheck

Returns null | FactCheck

forward

Returns null | MessageForwardInfo

forwards

Returns null | number

groupedId

Returns null | Long

groupedIdUnique

Returns null | string

hasUnreadMedia

Returns boolean

hideEditMark

Returns boolean

id

Returns number

invertMedia

Returns boolean

isAutomaticForward

Returns boolean

isChannelPost

Returns boolean

isContentProtected

Returns boolean

isForwardedPremiumMedia

Returns boolean

isFromOffline

Returns boolean

isFromScheduled

Returns boolean

isMention

Returns boolean

isOutgoing

Returns boolean

isPinned

Returns boolean

isService

Returns boolean

isSilent

Returns boolean

isTopicMessage

Returns boolean

link

Returns string

Throws

`Readonly`_name

`Readonly`_peers

`Readonly`client

`Readonly`isMessageGroup

`Readonly`isScheduled

`Readonly`messages

`Readonly`raw