Class ChosenInlineResultContext

Context of a chosen inline result update.

This is a subclass of ChosenInlineResult, so all its fields are also available.

Note: To receive these updates, you must enable Inline feedback in @BotFather

Hierarchy (view full)

ChosenInlineResult
- ChosenInlineResultContext

Implements

UpdateContext<ChosenInlineResult>

Index

Constructors

constructor

new ChosenInlineResultContext(client, result): ChosenInlineResultContext
Parameters
- client: TelegramClient
- result: ChosenInlineResult
Returns ChosenInlineResultContext
Overrides ChosenInlineResult.constructor
- Defined in packages/dispatcher/src/context/chosen-inline-result.ts:17

Properties

`Readonly`_name

_name: "chosen_inline_result" = ...

`Readonly`_peers

_peers: PeersIndex

`Readonly`client

client: TelegramClient

`Readonly`raw

raw: RawUpdateBotInlineSend

Accessors

id

get id(): string
Unique identifier of the chosen result, as set in InputInlineResult.id

Returns string
Implementation of UpdateContext.id
Inherited from ChosenInlineResult.id
- Defined in packages/core/src/highlevel/types/updates/chosen-inline-result.ts:26

location

get location(): null | Location
Sender location, only applicable to bots that requested user location

Returns null | Location
Implementation of UpdateContext.location
Inherited from ChosenInlineResult.location
- Defined in packages/core/src/highlevel/types/updates/chosen-inline-result.ts:48

messageId

get messageId(): null | TypeInputBotInlineMessageID
Identifier of the sent inline message, which can be used in TelegramClient.editInlineMessage

Note: this is only available in case the InputInlineMessage contained a reply keyboard markup.

Returns null | TypeInputBotInlineMessageID
Implementation of UpdateContext.messageId
Inherited from ChosenInlineResult.messageId
- Defined in packages/core/src/highlevel/types/updates/chosen-inline-result.ts:61

messageIdStr

get messageIdStr(): null | string
Identifier of the sent inline message as a TDLib and Bot API compatible string. Can be used instead of messageId in case you want to store it in some storage.

Note: this is only available in case the InputInlineMessage contained a reply keyboard markup.

Returns null | string
Implementation of UpdateContext.messageIdStr
Inherited from ChosenInlineResult.messageIdStr
- Defined in packages/core/src/highlevel/types/updates/chosen-inline-result.ts:74

query

get query(): string
The query that was previously sent by the user, which was used to obtain this result

Returns string
Implementation of UpdateContext.query
Inherited from ChosenInlineResult.query
- Defined in packages/core/src/highlevel/types/updates/chosen-inline-result.ts:41

user

get user(): User
User who has chosen the query

Returns User
Implementation of UpdateContext.user
Inherited from ChosenInlineResult.user
- Defined in packages/core/src/highlevel/types/updates/chosen-inline-result.ts:33

Methods

editMessage

editMessage(params): Promise<void>
Edit the message that was sent when this inline result that was chosen.

Note: This method can only be used if the message contained a reply markup
Parameters
- params: {
      disableWebPreview?: boolean;
      invertMedia?: boolean;
      media?: InputMediaLike;
      messageId: string | TypeInputBotInlineMessageID;
      progressCallback?: ((uploaded: number, total: number) => void);
      replyMarkup?: ReplyMarkup;
      text?: InputText;
  }
  - OptionaldisableWebPreview?: boolean
    Whether to disable links preview in this message
  - OptionalinvertMedia?: boolean
    Whether to invert media position.
    
    Currently only supported for web previews and makes the client render the preview above the caption and not below.
  - Optionalmedia?: InputMediaLike
    New message media
  - messageId: string | TypeInputBotInlineMessageID
    Inline message ID, either as a TL object, or as a TDLib and Bot API compatible string
  - OptionalprogressCallback?: ((uploaded: number, total: number) => void)
    For media, upload progress callback.
    - (uploaded, total): void
      Parameters
      uploaded: number
      Number of bytes uploaded
      
      total: number
      Total file size in bytes
      
      Returns void
  - OptionalreplyMarkup?: ReplyMarkup
    For bots: new reply markup. If omitted, existing markup will be removed.
  - Optionaltext?: InputText
    New message text
    
    When media is passed, media.caption is used instead
Returns Promise<void>
- Defined in packages/dispatcher/src/context/chosen-inline-result.ts:29

Class ChosenInlineResultContext

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ChosenInlineResultContext

Properties

Readonly_name

Readonly_peers

Readonlyclient

Readonlyraw

Accessors

id

Returns string

location

Returns null | Location

messageId

Returns null | TypeInputBotInlineMessageID

messageIdStr

Returns null | string

query

Returns string

user

Returns User

Methods

editMessage

Parameters

OptionaldisableWebPreview?: boolean

OptionalinvertMedia?: boolean

Optionalmedia?: InputMediaLike

messageId: string | TypeInputBotInlineMessageID

OptionalprogressCallback?: ((uploaded: number, total: number) => void)

Parameters

Returns void

OptionalreplyMarkup?: ReplyMarkup

Optionaltext?: InputText

Returns Promise<void>

Settings

On This Page

`Readonly`_name

`Readonly`_peers

`Readonly`client

`Readonly`raw

`Optional`disableWebPreview?: boolean

`Optional`invertMedia?: boolean

`Optional`media?: InputMediaLike

`Optional`progressCallback?: ((uploaded: number, total: number) => void)

`Optional`replyMarkup?: ReplyMarkup

`Optional`text?: InputText