Class MarketAlbumAttachment

Hierarchy (view full)

Attachment<IMarketAlbumAttachmentPayload, MARKET_ALBUM | "market_album">
- MarketAlbumAttachment

Index

Constructors

Properties

$filled api payload photo? type

Accessors

[toStringTag] accessKey canBeAttached count id isFilled ownerId title updatedAt

Methods

[kSerializeData] applyPayload equals loadAttachmentPayload toJSON toString fromString

Constructors

constructor

new MarketAlbumAttachment(options): MarketAlbumAttachment
Constructor
Parameters
- options: MarketAlbumAttachmentOptions
Returns MarketAlbumAttachment
Overrides Attachment.constructor
- Defined in packages/vk-io/src/structures/attachments/market-album.ts:26

Properties

`Protected` $filled

$filled: boolean

`Protected` api

api: API

`Protected` payload

payload: ISharedAttachmentPayload & IMarketAlbumAttachmentPayload

`Optional` photo

photo?: PhotoAttachment

type

type: "market_album" | MARKET_ALBUM

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

count

get count(): undefined | number
Returns count of products on the album

Returns undefined | number
- Defined in packages/vk-io/src/structures/attachments/market-album.ts:66

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

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 album title

Returns undefined | string
- Defined in packages/vk-io/src/structures/attachments/market-album.ts:59

updatedAt

get updatedAt(): undefined | number
Returns the date when this album was updated

Returns undefined | number
- Defined in packages/vk-io/src/structures/attachments/market-album.ts:73

Methods

[kSerializeData]

[kSerializeData](): object
Returns the custom data

Returns object
Inherited from Attachment.[kSerializeData]
- Defined in packages/vk-io/src/structures/attachments/attachment.ts:147

`Private` applyPayload

applyPayload(payload): void
Applies the payload
Parameters
- payload: IMarketAlbumAttachmentPayload
Returns void
- Defined in packages/vk-io/src/structures/attachments/market-album.ts:80

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/market-album.ts:41

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