InlineQuery Class

extends Base

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

Properties

  • chatType: ChatType
  • client: Client
  • from: User
  • id: string
  • location: Location
  • offset: string
  • query: string

Methods

{
  "id": 1389,
  "name": "InlineQuery",
  "variant": "declaration",
  "kind": 128,
  "flags": {},
  "comment": {
    "summary": [
      {
        "kind": "text",
        "text": "Represents an incoming inline query. When the user sends an empty query, \nyour bot could return some default or trending results."
      }
    ]
  },
  "children": [
    {
      "id": 1390,
      "name": "constructor",
      "variant": "declaration",
      "kind": 512,
      "flags": {},
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/InlineQuery.ts",
          "line": 36,
          "character": 1
        }
      ],
      "signatures": [
        {
          "id": 1391,
          "name": "new InlineQuery",
          "variant": "signature",
          "kind": 16384,
          "flags": {},
          "sources": [
            {
              "fileName": "packages/tgkit/src/structures/InlineQuery.ts",
              "line": 36,
              "character": 1
            }
          ],
          "parameters": [
            {
              "id": 1392,
              "name": "client",
              "variant": "param",
              "kind": 32768,
              "flags": {},
              "type": {
                "type": "reference",
                "target": 1,
                "name": "Client",
                "package": "tgkit",
                "qualifiedName": "default"
              }
            },
            {
              "id": 1393,
              "name": "data",
              "variant": "param",
              "kind": 32768,
              "flags": {},
              "type": {
                "type": "intrinsic",
                "name": "any"
              }
            }
          ],
          "type": {
            "type": "reference",
            "target": 1389,
            "name": "InlineQuery",
            "package": "tgkit",
            "qualifiedName": "default"
          },
          "overwrites": {
            "type": "reference",
            "target": -1,
            "name": "Base.constructor"
          }
        }
      ],
      "overwrites": {
        "type": "reference",
        "target": -1,
        "name": "Base.constructor"
      }
    },
    {
      "id": 1398,
      "name": "chatType",
      "variant": "declaration",
      "kind": 1024,
      "flags": {
        "isOptional": true
      },
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Type of the chat, from which the inline query was sent.\nCan be either “sender” for a private chat with the inline query sender, “private”, “group”, “supergroup”, \nor “channel”. The chat type should be always known for requests sent from official clients and most\nthird-party clients, unless the request was sent from a secret chat."
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/InlineQuery.ts",
          "line": 30,
          "character": 1
        }
      ],
      "type": {
        "type": "reference",
        "target": 2086,
        "name": "ChatType",
        "package": "tgkit"
      }
    },
    {
      "id": 1400,
      "name": "client",
      "variant": "declaration",
      "kind": 1024,
      "flags": {
        "isInherited": true
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/Base.ts",
          "line": 4,
          "character": 1
        }
      ],
      "type": {
        "type": "reference",
        "target": 1,
        "name": "Client",
        "package": "tgkit",
        "qualifiedName": "default"
      },
      "inheritedFrom": {
        "type": "reference",
        "target": -1,
        "name": "Base.client"
      }
    },
    {
      "id": 1395,
      "name": "from",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Sender"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/InlineQuery.ts",
          "line": 16,
          "character": 1
        }
      ],
      "type": {
        "type": "reference",
        "target": 1888,
        "name": "User",
        "package": "tgkit",
        "qualifiedName": "default"
      }
    },
    {
      "id": 1394,
      "name": "id",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Unique identifier for this query"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/InlineQuery.ts",
          "line": 13,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "string"
      }
    },
    {
      "id": 1399,
      "name": "location",
      "variant": "declaration",
      "kind": 1024,
      "flags": {
        "isOptional": true
      },
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Sender location, only for bots that request user location"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/InlineQuery.ts",
          "line": 33,
          "character": 1
        }
      ],
      "type": {
        "type": "reference",
        "target": 1455,
        "name": "Location",
        "package": "tgkit",
        "qualifiedName": "default"
      }
    },
    {
      "id": 1397,
      "name": "offset",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Offset of the results to be returned, can be controlled by the bot"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/InlineQuery.ts",
          "line": 22,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "string"
      }
    },
    {
      "id": 1396,
      "name": "query",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Text of the query (up to 256 characters)"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/InlineQuery.ts",
          "line": 19,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "string"
      }
    }
  ],
  "groups": [
    {
      "title": "Constructors",
      "children": [
        1390
      ]
    },
    {
      "title": "Properties",
      "children": [
        1398,
        1400,
        1395,
        1394,
        1399,
        1397,
        1396
      ]
    }
  ],
  "sources": [
    {
      "fileName": "packages/tgkit/src/structures/InlineQuery.ts",
      "line": 11,
      "character": 21
    }
  ],
  "extendedTypes": [
    {
      "type": "reference",
      "target": {
        "sourceFileName": "packages/tgkit/src/structures/Base.ts",
        "qualifiedName": "default"
      },
      "name": "default",
      "package": "tgkit"
    }
  ]
}