qiitex

v1.0.0

qiitex v1.0.0 Qiitex.Api.Comment

記事やプロジェクトに付けられたコメントを表します。プロジェクトへのコメントはQiita:Teamでのみ有効です。

Link to this section Summary

Functions

create_item_comment(client, item_id, params)

記事に対してコメントを投稿します。

create_project_comment(client, project_id, params)

プロジェクトに対してコメントを投稿します。

delete_comment(client, comment_id)

コメントを削除します。

get_comment(client, comment_id)

コメントを取得します。

import_item_comment(client, item_id, params)

ユーザー名を指定して記事に対するコメントを作成します。(Qiita:Teamでのみ有効。管理者権限が必要。)

import_project_comment(client, project_id, params)

ユーザー名を指定してプロジェクトに対するコメントを作成します。(Qiita:Teamでのみ有効。管理者権限が必要。)

list_item_comments(client, item_id)

投稿に付けられたコメント一覧を投稿日時の降順で取得します。

list_project_comments(client, project_id)

プロジェクトに付けられたコメント一覧を投稿日時の降順で取得します。

thank_comment(client, comment_id)

PUT /api/v2/comments/:comment_id/thank は2016年11月16日より非推奨となりました。 コメントにいいねを付けます。

unthank_comment(client, comment_id)

DELETE /api/v2/comments/:comment_id/thank は2016年11月16日より非推奨となりました。 コメントからいいねを外します。

update_comment(client, comment_id, params)

コメントを更新します。

Link to this section Functions

Link to this function

create_item_comment(client, item_id, params)

記事に対してコメントを投稿します。

POST /api/v2/items/:item_id/comments

  • body

    • コメントの内容を表すMarkdown形式の文字列
    • example: # Example
    • type: string
Link to this function

create_project_comment(client, project_id, params)

プロジェクトに対してコメントを投稿します。

POST /api/v2/projects/:project_id/comments

  • body

    • コメントの内容を表すMarkdown形式の文字列
    • example: # Example
    • type: string
Link to this function

delete_comment(client, comment_id)

コメントを削除します。

DELETE /api/v2/comments/:comment_id

Link to this function

get_comment(client, comment_id)

コメントを取得します。

GET /api/v2/comments/:comment_id

Link to this function

import_item_comment(client, item_id, params)

ユーザー名を指定して記事に対するコメントを作成します。(Qiita:Teamでのみ有効。管理者権限が必要。)

POST /api/v2/items/:item_id/imported_comments

  • body

    • コメントの内容を表すMarkdown形式の文字列
    • example: # Example
    • type: string

  • created_at optional

    • データが作成された日時
    • example: 2000-01-01T00:00:00+00:00
    • format: date-time
    • type: string

  • updated_at optional

    • データが最後に更新された日時
    • example: 2000-01-01T00:00:00+00:00
    • format: date-time
    • type: string

  • user_id

    • ユーザID
    • example: yaotti
    • type: string
Link to this function

import_project_comment(client, project_id, params)

ユーザー名を指定してプロジェクトに対するコメントを作成します。(Qiita:Teamでのみ有効。管理者権限が必要。)

POST /api/v2/projects/:project_id/imported_comments

  • body

    • コメントの内容を表すMarkdown形式の文字列
    • example: # Example
    • type: string

  • created_at optional

    • データが作成された日時
    • example: 2000-01-01T00:00:00+00:00
    • format: date-time
    • type: string

  • updated_at optional

    • データが最後に更新された日時
    • example: 2000-01-01T00:00:00+00:00
    • format: date-time
    • type: string

  • user_id

    • ユーザID
    • example: yaotti
    • type: string
Link to this function

list_item_comments(client, item_id)

投稿に付けられたコメント一覧を投稿日時の降順で取得します。

GET /api/v2/items/:item_id/comments

Link to this function

list_project_comments(client, project_id)

プロジェクトに付けられたコメント一覧を投稿日時の降順で取得します。

GET /api/v2/projects/:project_id/comments

Link to this function

thank_comment(client, comment_id)

PUT /api/v2/comments/:comment_id/thank は2016年11月16日より非推奨となりました。 コメントにいいねを付けます。

PUT /api/v2/comments/:comment_id/thank

Link to this function

unthank_comment(client, comment_id)

DELETE /api/v2/comments/:comment_id/thank は2016年11月16日より非推奨となりました。 コメントからいいねを外します。

DELETE /api/v2/comments/:comment_id/thank

Link to this function

update_comment(client, comment_id, params)

コメントを更新します。

PATCH /api/v2/comments/:comment_id

  • body

    • コメントの内容を表すMarkdown形式の文字列
    • example: # Example
    • type: string