Class PhotoAttachment

Hierarchy (View Summary)

Attachment<IPhotoAttachmentPayload, PHOTO | "photo">
- PhotoAttachment

Index

Constructors

Properties

$filled api payload type

Accessors

[toStringTag] accessKey albumId canBeAttached createdAt height id isFilled largeSizeUrl mediumSizeUrl ownerId sizes smallSizeUrl text userId width

Methods

[kSerializeData] equals getSizes loadAttachmentPayload toJSON toString fromString

Constructors

constructor

new PhotoAttachment(options: PhotoAttachmentOptions): PhotoAttachment
Constructor
Parameters
- options: PhotoAttachmentOptions
Returns PhotoAttachment
Overrides Attachment.constructor
- Defined in packages/vk-io/src/structures/attachments/photo.ts:38

Properties

`Protected`$filled

$filled: boolean

`Protected`api

api: API

`Protected`payload

payload: ISharedAttachmentPayload & IPhotoAttachmentPayload

type

type: "photo" | PHOTO

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/photo.ts:76

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 photo was created

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

height

get height(): undefined | number
Returns the photo height

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

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

largeSizeUrl

get largeSizeUrl(): undefined | string
Returns the URL of a large photo (2560 or 1280 or less)

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

mediumSizeUrl

get mediumSizeUrl(): undefined | string
Returns the URL of a medium photo (807 or 604 or less)

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

ownerId

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

sizes

get sizes(): undefined | IPhotoSize[]
Returns the sizes

Returns undefined | IPhotoSize[]
- Defined in packages/vk-io/src/structures/attachments/photo.ts:153

smallSizeUrl

get smallSizeUrl(): undefined | string
Returns the URL of a small photo (130 or 75)

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

text

get text(): undefined | string
Returns the photo text

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

userId

get userId(): undefined | number
Returns the ID of the user who uploaded the image

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

width

get width(): undefined | number
Returns the photo width

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

Methods

[kSerializeData]

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

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

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

getSizes

getSizes(sizeTypes: string[]): IPhotoSize[]
Returns the sizes of the required types
Parameters
- sizeTypes: string[]
Returns IPhotoSize[]
- Defined in packages/vk-io/src/structures/attachments/photo.ts:160

loadAttachmentPayload

loadAttachmentPayload(): Promise<void>
Load attachment payload

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

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