lemmy_feature_post: A moderator can feature a community post ( IE stick it to the...

In remmy: API Client for 'Lemmy'

A moderator can feature a community post ( IE stick it to the top of a community ).

Description

HTTP.POST /post/feature

Usage

lemmy_feature_post(
  post_id,
  featured,
  feature_type,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

post_id	A numeric value.
featured	A logical value.
feature_type	One of "Local" or "Community".
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 1:

<list>
`-post_view: <list>
  |-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
  |-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
  |-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
  |-creator_banned_from_community: A logical value
  |-counts: <list>
  | |-id: A numeric value
  | |-post_id: A numeric value
  | |-comments: A numeric value
  | |-score: A numeric value
  | |-upvotes: A numeric value
  | |-downvotes: A numeric value
  | |-published: A character value
  | |-newest_comment_time_necro: A character value
  | |-newest_comment_time: A character value
  | |-featured_community: A logical value
  | |-featured_local: A logical value
  | |-hot_rank: A numeric value
  | `-hot_rank_active: A numeric value
  |-subscribed: One of "Subscribed", "NotSubscri...
  |-saved: A logical value
  |-read: A logical value
  |-creator_blocked: A logical value
  |-my_vote: (Optional) A numeric value
  `-unread_comments: A numeric value

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