Function CommentApiFp

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

• createComment:function

  • createComment(teamName, postNumber, createCommentBody, page?, perPage?, options?): Promise<((axios?, basePath?) => AxiosPromise<Comment>)>

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

    Parameters

    • teamName: string

      チーム名

    • postNumber: number

      記事ID

    • createCommentBody: CreateCommentBody

    • Optional page: number

      ページ番号

    • Optional perPage: number

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

    • Optional options: any

      Override http request option.

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

    Summary

    コメントを投稿する

    Throws

• deleteComment:function

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

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

    Parameters

    • teamName: string

      チーム名

    • commentId: number

      コメントID

    • Optional options: any

      Override http request option.

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

    Summary

    コメントを削除する

    Throws

• getComment:function

  • getComment(teamName, commentId, include?, options?): Promise<((axios?, basePath?) => AxiosPromise<Comment>)>

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

    Parameters

    • teamName: string

      チーム名

    • commentId: number

      コメントID

    • Optional include: "stargazers"

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

    • Optional options: any

      Override http request option.

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

    Summary

    コメントを取得する

    Throws

• getComments:function

  • getComments(teamName, page?, perPage?, options?): Promise<((axios?, basePath?) => AxiosPromise<PaginatedComments>)>

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

    Parameters

    • teamName: string

      チーム名

    • Optional page: number

      ページ番号

    • Optional perPage: number

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

    • Optional options: any

      Override http request option.

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

    Summary

    コメント一覧を取得する

    Throws

• getPostComments:function

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

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

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

    Summary

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

    Throws

• updateComment:function

  • updateComment(teamName, commentId, updateCommentBody, options?): Promise<((axios?, basePath?) => AxiosPromise<Comment>)>

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

    Parameters

    • teamName: string

      チーム名

    • commentId: number

      コメントID

    • updateCommentBody: UpdateCommentBody

    • Optional options: any

      Override http request option.

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

    Summary

    コメントを更新する

    Throws