Class WatchApi

WatchApi - object-oriented interface

Export

Hierarchy

BaseAPI
- WatchApi

Index

Constructors

Properties

axios basePath configuration

Methods

getWatchers unwachPost watchPost

Constructors

constructor

new WatchApi(configuration?, basePath?, axios?): WatchApi
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns WatchApi
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

getWatchers

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

Summary
Watchしたユーザー一覧を取得する

Throws

Memberof
WatchApi
- Defined in client/api/watch-api.ts:532

unwachPost

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

Summary
記事のWatchを取り消す

Throws

Memberof
WatchApi
- Defined in client/api/watch-api.ts:555

watchPost

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

Summary
記事をWatchする

Throws

Memberof
WatchApi
- Defined in client/api/watch-api.ts:576

Generated using TypeDoc