Class WallAttachment

Hierarchy (View Summary)

Attachment<IWallAttachmentPayload, WALL | "wall">
Attachmentable
- WallAttachment

Constructors

constructor

new WallAttachment(options: WallAttachmentOptions): WallAttachment
Constructor
Parameters
- options: WallAttachmentOptions
Returns WallAttachment
Overrides Attachment.constructor
- Defined in packages/vk-io/src/structures/attachments/wall.ts:95

Properties

`Protected`[kAttachments]

"[kAttachments]": (
Attachment<object, string>
| ExternalAttachment<object, string>
)[]

`Protected`[kCopyHistoryAttachments]

"[kCopyHistoryAttachments]": WallAttachment[]

`Protected`$filled

$filled: boolean

`Protected`api

api: API

`Protected`payload

payload: ISharedAttachmentPayload & IWallAttachmentPayload

type

type: "wall" | WALL

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

attachments

get attachments(): (
Attachment<object, string>
| ExternalAttachment<object, string>
)[]
Returns the attachments

Returns (Attachment<object, string> | ExternalAttachment<object, string>)[]
- Defined in packages/vk-io/src/structures/attachments/wall.ts:443

authorId

get authorId(): undefined | number
Returns the identifier author

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

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

commentsCount

get commentsCount(): undefined | number
Returns the comments count

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

copyHistory

get copyHistory(): undefined | WallAttachment[]
Returns the history of reposts for post

Returns undefined | WallAttachment[]
- Defined in packages/vk-io/src/structures/attachments/wall.ts:450

copyright

get copyright(): | undefined
| { id?: number; link: string; name: string; type: string }
Returns the copyright

Returns undefined | { id?: number; link: string; name: string; type: string }
- Defined in packages/vk-io/src/structures/attachments/wall.ts:429

createdAt

get createdAt(): undefined | number
Returns the date when this post was created

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

createdUserId

get createdUserId(): undefined | number
Returns the administrator identifier that posted the entry

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

donut

get donut(): | undefined
| {
    can_publish_free_copy?: boolean;
    durations?: { id: number; name: string }[];
    edit_mode?: "all" | "duration";
    is_donut: boolean;
    paid_duration?: number;
    placeholder?: { text: string };
}
Returns the donut

Returns
    | undefined
    | {
        can_publish_free_copy?: boolean;
        durations?: { id: number; name: string }[];
        edit_mode?: "all" | "duration";
        is_donut: boolean;
        paid_duration?: number;
        placeholder?: { text: string };
    }
- Defined in packages/vk-io/src/structures/attachments/wall.ts:436

geo

get geo(): undefined | object
Returns the geolocation

Returns undefined | object
- Defined in packages/vk-io/src/structures/attachments/wall.ts:422

hasAds

get hasAds(): undefined | boolean
Checks has ads in post

Returns undefined | boolean
- Defined in packages/vk-io/src/structures/attachments/wall.ts:139

hasComments

get hasComments(): undefined | boolean
Checks has comments

Returns undefined | boolean
- Defined in packages/vk-io/src/structures/attachments/wall.ts:130

hasUserLike

get hasUserLike(): undefined | boolean
Checks has this user likes

Returns undefined | boolean
- Defined in packages/vk-io/src/structures/attachments/wall.ts:161

hasUserReposted

get hasUserReposted(): undefined | boolean
Checks has this user reposted

Returns undefined | boolean
- Defined in packages/vk-io/src/structures/attachments/wall.ts:150

id

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

isCanCloseComments

get isCanCloseComments(): undefined | boolean
Checks if a user can close on a comments

Returns undefined | boolean
- Defined in packages/vk-io/src/structures/attachments/wall.ts:201

isCanCommented

get isCanCommented(): undefined | boolean
Checks if you can comment on a post

Returns undefined | boolean
- Defined in packages/vk-io/src/structures/attachments/wall.ts:194

isCanDelete

get isCanDelete(): undefined | boolean
Checks is can this user delete post

Returns undefined | boolean
- Defined in packages/vk-io/src/structures/attachments/wall.ts:256

isCanEdit

get isCanEdit(): undefined | boolean
Checks is can this user edit post

Returns undefined | boolean
- Defined in packages/vk-io/src/structures/attachments/wall.ts:267

isCanGroupsCommented

get isCanGroupsCommented(): undefined | boolean
Checks if a community can comment on a post

Returns undefined | boolean
- Defined in packages/vk-io/src/structures/attachments/wall.ts:183

isCanLike

get isCanLike(): undefined | boolean
Checks whether the current user can like the record

Returns undefined | boolean
- Defined in packages/vk-io/src/structures/attachments/wall.ts:223

isCanOpenComments

get isCanOpenComments(): undefined | boolean
Checks if a user can open on a comments

Returns undefined | boolean
- Defined in packages/vk-io/src/structures/attachments/wall.ts:212

isCanPin

get isCanPin(): undefined | boolean
Checks is can this user pin post

