Function WatchApiAxiosParamCreator

  • WatchApi - axios parameter creator

    Parameters

    Returns {
        getWatchers: ((teamName, postNumber, page?, perPage?, options?) => Promise<RequestArgs>);
        unwachPost: ((teamName, postNumber, options?) => Promise<RequestArgs>);
        watchPost: ((teamName, postNumber, options?) => Promise<RequestArgs>);
    }

    • getWatchers: ((teamName, postNumber, page?, perPage?, options?) => Promise<RequestArgs>)
        • (teamName, postNumber, page?, perPage?, options?): Promise<RequestArgs>
        • 指定された記事にWatchをしたユーザ一覧を取得します。

          Parameters

          • teamName: string

            チーム名

          • postNumber: number

            記事ID

          • Optional page: number

            ページ番号

          • Optional perPage: number

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

          • Optional options: any = {}

            Override http request option.

          Returns Promise<RequestArgs>

          Summary

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

          Throws

    • unwachPost: ((teamName, postNumber, options?) => Promise<RequestArgs>)
        • (teamName, postNumber, options?): Promise<RequestArgs>
        • 指定された記事へのWatchを取り消します。

          Parameters

          • teamName: string

            チーム名

          • postNumber: number

            記事ID

          • Optional options: any = {}

            Override http request option.

          Returns Promise<RequestArgs>

          Summary

          記事のWatchを取り消す

          Throws

    • watchPost: ((teamName, postNumber, options?) => Promise<RequestArgs>)
        • (teamName, postNumber, options?): Promise<RequestArgs>
        • 指定された記事にWatchをします。

          Parameters

          • teamName: string

            チーム名

          • postNumber: number

            記事ID

          • Optional options: any = {}

            Override http request option.

          Returns Promise<RequestArgs>

          Summary

          記事をWatchする

          Throws

    Export

Generated using TypeDoc