Class Comment

Schema

See

Documentation for more details.

Hierarchy (View Summary)

Comment
Base<CommentData>
- Comment

Index

Constructors

Methods

[custom] delete edit hide mark toJSON unhide unvote vote

Constructors

constructor

new Comment(e621: E621, data: Comment): Comment
Parameters
- e621: E621
- data: Comment
Returns Comment
Inherited from Base.constructor
- Defined in lib/models/Base.ts:9

Methods

[custom]

"[custom]"(_depth: never, opts: InspectOptions): string
Parameters
- _depth: never
- opts: InspectOptions
Returns string
Inherited from Base.[custom]
- Defined in lib/models/Base.ts:17

delete

delete(): Promise<null>
Requires Api Key Auth
Delete Comment

You must be Admin+.

Returns Promise<null>
Operation Id
deleteComment

See
Documentation for more details.
- Defined in lib/models/Comment.ts:35

edit

edit(options: EditCommentOptions): Promise<null>
Requires Api Key Auth
Edit Comment

You must be the creator of the comment, or Admin+ to edit. Marked comments cannot be edited.
Parameters
- options: EditCommentOptions
Returns Promise<null>
Operation Id
editComment

See
Documentation for more details.
- Defined in lib/models/Comment.ts:52

hide

hide(): Promise<Comment>
Requires Api Key Auth
Hide Comment

You must be the creator or Moderator+.

Returns Promise<Comment>
Operation Id
hideComment

See
Documentation for more details.
- Defined in lib/models/Comment.ts:69

mark

mark(type: "unmark" | "ban" | "record" | "warning"): Promise<DTextResponse>
Requires Api Key Auth
Mark Comment

You must be Moderator+.
Parameters
- type: "unmark" | "ban" | "record" | "warning"
Returns Promise<DTextResponse>
Operation Id
markComment

See
Documentation for more details.
- Defined in lib/models/Comment.ts:85

toJSON

toJSON(): Comment
Returns Comment
Inherited from Base.toJSON
- Defined in lib/models/Base.ts:39

unhide

unhide(): Promise<Comment>
Requires Api Key Auth
Unhide Comment

You must be Moderator+.

Returns Promise<Comment>
Operation Id
unhideComment

See
Documentation for more details.
- Defined in lib/models/Comment.ts:102

unvote

unvote(): Promise<null>
Requires Api Key Auth
Delete Comment Vote

Returns Promise<null>
Operation Id
deleteCommentVote

See
Documentation for more details.
- Defined in lib/models/Comment.ts:116

vote

vote(score: -1 | 1, no_unvote?: boolean): Promise<{}>
Requires Api Key Auth
Create Comment Vote
Parameters
- score: -1 | 1
- Optionalno_unvote: boolean
Returns Promise<{}>
Operation Id
createCommentVote

See
Documentation for more details.
- Defined in lib/models/Comment.ts:130