Class StarApi

StarApi - object-oriented interface

Export

Hierarchy

BaseAPI
- StarApi

Index

Constructors

Properties

axios basePath configuration

Methods

getCommentStargazers getPostStargazers starComment starPost unstarComment unstarPost

Constructors

constructor

new StarApi(configuration?, basePath?, axios?): StarApi
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns StarApi
Inherited from BaseAPI.constructor
- Defined in client/base.ts:51

Properties

`Protected` axios

axios: AxiosInstance = globalAxios

`Protected` basePath

basePath: string = BASE_PATH

`Protected` configuration

configuration: undefined | Configuration

Methods

getCommentStargazers

getCommentStargazers(requestParameters, options?): Promise<AxiosResponse<PaginatedStargazers, any>>
指定されたコメントにStarをしたユーザ一覧を取得します。
Parameters
- requestParameters: StarApiGetCommentStargazersRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<PaginatedStargazers, any>>

Summary
コメントのStarを取得する

Throws

Memberof
StarApi
- Defined in client/api/star-api.ts:1023

getPostStargazers

getPostStargazers(requestParameters, options?): Promise<AxiosResponse<PaginatedStargazers, any>>
指定された記事にStarをしたユーザ一覧を取得します。
Parameters
- requestParameters: StarApiGetPostStargazersRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<PaginatedStargazers, any>>

Summary
記事のStarを取得する

Throws

Memberof
StarApi
- Defined in client/api/star-api.ts:1046

starComment

starComment(requestParameters, options?): Promise<AxiosResponse<void, any>>
指定されたコメントにStarをします。
Parameters
- requestParameters: StarApiStarCommentRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<void, any>>

Summary
コメントをStarする

Throws

Memberof
StarApi
- Defined in client/api/star-api.ts:1069

starPost

starPost(requestParameters, options?): Promise<AxiosResponse<void, any>>
指定された記事にStarをします。
Parameters
- requestParameters: StarApiStarPostRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<void, any>>

Summary
記事をStarする

Throws

Memberof
StarApi
- Defined in client/api/star-api.ts:1091

unstarComment

unstarComment(requestParameters, options?): Promise<AxiosResponse<void, any>>
指定されたコメントへのStarを取り消します。
Parameters
- requestParameters: StarApiUnstarCommentRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<void, any>>

Summary
コメントのStarを取り消す

Throws

Memberof
StarApi
- Defined in client/api/star-api.ts:1110

unstarPost

unstarPost(requestParameters, options?): Promise<AxiosResponse<void, any>>
指定された記事へのStarを取り消します。
Parameters
- requestParameters: StarApiUnstarPostRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<void, any>>

Summary
記事のStarを取り消す

Throws

Memberof
StarApi
- Defined in client/api/star-api.ts:1131

Generated using TypeDoc