View Source VRChat.Playermoderation (vrchat v1.11.1)

API calls for all endpoints tagged Playermoderation.

Link to this section Summary

Functions

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

Delete Player Moderation Deletes a specific player moderation based on it's pmod_ ID. The website uses unmoderateUser instead. You can delete the same player moderation multiple times successfully.

Get Player Moderation Returns a single Player Moderation. This returns the exact same amount of information as the more generalised getPlayerModerations.

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.

Link to this section Functions

Link to this function

clear_all_player_moderations(connection, opts \\ [])

View Source
@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

Parameters

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

returns

Returns

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

delete_player_moderation(connection, player_moderation_id, opts \\ [])

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

Delete Player Moderation Deletes a specific player moderation based on it's pmod_ ID. The website uses unmoderateUser instead. You can delete the same player moderation multiple times successfully.

parameters

Parameters

  • connection (VRChat.Connection): Connection to server
  • player_moderation_id (String.t): Must be a valid pmod_ ID.
  • opts (keyword): Optional parameters

returns

Returns

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

get_player_moderation(connection, player_moderation_id, opts \\ [])

View Source
@spec get_player_moderation(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, VRChat.Model.PlayerModeration.t()}
  | {:ok, VRChat.Model.Error.t()}
  | {:error, Tesla.Env.t()}

Get Player Moderation Returns a single Player Moderation. This returns the exact same amount of information as the more generalised getPlayerModerations.

parameters

Parameters

  • connection (VRChat.Connection): Connection to server
  • player_moderation_id (String.t): Must be a valid pmod_ ID.
  • opts (keyword): Optional parameters

returns

Returns

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

get_player_moderations(connection, opts \\ [])

View Source
@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

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

Returns

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

moderate_user(connection, opts \\ [])

View Source
@spec moderate_user(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, VRChat.Model.PlayerModeration.t()}
  | {:ok, VRChat.Model.Error.t()}
  | {:error, Tesla.Env.t()}

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

Parameters

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

returns

Returns

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

unmoderate_user(connection, opts \\ [])

View Source
@spec unmoderate_user(
  Tesla.Env.client(),
  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

Parameters

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

returns

Returns

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