Contact Class

extends Base

Represents a phone contact

Properties

  • client: Client
  • firstName: string
  • lastName: string
  • phoneNumber: string
  • userId: number
  • vcard: string

Methods

{
  "id": 1254,
  "name": "Contact",
  "variant": "declaration",
  "kind": 128,
  "flags": {},
  "comment": {
    "summary": [
      {
        "kind": "text",
        "text": "Represents a phone contact"
      }
    ]
  },
  "children": [
    {
      "id": 1255,
      "name": "constructor",
      "variant": "declaration",
      "kind": 512,
      "flags": {},
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/Contact.ts",
          "line": 25,
          "character": 1
        }
      ],
      "signatures": [
        {
          "id": 1256,
          "name": "new Contact",
          "variant": "signature",
          "kind": 16384,
          "flags": {},
          "sources": [
            {
              "fileName": "packages/tgkit/src/structures/Contact.ts",
              "line": 25,
              "character": 1
            }
          ],
          "parameters": [
            {
              "id": 1257,
              "name": "client",
              "variant": "param",
              "kind": 32768,
              "flags": {},
              "type": {
                "type": "reference",
                "target": 1,
                "name": "Client",
                "package": "tgkit",
                "qualifiedName": "default"
              }
            },
            {
              "id": 1258,
              "name": "data",
              "variant": "param",
              "kind": 32768,
              "flags": {},
              "type": {
                "type": "intrinsic",
                "name": "any"
              }
            }
          ],
          "type": {
            "type": "reference",
            "target": 1254,
            "name": "Contact",
            "package": "tgkit",
            "qualifiedName": "default"
          },
          "overwrites": {
            "type": "reference",
            "target": -1,
            "name": "Base.constructor"
          }
        }
      ],
      "overwrites": {
        "type": "reference",
        "target": -1,
        "name": "Base.constructor"
      }
    },
    {
      "id": 1264,
      "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": 1260,
      "name": "firstName",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Contact's first name"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/Contact.ts",
          "line": 10,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "string"
      }
    },
    {
      "id": 1261,
      "name": "lastName",
      "variant": "declaration",
      "kind": 1024,
      "flags": {
        "isOptional": true
      },
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Contact's last name"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/Contact.ts",
          "line": 13,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "string"
      }
    },
    {
      "id": 1259,
      "name": "phoneNumber",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Contact's phone number"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/Contact.ts",
          "line": 7,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "string"
      }
    },
    {
      "id": 1262,
      "name": "userId",
      "variant": "declaration",
      "kind": 1024,
      "flags": {
        "isOptional": true
      },
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Contact's user identifier in Telegram"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/Contact.ts",
          "line": 16,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "number"
      }
    },
    {
      "id": 1263,
      "name": "vcard",
      "variant": "declaration",
      "kind": 1024,
      "flags": {
        "isOptional": true
      },
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Additional data about the contact in the form of a vCard"
          }
        ],
        "blockTags": [
          {
            "tag": "@see",
            "content": [
              {
                "kind": "inline-tag",
                "tag": "@link",
                "text": "https://en.wikipedia.org/wiki/VCard",
                "target": "https://en.wikipedia.org/wiki/VCard"
              }
            ]
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/Contact.ts",
          "line": 22,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "string"
      }
    }
  ],
  "groups": [
    {
      "title": "Constructors",
      "children": [
        1255
      ]
    },
    {
      "title": "Properties",
      "children": [
        1264,
        1260,
        1261,
        1259,
        1262,
        1263
      ]
    }
  ],
  "sources": [
    {
      "fileName": "packages/tgkit/src/structures/Contact.ts",
      "line": 5,
      "character": 21
    }
  ],
  "extendedTypes": [
    {
      "type": "reference",
      "target": {
        "sourceFileName": "packages/tgkit/src/structures/Base.ts",
        "qualifiedName": "default"
      },
      "name": "default",
      "package": "tgkit"
    }
  ]
}