Function StarApiAxiosParamCreator

  • StarApi - axios parameter creator

    Parameters

    Returns {
        getCommentStargazers: ((teamName, commentId, page?, perPage?, options?) => Promise<RequestArgs>);
        getPostStargazers: ((teamName, postNumber, page?, perPage?, options?) => Promise<RequestArgs>);
        starComment: ((teamName, commentId, newStar, options?) => Promise<RequestArgs>);
        starPost: ((teamName, postNumber, newStar, options?) => Promise<RequestArgs>);
        unstarComment: ((teamName, commentId, options?) => Promise<RequestArgs>);
        unstarPost: ((teamName, postNumber, options?) => Promise<RequestArgs>);
    }

    • getCommentStargazers: ((teamName, commentId, page?, perPage?, options?) => Promise<RequestArgs>)
        • (teamName, commentId, page?, perPage?, options?): Promise<RequestArgs>
        • 指定されたコメントにStarをしたユーザ一覧を取得します。

          Parameters

          • teamName: string

            チーム名

          • commentId: number

            コメントID

          • Optional page: number

            ページ番号

          • Optional perPage: number

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

          • Optional options: any = {}

            Override http request option.

          Returns Promise<RequestArgs>

          Summary

          コメントのStarを取得する

          Throws

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

          Parameters

          • teamName: string

            チーム名

          • postNumber: number

            記事ID

          • Optional page: number

            ページ番号

          • Optional perPage: number

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

          • Optional options: any = {}

            Override http request option.

          Returns Promise<RequestArgs>

          Summary

          記事のStarを取得する

          Throws

    • starComment: ((teamName, commentId, newStar, options?) => Promise<RequestArgs>)
        • (teamName, commentId, newStar, options?): Promise<RequestArgs>
        • 指定されたコメントにStarをします。

          Parameters

          • teamName: string

            チーム名

          • commentId: number

            コメントID

          • newStar: NewStar
          • Optional options: any = {}

            Override http request option.

          Returns Promise<RequestArgs>

          Summary

          コメントをStarする

          Throws

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

          Parameters

          • teamName: string

            チーム名

          • postNumber: number

            記事ID

          • newStar: NewStar
          • Optional options: any = {}

            Override http request option.

          Returns Promise<RequestArgs>

          Summary

          記事をStarする

          Throws

    • unstarComment: ((teamName, commentId, options?) => Promise<RequestArgs>)
        • (teamName, commentId, options?): Promise<RequestArgs>
        • 指定されたコメントへのStarを取り消します。

          Parameters

          • teamName: string

            チーム名

          • commentId: number

            コメントID

          • Optional options: any = {}

            Override http request option.

          Returns Promise<RequestArgs>

          Summary

          コメントのStarを取り消す

          Throws

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

          Parameters

          • teamName: string

            チーム名

          • postNumber: number

            記事ID

          • Optional options: any = {}

            Override http request option.

          Returns Promise<RequestArgs>

          Summary

          記事のStarを取り消す

          Throws

    Export

Generated using TypeDoc