Class InlineQuery

Hierarchy (view full)

Constructors

constructor

Properties

author id location? offset query type?

Accessors

client

Methods

_clone _patch _update answerQuery toJSON valueOf

Constructors

constructor

  • new InlineQuery(client, data): InlineQuery

  • Parameters

    • client: TelegramClient | BaseClient

      The client that instantiated this

    • data: InlineQuery

      Data about the represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results

    Returns InlineQuery

Properties

author

author: User

Sender

id

id: string

Unique identifier for this query

Optionallocation

location?: Location

Sender location, only for bots that request user location

offset

offset: string

Offset of the results to be returned, can be controlled by the bot

query

query: string

Text of the query (up to 256 characters)

Optionaltype

type?:
    | "group"
    | "channel"
    | "private"
    | "supergroup"
    | "sender"

Type of the chat from which the inline query was sent. Can be either “sender” for a private chat with the inline query sender, “private”, “group”, “supergroup”, or “channel”. The chat type should be always known for requests sent from official clients and most third-party clients, unless the request was sent from a secret chat

Accessors

client

Methods

Protected_clone

  • _clone(): Base
  • Protected

    Creates a clone of the current instance

    Returns Base

    A clone of the current instance

Protected_patch

  • _patch(data): Record<string, any>
  • Protected

    Patches the current instance with new data

    Parameters

    • data: Record<string, any>

      The data to patch the instance with

    Returns Record<string, any>

    The patched data

Protected_update

  • _update(data): Base
  • Protected

    Updates the current instance with new data and returns a clone of the updated instance

    Parameters

    • data: Record<string, any>

      The data to update the instance with

    Returns Base

    A clone of the updated instance

answerQuery

  • answerQuery(results, options?): Promise<true>

  • Use this method to send answers to an inline query.

    Parameters

    • results: readonly InlineQueryResult[]

      An array of results for the inline query

    • Optionaloptions: Omit<{
          button?: InlineQueryResultsButton;
          cacheTime?: number;
          inlineQueryId: string;
          isPersonal?: boolean;
          nextOffset?: string;
          results: readonly InlineQueryResult[];
      }, "results" | "inlineQueryId">

      out parameters

    Returns Promise<true>

    On success, True is returned.

toJSON

  • toJSON(propsRecursive?, ...props): Record<string, any>

  • Flatten an object. Any properties that are collections will get converted to an array of keys.

    Parameters

    • OptionalpropsRecursive: boolean

      Optional. If true, calls toJSON method on nested objects.

    • Rest...props: Record<string, string | boolean>[]

      Optional. Specific properties to include/exclude, or rename.

    Returns Record<string, any>

    Flattened object.

valueOf

  • valueOf(): null | string

  • Returns the id instance Chat, User, ChatMember and other

    Returns null | string

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods