lemmy_ban_person {remmy}

Ban a person from your site.

Description

HTTP.POST /user/ban

Usage

lemmy_ban_person(
  person_id,
  ban,
  remove_data = NULL,
  reason = NULL,
  expires = NULL,
  auth,
  .lemmy_instance = getOption("lemmy_instance", "https://lemmy.world")
)

Arguments

person_id

A numeric value.

ban

A logical value.

remove_data

(Optional) A logical value.

reason

(Optional) A character value.

expires

(Optional) A numeric 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
`-banned: A logical value