Class AvoidPostings

Hierarchy (View Summary)

Base
- AvoidPostings

Index

Constructors

Methods

create delete destroy edit get search undelete

Constructors

constructor

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

Methods

create

create(options?: CreateAvoidPostingOptions): Promise<AvoidPosting>
Requires Api Key Auth
Create Avoid Posting Entry

Must have the bd staff user flag.
Parameters
- Optionaloptions: CreateAvoidPostingOptions
Returns Promise<AvoidPosting>
Operation Id
createAvoidPosting

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

delete

delete(idOrName: string | number): Promise<null>
Requires Api Key Auth
Delete Avoid Posting Entry

Soft deletion. Must have the bd staff user flag.
Parameters
- idOrName: string | number
Returns Promise<null>
Operation Id
deleteAvoidPosting

See
Documentation for more details.
- Defined in lib/modules/AvoidPostings.ts:88

destroy

destroy(idOrName: string | number): Promise<null>
Requires Api Key Auth
Destroy Avoid Posting Entry

Must have the bd staff user flag.
Parameters
- idOrName: string | number
Returns Promise<null>
Operation Id
destroyAvoidPosting

See
Documentation for more details.
- Defined in lib/modules/AvoidPostings.ts:107

edit

edit(
idOrName: string | number,
options?: EditAvoidPostingOptions,
): Promise<null>
Requires Api Key Auth
Edit Avoid Posting Entry

Must have the bd staff user flag.
Parameters
- idOrName: string | number
- Optionaloptions: EditAvoidPostingOptions
Returns Promise<null>
Operation Id
editAvoidPosting

See
Documentation for more details.
- Defined in lib/modules/AvoidPostings.ts:126

get

get(idOrName: string | number): Promise<AvoidPosting | null>
Get Avoid Posting Entry
Parameters
- idOrName: string | number
Returns Promise<AvoidPosting | null>
Operation Id
getAvoidPosting

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

search

search(options?: SearchAvoidPostingsOptions): Promise<AvoidPosting[]>
Search Avoid Posting Entries
Parameters
- Optionaloptions: SearchAvoidPostingsOptions
Returns Promise<AvoidPosting[]>
Operation Id
searchAvoidPostings

See
Documentation for more details.
- Defined in lib/modules/AvoidPostings.ts:166

undelete

undelete(idOrName: string | number): Promise<null>
Requires Api Key Auth
Undelete Avoid Posting Entry

Must have the bd staff user flag.
Parameters
- idOrName: string | number
Returns Promise<null>
Operation Id
undeleteAvoidPosting

See
Documentation for more details.
- Defined in lib/modules/AvoidPostings.ts:185