Class CommentContext<S>

Type Parameters

S = ContextDefaultState

Hierarchy (view full)

Context<ICommentContextPayload, S, CommentContextType, CommentContextSubType>
Attachmentable
- CommentContext

Constructors

constructor

new CommentContext<S>(options): CommentContext<S>
Type Parameters
- S = ContextDefaultState
Parameters
- options: CommentContextOptions<S>
Returns CommentContext<S>
Overrides Attachmentable.constructor
- Defined in packages/vk-io/src/structures/contexts/comment.ts:75

Properties

`Optional` $groupId

$groupId?: number

`Protected` api

api: API

attachments

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

`Protected` payload

payload: ICommentContextPayload

state

state: S

subTypes

subTypes: CommentContextSubType[]

type

type: "comment"

`Protected` upload

upload: Upload

Accessors

[toStringTag]

get [toStringTag](): string
Returns custom tag

Returns string
Inherited from Context.[toStringTag]
- Defined in packages/vk-io/src/structures/contexts/context.ts:76

createdAt

get createdAt(): undefined | number
Returns the date creation action comment

Returns undefined | number
- Defined in packages/vk-io/src/structures/contexts/comment.ts:250

deleterUserId

get deleterUserId(): undefined | number
Returns the identifier of the user who deleted the comment

Returns undefined | number
- Defined in packages/vk-io/src/structures/contexts/comment.ts:212

fromId

get fromId(): undefined | number
identifier of who wrote the comment

Returns undefined | number
- Defined in packages/vk-io/src/structures/contexts/comment.ts:195

id

get id(): number
Returns the identifier comment

Returns number
- Defined in packages/vk-io/src/structures/contexts/comment.ts:181

isBoardComment

get isBoardComment(): boolean
Checks is board comment

Returns boolean
- Defined in packages/vk-io/src/structures/contexts/comment.ts:146

isDelete

get isDelete(): boolean
Checks is delete comment

Returns boolean
- Defined in packages/vk-io/src/structures/contexts/comment.ts:111

isEdit

get isEdit(): boolean
Checks is edit comment

Returns boolean
- Defined in packages/vk-io/src/structures/contexts/comment.ts:104

isGroup

get isGroup(): boolean
Checks if the group wrote a message

Returns boolean
- Defined in packages/vk-io/src/structures/contexts/comment.ts:174

isMarketComment

get isMarketComment(): boolean
Checks is board comment

Returns boolean
- Defined in packages/vk-io/src/structures/contexts/comment.ts:153

isNew

get isNew(): boolean
Checks is new comment

Returns boolean
- Defined in packages/vk-io/src/structures/contexts/comment.ts:97

isPhotoComment

get isPhotoComment(): boolean
Checks is photo comment

Returns boolean
- Defined in packages/vk-io/src/structures/contexts/comment.ts:125

isReply

get isReply(): boolean
Checks is reply comment

Returns boolean
- Defined in packages/vk-io/src/structures/contexts/comment.ts:160

isRestore

get isRestore(): boolean
Checks is restore comment

Returns boolean
- Defined in packages/vk-io/src/structures/contexts/comment.ts:118

isUser

get isUser(): boolean
Checks if the user wrote a message

Returns boolean
- Defined in packages/vk-io/src/structures/contexts/comment.ts:167

isVideoComment

get isVideoComment(): boolean
Checks is video comment

Returns boolean
- Defined in packages/vk-io/src/structures/contexts/comment.ts:139

isWallComment

get isWallComment(): boolean
Checks is wall comment

Returns boolean
- Defined in packages/vk-io/src/structures/contexts/comment.ts:132

likes

get likes(): undefined | Record<string, any>
Returns the likes

Returns undefined | Record<string, any>
- Defined in packages/vk-io/src/structures/contexts/comment.ts:265

objectId

get objectId(): number
Returns the identifier of object

Returns number
- Defined in packages/vk-io/src/structures/contexts/comment.ts:219

ownerId

get ownerId(): number
Returns the identifier of owner

Returns number
- Defined in packages/vk-io/src/structures/contexts/comment.ts:234

replyId

get replyId(): undefined | number
Returns the identifier reply comment

Returns undefined | number
- Defined in packages/vk-io/src/structures/contexts/comment.ts:188

replyUserId

get replyUserId(): undefined | number
Returns the identifier reply user

Returns undefined | number
- Defined in packages/vk-io/src/structures/contexts/comment.ts:205

text

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

Returns undefined | string
- Defined in packages/vk-io/src/structures/contexts/comment.ts:257

Methods

[kSerializeData]

[kSerializeData](): object
Returns the custom data

Returns object
Overrides Context.[kSerializeData]
- Defined in packages/vk-io/src/structures/contexts/comment.ts:376

deleteComment

deleteComment(): Promise<number>
Removes comment

Returns Promise<number>
- Defined in packages/vk-io/src/structures/contexts/comment.ts:330

editComment

editComment(options): Promise<number>
Edits a comment
Parameters
- options: {
  attachments?: any;
  message?: string;
  }
  - Optional attachments?: any
  - Optional message?: string
Returns Promise<number>
- Defined in packages/vk-io/src/structures/contexts/comment.ts:280

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

includesFromSubType

includesFromSubType(type): boolean
Includes from subtype
Parameters
- type: string
Returns boolean
- Defined in packages/vk-io/src/structures/contexts/comment.ts:272

is

is(rawTypes): boolean
Checks whether the context of some of these types
Parameters
- rawTypes: ("comment" | CommentContextSubType)[]
Returns boolean
Inherited from Context.is
- Defined in packages/vk-io/src/structures/contexts/context.ts:83

toJSON

toJSON(): object
Returns data for JSON

Returns object
Inherited from Context.toJSON
- Defined in packages/vk-io/src/structures/contexts/context.ts:100

Class CommentContext<S>

Type Parameters

S = ContextDefaultState

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

S = ContextDefaultState

Parameters

options: CommentContextOptions<S>

Returns CommentContext<S>

Properties

Optional $groupId

Protected api

attachments

Protected payload

state

subTypes

type

Protected upload

Accessors

[toStringTag]

Returns string

createdAt

Returns undefined | number

deleterUserId

Returns undefined | number

fromId

Returns undefined | number

id

Returns number

isBoardComment

Returns boolean

isDelete

Returns boolean

isEdit

Returns boolean

isGroup

Returns boolean

isMarketComment

Returns boolean

isNew

Returns boolean

isPhotoComment

Returns boolean

isReply

Returns boolean

isRestore

Returns boolean

isUser

Returns boolean

isVideoComment

Returns boolean

isWallComment

Returns boolean

likes

Returns undefined | Record<string, any>

objectId

Returns number

ownerId

Returns number

replyId

Returns undefined | number

replyUserId

Returns undefined | number

text

Returns undefined | string

Methods

[kSerializeData]

Returns object

deleteComment

Returns Promise<number>

editComment

Parameters

options: { attachments?: any; message?: string; }

`Optional` $groupId

`Protected` api

`Protected` payload

`Protected` upload

options: {
attachments?: any;
message?: string;
}

`Optional` attachments?: any

`Optional` message?: string

`Optional` type: AttachmentTypeString | AttachmentType