Class WallAttachment

Hierarchy (view full)

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

Constructors

constructor

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

Properties

`Protected` $filled

$filled: boolean

`Protected` [kAttachments]

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

`Protected` [kCopyHistoryAttachments]

[kCopyHistoryAttachments]: WallAttachment[]

`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:437

authorId

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

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

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:402

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:444

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:430

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:360

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:324

geo

get geo(): undefined | object
Returns the geolocation

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

hasAds

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

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

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:163

hasUserReposted

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

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

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:203

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:196

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:258

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:269

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:185

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:225

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:214

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:247

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:236

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:174

isFavorited

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

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

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

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:291

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:280

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:409

likesCount

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

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

ownerId

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

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:416

postType

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

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

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:353

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:331

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:338

repostsCount

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

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

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:346

text

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

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

viewsCount

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

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

Methods

[kSerializeData]

[kSerializeData](): object
Returns the custom data

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

`Private` applyPayload

applyPayload(payload): void
Applies the payload
Parameters
- payload: IWallAttachmentPayload
Returns void
- Defined in packages/vk-io/src/structures/attachments/wall.ts:451

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

getAttachments

getAttachments(type): AudioAttachment[]
Returns the attachments
Parameters
- type: "audio" | AUDIO
Returns AudioAttachment[]
Inherited from Attachmentable.getAttachments
- Defined in packages/vk-io/src/structures/shared/attachmentable.ts:44
getAttachments(type): AudioMessageAttachment[]
Parameters
- type: "audio_message" | AUDIO_MESSAGE
Returns AudioMessageAttachment[]
Inherited from Attachmentable.getAttachments
- Defined in packages/vk-io/src/structures/shared/attachmentable.ts:46
getAttachments(type): GraffitiAttachment[]
Parameters
- type: "graffiti" | GRAFFITI
Returns GraffitiAttachment[]
Inherited from Attachmentable.getAttachments
- Defined in packages/vk-io/src/structures/shared/attachmentable.ts:48
getAttachments(type): DocumentAttachment[]
Parameters
- type: "doc" | DOCUMENT
Returns DocumentAttachment[]
Inherited from Attachmentable.getAttachments
- Defined in packages/vk-io/src/structures/shared/attachmentable.ts:50
getAttachments(type): MarketAlbumAttachment[]
Parameters
- type: "market_album" | MARKET_ALBUM
Returns MarketAlbumAttachment[]
Inherited from Attachmentable.getAttachments
- Defined in packages/vk-io/src/structures/shared/attachmentable.ts:52
getAttachments(type): MarketAttachment[]
Parameters
- type: "market" | MARKET
Returns MarketAttachment[]
Inherited from Attachmentable.getAttachments
- Defined in packages/vk-io/src/structures/shared/attachmentable.ts:54
getAttachments(type): PhotoAttachment[]
Parameters
- type: "photo" | PHOTO
Returns PhotoAttachment[]
Inherited from Attachmentable.getAttachments
- Defined in packages/vk-io/src/structures/shared/attachmentable.ts:56
getAttachments(type): StoryAttachment[]
Parameters
- type: "story" | STORY
Returns StoryAttachment[]
Inherited from Attachmentable.getAttachments
- Defined in packages/vk-io/src/structures/shared/attachmentable.ts:58
getAttachments(type): VideoAttachment[]
Parameters
- type: "video" | VIDEO
Returns VideoAttachment[]
Inherited from Attachmentable.getAttachments
- Defined in packages/vk-io/src/structures/shared/attachmentable.ts:60
getAttachments(type): WallAttachment[]
Parameters
- type: "wall" | WALL
Returns WallAttachment[]
Inherited from Attachmentable.getAttachments
- Defined in packages/vk-io/src/structures/shared/attachmentable.ts:62
getAttachments(type): PollAttachment[]
Parameters
- type: "poll" | POLL
Returns PollAttachment[]
Inherited from Attachmentable.getAttachments
- Defined in packages/vk-io/src/structures/shared/attachmentable.ts:64
getAttachments(type): GiftAttachment[]
Parameters
- type: "gift" | GIFT
Returns GiftAttachment[]
Inherited from Attachmentable.getAttachments
- Defined in packages/vk-io/src/structures/shared/attachmentable.ts:66
getAttachments(type): LinkAttachment[]
Parameters
- type: "link" | LINK
Returns LinkAttachment[]
Inherited from Attachmentable.getAttachments
- Defined in packages/vk-io/src/structures/shared/attachmentable.ts:68
getAttachments(type): StickerAttachment[]
Parameters
- type: "sticker" | STICKER
Returns StickerAttachment[]
Inherited from Attachmentable.getAttachments
- Defined in packages/vk-io/src/structures/shared/attachmentable.ts:70
getAttachments(type): WallReplyAttachment[]
Parameters
- type: "wall_reply" | WALL_REPLY
Returns WallReplyAttachment[]
Inherited from Attachmentable.getAttachments
- Defined in packages/vk-io/src/structures/shared/attachmentable.ts:72

hasAttachments

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

loadAttachmentPayload

loadAttachmentPayload(): Promise<void>
Load attachment payload

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

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

Class WallAttachment

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: WallAttachmentOptions

Returns WallAttachment

Properties

Protected $filled

Protected [kAttachments]

Protected [kCopyHistoryAttachments]

Protected api

Protected payload

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

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

Returns undefined | boolean

`Protected` $filled

`Protected` [kAttachments]

`Protected` [kCopyHistoryAttachments]

`Protected` api

`Protected` payload

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

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

Returns undefined | {
data: string;
platform: string;
type: string;
url: string;
}

`Private` applyPayload