UserShared Class

extends Base

Information about the user whose identifier was shared with the bot using a KeyboardButtonRequestUser button

Properties

  • client: Client
  • requestId: number
  • userId: number

Methods

{
  "id": 1908,
  "name": "UserShared",
  "variant": "declaration",
  "kind": 128,
  "flags": {},
  "comment": {
    "summary": [
      {
        "kind": "text",
        "text": "Information about the user whose identifier was shared with the bot using a KeyboardButtonRequestUser button"
      }
    ]
  },
  "children": [
    {
      "id": 1909,
      "name": "constructor",
      "variant": "declaration",
      "kind": 512,
      "flags": {},
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/UserShared.ts",
          "line": 16,
          "character": 1
        }
      ],
      "signatures": [
        {
          "id": 1910,
          "name": "new UserShared",
          "variant": "signature",
          "kind": 16384,
          "flags": {},
          "sources": [
            {
              "fileName": "packages/tgkit/src/structures/UserShared.ts",
              "line": 16,
              "character": 1
            }
          ],
          "parameters": [
            {
              "id": 1911,
              "name": "client",
              "variant": "param",
              "kind": 32768,
              "flags": {},
              "type": {
                "type": "reference",
                "target": 1,
                "name": "Client",
                "package": "tgkit",
                "qualifiedName": "default"
              }
            },
            {
              "id": 1912,
              "name": "data",
              "variant": "param",
              "kind": 32768,
              "flags": {},
              "type": {
                "type": "intrinsic",
                "name": "any"
              }
            }
          ],
          "type": {
            "type": "reference",
            "target": 1908,
            "name": "User",
            "package": "tgkit",
            "qualifiedName": "default"
          },
          "overwrites": {
            "type": "reference",
            "target": -1,
            "name": "Base.constructor"
          }
        }
      ],
      "overwrites": {
        "type": "reference",
        "target": -1,
        "name": "Base.constructor"
      }
    },
    {
      "id": 1915,
      "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": 1913,
      "name": "requestId",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Identifier of the request."
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/UserShared.ts",
          "line": 7,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "number"
      }
    },
    {
      "id": 1914,
      "name": "userId",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Identifier of the shared user.\nThe bot may not have access to the user and could be unable to use this identifier,\nunless the user is already known to the bot by some other means."
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/UserShared.ts",
          "line": 14,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "number"
      }
    }
  ],
  "groups": [
    {
      "title": "Constructors",
      "children": [
        1909
      ]
    },
    {
      "title": "Properties",
      "children": [
        1915,
        1913,
        1914
      ]
    }
  ],
  "sources": [
    {
      "fileName": "packages/tgkit/src/structures/UserShared.ts",
      "line": 5,
      "character": 21
    }
  ],
  "extendedTypes": [
    {
      "type": "reference",
      "target": {
        "sourceFileName": "packages/tgkit/src/structures/Base.ts",
        "qualifiedName": "default"
      },
      "name": "default",
      "package": "tgkit"
    }
  ]
}