Class AudioAttachment

Hierarchy (view full)

Attachment<IAudioAttachmentPayload, AUDIO | "audio">
- AudioAttachment

Index

Constructors

Properties

$filled api payload type

Accessors

[toStringTag] accessKey albumId artist canBeAttached createdAt duration genreId id isFilled isHq lyricsId ownerId title url

Methods

[kSerializeData] equals loadAttachmentPayload toJSON toString fromString

Constructors

constructor

new AudioAttachment(options): AudioAttachment
Constructor
Parameters
- options: AudioAttachmentOptions
Returns AudioAttachment
Overrides Attachment.constructor
- Defined in packages/vk-io/src/structures/attachments/audio.ts:29

Properties

`Protected` $filled

$filled: boolean

`Protected` api

api: API

`Protected` payload

payload: ISharedAttachmentPayload & IAudioAttachmentPayload

type

type: "audio" | AUDIO

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

albumId

get albumId(): undefined | number
Returns the ID of the album

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

artist

get artist(): undefined | string
Returns the artist

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

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 object when this audio was created

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

duration

get duration(): undefined | number
Returns the duration

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

genreId

get genreId(): undefined | number
Returns the ID of the genre

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

id

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

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:93

isHq

get isHq(): undefined | boolean
Checks whether audio is in high quality

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

lyricsId

get lyricsId(): undefined | number
Returns the ID of the lyric

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

ownerId

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

title

get title(): undefined | string
Returns the title

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

url

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

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

Methods

[kSerializeData]

[kSerializeData](): object
Returns the custom data

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

equals

equals(attachment): 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

loadAttachmentPayload

loadAttachmentPayload(): Promise<void>
Load attachment payload

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

toJSON

toJSON(): object
Returns data for JSON

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

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:123

`Static` fromString

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

Generated using TypeDoc