Class MessageContext

Hierarchy

Context<IMessage>
- MessageContext
  - IncomingMessageContext
  - UserMessageContext

Index

Constructors

Constructors

constructor

new MessageContext(_client, _source): MessageContext
Parameters
- _client: Evogram
- _source: IMessage
Returns MessageContext
Inherited from Context.constructor
- Defined in src/modules/context/Context.ts:4

Properties

`Protected` _client

_client: Evogram

`Protected` _source

_source: IMessage

chat

chat: ChatContext = ...

client

client: Evogram = ...

date

date: Date = ...

editDate

editDate: undefined | 0 | Date = ...

entities

entities: undefined | IMessageEntity | IMessageEntity[] = ...

forumTopic

forumTopic: undefined | ForumTopicContext = ...

forwardMessage

forwardMessage: undefined | 0 | ForwardMessageContext = ...

isAnswer

isAnswer: undefined | boolean = ...

location

location: undefined | LocationContext = ...

media

media: {
    animation: undefined | IAnimation;
    audio: undefined | IAudio;
    has_media_spoiler: undefined | true;
    media_group_id: undefined | string;
    photo: undefined | IPhotoSize[];
    sticker: undefined | ISticker;
    video: undefined | IVideo;
    video_note: undefined | IVideoNote;
    voice: undefined | IVoice;
} = ...

Type declaration

animation: undefined | IAnimation
audio: undefined | IAudio
has_media_spoiler: undefined | true
media_group_id: undefined | string
photo: undefined | IPhotoSize[]
sticker: undefined | ISticker
video: undefined | IVideo
video_note: undefined | IVideoNote
voice: undefined | IVoice

poll

poll: undefined | PollContext = ...

replyMessage

replyMessage: undefined | MessageContext = ...

senderChat

senderChat: undefined | ChatContext = ...

source

source: IMessage = ...

update

update: {
    channel_chat_created: undefined | true;
    connected_website: undefined | string;
    delete_chat_photo: undefined | true;
    group_chat_created: undefined | true;
    left_chat_member: undefined | UserContext;
    message_auto_delete_timer_changed: undefined | IMessageAutoDeleteTimerChanged;
    migrate_from_chat_id: undefined | number;
    migrate_to_chat_id: undefined | number;
    new_chat_members: undefined | UserContext[];
    new_chat_photo: undefined | IPhotoSize[];
    new_chat_title: undefined | string;
    pinned_message: undefined | IMessage;
    successful_payment: undefined | ISuccessfulPayment;
    supergroup_chat_created: undefined | true;
    video_chat_ended: undefined | IVideoChatEnded;
    video_chat_participants_invited: undefined | IVideoChatParticipantsInvited;
    video_chat_scheduled: undefined | IVideoChatScheduled;
    video_chat_started: undefined | IVideoChatStarted;
    web_app_data: undefined | IWebAppData;
    write_access_allowed: undefined | IWriteAccessAllowed;
} = ...

Type declaration

channel_chat_created: undefined | true
connected_website: undefined | string
delete_chat_photo: undefined | true
group_chat_created: undefined | true
left_chat_member: undefined | UserContext
message_auto_delete_timer_changed: undefined | IMessageAutoDeleteTimerChanged
migrate_from_chat_id: undefined | number
migrate_to_chat_id: undefined | number
new_chat_members: undefined | UserContext[]
new_chat_photo: undefined | IPhotoSize[]
new_chat_title: undefined | string
pinned_message: undefined | IMessage
successful_payment: undefined | ISuccessfulPayment
supergroup_chat_created: undefined | true
video_chat_ended: undefined | IVideoChatEnded
video_chat_participants_invited: undefined | IVideoChatParticipantsInvited
video_chat_scheduled: undefined | IVideoChatScheduled
video_chat_started: undefined | IVideoChatStarted
web_app_data: undefined | IWebAppData
write_access_allowed: undefined | IWriteAccessAllowed

user

user: undefined | UserContext = ...

venue

venue: undefined | VenueContext = ...

viaBot

viaBot: undefined | UserContext = ...

