Document Class
extends BaseRepresents an audio file to be treated as music by the Telegram clients
Properties
client: Client
fileId: string
fileName: string
fileSize: number
fileUniqueId: string
mimeType: string
thumbnail: PhotoSize
Methods
{ "id": 1273, "name": "Document", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Represents an audio file to be treated as music by the Telegram clients" } ] }, "children": [ { "id": 1274, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { "fileName": "packages/tgkit/src/structures/Document.ts", "line": 29, "character": 1 } ], "signatures": [ { "id": 1275, "name": "new Document", "variant": "signature", "kind": 16384, "flags": {}, "sources": [ { "fileName": "packages/tgkit/src/structures/Document.ts", "line": 29, "character": 1 } ], "parameters": [ { "id": 1276, "name": "client", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 1, "name": "Client", "package": "tgkit", "qualifiedName": "default" } }, { "id": 1277, "name": "data", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "reference", "target": 1273, "name": "Document", "package": "tgkit", "qualifiedName": "default" }, "overwrites": { "type": "reference", "target": -1, "name": "Base.constructor" } } ], "overwrites": { "type": "reference", "target": -1, "name": "Base.constructor" } }, { "id": 1284, "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": 1278, "name": "fileId", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Identifier for this file, which can be used to download or reuse the file" } ] }, "sources": [ { "fileName": "packages/tgkit/src/structures/Document.ts", "line": 8, "character": 1 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1281, "name": "fileName", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Original filename as defined by sender" } ] }, "sources": [ { "fileName": "packages/tgkit/src/structures/Document.ts", "line": 20, "character": 1 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1283, "name": "fileSize", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "File size in bytes" } ] }, "sources": [ { "fileName": "packages/tgkit/src/structures/Document.ts", "line": 26, "character": 1 } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 1279, "name": "fileUniqueId", "variant": "declaration", "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Unique identifier for this file, which is supposed to be the same over time and for different bots.\nCan't be used to download or reuse the file." } ] }, "sources": [ { "fileName": "packages/tgkit/src/structures/Document.ts", "line": 14, "character": 1 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1282, "name": "mimeType", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "MIME type of the file as defined by sender" } ] }, "sources": [ { "fileName": "packages/tgkit/src/structures/Document.ts", "line": 23, "character": 1 } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 1280, "name": "thumbnail", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Document thumbnail as defined by sender" } ] }, "sources": [ { "fileName": "packages/tgkit/src/structures/Document.ts", "line": 17, "character": 1 } ], "type": { "type": "reference", "target": 1726, "name": "PhotoSize", "package": "tgkit", "qualifiedName": "default" } } ], "groups": [ { "title": "Constructors", "children": [ 1274 ] }, { "title": "Properties", "children": [ 1284, 1278, 1281, 1283, 1279, 1282, 1280 ] } ], "sources": [ { "fileName": "packages/tgkit/src/structures/Document.ts", "line": 6, "character": 21 } ], "extendedTypes": [ { "type": "reference", "target": { "sourceFileName": "packages/tgkit/src/structures/Base.ts", "qualifiedName": "default" }, "name": "default", "package": "tgkit" } ] }