Function StarApiFp

  • StarApi - functional programming interface

    Parameters

    Returns {
        getCommentStargazers(teamName, commentId, page?, perPage?, options?) => Promise<((axios?, basePath?) => AxiosPromise<PaginatedStargazers>)>;
        getPostStargazers(teamName, postNumber, page?, perPage?, options?) => Promise<((axios?, basePath?) => AxiosPromise<PaginatedStargazers>)>;
        starComment(teamName, commentId, newStar, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
        starPost(teamName, postNumber, newStar, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
        unstarComment(teamName, commentId, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
        unstarPost(teamName, postNumber, options?) => Promise<((axios?, basePath?) => AxiosPromise<void>)>;
    }

    • getCommentStargazers:function
      • 指定されたコメントにStarをしたユーザ一覧を取得します。

        Parameters

        • teamName: string

          チーム名

        • commentId: number

          コメントID

        • Optional page: number

          ページ番号

        • Optional perPage: number

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

        • Optional options: any

          Override http request option.

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

        Summary

        コメントのStarを取得する

        Throws

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

        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<PaginatedStargazers>)>

        Summary

        記事のStarを取得する

        Throws

    • starComment:function
      • 指定されたコメントにStarをします。

        Parameters

        • teamName: string

          チーム名

        • commentId: number

          コメントID

        • newStar: NewStar
        • Optional options: any

          Override http request option.

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

        Summary

        コメントをStarする

        Throws

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

        Parameters

        • teamName: string

          チーム名

        • postNumber: number

          記事ID

        • newStar: NewStar
        • Optional options: any

          Override http request option.

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

        Summary

        記事をStarする

        Throws

    • unstarComment:function
      • 指定されたコメントへのStarを取り消します。

        Parameters

        • teamName: string

          チーム名

        • commentId: number

          コメントID

        • Optional options: any

          Override http request option.

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

        Summary

        コメントのStarを取り消す

        Throws

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

        Parameters

        • teamName: string

          チーム名

        • postNumber: number

          記事ID

        • Optional options: any

          Override http request option.

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

        Summary

        記事のStarを取り消す

        Throws

    Export

Generated using TypeDoc