Class PostFlags

Hierarchy (View Summary)

Base
- PostFlags

Index

Constructors

Methods

clearNote create get 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:19

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
clearPostFlagNote

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

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
createPostFlag

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

get

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

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

search

search(options?: SearchPostFlagsOptions): Promise<PostFlag[]>
Search Post Flags
Parameters
- Optionaloptions: SearchPostFlagsOptions
Returns Promise<PostFlag[]>
Operation Id
searchPostFlags

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