GramIO API Reference / @gramio/contexts/dist / InlineQueryContext
Class: InlineQueryContext<Bot>
Defined in: contexts/index.d.ts:6681
This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results.
Extends
Context<Bot>.Constructor<InlineQueryContext<Bot>>.InlineQuery.CloneMixin<Bot,InlineQueryContext<Bot>,InlineQueryContextOptions<Bot>>
Type Parameters
| Type Parameter |
|---|
Bot extends BotLike |
Constructors
Constructor
new InlineQueryContext<
Bot>(options):InlineQueryContext<Bot>
Defined in: contexts/index.d.ts:6684
Parameters
| Parameter | Type |
|---|---|
options | InlineQueryContextOptions<Bot> |
Returns
InlineQueryContext<Bot>
Overrides
Constructor
new InlineQueryContext(...
args):InlineQueryContext
Defined in: contexts/index.d.ts:6681
Parameters
| Parameter | Type |
|---|---|
...args | any[] |
Returns
InlineQueryContext
Overrides
Context<Bot>.constructor
Properties
| Property | Modifier | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|---|
bot | public | Bot | - | Context.bot | contexts/index.d.ts:5240 |
payload | public | TelegramInlineQuery | The raw data that is used for this Context | InlineQuery.payload | contexts/index.d.ts:6683 |
update? | public | TelegramUpdate | - | Context.update | contexts/index.d.ts:5242 |
updateId? | public | number | - | Context.updateId | contexts/index.d.ts:5241 |
updateType | protected | UpdateName | - | Context.updateType | contexts/index.d.ts:5243 |
Accessors
[toStringTag]
Get Signature
get [toStringTag]():
string
Defined in: contexts/index.d.ts:5246
Returns
string
Inherited from
from
Get Signature
get from():
User
Defined in: contexts/index.d.ts:4473
Sender
Returns
Inherited from
id
Get Signature
get id():
string
Defined in: contexts/index.d.ts:4471
Unique identifier for this query
Returns
string
Inherited from
location
Get Signature
get location():
Location
Defined in: contexts/index.d.ts:4475
Sender location, only for bots that request user location
Returns
Inherited from
offset
Get Signature
get offset():
string
Defined in: contexts/index.d.ts:4479
Offset of the results to be returned, can be controlled by the bot
Returns
string
Inherited from
query
Get Signature
get query():
string
Defined in: contexts/index.d.ts:4477
Text of the query (up to 256 characters)
Returns
string
Inherited from
senderId
Get Signature
get senderId():
number
Defined in: contexts/index.d.ts:6686
Sender's ID
Returns
number
Methods
answer()
answer(
results,params?):Promise<true>
Defined in: contexts/index.d.ts:6692
Answers to inline query. An alias for answerInlineQuery
Parameters
| Parameter | Type |
|---|---|
results | TelegramInlineQueryResult[] |
params? | Partial<AnswerInlineQueryParams> |
Returns
Promise<true>
answerInlineQuery()
answerInlineQuery(
results,params?):Promise<true>
Defined in: contexts/index.d.ts:6690
Answers to inline query
Parameters
| Parameter | Type |
|---|---|
results | TelegramInlineQueryResult[] |
params? | Partial<AnswerInlineQueryParams> |
Returns
Promise<true>
clone()
clone(
options?):InlineQueryContext
Defined in: contexts/index.d.ts:5935
Parameters
| Parameter | Type |
|---|---|
options? | InlineQueryContextOptions |
Returns
InlineQueryContext
Inherited from
hasLocation()
hasLocation():
this is Require<InlineQueryContext<Bot>, "location">
Defined in: contexts/index.d.ts:6688
Checks if query has location property
Returns
this is Require<InlineQueryContext<Bot>, "location">
is()
is<
T>(rawTypes):this is InstanceType<ContextsMapping<Bot>[T]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})
Defined in: contexts/index.d.ts:5249
Type Parameters
| Type Parameter |
|---|
T extends UpdateName |
Parameters
| Parameter | Type |
|---|---|
rawTypes | MaybeArray<SoftString<T>> |
Returns
this is InstanceType<ContextsMapping<Bot>[T]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})