Class DocumentAttachment

Hierarchy (View Summary)

Attachment<IDocumentAttachmentPayload, DOCUMENT | "doc">
- DocumentAttachment

Index

Constructors

Properties

Accessors

[toStringTag] accessKey canBeAttached createdAt extension id isArchive isAudio isBook isFilled isGif isGraffiti isImage isText isVideo isVoice ownerId preview size title typeId url

Methods

[kSerializeData] equals hasPreviewProperty loadAttachmentPayload toJSON toString fromString

Constructors

constructor

new DocumentAttachment(options: DocumentAttachmentOptions): DocumentAttachment
Constructor
Parameters
- options: DocumentAttachmentOptions
Returns DocumentAttachment
Overrides Attachment.constructor
- Defined in packages/vk-io/src/structures/attachments/document.ts:41

Properties

`Protected`$filled

$filled: boolean

`Protected`api

api: API

`Protected`payload

payload: ISharedAttachmentPayload & IDocumentAttachmentPayload

type

type: "doc" | DOCUMENT

Accessors

[toStringTag]

get "[toStringTag]"(): string
Returns custom tag

Returns string
Inherited from Attachment.[toStringTag]
- Defined in packages/vk-io/src/structures/attachments/attachment.ts:65

accessKey

get accessKey(): undefined | string
Returns undefined | string
Inherited from Attachment.accessKey
- Defined in packages/vk-io/src/structures/attachments/attachment.ts:58

canBeAttached

get canBeAttached(): boolean
Can be attached via string representation

Returns boolean
Inherited from Attachment.canBeAttached
- Defined in packages/vk-io/src/structures/attachments/attachment.ts:101

createdAt

get createdAt(): undefined | number
Returns the date when this document was created

Returns undefined | number
- Defined in packages/vk-io/src/structures/attachments/document.ts:177

extension

get extension(): undefined | string
Returns the extension

Returns undefined | string
- Defined in packages/vk-io/src/structures/attachments/document.ts:214

id

get id(): number
Returns number
Inherited from Attachment.id
- Defined in packages/vk-io/src/structures/attachments/attachment.ts:50

isArchive

get isArchive(): undefined | boolean
Checks if the document is an archive

Returns undefined | boolean
- Defined in packages/vk-io/src/structures/attachments/document.ts:82

isAudio

get isAudio(): undefined | boolean
Checks if the document is an audio

Returns undefined | boolean
- Defined in packages/vk-io/src/structures/attachments/document.ts:126

isBook

get isBook(): undefined | boolean
Checks if the document is a book

Returns undefined | boolean
- Defined in packages/vk-io/src/structures/attachments/document.ts:159

isFilled

get isFilled(): boolean
Returns whether the attachment is filled

Returns boolean
Inherited from Attachment.isFilled
- Defined in packages/vk-io/src/structures/attachments/attachment.ts:94

isGif

get isGif(): undefined | boolean
Checks if the document is a gif file

Returns undefined | boolean
- Defined in packages/vk-io/src/structures/attachments/document.ts:93

isGraffiti

get isGraffiti(): undefined | boolean
Checks if the document is a graffiti

Returns undefined | boolean
- Defined in packages/vk-io/src/structures/attachments/document.ts:115

isImage

get isImage(): undefined | boolean
Checks if the document is an image

Returns undefined | boolean
- Defined in packages/vk-io/src/structures/attachments/document.ts:104

isText

get isText(): undefined | boolean
Checks if the document is a text

Returns undefined | boolean
- Defined in packages/vk-io/src/structures/attachments/document.ts:71

isVideo

get isVideo(): undefined | boolean
Checks if the document is a video

Returns undefined | boolean
- Defined in packages/vk-io/src/structures/attachments/document.ts:148

isVoice

get isVoice(): undefined | boolean
Checks if the document is a voice

Returns undefined | boolean
- Defined in packages/vk-io/src/structures/attachments/document.ts:137

ownerId

get ownerId(): number
Returns number
Inherited from Attachment.ownerId
- Defined in packages/vk-io/src/structures/attachments/attachment.ts:54

preview

get preview(): | undefined
| {
    audio_message?: {
        duration: number;
        link_mp3: string;
        link_ogg: string;
        waveform: number[];
    };
    graffiti?: { height: number; src: string; width: number };
    photo?: IPhotoSize[];
}
Returns the info to preview

