Class VideoAttachment

Hierarchy (view full)

Attachment<IVideoAttachmentPayload, VIDEO | "video">
- VideoAttachment

Index

Constructors

constructor

new VideoAttachment(options): VideoAttachment
Constructor
Parameters
- options: VideoAttachmentOptions
Returns VideoAttachment
Overrides Attachment.constructor
- Defined in packages/vk-io/src/structures/attachments/video.ts:36

Properties

`Protected` $filled

$filled: boolean

`Protected` api

api: API

`Protected` payload

payload: ISharedAttachmentPayload & IVideoAttachmentPayload

type

type: "video" | VIDEO

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

addedAt

get addedAt(): undefined | number
Returns the date when this video was added

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

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

commentsCount

get commentsCount(): undefined | number
Returns the count comments

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

createdAt

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

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

description

get description(): undefined | string
Returns the description

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

duration

get duration(): undefined | number
Returns the duration

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

id

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

isBroadcast

get isBroadcast(): undefined | boolean
Checks whether the video is a broadcast

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

isCanAdd

get isCanAdd(): undefined | boolean
Checks that the user can add a video to himself

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

isCanEdit

get isCanEdit(): undefined | boolean
Checks if the user can edit the video

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

isFavorited

get isFavorited(): undefined | boolean
Checks is bookmarked current user

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

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

isProcessing

get isProcessing(): undefined | boolean
Checks whether the video is being processed

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

isRepeat

get isRepeat(): undefined | boolean
Checks whether the video is repeatable

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

isUpcoming

get isUpcoming(): undefined | boolean
Checks whether the video is a broadcast

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

ownerId

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

platformName

get platformName(): undefined | string
Returns the name of the platform (for video recordings added from external sites)

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

player

get player(): undefined | string
Returns the URL of the page with the player

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

title

get title(): undefined | string
Returns the title

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

viewsCount

get viewsCount(): undefined | number
Returns the count views

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

Methods

[kSerializeData]

[kSerializeData](): object
Returns the custom data

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

`Protected` checkBooleanInProperty

checkBooleanInProperty(name): undefined | boolean
Checks for a boolean value in the property
Parameters
- name: string
Returns undefined | boolean
- Defined in packages/vk-io/src/structures/attachments/video.ts:185

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/video.ts:49

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