Class PostFlags

Hierarchy (View Summary)

Base
- PostFlags

Index

Constructors

Methods

clearNote create get resolve search

Constructors

constructor

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

Methods

clearNote

clearNote(id: number): Promise<PostFlag>
Requires Api Key Auth
Clear Post Flag Note

You must be Janitor+
Parameters
- id: number
Returns Promise<PostFlag>

Operation Id
post_flags#clear_note

See
Documentation for more details.
- Defined in lib/modules/PostFlags.ts:29

create

create(options: CreatePostFlagOptions): Promise<PostFlag>
Requires Api Key Auth
Create Post Flag

Will error if post_id is not provided.
Parameters
- options: CreatePostFlagOptions
Returns Promise<PostFlag>

Operation Id
post_flags#create

See
Documentation for more details.
- Defined in lib/modules/PostFlags.ts:48

get

get(id: number): Promise<PostFlag | null>
Get Post Flag
Parameters
- id: number
Returns Promise<PostFlag | null>

Operation Id
post_flags#show

See
Documentation for more details.
- Defined in lib/modules/PostFlags.ts:63

resolve

resolve(post_id: number): Promise<null>
Requires Api Key Auth
Unflag Post

You must have the "Approve Posts" permission.
Parameters
- post_id: number
Returns Promise<null>

Operation Id
post_flags#destroy

See
Documentation for more details.
- Defined in lib/modules/PostFlags.ts:82

search

search(options?: SearchPostFlagsOptions): Promise<PostFlag[]>
Post Flags Index
Parameters
- Optionaloptions: SearchPostFlagsOptions
Returns Promise<PostFlag[]>

Operation Id
post_flags#index

See
Documentation for more details.
- Defined in lib/modules/PostFlags.ts:97