Function WatchApiFactory

  • WatchApi - factory interface

    Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

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

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

        Parameters

        • teamName: string

          チーム名

        • postNumber: number

          記事ID

        • Optional page: number

          ページ番号

        • Optional perPage: number

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

        • Optional options: any

          Override http request option.

        Returns AxiosPromise<PaginatedWatchers>

        Summary

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

        Throws

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

        Parameters

        • teamName: string

          チーム名

        • postNumber: number

          記事ID

        • Optional options: any

          Override http request option.

        Returns AxiosPromise<void>

        Summary

        記事のWatchを取り消す

        Throws

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

        Parameters

        • teamName: string

          チーム名

        • postNumber: number

          記事ID

        • Optional options: any

          Override http request option.

        Returns AxiosPromise<void>

        Summary

        記事をWatchする

        Throws

    Export

Generated using TypeDoc