lemmy_edit_comment: Edit a comment.

View source: R/http-methods.R

lemmy_edit_commentR Documentation

Edit a comment.

Description

HTTP.PUT /comment

Usage

lemmy_edit_comment(
  comment_id,
  content = NULL,
  language_id = NULL,
  form_id = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

comment_id

A numeric value.

content

(Optional) A character value.

language_id

(Optional) A numeric value.

form_id

(Optional) A character value.

auth

A character value.

.lemmy_instance

Default: "https://lemmy.world". Change the default instance by setting the lemmy_instance options().

Value

A list of length 3:

<list>
|-comment_view: <list>
| |-comment: <list>
| | |-id: A numeric value
| | |-creator_id: A numeric value
| | |-post_id: A numeric value
| | |-content: A character value
| | |-removed: A logical value
| | |-published: A character value
| | |-updated: (Optional) A character value
| | |-deleted: A logical value
| | |-ap_id: A character value
| | |-local: A logical value
| | |-path: A character value
| | |-distinguished: A logical value
| | `-language_id: A numeric value
| |-creator: <list>
| | |-id: A numeric value
| | |-name: A character value
| | |-display_name: (Optional) A character value
| | |-avatar: (Optional) A character value
| | |-banned: A logical value
| | |-published: A character value
| | |-updated: (Optional) A character value
| | |-actor_id: A character value
| | |-bio: (Optional) A character value
| | |-local: A logical value
| | |-banner: (Optional) A character value
| | |-deleted: A logical value
| | |-inbox_url: A character value
| | |-matrix_user_id: (Optional) A character value
| | |-admin: A logical value
| | |-bot_account: A logical value
| | |-ban_expires: (Optional) A character value
| | `-instance_id: A numeric value
| |-post: <list>
| | |-id: A numeric value
| | |-name: A character value
| | |-url: (Optional) A character value
| | |-body: (Optional) A character value
| | |-creator_id: A numeric value
| | |-community_id: A numeric value
| | |-removed: A logical value
| | |-locked: A logical value
| | |-published: A character value
| | |-updated: (Optional) A character value
| | |-deleted: A logical value
| | |-nsfw: A logical value
| | |-embed_title: (Optional) A character value
| | |-embed_description: (Optional) A character value
| | |-thumbnail_url: (Optional) A character value
| | |-ap_id: A character value
| | |-local: A logical value
| | |-embed_video_url: (Optional) A character value
| | |-language_id: A numeric value
| | |-featured_community: A logical value
| | `-featured_local: A logical value
| |-community: <list>
| | |-id: A numeric value
| | |-name: A character value
| | |-title: A character value
| | |-description: (Optional) A character value
| | |-removed: A logical value
| | |-published: A character value
| | |-updated: (Optional) A character value
| | |-deleted: A logical value
| | |-nsfw: A logical value
| | |-actor_id: A character value
| | |-local: A logical value
| | |-icon: (Optional) A character value
| | |-banner: (Optional) A character value
| | |-followers_url: A character value
| | |-inbox_url: A character value
| | |-hidden: A logical value
| | |-posting_restricted_to_mods: A logical value
| | `-instance_id: A numeric value
| |-counts: <list>
| | |-id: A numeric value
| | |-comment_id: A numeric value
| | |-score: A numeric value
| | |-upvotes: A numeric value
| | |-downvotes: A numeric value
| | |-published: A character value
| | |-child_count: A numeric value
| | `-hot_rank: A numeric value
| |-creator_banned_from_community: A logical value
| |-subscribed: One of "Subscribed", "NotSubscri...
| |-saved: A logical value
| |-creator_blocked: A logical value
| `-my_vote: (Optional) A numeric value
|-recipient_ids: A numeric vector
`-form_id: (Optional) A character value

remmy documentation built on July 26, 2023, 5:37 p.m.