Class PostSets

Hierarchy (View Summary)

Base
- PostSets

Index

Constructors

Methods

addPosts create delete edit forSelect get removePosts search 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:19

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
addPostsToPostSet

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

create

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

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

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
deletePostSet

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

edit

edit(id: number, options: EditPostSetOptions): Promise<null>
Requires Api Key Auth
Edit Post Set

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

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

forSelect

forSelect(): Promise<ListPostSetsForSelectResponse>
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<ListPostSetsForSelectResponse>
Operation Id
listPostSetsForSelect

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

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
getPostSet

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

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
removePostsFromPostSet

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

search

search(options?: SearchPostSetsOptions): Promise<PostSet[]>
Search Post Sets
Parameters
- Optionaloptions: SearchPostSetsOptions
Returns Promise<PostSet[]>
Operation Id
searchPostSets

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

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
updatePostSetPosts

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