Class GiftAttachment

Hierarchy (view full)

ExternalAttachment<IGiftAttachmentPayload, GIFT | "gift">
- GiftAttachment

Index

Constructors

Properties

$filled api payload type

Accessors

[toStringTag] canBeAttached id isFilled

Methods

[kSerializeData] toJSON

Constructors

constructor

new GiftAttachment(options): GiftAttachment
Constructor
Parameters
- options: GiftAttachmentOptions
Returns GiftAttachment
Overrides ExternalAttachment.constructor
- Defined in packages/vk-io/src/structures/attachments/gift.ts:17

Properties

`Protected` $filled

$filled: boolean

`Protected` api

api: API

`Protected` payload

payload: IGiftAttachmentPayload

type

type: "gift" | GIFT

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

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

id

get id(): number
Returns the identifier gift

Returns number
- Defined in packages/vk-io/src/structures/attachments/gift.ts:28

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

Methods

[kSerializeData]

[kSerializeData](): object
Returns the custom data

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

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