VRChat.Playermoderation (vrchat v1.20.0)

View Source

API calls for all endpoints tagged Playermoderation.

Summary

Functions

Clear All Player Moderations ⚠️ This will delete every single player moderation you've ever made.

Search Player Moderations Returns a list of all player moderations made by you. This endpoint does not have pagination, and will return all results. Use query parameters to limit your query if needed.

Moderate User Moderate a user, e.g. unmute them or show their avatar. Please see the Player Moderation docs on what playerModerations are, and how they differ from staff moderations.

Unmoderate User Removes a player moderation previously added through moderateUser. E.g if you previously have shown their avatar, but now want to reset it to default.

Functions

clear_all_player_moderations(connection, opts \\ [])

@spec clear_all_player_moderations(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, VRChat.Model.Success.t()}
  | {:ok, VRChat.Model.Error.t()}
  | {:error, Tesla.Env.t()}

Clear All Player Moderations ⚠️ This will delete every single player moderation you've ever made.

Parameters

  • connection (VRChat.Connection): Connection to server
  • opts (keyword): Optional parameters

Returns

  • {:ok, VRChat.Model.Success.t} on success
  • {:error, Tesla.Env.t} on failure

get_player_moderations(connection, opts \\ [])

@spec get_player_moderations(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, [VRChat.Model.PlayerModeration.t()]}
  | {:ok, VRChat.Model.Error.t()}
  | {:error, Tesla.Env.t()}

Search Player Moderations Returns a list of all player moderations made by you. This endpoint does not have pagination, and will return all results. Use query parameters to limit your query if needed.

Parameters

  • connection (VRChat.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :type (String.t): Must be one of PlayerModerationType, except unblock. Unblocking simply removes a block.
    • :targetUserId (String.t): Must be valid UserID.

Returns

  • {:ok, [%PlayerModeration{}, ...]} on success
  • {:error, Tesla.Env.t} on failure

moderate_user(connection, moderate_user_request, opts \\ [])

Moderate User Moderate a user, e.g. unmute them or show their avatar. Please see the Player Moderation docs on what playerModerations are, and how they differ from staff moderations.

Parameters

  • connection (VRChat.Connection): Connection to server
  • moderate_user_request (ModerateUserRequest):
  • opts (keyword): Optional parameters

Returns

  • {:ok, VRChat.Model.PlayerModeration.t} on success
  • {:error, Tesla.Env.t} on failure

unmoderate_user(connection, moderate_user_request, opts \\ [])

@spec unmoderate_user(
  Tesla.Env.client(),
  VRChat.Model.ModerateUserRequest.t(),
  keyword()
) ::
  {:ok, VRChat.Model.Success.t()}
  | {:ok, VRChat.Model.Error.t()}
  | {:error, Tesla.Env.t()}

Unmoderate User Removes a player moderation previously added through moderateUser. E.g if you previously have shown their avatar, but now want to reset it to default.

Parameters

  • connection (VRChat.Connection): Connection to server
  • moderate_user_request (ModerateUserRequest):
  • opts (keyword): Optional parameters

Returns

  • {:ok, VRChat.Model.Success.t} on success
  • {:error, Tesla.Env.t} on failure