Class Takedowns

Hierarchy (View Summary)

Base
- Takedowns

Index

Constructors

Methods

addByIds addByTags countMatchingPosts create delete edit get removeByIds search

Constructors

constructor

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

Methods

addByIds

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

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

See
Documentation for more details.
- Defined in lib/modules/Takedowns.ts:57

addByTags

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

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

See
Documentation for more details.
- Defined in lib/modules/Takedowns.ts:77

countMatchingPosts

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

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

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

create

create(options: CreateTakedownOptions): Promise<Takedown>
Requires Api Key Auth
Create Takedown
Parameters
- options: CreateTakedownOptions
Returns Promise<Takedown>
Operation Id
createTakedown

See
Documentation for more details.
- Defined in lib/modules/Takedowns.ts:115

delete

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

You must have the bd staff user flag.
Parameters
- id: number
Returns Promise<null>
Operation Id
deleteTakedown

See
Documentation for more details.
- Defined in lib/modules/Takedowns.ts:134

edit

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

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

See
Documentation for more details.
- Defined in lib/modules/Takedowns.ts:153

get

get(id: number): Promise<Takedown | null>
Get Takedown
Parameters
- id: number
Returns Promise<Takedown | null>
Operation Id
getTakedown

See
Documentation for more details.
- Defined in lib/modules/Takedowns.ts:169

removeByIds

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

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

See
Documentation for more details.
- Defined in lib/modules/Takedowns.ts:188

search

search(options?: SearchTakedownsOptions): Promise<Takedown[]>
Search Takedowns
Parameters
- Optionaloptions: SearchTakedownsOptions
Returns Promise<Takedown[]>
Operation Id
searchTakedowns

See
Documentation for more details.
- Defined in lib/modules/Takedowns.ts:204