Class Takedowns

Hierarchy (View Summary)

Base
- Takedowns

Index

Constructors

Methods

addByIds addByTags countMatchingPosts create delete get removeByIds search update

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

Methods

addByIds

addByIds(id: number, post_ids: number[]): Promise<TakedownsAddByIdsResponse>
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<TakedownsAddByIdsResponse>

Operation Id
takedowns#add_by_ids

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

addByTags

addByTags(id: number, tags: string[]): Promise<TakedownsAddByTagsResponse>
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<TakedownsAddByTagsResponse>

Operation Id
takedowns#add_by_tags

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

countMatchingPosts

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

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

Operation Id
takedowns#count_matching_posts

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

create

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

Operation Id
takedowns#create

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

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

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

get

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

Operation Id
takedowns#show

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

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
takedowns#remove_by_ids

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

search

search(options?: SearchTakedownsOptions): Promise<Takedown[]>
Takedowns Index
Parameters
- Optionaloptions: SearchTakedownsOptions
Returns Promise<Takedown[]>

Operation Id
takedowns#index

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

update

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

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

Operation Id
takedowns#update

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