ChatInviteLink Class

extends Base

Properties

  • client: Client
  • creator: User
  • expireDate: Date
  • inviteLink: string
  • isPrimary: boolean
  • isRevoked: boolean
  • memberLimit: number
  • pendingJoinRequestCount: number

Methods

  • toJSON()
{
  "id": 1142,
  "name": "ChatInviteLink",
  "variant": "declaration",
  "kind": 128,
  "flags": {},
  "children": [
    {
      "id": 1143,
      "name": "constructor",
      "variant": "declaration",
      "kind": 512,
      "flags": {},
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/ChatInviteLink.ts",
          "line": 31,
          "character": 1
        }
      ],
      "signatures": [
        {
          "id": 1144,
          "name": "new ChatInviteLink",
          "variant": "signature",
          "kind": 16384,
          "flags": {},
          "sources": [
            {
              "fileName": "packages/tgkit/src/structures/ChatInviteLink.ts",
              "line": 31,
              "character": 1
            }
          ],
          "parameters": [
            {
              "id": 1145,
              "name": "client",
              "variant": "param",
              "kind": 32768,
              "flags": {},
              "type": {
                "type": "reference",
                "target": 1,
                "name": "Client",
                "package": "tgkit",
                "qualifiedName": "default"
              }
            },
            {
              "id": 1146,
              "name": "data",
              "variant": "param",
              "kind": 32768,
              "flags": {},
              "type": {
                "type": "intrinsic",
                "name": "any"
              }
            }
          ],
          "type": {
            "type": "reference",
            "target": 1142,
            "name": "ChatInviteLink",
            "package": "tgkit",
            "qualifiedName": "default"
          },
          "overwrites": {
            "type": "reference",
            "target": -1,
            "name": "Base.constructor"
          }
        }
      ],
      "overwrites": {
        "type": "reference",
        "target": -1,
        "name": "Base.constructor"
      }
    },
    {
      "id": 1156,
      "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": 1148,
      "name": "creator",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Creator of the link"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/ChatInviteLink.ts",
          "line": 11,
          "character": 1
        }
      ],
      "type": {
        "type": "reference",
        "target": 1888,
        "name": "User",
        "package": "tgkit",
        "qualifiedName": "default"
      }
    },
    {
      "id": 1151,
      "name": "expireDate",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Point in time when the link will expire or has been expired"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/ChatInviteLink.ts",
          "line": 20,
          "character": 1
        }
      ],
      "type": {
        "type": "reference",
        "target": {
          "sourceFileName": "node_modules/.pnpm/typescript@5.5.3/node_modules/typescript/lib/lib.es5.d.ts",
          "qualifiedName": "Date"
        },
        "name": "Date",
        "package": "typescript"
      }
    },
    {
      "id": 1147,
      "name": "inviteLink",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Invite link"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/ChatInviteLink.ts",
          "line": 8,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "string"
      }
    },
    {
      "id": 1149,
      "name": "isPrimary",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "*true*, if the link is primary"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/ChatInviteLink.ts",
          "line": 14,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "boolean"
      }
    },
    {
      "id": 1150,
      "name": "isRevoked",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "*true*, if the link is revoked"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/ChatInviteLink.ts",
          "line": 17,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "boolean"
      }
    },
    {
      "id": 1152,
      "name": "memberLimit",
      "variant": "declaration",
      "kind": 1024,
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Maximum number of users that can be members of the chat \nsimultaneously after joining the chat via this invite link; 1-99999"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/ChatInviteLink.ts",
          "line": 25,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "number"
      }
    },
    {
      "id": 1153,
      "name": "pendingJoinRequestCount",
      "variant": "declaration",
      "kind": 1024,
      "flags": {
        "isOptional": true
      },
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Number of pending join requests created using this link"
          }
        ]
      },
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/ChatInviteLink.ts",
          "line": 28,
          "character": 1
        }
      ],
      "type": {
        "type": "intrinsic",
        "name": "number"
      }
    },
    {
      "id": 1154,
      "name": "toJSON",
      "variant": "declaration",
      "kind": 2048,
      "flags": {},
      "sources": [
        {
          "fileName": "packages/tgkit/src/structures/ChatInviteLink.ts",
          "line": 42,
          "character": 1
        }
      ],
      "signatures": [
        {
          "id": 1155,
          "name": "toJSON",
          "variant": "signature",
          "kind": 4096,
          "flags": {},
          "sources": [
            {
              "fileName": "packages/tgkit/src/structures/ChatInviteLink.ts",
              "line": 42,
              "character": 1
            }
          ],
          "type": {
            "type": "intrinsic",
            "name": "object"
          }
        }
      ]
    }
  ],
  "groups": [
    {
      "title": "Constructors",
      "children": [
        1143
      ]
    },
    {
      "title": "Properties",
      "children": [
        1156,
        1148,
        1151,
        1147,
        1149,
        1150,
        1152,
        1153
      ]
    },
    {
      "title": "Methods",
      "children": [
        1154
      ]
    }
  ],
  "sources": [
    {
      "fileName": "packages/tgkit/src/structures/ChatInviteLink.ts",
      "line": 6,
      "character": 21
    }
  ],
  "extendedTypes": [
    {
      "type": "reference",
      "target": {
        "sourceFileName": "packages/tgkit/src/structures/Base.ts",
        "qualifiedName": "default"
      },
      "name": "default",
      "package": "tgkit"
    }
  ]
}