Class FanboxClient

Index

Constructors

Methods

getCreator getPost listCreatorPlans listCreatorPosts listFollowingCreators listHomePosts listSupportingPlans listSupportingPosts paginateCreatorPosts

Constructors

constructor

new FanboxClient(options?: FanboxClientOptions): FanboxClient
Parameters
- options: FanboxClientOptions = {}
Returns FanboxClient
- Defined in src/client.ts:76

Methods

getCreator

getCreator(params: GetCreatorParams): Promise<Creator>
Parameters
- params: GetCreatorParams
Returns Promise<Creator>
- Defined in src/client.ts:85

getPost

getPost(params: GetPostParams): Promise<Post>
Parameters
- params: GetPostParams
Returns Promise<Post>
- Defined in src/client.ts:89

listCreatorPlans

listCreatorPlans(
params: ListCreatorPlansParams,
): Promise<ListCreatorPlansResult>
Parameters
- params: ListCreatorPlansParams
Returns Promise<ListCreatorPlansResult>
- Defined in src/client.ts:93

listCreatorPosts

listCreatorPosts(
params: ListCreatorPostsParams,
): Promise<ListCreatorPostsResult>
Parameters
- params: ListCreatorPostsParams
Returns Promise<ListCreatorPostsResult>
- Defined in src/client.ts:99

listFollowingCreators

listFollowingCreators(): Promise<ListFollowingCreatorsResult>
Returns Promise<ListFollowingCreatorsResult>
- Defined in src/client.ts:105

listHomePosts

listHomePosts(params?: PostListParams): Promise<ListHomePostsResult>
Parameters
- params: PostListParams = {}
Returns Promise<ListHomePostsResult>
- Defined in src/client.ts:109

listSupportingPlans

listSupportingPlans(): Promise<ListSupportingPlansResult>
Returns Promise<ListSupportingPlansResult>
- Defined in src/client.ts:115

listSupportingPosts

listSupportingPosts(params?: PostListParams): Promise<ListSupportingPostsResult>
Parameters
- params: PostListParams = {}
Returns Promise<ListSupportingPostsResult>
- Defined in src/client.ts:119

paginateCreatorPosts

paginateCreatorPosts(
params: PaginateCreatorPostsParams,
): Promise<PaginateCreatorPostsResult>
Parameters
- params: PaginateCreatorPostsParams
Returns Promise<PaginateCreatorPostsResult>
- Defined in src/client.ts:125