LoginUrl Interface

{
  "id": 2103,
  "name": "LoginUrl",
  "variant": "declaration",
  "kind": 256,
  "flags": {},
  "children": [
    {
      "id": 2106,
      "name": "botUsername",
      "variant": "declaration",
      "kind": 1024,
      "flags": {
        "isOptional": true
      },
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Username of a bot, which will be used for user authorization. See Setting up a bot for more details.\nIf not specified, the current bot's username will be assumed.\nThe url's domain must be the same as the domain linked with the bot."
          }
        ],
        "blockTags": [
          {
            "tag": "@see",
            "content": [
              {
                "kind": "inline-tag",
                "tag": "@link",
                "text": "https://core.telegram.org/widgets/login#linking-your-domain-to-the-bot",
                "target": "https://core.telegram.org/widgets/login#linking-your-domain-to-the-bot"
              }
            ]
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/types.ts",
          "line": 206,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "string"
      }
    },
    {
      "id": 2105,
      "name": "forwardText",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "New text of the button in forwarded messages."
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/types.ts",
          "line": 199,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "string"
      }
    },
    {
      "id": 2107,
      "name": "requestWriteAccess",
      "variant": "declaration",
      "kind": 1024,
      "flags": {
        "isOptional": true
      },
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Pass *true* to request the permission for your bot to send messages to the user."
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/types.ts",
          "line": 208,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "boolean"
      }
    },
    {
      "id": 2104,
      "name": "url",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "An HTTPS URL to be opened with user authorization data added to the query string when the button is pressed. \nIf the user refuses to provide authorization data, the original URL without information about the user \nwill be opened. The data added is the same as described in\n[Receiving authorization data](https://core.telegram.org/widgets/login#receiving-authorization-data).\n\nNOTE: You must always check the hash of the received data to verify the authentication and the integrity\nof the data as described in\n[Checking authorization](https://core.telegram.org/widgets/login#checking-authorization)."
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/types.ts",
          "line": 197,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "string"
      }
    }
  ],
  "groups": [
    {
      "title": "Properties",
      "children": [
        2106,
        2105,
        2107,
        2104
      ]
    }
  ],
  "sources": [
    {
      "fileName": "packages/tgkit/src/types.ts",
      "line": 186,
      "character": 17
    }
  ]
}