Accessors

authorSignature

get authorSignature(): undefined | string
Returns undefined | string
- Defined in src/contexts/Message/MessageContext.ts:78

dice

get dice(): undefined | IDice
Returns undefined | IDice
- Defined in src/contexts/Message/MessageContext.ts:73

game

get game(): undefined | IGame
Returns undefined | IGame
- Defined in src/contexts/Message/MessageContext.ts:74

hasCommand

get hasCommand(): undefined | string
Checks whether the incoming message to the bot has a recognized command.

Returns undefined | string
Returns the matched command from the message, or undefined if no match was found.
- Defined in src/contexts/Message/MessageContext.ts:91

hasProtectedContent

get hasProtectedContent(): undefined | true
Returns undefined | true
- Defined in src/contexts/Message/MessageContext.ts:82

id

get id(): number
Returns number
- Defined in src/contexts/Message/MessageContext.ts:76

invoice

get invoice(): undefined | IInvoice
Returns undefined | IInvoice
- Defined in src/contexts/Message/MessageContext.ts:79

isAutomaticForward

get isAutomaticForward(): undefined | true
Returns undefined | true
- Defined in src/contexts/Message/MessageContext.ts:84

isTopicMessage

get isTopicMessage(): undefined | true
Returns undefined | true
- Defined in src/contexts/Message/MessageContext.ts:83

passportData

get passportData(): undefined | IPassportData
Returns undefined | IPassportData
- Defined in src/contexts/Message/MessageContext.ts:81

replyMarkup

get replyMarkup(): undefined | IInlineKeyboardMarkup
Returns undefined | IInlineKeyboardMarkup
- Defined in src/contexts/Message/MessageContext.ts:80

text

get text(): undefined | string
Returns undefined | string
- Defined in src/contexts/Message/MessageContext.ts:77

Methods

delete

delete(): Promise<true>
Deletes the current message.

Returns Promise<true>
- Defined in src/contexts/Message/MessageContext.ts:127

forward

forward<T>(chat_id, params?): Promise<T>
Forwards the current message to a specified chat.
Type Parameters
- T extends Context<IMessage, T> = IncomingMessageContext
Parameters
- chat_id: string | number
- Optional params: Partial<IForwardMessageParams>
Returns Promise<T>
- Defined in src/contexts/Message/MessageContext.ts:132

pin(params?): Promise<true>
Pin the message in the chat.
Parameters
- Optional params: Partial<IPinChatMessageParams>
Returns Promise<true>
- Defined in src/contexts/Message/MessageContext.ts:137

question

question<T>(text, callback): Promise<T>
Asks a question to the user and waits for a response.

Throws
- If there is no user id in the source object.
Type Parameters
- T extends Context<IMessage, T> = IncomingMessageContext
  
  The context type. Default is IncomingMessageContext.
Parameters
- text: string
  
  The text of the message to be sent, or an object containing the text and other options.
- callback: ((message) => any)
  
  The function to run once the user responds to the question.
  - - (message): any
    - Parameters
      
      message: MessageContext
      
      Returns any
Returns Promise<T>
- A promise that resolves with the context of the user's response.
- Defined in src/contexts/Message/MessageContext.ts:159
question<T>(params, callback): Promise<T>
Type Parameters
- T extends Context<IMessage, T> = IncomingMessageContext
Parameters
- params: {
  text: string;
  } & Partial<ISendMessageParams>
- callback: ((message) => any)
  - - (message): any
    - Parameters
      
      message: MessageContext
      
      Returns any
Returns Promise<T>
- Defined in src/contexts/Message/MessageContext.ts:160

reply

reply<T>(text, params?): Promise<T>
Replies to the current message.
Type Parameters
- T extends Context<IMessage, T> = IncomingMessageContext
Parameters
- text: string
- Optional params: Partial<ISendMessageParams>
Returns Promise<T>
- Defined in src/contexts/Message/MessageContext.ts:117
reply<T>(params): Promise<T>
Type Parameters
- T extends Context<IMessage, T> = IncomingMessageContext
Parameters
- params: {
  text: string;
  } & Partial<ISendMessageParams>
