Class Pools

Hierarchy (View Summary)

Base
- Pools

Index

Constructors

Methods

addPost create delete edit get getRecent removePost revert search

Constructors

constructor

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

Methods

addPost

addPost(pool_id: number, post_id: number): Promise<Pool>
Requires Api Key Auth
Add Post To Pool
Parameters
- pool_id: number
- post_id: number
Returns Promise<Pool>
Operation Id
addPostToPool

See
Documentation for more details.
- Defined in lib/modules/Pools.ts:36

create

create(options: CreatePoolOptions): Promise<Pool>
Requires Api Key Auth
Create Pool
Parameters
- options: CreatePoolOptions
Returns Promise<Pool>
Operation Id
createPool

See
Documentation for more details.
- Defined in lib/modules/Pools.ts:53

delete

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

You must be Janitor+.
Parameters
- id: number
Returns Promise<null>
Operation Id
deletePool

See
Documentation for more details.
- Defined in lib/modules/Pools.ts:72

edit

edit(id: number, options: EditPoolOptions): Promise<null>
Requires Api Key Auth
Edit Pool
Parameters
- id: number
- options: EditPoolOptions
Returns Promise<null>
Operation Id
editPool

See
Documentation for more details.
- Defined in lib/modules/Pools.ts:89

get

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

See
Documentation for more details.
- Defined in lib/modules/Pools.ts:105

getRecent

getRecent(): Promise<{}[]>
Requires Api Key Auth
Get Recent Pools

Returns Promise<{}[]>
Operation Id
getRecentPools

See
Documentation for more details.
- Defined in lib/modules/Pools.ts:122

removePost

removePost(pool_id: number, post_id: number): Promise<null>
Requires Api Key Auth
Remove Post From Pool
Parameters
- pool_id: number
- post_id: number
Returns Promise<null>
Operation Id
removePostFromPool

See
Documentation for more details.
- Defined in lib/modules/Pools.ts:138

revert

revert(id: number, version_id: number): Promise<null>
Requires Api Key Auth
Revert Pool
Parameters
- id: number
- version_id: number
Returns Promise<null>
Operation Id
revertPool

See
Documentation for more details.
- Defined in lib/modules/Pools.ts:155

search

search(options?: SearchPoolsOptions): Promise<Pool[]>
Search Pools
Parameters
- Optionaloptions: SearchPoolsOptions
Returns Promise<Pool[]>
Operation Id
searchPools

See
Documentation for more details.
- Defined in lib/modules/Pools.ts:171