Class AudioMessageAttachment

Hierarchy (View Summary)

Attachment<IAudioMessageAttachmentPayload, AUDIO_MESSAGE | "audio_message">
- AudioMessageAttachment

Index

Constructors

Properties

$filled api payload type

Accessors

[toStringTag] accessKey canBeAttached duration id isFilled isTranscriptDone locale mp3Url oggUrl ownerId transcript transcriptState url waveform

Methods

[kSerializeData] equals loadAttachmentPayload toJSON toString fromString

Constructors

constructor

new AudioMessageAttachment(
options: AudioMessageAttachmentOptions,
): AudioMessageAttachment
Constructor
Parameters
- options: AudioMessageAttachmentOptions
Returns AudioMessageAttachment
Overrides Attachment.constructor
- Defined in packages/vk-io/src/structures/attachments/audio-message.ts:30

Properties

`Protected`$filled

$filled: boolean

`Protected`api

api: API

`Protected`payload

payload: ISharedAttachmentPayload & IAudioMessageAttachmentPayload

type

type: "audio_message" | AUDIO_MESSAGE

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

duration

get duration(): undefined | number
Returns the duration of the audio message

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

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

isTranscriptDone

get isTranscriptDone(): boolean
Returns the transcript of the audio message

Returns boolean
- Defined in packages/vk-io/src/structures/attachments/audio-message.ts:109

locale

get locale(): undefined | string
Returns the locale of the audio message

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

mp3Url

get mp3Url(): undefined | string
Returns the mp3 URL of the audio message

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

oggUrl

get oggUrl(): undefined | string
Returns the ogg URL of the audio message

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

ownerId

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

transcript

get transcript(): undefined | string
Returns the transcript of the audio message

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

transcriptState

get transcriptState(): undefined | "done"
Returns the transcript of the audio message

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

url

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

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

waveform

get waveform(): undefined | number[]
Returns the waveform of the audio message

Returns undefined | number[]
- Defined in packages/vk-io/src/structures/attachments/audio-message.ts:67

Methods

[kSerializeData]

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

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

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

loadAttachmentPayload

loadAttachmentPayload(): Promise<void>
Load attachment payload

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

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