Returns Promise<T>
- Defined in src/contexts/Message/MessageContext.ts:118

send

send<T>(text, params?): Promise<T>
Sends a message to the chat.

Example
```
send("Hello, World!")
    send("<b>This text is bold</b>", { parse_mode: "HTML" })
    send({ text: "Hello, Evogram!" })
```
Type Parameters
- T extends Context<IMessage, T> = IncomingMessageContext
Parameters
- text: string
- Optional params: Partial<ISendMessageParams>
Returns Promise<T>
- Defined in src/contexts/Message/MessageContext.ts:107
send<T>(params): Promise<T>
Type Parameters
- T extends Context<IMessage, T> = IncomingMessageContext
Parameters
- params: {
  text: string;
  } & Partial<ISendMessageParams>
Returns Promise<T>
- Defined in src/contexts/Message/MessageContext.ts:108

sendAction

sendAction(action): Promise<true>
Send the action in the chat.
Parameters
- action: IChatActionType
Returns Promise<true>
- Defined in src/contexts/Message/MessageContext.ts:147

toContext

toContext<TContext>(): TContext
Converts the source object to a context object of a given type.

Example
```
client.updates.on("message", message => {
        const user = message.user.toContext<CustomUserContext>();
        // Now user works correctly with your context
    })
```
Type Parameters
- TContext extends object
  
  Generic type parameter for the context object.
Returns TContext
The context object.
Inherited from Context.toContext
- Defined in src/modules/context/Context.ts:16

unpin

unpin(params?): Promise<true>
Unpin the message in the chat.
Parameters
- Optional params: Partial<IUnpinChatMessageParams>
Returns Promise<true>
- Defined in src/contexts/Message/MessageContext.ts:142

Class MessageContext

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

_client: Evogram

_source: IMessage

Returns MessageContext

Properties

Protected _client

Protected _source

chat

client

date

editDate

entities

forumTopic

forwardMessage

isAnswer

location

media

Type declaration

animation: undefined | IAnimation

audio: undefined | IAudio

has_media_spoiler: undefined | true

media_group_id: undefined | string

photo: undefined | IPhotoSize[]

sticker: undefined | ISticker

video: undefined | IVideo

video_note: undefined | IVideoNote

voice: undefined | IVoice

poll

replyMessage

senderChat

source

update

Type declaration

channel_chat_created: undefined | true

connected_website: undefined | string

delete_chat_photo: undefined | true

group_chat_created: undefined | true

left_chat_member: undefined | UserContext

message_auto_delete_timer_changed: undefined | IMessageAutoDeleteTimerChanged

migrate_from_chat_id: undefined | number

migrate_to_chat_id: undefined | number

new_chat_members: undefined | UserContext[]

new_chat_photo: undefined | IPhotoSize[]

new_chat_title: undefined | string

pinned_message: undefined | IMessage

successful_payment: undefined | ISuccessfulPayment

supergroup_chat_created: undefined | true

video_chat_ended: undefined | IVideoChatEnded

video_chat_participants_invited: undefined | IVideoChatParticipantsInvited

video_chat_scheduled: undefined | IVideoChatScheduled

video_chat_started: undefined | IVideoChatStarted

web_app_data: undefined | IWebAppData

write_access_allowed: undefined | IWriteAccessAllowed

user

venue

viaBot

Accessors

authorSignature

Returns undefined | string

dice

Returns undefined | IDice

game

Returns undefined | IGame

hasCommand

Returns undefined | string

hasProtectedContent

Returns undefined | true

id

Returns number

invoice

Returns undefined | IInvoice

`Protected` _client

`Protected` _source

`Optional` params: Partial<IForwardMessageParams>

`Optional` params: Partial<IPinChatMessageParams>

params: {
text: string;
} & Partial<ISendMessageParams>

`Optional` params: Partial<ISendMessageParams>

params: {
text: string;
} & Partial<ISendMessageParams>

`Optional` params: Partial<ISendMessageParams>

params: {
text: string;
} & Partial<ISendMessageParams>