Class Document

Hierarchy

BaseEntity
- Document

Index

Constructors

Properties

Accessors

caption encryptedUrl fileSize key mimeType mimetype sha256 timestamp

Methods

Constructors

constructor

new Document(raw: IDocumentMessage): Document
Parameters
- raw: IDocumentMessage
Returns Document
Overrides BaseEntity.constructor
- Defined in src/structures/entities/document.ts:11

Properties

raw

raw: IDocumentMessage

Accessors

caption

get caption(): undefined | string
Get caption from the document

Returns

Returns undefined | string
- Defined in src/structures/entities/document.ts:20

encryptedUrl

get encryptedUrl(): string
Get encrypted message media url

Returns

Returns string
Inherited from BaseEntity.encryptedUrl
- Defined in src/structures/entities/baseEntity.ts:33

fileSize

get fileSize(): number
Get file size of media

Returns

Returns number
Inherited from BaseEntity.fileSize
- Defined in src/structures/entities/baseEntity.ts:83

key

get key(): Uint8Array
Get mediaKey of media file

Returns

Returns Uint8Array
Inherited from BaseEntity.key
- Defined in src/structures/entities/baseEntity.ts:74

mimeType

get mimeType(): string
Get mimetype of media

Returns

Returns string
Inherited from BaseEntity.mimeType
- Defined in src/structures/entities/baseEntity.ts:42

mimetype

get mimetype(): string
Get mimetype from the document

Returns

Returns string
- Defined in src/structures/entities/document.ts:29

sha256

get sha256(): {
enc: Uint8Array;
source: Uint8Array;
}
SHA256 media file

Returns

Returns {
enc: Uint8Array;
source: Uint8Array;
}
- enc: Uint8Array
- source: Uint8Array
Inherited from BaseEntity.sha256
- Defined in src/structures/entities/baseEntity.ts:62

timestamp

get timestamp(): number
Get message timestamp message

Returns

Returns number
Inherited from BaseEntity.timestamp
- Defined in src/structures/entities/baseEntity.ts:51

Methods

retrieveFile

retrieveFile(type: "image" | "video" | "audio" | "ptt" | "sticker" | "document" | "product" | "gif" | "ppic" | "thumbnail-document" | "thumbnail-image" | "thumbnail-video" | "thumbnail-link" | "md-msg-hist" | "md-app-state" | "product-catalog-image" | "payment-bg-image"): Promise<Buffer>
Fetch encrypted url file.

Returns
Parameters
- type: "image" | "video" | "audio" | "ptt" | "sticker" | "document" | "product" | "gif" | "ppic" | "thumbnail-document" | "thumbnail-image" | "thumbnail-video" | "thumbnail-link" | "md-msg-hist" | "md-app-state" | "product-catalog-image" | "payment-bg-image"
  
  Media Type (e.g sticker, video, image)
Returns Promise<Buffer>
Inherited from BaseEntity.retrieveFile
- Defined in src/structures/entities/baseEntity.ts:95

Generated using TypeDoc