lemmy_block_person: Block a person.

In remmy: API Client for 'Lemmy'

Block a person.

Description

HTTP.POST /user/block

Usage

lemmy_block_person(
  person_id,
  block,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

person_id	A numeric value.
block	A logical 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 2:

<list>
|-person_view: <list>
| |-person: <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
| `-counts: <list>
|   |-id: A numeric value
|   |-person_id: A numeric value
|   |-post_count: A numeric value
|   |-post_score: A numeric value
|   |-comment_count: A numeric value
|   `-comment_score: A numeric value
`-blocked: A logical value

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