Returns undefined | boolean
- Defined in packages/vk-io/src/structures/attachments/wall.ts:245

isCanReposted

get isCanReposted(): undefined | boolean
hecks whether the current user can repost the record

Returns undefined | boolean
- Defined in packages/vk-io/src/structures/attachments/wall.ts:234

isCanUserCommented

get isCanUserCommented(): undefined | boolean
Checks can the current user comment on the entry

Returns undefined | boolean
- Defined in packages/vk-io/src/structures/attachments/wall.ts:172

isFavorited

get isFavorited(): undefined | boolean
Checks is bookmarked current user

Returns undefined | boolean
- Defined in packages/vk-io/src/structures/attachments/wall.ts:300

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

isFriendsOnly

get isFriendsOnly(): undefined | boolean
Checks is post created only by friends

Returns undefined | boolean
- Defined in packages/vk-io/src/structures/attachments/wall.ts:289

isPinned

get isPinned(): undefined | boolean
Checks is can this user edit post

Returns undefined | boolean
- Defined in packages/vk-io/src/structures/attachments/wall.ts:278

likes

get likes(): | undefined
| {
    can_like: number;
    can_publish: number;
    count: number;
    user_likes: number;
}
Returns the likes info

Returns
    | undefined
    | {
        can_like: number;
        can_publish: number;
        count: number;
        user_likes: number;
    }
- Defined in packages/vk-io/src/structures/attachments/wall.ts:408

likesCount

get likesCount(): undefined | number
Returns the likes count

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

ownerId

get ownerId(): number
Returns number
Overrides Attachment.ownerId
- Defined in packages/vk-io/src/structures/attachments/wall.ts:308

postponedId

get postponedId(): undefined | number
Returns the id of the pending entry. This field is returned when the entry was on the timer.

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

postSource

get postSource(): | undefined
| { data: string; platform: string; type: string; url: string }
Returns the post source

Returns undefined | { data: string; platform: string; type: string; url: string }
- Defined in packages/vk-io/src/structures/attachments/wall.ts:415

postType

get postType(): undefined | string
Returns the post type

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

replyOwnerId

get replyOwnerId(): undefined | number
The identifier of the record owner, in response to which the current

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

replyPostId

get replyPostId(): undefined | number
The identifier of the record in response to which the current one was left.

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

repostsCount

get repostsCount(): undefined | number
Returns the reposts count

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

signerId

get signerId(): undefined | number
Returns author identifier if the entry was published on behalf of the community and signed by the user

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

text

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

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

viewsCount

get viewsCount(): undefined | number
Returns the number of record views

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

Methods

[kSerializeData]

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

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

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

getAttachments

getAttachments(type: "audio" | AUDIO): AudioAttachment[]
Returns the attachments
Parameters
- type: "audio" | AUDIO
Returns AudioAttachment[]
Inherited from Attachmentable.getAttachments
- Defined in packages/vk-io/src/structures/shared/attachmentable.ts:41
getAttachments(type: "audio_message" | AUDIO_MESSAGE): AudioMessageAttachment[]
Returns the attachments
Parameters
- type: "audio_message" | AUDIO_MESSAGE
Returns AudioMessageAttachment[]
Inherited from Attachmentable.getAttachments
- Defined in packages/vk-io/src/structures/shared/attachmentable.ts:43
getAttachments(type: "graffiti" | GRAFFITI): GraffitiAttachment[]
Returns the attachments
Parameters
- type: "graffiti" | GRAFFITI
Returns GraffitiAttachment[]
Inherited from Attachmentable.getAttachments
- Defined in packages/vk-io/src/structures/shared/attachmentable.ts:45
getAttachments(type: "doc" | DOCUMENT): DocumentAttachment[]
Returns the attachments
Parameters
- type: "doc" | DOCUMENT
Returns DocumentAttachment[]
Inherited from Attachmentable.getAttachments
- Defined in packages/vk-io/src/structures/shared/attachmentable.ts:47
getAttachments(type: "market_album" | MARKET_ALBUM): MarketAlbumAttachment[]
Returns the attachments
Parameters
- type: "market_album" | MARKET_ALBUM
Returns MarketAlbumAttachment[]
Inherited from Attachmentable.getAttachments
- Defined in packages/vk-io/src/structures/shared/attachmentable.ts:49
getAttachments(type: "market" | MARKET): MarketAttachment[]
Returns the attachments
Parameters
- type: "market" | MARKET
Returns MarketAttachment[]
Inherited from Attachmentable.getAttachments
- Defined in packages/vk-io/src/structures/shared/attachmentable.ts:51
getAttachments(type: "photo" | PHOTO): PhotoAttachment[]
Returns the attachments
Parameters
- type: "photo" | PHOTO
Returns PhotoAttachment[]
Inherited from Attachmentable.getAttachments
- Defined in packages/vk-io/src/structures/shared/attachmentable.ts:53
getAttachments(type: "story" | STORY): StoryAttachment[]
Returns the attachments
Parameters
- type: "story" | STORY
Returns StoryAttachment[]
Inherited from Attachmentable.getAttachments
- Defined in packages/vk-io/src/structures/shared/attachmentable.ts:55
getAttachments(type: "video" | VIDEO): VideoAttachment[]
Returns the attachments
Parameters
- type: "video" | VIDEO
Returns VideoAttachment[]
Inherited from Attachmentable.getAttachments
- Defined in packages/vk-io/src/structures/shared/attachmentable.ts:57
getAttachments(type: "wall" | WALL): WallAttachment[]
Returns the attachments
Parameters
- type: "wall" | WALL
Returns WallAttachment[]
Inherited from Attachmentable.getAttachments
- Defined in packages/vk-io/src/structures/shared/attachmentable.ts:59
getAttachments(type: "poll" | POLL): PollAttachment[]
Returns the attachments
Parameters
- type: "poll" | POLL
Returns PollAttachment[]
Inherited from Attachmentable.getAttachments
- Defined in packages/vk-io/src/structures/shared/attachmentable.ts:61
getAttachments(type: "gift" | GIFT): GiftAttachment[]
Returns the attachments
Parameters
- type: "gift" | GIFT
Returns GiftAttachment[]
Inherited from Attachmentable.getAttachments
- Defined in packages/vk-io/src/structures/shared/attachmentable.ts:63
getAttachments(type: "link" | LINK): LinkAttachment[]
Returns the attachments
Parameters
- type: "link" | LINK
Returns LinkAttachment[]
Inherited from Attachmentable.getAttachments
- Defined in packages/vk-io/src/structures/shared/attachmentable.ts:65
getAttachments(type: "sticker" | STICKER): StickerAttachment[]
Returns the attachments
Parameters
- type: "sticker" | STICKER
Returns StickerAttachment[]
Inherited from Attachmentable.getAttachments
- Defined in packages/vk-io/src/structures/shared/attachmentable.ts:67
getAttachments(type: "wall_reply" | WALL_REPLY): WallReplyAttachment[]
Returns the attachments
Parameters
- type: "wall_reply" | WALL_REPLY
Returns WallReplyAttachment[]
Inherited from Attachmentable.getAttachments
- Defined in packages/vk-io/src/structures/shared/attachmentable.ts:69

