Function CommentApiFactory

  • CommentApi - factory interface

    Parameters

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

    Returns {
        createComment(teamName, postNumber, createCommentBody, page?, perPage?, options?) => AxiosPromise<Comment>;
        deleteComment(teamName, commentId, options?) => AxiosPromise<void>;
        getComment(teamName, commentId, include?, options?) => AxiosPromise<Comment>;
        getComments(teamName, page?, perPage?, options?) => AxiosPromise<PaginatedComments>;
        getPostComments(teamName, postNumber, page?, perPage?, options?) => AxiosPromise<PaginatedComments>;
        updateComment(teamName, commentId, updateCommentBody, options?) => AxiosPromise<Comment>;
    }

    • createComment:function
      • 記事に新しいコメントを作成します。

        Parameters

        • teamName: string

          チーム名

        • postNumber: number

          記事ID

        • createCommentBody: CreateCommentBody
        • Optional page: number

          ページ番号

        • Optional perPage: number

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

        • Optional options: any

          Override http request option.

        Returns AxiosPromise<Comment>

        Summary

        コメントを投稿する

        Throws

    • deleteComment:function
      • 指定されたコメントを削除します。

        Parameters

        • teamName: string

          チーム名

        • commentId: number

          コメントID

        • Optional options: any

          Override http request option.

        Returns AxiosPromise<void>

        Summary

        コメントを削除する

        Throws

    • getComment:function
      • 指定されたコメントを取得します。

        Parameters

        • teamName: string

          チーム名

        • commentId: number

          コメントID

        • Optional include: "stargazers"

          `stargazers`を指定するとStarの配列を含んだレスポンスを返します。

        • Optional options: any

          Override http request option.

        Returns AxiosPromise<Comment>

        Summary

        コメントを取得する

        Throws

    • getComments:function
      • チーム全体のコメント一覧を作成日の降順で返却します。

        Parameters

        • teamName: string

          チーム名

        • Optional page: number

          ページ番号

        • Optional perPage: number

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

        • Optional options: any

          Override http request option.

        Returns AxiosPromise<PaginatedComments>

        Summary

        コメント一覧を取得する

        Throws

    • getPostComments:function
      • 記事のコメント一覧を更新日の降順で返却します。

        Parameters

        • teamName: string

          チーム名

        • postNumber: number

          記事ID

        • Optional page: number

          ページ番号

        • Optional perPage: number

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

        • Optional options: any

          Override http request option.

        Returns AxiosPromise<PaginatedComments>

        Summary

        記事のコメント一覧を取得する

        Throws

    • updateComment:function
      • 指定されたコメントを更新します。

        Parameters

        • teamName: string

          チーム名

        • commentId: number

          コメントID

        • updateCommentBody: UpdateCommentBody
        • Optional options: any

          Override http request option.

        Returns AxiosPromise<Comment>

        Summary

        コメントを更新する

        Throws

    Export

Generated using TypeDoc