Class Comment

Schema

See

Documentation for more details.

Hierarchy (View Summary)

Comment
Base<CommentData>
- Comment

Index

Constructors

Methods

[custom] createVote delete hide mark toJSON unhide unvote update

Constructors

constructor

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

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

createVote

createVote(
score: UpDownVote,
no_unvote?: boolean,
): Promise<CommentVotesCreateResponse>
Requires Api Key Auth
Parameters
- score: UpDownVote
- Optionalno_unvote: boolean
Returns Promise<CommentVotesCreateResponse>

Operation Id
comment_votes#create

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

delete

delete(): Promise<null>
Requires Api Key Auth
You must be Admin+.

Returns Promise<null>

Operation Id
comments#destroy

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

hide

hide(): Promise<Comment>
Requires Api Key Auth
You must be the creator or Moderator+.

Returns Promise<Comment>

Operation Id
comments#hide

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

mark

mark(
type: "unmark" | "ban" | "record" | "warning",
): Promise<CommentsWarningResponse>
Requires Api Key Auth
You must be Moderator+.
Parameters
- type: "unmark" | "ban" | "record" | "warning"
Returns Promise<CommentsWarningResponse>

Operation Id
comments#warning

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

toJSON

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

unhide

unhide(): Promise<Comment>
Requires Api Key Auth
You must be Moderator+.

Returns Promise<Comment>

Operation Id
comments#unhide

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

unvote

unvote(): Promise<null>
Requires Api Key Auth
Returns Promise<null>

Operation Id
comment_votes#destroy

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

update

update(options: UpdateCommentOptions): Promise<null>
Requires Api Key Auth
You must be the creator of the comment, or Admin+ to edit. Marked comments cannot be edited.
Parameters
- options: UpdateCommentOptions
Returns Promise<null>

Operation Id
comments#update

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