Class PostSets

Hierarchy (View Summary)

Base
- PostSets

Index

Constructors

Methods

addPosts create delete forSelect get removePosts search update updatePosts

Constructors

constructor

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

Methods

addPosts

addPosts(id: number, post_ids: number[]): Promise<PostSet>
Requires Api Key Auth
Add Posts To Post Set

You must be the owner of the set, a maintainer (if public), or Admin+.
Parameters
- id: number
- post_ids: number[]
Returns Promise<PostSet>

Operation Id
post_sets#add_posts

See
Documentation for more details.
- Defined in lib/modules/PostSets.ts:48

create

create(options: CreatePostSetOptions): Promise<PostSet>
Requires Api Key Auth
Create Post Set
Parameters
- options: CreatePostSetOptions
Returns Promise<PostSet>

Operation Id
post_sets#create

See
Documentation for more details.
- Defined in lib/modules/PostSets.ts:66

delete

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

You must be the owner of the set, or Admin+.
Parameters
- id: number
Returns Promise<null>

Operation Id
post_sets#destroy

See
Documentation for more details.
- Defined in lib/modules/PostSets.ts:85

forSelect

forSelect(): Promise<PostSetsForSelectResponse>
Requires Api Key Auth
List Post Sets For Select

You must be the owner of the set, a maintainer (if public), or Admin+.

Returns Promise<PostSetsForSelectResponse>

Operation Id
post_sets#for_select

See
Documentation for more details.
- Defined in lib/modules/PostSets.ts:104

get

get(id: number): Promise<PostSet | null>
Get Post Set

You must be Moderator+ if the set is not public.
Parameters
- id: number
Returns Promise<PostSet | null>

Operation Id
post_sets#show

See
Documentation for more details.
- Defined in lib/modules/PostSets.ts:120

removePosts

removePosts(id: number, post_ids: number[]): Promise<PostSet>
Requires Api Key Auth
Remove Posts From Post Set

You must be the owner of the set, a maintainer (if public), or Admin+.
Parameters
- id: number
- post_ids: number[]
Returns Promise<PostSet>

Operation Id
post_sets#remove_posts

See
Documentation for more details.
- Defined in lib/modules/PostSets.ts:139

search

search(options?: SearchPostSetsOptions): Promise<PostSet[]>
Post Sets Index
Parameters
- Optionaloptions: SearchPostSetsOptions
Returns Promise<PostSet[]>

Operation Id
post_sets#index

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

update

update(id: number, options: UpdatePostSetOptions): Promise<null>
Requires Api Key Auth
Update Post Set

You must be the owner of the set, or Admin+.
Parameters
- id: number
- options: UpdatePostSetOptions
Returns Promise<null>

Operation Id
post_sets#update

See
Documentation for more details.
- Defined in lib/modules/PostSets.ts:174

updatePosts

updatePosts(id: number, post_ids: number[]): Promise<PostSet>
Requires Api Key Auth
Update Post Set Posts

You must be the owner of the set, a maintainer (if public), or Admin+.
Parameters
- id: number
- post_ids: number[]
Returns Promise<PostSet>

Operation Id
post_sets#update_posts

See
Documentation for more details.
- Defined in lib/modules/PostSets.ts:194