Class GraffitiAttachment

Hierarchy (view full)

Attachment<IGraffitiAttachmentPayload, GRAFFITI | "graffiti">
- GraffitiAttachment

Index

Constructors

Properties

$filled api payload type

Accessors

[toStringTag] accessKey canBeAttached height id isFilled ownerId url width

Methods

[kSerializeData] equals loadAttachmentPayload toJSON toString fromString

Constructors

constructor

new GraffitiAttachment(options): GraffitiAttachment
Constructor
Parameters
- options: GraffitiAttachmentOptions
Returns GraffitiAttachment
Overrides Attachment.constructor
- Defined in packages/vk-io/src/structures/attachments/graffiti.ts:24

Properties

`Protected` $filled

$filled: boolean

`Protected` api

api: API

`Protected` payload

payload: ISharedAttachmentPayload & IGraffitiAttachmentPayload

type

type: "graffiti" | GRAFFITI

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

height

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

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

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

url

get url(): undefined | string
Returns the URL of the document

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

width

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

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

Methods

[kSerializeData]

[kSerializeData](): object
Returns the custom data

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

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/graffiti.ts:37

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