Class Takedown

Schema

See

Documentation for more details.

Hierarchy (View Summary)

Takedown
Base<TakedownData>
- Takedown

Index

Constructors

Methods

[custom] addByIds addByTags countMatchingPosts delete edit removeByIds toJSON

Constructors

constructor

new Takedown(e621: E621, data: Takedown): Takedown
Parameters
- e621: E621
- data: Takedown
Returns Takedown
Inherited from Base.constructor
- Defined in lib/models/Base.ts:9

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

addByIds

addByIds(post_ids: number[]): Promise<AddPostsToTakedownByIdsResponse>
Requires Api Key Auth
Add Posts To Takedown By IDs

You must have the bd staff user flag.
Parameters
- post_ids: number[]
Returns Promise<AddPostsToTakedownByIdsResponse>
Operation Id
addPostsToTakedownByIds

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

addByTags

addByTags(tags: string[]): Promise<AddPostsToTakedownByTagsResponse>
Requires Api Key Auth
Add Posts To Takedown By Tags

You must have the bd staff user flag.
Parameters
- tags: string[]
Returns Promise<AddPostsToTakedownByTagsResponse>
Operation Id
addPostsToTakedownByTags

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

countMatchingPosts

countMatchingPosts(tags: string): Promise<CountMatchingPostsResponse>
Requires Api Key Auth
Count Matching Posts

You must have the bd staff user flag.
Parameters
- tags: string
Returns Promise<CountMatchingPostsResponse>
Operation Id
countMatchingPosts

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

delete

delete(): Promise<null>
Requires Api Key Auth
Delete Takedown

You must have the bd staff user flag.

Returns Promise<null>
Operation Id
deleteTakedown

See
Documentation for more details.
- Defined in lib/models/Takedown.ts:76

edit

edit(options: EditTakedownOptions): Promise<null>
Requires Api Key Auth
Edit Takedown

You must have the bd staff user flag.
Parameters
- options: EditTakedownOptions
Returns Promise<null>
Operation Id
editTakedown

See
Documentation for more details.
- Defined in lib/models/Takedown.ts:92

removeByIds

removeByIds(post_ids: number[]): Promise<null>
Requires Api Key Auth
Remove Posts From Takedown By IDs

You must have the bd staff user flag.
Parameters
- post_ids: number[]
Returns Promise<null>
Operation Id
removePostsFromTakedownByIds

See
Documentation for more details.
- Defined in lib/models/Takedown.ts:108

toJSON

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