Function PostApiFactory

Returns {
    createPost(teamName, createPostBody, options?) => AxiosPromise<Post>;
    deletePost(teamName, postNumber, options?) => AxiosPromise<void>;
    getPost(teamName, postNumber, include?, options?) => AxiosPromise<Post>;
    getPosts(teamName, q?, include?, sort?, order?, page?, perPage?, options?) => AxiosPromise<PaginatedPosts>;
    updatePost(teamName, postNumber, updatePostBody, options?) => AxiosPromise<Post>;
}

• createPost:function

  • createPost(teamName, createPostBody, options?): AxiosPromise<Post>

  • Parameters

    • teamName: string

      チーム名

    • createPostBody: CreatePostBody

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<Post>

    Summary

    記事を投稿する

    Throws

• deletePost:function

  • deletePost(teamName, postNumber, options?): AxiosPromise<void>

  • 指定された記事を削除します。

    Parameters

    • teamName: string

      チーム名

    • postNumber: number

      記事ID

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    記事を削除する

    Throws

• getPost:function

  • getPost(teamName, postNumber, include?, options?): AxiosPromise<Post>

  • 指定された記事を取得します。

    Parameters

    • teamName: string

      チーム名

    • postNumber: number

      記事ID

    • Optional include: ("stargazers" | "comments" | "comments.stargazers")[]

      `comments` を指定するとコメントの配列を含んだレスポンスを返します。 - `comments,comments.stargazers`を指定するとコメントとコメントに対するStarの配列を含んだレスポンスを返します。 - `stargazers` を指定するとStarの配列を含んだレスポンスを返します。 - `stargazers,comments` のように `,` で区切ることで複数指定できます

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<Post>

    Summary

    記事を取得する

    Throws

• getPosts:function

  • getPosts(teamName, q?, include?, sort?, order?, page?, perPage?, options?): AxiosPromise<PaginatedPosts>

  • Parameters

    • teamName: string

      チーム名

    • Optional q: string

      記事を絞り込むための条件を指定します

    • Optional include: ("stargazers" | "comments" | "comments.stargazers")[]

      `comments` を指定するとコメントの配列を含んだレスポンスを返します。 - `comments,comments.stargazers`を指定するとコメントとコメントに対するStarの配列を含んだレスポンスを返します。 - `stargazers` を指定するとStarの配列を含んだレスポンスを返します。 - `stargazers,comments` のように `,` で区切ることで複数指定できます

    • Optional sort: "number" | "comments" | "updated" | "created" | "stars" | "watches" | "best_match"

      記事の並び順を指定します - 設定可能な値 - `updated` (default) - 記事の更新日時 - `created` - 記事の作成日時 - `number` - 記事番号 - `stars` - 記事へのStarの数 - `watches` - 記事へのWatchの数 - `comments` - 記事へのCommentの数 - `best_match` - 総合的な記事のスコア

    • Optional order: "asc" | "desc"

      設定可能な値: - `desc`: 降順 (default) - `asc`: 昇順

    • Optional page: number

      ページ番号

    • Optional perPage: number

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

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<PaginatedPosts>

    Summary

    記事一覧を取得する

    Throws

• updatePost:function

  • updatePost(teamName, postNumber, updatePostBody, options?): AxiosPromise<Post>

  • 指定された記事を編集します。

    Parameters

    • teamName: string

      チーム名

    • postNumber: number

      記事ID

    • updatePostBody: UpdatePostBody

    • Optional options: any

      Override http request option.

    Returns AxiosPromise<Post>

    Summary

    記事を編集する

    Throws