Class Comments

Hierarchy (View Summary)

Base
- Comments

Index

Constructors

Properties

Methods

create delete edit get hide mark search unhide

Constructors

constructor

new Comments(e621: E621, client: Client): Comments
Parameters
- e621: E621
- client: Client
Returns Comments
Inherited from Base.constructor
- Defined in lib/modules/Base.ts:19

Properties

votes

votes: CommentVotes = ...

Methods

create

create(options: CreateCommentOptions): Promise<Comment>
Requires Api Key Auth
Create Comment
Parameters
- options: CreateCommentOptions
Returns Promise<Comment>
Operation Id
createComment

See
Documentation for more details.
- Defined in lib/modules/Comments.ts:52

delete

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

You must be Admin+.
Parameters
- id: number
Returns Promise<null>
Operation Id
deleteComment

See
Documentation for more details.
- Defined in lib/modules/Comments.ts:72

edit

edit(id: number, 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
- id: number
- options: EditCommentOptions
Returns Promise<null>
Operation Id
editComment

See
Documentation for more details.
- Defined in lib/modules/Comments.ts:92

get

get(id: number): Promise<Comment | null>
Get Comment

If the comment is hidden, you must be the creator or Janitor+ to see it.
Parameters
- id: number
Returns Promise<Comment | null>
Operation Id
getComment

See
Documentation for more details.
- Defined in lib/modules/Comments.ts:110

hide

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

You must be the creator or Moderator+.
Parameters
- id: number
Returns Promise<Comment>
Operation Id
hideComment

See
Documentation for more details.
- Defined in lib/modules/Comments.ts:130

mark

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

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

See
Documentation for more details.
- Defined in lib/modules/Comments.ts:149

search

search(options?: SearchCommentsOptions): Promise<Comment[]>
Search Comments

For searching comments, group_by=comment must be set.
Parameters
- Optionaloptions: SearchCommentsOptions
Returns Promise<Comment[]>
Operation Id
searchComments

See
Documentation for more details.
- Defined in lib/modules/Comments.ts:167

unhide

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

You must be Moderator+.
Parameters
- id: number
Returns Promise<Comment>
Operation Id
unhideComment

See
Documentation for more details.
- Defined in lib/modules/Comments.ts:187