Function WatchApiFp

Returns {
    getWatchers(teamName, postNumber, page?, perPage?, options?) => Promise<((axios?, basePath?) => AxiosPromise<PaginatedWatchers>)>;
    unwachPost(teamName, postNumber, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    watchPost(teamName, postNumber, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
}

• getWatchers:function

  • getWatchers(teamName, postNumber, page?, perPage?, options?): Promise<((axios?, basePath?) => AxiosPromise<PaginatedWatchers>)>

  • 指定された記事にWatchをしたユーザ一覧を取得します。

    Parameters

    • teamName: string

      チーム名

    • postNumber: number

      記事ID

    • Optional page: number

      ページ番号

    • Optional perPage: number

      1ページあたりに含まれる要素数

    • Optional options: any

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<PaginatedWatchers>)>

    Summary

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

    Throws

• unwachPost:function

  • unwachPost(teamName, postNumber, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • 指定された記事へのWatchを取り消します。

    Parameters

    • teamName: string

      チーム名

    • postNumber: number

      記事ID

    • Optional options: any

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    記事のWatchを取り消す

    Throws

• watchPost:function

  • watchPost(teamName, postNumber, options?): Promise<((axios?, basePath?) => AxiosPromise<void>)>

  • 指定された記事にWatchをします。

    Parameters

    • teamName: string

      チーム名

    • postNumber: number

      記事ID

    • Optional options: any

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<void>)>

    Summary

    記事をWatchする

    Throws