Class Takedown

Schema

See

Documentation for more details.

Hierarchy (View Summary)

Takedown
Base<TakedownData>
- Takedown

Index

Constructors

Methods

[custom] addByIds addByTags countMatchingPosts delete removeByIds toJSON update

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

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

addByIds

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

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

Operation Id
takedowns#add_by_ids

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

addByTags

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

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

Operation Id
takedowns#add_by_tags

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

countMatchingPosts

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

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

Operation Id
takedowns#count_matching_posts

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

delete

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

You must have the bd staff user flag.

Returns Promise<null>

Operation Id
takedowns#destroy

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

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

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

toJSON

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

update

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

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

Operation Id
takedowns#update

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