Class LinkAttachment

Hierarchy (view full)

ExternalAttachment<ILinkAttachmentPayload, LINK | "link">
- LinkAttachment

Index

Constructors

Properties

$filled [kPhoto] api payload type

Accessors

[toStringTag] button canBeAttached caption description hasPhoto isFilled photo product title url

Methods

[kSerializeData] toJSON

Constructors

constructor

new LinkAttachment(options): LinkAttachment
Constructor
Parameters
- options: LinkAttachmentOptions
Returns LinkAttachment
Overrides ExternalAttachment.constructor
- Defined in packages/vk-io/src/structures/attachments/link.ts:37

Properties

`Protected` $filled

$filled: boolean

`Protected` [kPhoto]

[kPhoto]: undefined | PhotoAttachment

`Protected` api

api: API

`Protected` payload

payload: ILinkAttachmentPayload

type

type: "link" | LINK

Accessors

[toStringTag]

get [toStringTag](): string
Returns custom tag

Returns string
Inherited from ExternalAttachment.[toStringTag]
- Defined in packages/vk-io/src/structures/attachments/external.ts:38

button

get button(): undefined | {
    action: {
        type: string;
        url: string;
    };
    title: string;
}
Returns the button

Returns undefined | {
    action: {
        type: string;
        url: string;
    };
    title: string;
}
- Defined in packages/vk-io/src/structures/attachments/link.ts:97

canBeAttached

get canBeAttached(): boolean
Can be attached via string representation

Returns boolean
Inherited from ExternalAttachment.canBeAttached
- Defined in packages/vk-io/src/structures/attachments/external.ts:53

caption

get caption(): undefined | string
Returns the title

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

description

get description(): undefined | string
Returns the description

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

hasPhoto

get hasPhoto(): boolean
Checks for the presence of a photo in a link

Returns boolean
- Defined in packages/vk-io/src/structures/attachments/link.ts:55

isFilled

get isFilled(): boolean
Returns whether the attachment is filled

Returns boolean
Inherited from ExternalAttachment.isFilled
- Defined in packages/vk-io/src/structures/attachments/external.ts:45

photo

get photo(): undefined | PhotoAttachment
Returns the photo

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

product

get product(): undefined | {
price: object;
}
Returns the product

Returns undefined | {
price: object;
}
- Defined in packages/vk-io/src/structures/attachments/link.ts:90

title

get title(): string
Returns the title

Returns string
- Defined in packages/vk-io/src/structures/attachments/link.ts:62

url

get url(): string
Returns the URL of the link

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

Methods

[kSerializeData]

[kSerializeData](): object
Returns the custom data

Returns object
Overrides ExternalAttachment.[kSerializeData]
- Defined in packages/vk-io/src/structures/attachments/link.ts:111

toJSON

toJSON(): object
Returns data for JSON

Returns object
Inherited from ExternalAttachment.toJSON
- Defined in packages/vk-io/src/structures/attachments/external.ts:60

Generated using TypeDoc