Class Comments

Hierarchy (View Summary)

Base
- Comments

Index

Constructors

Methods

create delete get hide mark search unhide update

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

Methods

create

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

Operation Id
comments#create

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
comments#destroy

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

get

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

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

Operation Id
comments#show

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

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
comments#hide

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

mark

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

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

Operation Id
comments#warning

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

search

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

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

Operation Id
comments#index

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

unhide

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

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

Operation Id
comments#unhide

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

update

update(id: number, options: UpdateCommentOptions): Promise<null>
Requires Api Key Auth
Update Comment

You must be the creator of the comment, or Admin+ to edit. Marked comments cannot be edited.
Parameters
- id: number
- options: UpdateCommentOptions
Returns Promise<null>

Operation Id
comments#update

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