Class InlineQueryContext

Hierarchy

Context<IInlineQuery>
- InlineQueryContext

Index

Constructors

Properties

_client _source client location user

Accessors

chatType id offset query

Methods

answer toContext

Constructors

constructor

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

Properties

`Protected` _client

_client: Evogram

`Protected` _source

_source: IInlineQuery

client

client: Evogram = ...

location

location: undefined | LocationContext = ...

Sender location, only for bots that request user location

user

user: UserContext = ...

Sender

Accessors

chatType

get chatType(): undefined | "channel" | "private" | "group" | "supergroup" | "sender"
Type of the chat from which the inline query was sent

Returns undefined | "channel" | "private" | "group" | "supergroup" | "sender"
- Defined in src/contexts/Inline/InlineQueryContext.ts:24

id

get id(): string
Unique identifier for this query

Returns string
- Defined in src/contexts/Inline/InlineQueryContext.ts:15

offset

get offset(): string
Offset of the results to be returned, can be controlled by the bot

Returns string
- Defined in src/contexts/Inline/InlineQueryContext.ts:21

query

get query(): string
Text of the query (up to 256 characters)

Returns string
- Defined in src/contexts/Inline/InlineQueryContext.ts:18

Methods

answer

answer(results, params?): Promise<true>
Internal implementation of the answer method
Parameters
- results: IInlineQueryResult[]
- Optional params: Partial<IAnswerInlineQueryParams>
Returns Promise<true>
- Defined in src/contexts/Inline/InlineQueryContext.ts:28
answer(params): Promise<true>
Parameters
- params: {
  inline_query_id?: string;
  } & IAnswerInlineQueryParams
Returns Promise<true>
- Defined in src/contexts/Inline/InlineQueryContext.ts:29

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

Generated using TypeDoc