hasAttachments

hasAttachments(type?: AttachmentTypeString | AttachmentType): boolean
Checks for the presence of attachments
Parameters
- Optionaltype: AttachmentTypeString | AttachmentType
Returns boolean
Inherited from Attachmentable.hasAttachments
- Defined in packages/vk-io/src/structures/shared/attachmentable.ts:30

loadAttachmentPayload

loadAttachmentPayload(): Promise<void>
Load attachment payload

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

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

Class WallAttachment

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns WallAttachment

Properties

Protected[kAttachments]

Protected[kCopyHistoryAttachments]

Protected$filled

Protectedapi

Protectedpayload

type

Accessors

[toStringTag]

Returns string

accessKey

Returns undefined | string

attachments

Returns (Attachment<object, string> | ExternalAttachment<object, string>)[]

authorId

Returns undefined | number

canBeAttached

Returns boolean

commentsCount

Returns undefined | number

copyHistory

Returns undefined | WallAttachment[]

copyright

Returns undefined | { id?: number; link: string; name: string; type: string }

createdAt

Returns undefined | number

createdUserId

Returns undefined | number

donut

Returns | undefined | { can_publish_free_copy?: boolean; durations?: { id: number; name: string }[]; edit_mode?: "all" | "duration"; is_donut: boolean; paid_duration?: number; placeholder?: { text: string }; }

geo

Returns undefined | object

hasAds

Returns undefined | boolean

hasComments

Returns undefined | boolean

hasUserLike

Returns undefined | boolean

hasUserReposted

Returns undefined | boolean

id

Returns number

isCanCloseComments

Returns undefined | boolean

isCanCommented

Returns undefined | boolean

isCanDelete

Returns undefined | boolean

isCanEdit

Returns undefined | boolean

isCanGroupsCommented

Returns undefined | boolean

isCanLike

Returns undefined | boolean

isCanOpenComments

Returns undefined | boolean

isCanPin

Returns undefined | boolean

isCanReposted

Returns undefined | boolean

isCanUserCommented

Returns undefined | boolean

isFavorited

Returns undefined | boolean

isFilled

Returns boolean

isFriendsOnly

Returns undefined | boolean

isPinned

`Protected`[kAttachments]

`Protected`[kCopyHistoryAttachments]

`Protected`$filled

`Protected`api

`Protected`payload

Returns
| undefined
| {
can_publish_free_copy?: boolean;
durations?: { id: number; name: string }[];
edit_mode?: "all" | "duration";
is_donut: boolean;
paid_duration?: number;
placeholder?: { text: string };
}

Returns
| undefined
| {
can_like: number;
can_publish: number;
count: number;
user_likes: number;
}