120 lines
3.8 KiB
Markdown
120 lines
3.8 KiB
Markdown
# PlayermoderationApi
|
|
|
|
All URIs are relative to *https://api.vrchat.cloud/api/1*
|
|
|
|
| Method | HTTP request | Description |
|
|
|------------- | ------------- | -------------|
|
|
| [**clearAllPlayerModerations**](PlayermoderationApi.md#clearAllPlayerModerations) | **DELETE** /auth/user/playermoderations | Clear All Player Moderations |
|
|
| [**getPlayerModerations**](PlayermoderationApi.md#getPlayerModerations) | **GET** /auth/user/playermoderations | Search Player Moderations |
|
|
| [**moderateUser**](PlayermoderationApi.md#moderateUser) | **POST** /auth/user/playermoderations | Moderate User |
|
|
| [**unmoderateUser**](PlayermoderationApi.md#unmoderateUser) | **PUT** /auth/user/unplayermoderate | Unmoderate User |
|
|
|
|
|
|
<a name="clearAllPlayerModerations"></a>
|
|
# **clearAllPlayerModerations**
|
|
> Success clearAllPlayerModerations()
|
|
|
|
Clear All Player Moderations
|
|
|
|
⚠️ **This will delete every single player moderation you've ever made.**
|
|
|
|
### Parameters
|
|
This endpoint does not need any parameter.
|
|
|
|
### Return type
|
|
|
|
[**Success**](../Models/Success.md)
|
|
|
|
### Authorization
|
|
|
|
[authCookie](../README.md#authCookie)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
<a name="getPlayerModerations"></a>
|
|
# **getPlayerModerations**
|
|
> List getPlayerModerations(type, sourceUserId, targetUserId)
|
|
|
|
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
|
|
|
|
|Name | Type | Description | Notes |
|
|
|------------- | ------------- | ------------- | -------------|
|
|
| **type** | **String**| Must be one of PlayerModerationType. | [optional] [default to unmute] [enum: block, hideAvatar, interactOff, interactOn, mute, muteChat, showAvatar, unmute, unmuteChat] |
|
|
| **sourceUserId** | **String**| Must be valid UserID. Trying to view someone else's moderations results with \"Can't view someone else's player moderations\" error. | [optional] [default to null] |
|
|
| **targetUserId** | **String**| Must be valid UserID. | [optional] [default to null] |
|
|
|
|
### Return type
|
|
|
|
[**List**](../Models/PlayerModeration.md)
|
|
|
|
### Authorization
|
|
|
|
[authCookie](../README.md#authCookie)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
<a name="moderateUser"></a>
|
|
# **moderateUser**
|
|
> PlayerModeration moderateUser(ModerateUserRequest)
|
|
|
|
Moderate User
|
|
|
|
Moderate a user, e.g. unmute them or show their avatar. Please see the [Player Moderation docs](https://vrchatapi.github.io/docs/api/#tag--playermoderation) on what playerModerations are, and how they differ from staff moderations.
|
|
|
|
### Parameters
|
|
|
|
|Name | Type | Description | Notes |
|
|
|------------- | ------------- | ------------- | -------------|
|
|
| **ModerateUserRequest** | [**ModerateUserRequest**](../Models/ModerateUserRequest.md)| | |
|
|
|
|
### Return type
|
|
|
|
[**PlayerModeration**](../Models/PlayerModeration.md)
|
|
|
|
### Authorization
|
|
|
|
[authCookie](../README.md#authCookie)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: application/json
|
|
|
|
<a name="unmoderateUser"></a>
|
|
# **unmoderateUser**
|
|
> Success unmoderateUser(ModerateUserRequest)
|
|
|
|
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
|
|
|
|
|Name | Type | Description | Notes |
|
|
|------------- | ------------- | ------------- | -------------|
|
|
| **ModerateUserRequest** | [**ModerateUserRequest**](../Models/ModerateUserRequest.md)| | |
|
|
|
|
### Return type
|
|
|
|
[**Success**](../Models/Success.md)
|
|
|
|
### Authorization
|
|
|
|
[authCookie](../README.md#authCookie)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: application/json
|
|
|