PreCheckoutQuery Class

extends Base

Contains information about an incoming pre-checkout query.

Properties

  • client: Client
  • currency: Currency
  • from: User
  • id: string
  • invoicePayload: string
  • orderInfo: OrderInfo
  • shippingOptionId: string
  • totalAmount: number

Methods

{
  "id": 1773,
  "name": "PreCheckoutQuery",
  "variant": "declaration",
  "kind": 128,
  "flags": {},
  "comment": {
    "summary": [
      {
        "kind": "text",
        "text": "Contains information about an incoming pre-checkout query."
      }
    ]
  },
  "children": [
    {
      "id": 1774,
      "name": "constructor",
      "variant": "declaration",
      "kind": 512,
      "flags": {},
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/PreCheckoutQuery.ts",
          "line": 37,
          "character": 1
        }
      ],
      "signatures": [
        {
          "id": 1775,
          "name": "new PreCheckoutQuery",
          "variant": "signature",
          "kind": 16384,
          "flags": {},
          "sources": [
            {
              "fileName": "packages/tgkit/src/structures/PreCheckoutQuery.ts",
              "line": 37,
              "character": 1
            }
          ],
          "parameters": [
            {
              "id": 1776,
              "name": "client",
              "variant": "param",
              "kind": 32768,
              "flags": {},
              "type": {
                "type": "reference",
                "target": 1,
                "name": "Client",
                "package": "tgkit",
                "qualifiedName": "default"
              }
            },
            {
              "id": 1777,
              "name": "data",
              "variant": "param",
              "kind": 32768,
              "flags": {},
              "type": {
                "type": "intrinsic",
                "name": "any"
              }
            }
          ],
          "type": {
            "type": "reference",
            "target": 1773,
            "name": "PreCheckoutQuery",
            "package": "tgkit",
            "qualifiedName": "default"
          },
          "overwrites": {
            "type": "reference",
            "target": -1,
            "name": "Base.constructor"
          }
        }
      ],
      "overwrites": {
        "type": "reference",
        "target": -1,
        "name": "Base.constructor"
      }
    },
    {
      "id": 1785,
      "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": 1780,
      "name": "currency",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Three-letter ISO 4217 currency code, or \"XTR\" for payments in Telegram Stars"
          }
        ],
        "blockTags": [
          {
            "tag": "@see",
            "content": [
              {
                "kind": "inline-tag",
                "tag": "@link",
                "text": "https://core.telegram.org/bots/payments#supported-currencies",
                "target": "https://core.telegram.org/bots/payments#supported-currencies"
              }
            ]
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/PreCheckoutQuery.ts",
          "line": 18,
          "character": 1
        }
      ],
      "type": {
        "type": "reference",
        "target": 2088,
        "name": "Currency",
        "package": "tgkit"
      }
    },
    {
      "id": 1779,
      "name": "from",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "User who sent the query"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/PreCheckoutQuery.ts",
          "line": 12,
          "character": 1
        }
      ],
      "type": {
        "type": "reference",
        "target": 1888,
        "name": "User",
        "package": "tgkit",
        "qualifiedName": "default"
      }
    },
    {
      "id": 1778,
      "name": "id",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Unique query identifier"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/PreCheckoutQuery.ts",
          "line": 9,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "string"
      }
    },
    {
      "id": 1782,
      "name": "invoicePayload",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Bot-specified invoice payload"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/PreCheckoutQuery.ts",
          "line": 29,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "string"
      }
    },
    {
      "id": 1784,
      "name": "orderInfo",
      "variant": "declaration",
      "kind": 1024,
      "flags": {
        "isOptional": true
      },
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Order information provided by the user"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/PreCheckoutQuery.ts",
          "line": 35,
          "character": 1
        }
      ],
      "type": {
        "type": "reference",
        "target": 2812,
        "name": "OrderInfo",
        "package": "tgkit"
      }
    },
    {
      "id": 1783,
      "name": "shippingOptionId",
      "variant": "declaration",
      "kind": 1024,
      "flags": {
        "isOptional": true
      },
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Identifier of the shipping option chosen by the user"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/PreCheckoutQuery.ts",
          "line": 32,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "string"
      }
    },
    {
      "id": 1781,
      "name": "totalAmount",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Total price in the *smallest units* of the currency (integer, **not** float/double).\nFor example, for a price of "
          },
          {
            "kind": "code",
            "text": "`US$ 1.45`"
          },
          {
            "kind": "text",
            "text": " pass "
          },
          {
            "kind": "code",
            "text": "`totalAmount: 145`"
          },
          {
            "kind": "text",
            "text": ".\nSee the *exp* parameter in [currencies.json](https://core.telegram.org/bots/payments/currencies.json),\nit shows the number of digits past the decimal point for each currency (2 for the majority of currencies)."
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/PreCheckoutQuery.ts",
          "line": 26,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "number"
      }
    }
  ],
  "groups": [
    {
      "title": "Constructors",
      "children": [
        1774
      ]
    },
    {
      "title": "Properties",
      "children": [
        1785,
        1780,
        1779,
        1778,
        1782,
        1784,
        1783,
        1781
      ]
    }
  ],
  "sources": [
    {
      "fileName": "packages/tgkit/src/structures/PreCheckoutQuery.ts",
      "line": 7,
      "character": 21
    }
  ],
  "extendedTypes": [
    {
      "type": "reference",
      "target": {
        "sourceFileName": "packages/tgkit/src/structures/Base.ts",
        "qualifiedName": "default"
      },
      "name": "default",
      "package": "tgkit"
    }
  ]
}