Returns
    | undefined
    | {
        audio_message?: {
            duration: number;
            link_mp3: string;
            link_ogg: string;
            waveform: number[];
        };
        graffiti?: { height: number; src: string; width: number };
        photo?: IPhotoSize[];
    }
- Defined in packages/vk-io/src/structures/attachments/document.ts:228

size

get size(): undefined | number
Returns the size in bytes

Returns undefined | number
- Defined in packages/vk-io/src/structures/attachments/document.ts:207

title

get title(): undefined | string
Returns the document title

Returns undefined | string
- Defined in packages/vk-io/src/structures/attachments/document.ts:170

typeId

get typeId(): undefined | 2 | 1 | 3 | 4 | 8 | 5 | 6 | 7
Returns the type identifier

1 - text documents

2 - archives

3 - gif

4 - images

5 - audio

6 - video

7 - e-books

8 - unknown

Returns undefined | 2 | 1 | 3 | 4 | 8 | 5 | 6 | 7
- Defined in packages/vk-io/src/structures/attachments/document.ts:200

url

get url(): undefined | string
Returns the URL of the document

Returns undefined | string
- Defined in packages/vk-io/src/structures/attachments/document.ts:221

Methods

[kSerializeData]

"[kSerializeData]"(): object
Returns the custom data

Returns object
Overrides Attachment.[kSerializeData]
- Defined in packages/vk-io/src/structures/attachments/document.ts:242

equals

equals(attachment: string | Attachment<object, string>): boolean
Checks that the attachment is equivalent with object
Parameters
- attachment: string | Attachment<object, string>
Returns boolean
Inherited from Attachment.equals
- Defined in packages/vk-io/src/structures/attachments/attachment.ts:108

hasPreviewProperty

hasPreviewProperty(name: "audio_message" | "graffiti" | "photo"): boolean
Checks for a property in preview
Parameters
- name: "audio_message" | "graffiti" | "photo"
Returns boolean
- Defined in packages/vk-io/src/structures/attachments/document.ts:235

loadAttachmentPayload

loadAttachmentPayload(): Promise<void>
Load attachment payload

Returns Promise<void>
- Defined in packages/vk-io/src/structures/attachments/document.ts:54

toJSON

toJSON(): object
Returns data for JSON

Returns object
Inherited from Attachment.toJSON
- Defined in packages/vk-io/src/structures/attachments/attachment.ts:126

toString

toString(): string
Returns a string to attach a VK

Returns string
Inherited from Attachment.toString
- Defined in packages/vk-io/src/structures/attachments/attachment.ts:117

`Static`fromString

fromString(attachment: string, api: API): Attachment
Parse attachment with string
Parameters
- attachment: string
- api: API
Returns Attachment
Inherited from Attachment.fromString
- Defined in packages/vk-io/src/structures/attachments/attachment.ts:72

Class DocumentAttachment

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns DocumentAttachment

Properties

Protected$filled

Protectedapi

Protectedpayload

type

Accessors

[toStringTag]

Returns string

accessKey

Returns undefined | string

canBeAttached

Returns boolean

createdAt

Returns undefined | number

extension

Returns undefined | string

id

Returns number

isArchive

Returns undefined | boolean

isAudio

Returns undefined | boolean

isBook

Returns undefined | boolean

isFilled

Returns boolean

isGif

Returns undefined | boolean

isGraffiti

Returns undefined | boolean

isImage

Returns undefined | boolean

isText

Returns undefined | boolean

isVideo

Returns undefined | boolean

isVoice

Returns undefined | boolean

ownerId

Returns number

preview

Returns | undefined | { audio_message?: { duration: number; link_mp3: string; link_ogg: string; waveform: number[]; }; graffiti?: { height: number; src: string; width: number }; photo?: IPhotoSize[]; }

size

Returns undefined | number

title

Returns undefined | string

typeId

Returns undefined | 2 | 1 | 3 | 4 | 8 | 5 | 6 | 7

url

Returns undefined | string

Methods

[kSerializeData]

Returns object

equals

Parameters

Returns boolean

hasPreviewProperty

Parameters

Returns boolean

loadAttachmentPayload

Returns Promise<void>

toJSON

Returns object

toString

Returns string

StaticfromString

Parameters

Returns Attachment

Settings

`Protected`$filled

`Protected`api

`Protected`payload

Returns
| undefined
| {
audio_message?: {
duration: number;
link_mp3: string;
link_ogg: string;
waveform: number[];
};
graffiti?: { height: number; src: string; width: number };
photo?: IPhotoSize[];
}

`Static`fromString