mirror of
https://github.com/mii443/vrchatapi-rust.git
synced 2025-08-22 15:45:35 +00:00
193 lines
6.3 KiB
Markdown
193 lines
6.3 KiB
Markdown
# \PlayermoderationApi
|
|
|
|
All URIs are relative to *https://api.vrchat.cloud/api/1*
|
|
|
|
Method | HTTP request | Description
|
|
------------- | ------------- | -------------
|
|
[**clear_all_player_moderations**](PlayermoderationApi.md#clear_all_player_moderations) | **DELETE** /auth/user/playermoderations | Clear All Player Moderations
|
|
[**delete_player_moderation**](PlayermoderationApi.md#delete_player_moderation) | **DELETE** /auth/user/playermoderations/{playerModerationId} | Delete Player Moderation
|
|
[**get_player_moderation**](PlayermoderationApi.md#get_player_moderation) | **GET** /auth/user/playermoderations/{playerModerationId} | Get Player Moderation
|
|
[**get_player_moderations**](PlayermoderationApi.md#get_player_moderations) | **GET** /auth/user/playermoderations | Search Player Moderations
|
|
[**moderate_user**](PlayermoderationApi.md#moderate_user) | **POST** /auth/user/playermoderations | Moderate User
|
|
[**unmoderate_user**](PlayermoderationApi.md#unmoderate_user) | **PUT** /auth/user/unplayermoderate | Unmoderate User
|
|
|
|
|
|
|
|
## clear_all_player_moderations
|
|
|
|
> crate::models::Error clear_all_player_moderations()
|
|
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
|
|
|
|
[**crate::models::Error**](Error.md)
|
|
|
|
### Authorization
|
|
|
|
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
|
|
## delete_player_moderation
|
|
|
|
> crate::models::Success delete_player_moderation(player_moderation_id)
|
|
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
|
|
|
|
|
|
Name | Type | Description | Required | Notes
|
|
------------- | ------------- | ------------- | ------------- | -------------
|
|
**player_moderation_id** | **String** | | [required] |
|
|
|
|
### Return type
|
|
|
|
[**crate::models::Success**](Success.md)
|
|
|
|
### Authorization
|
|
|
|
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
|
|
## get_player_moderation
|
|
|
|
> crate::models::PlayerModeration get_player_moderation(player_moderation_id)
|
|
Get Player Moderation
|
|
|
|
Returns a single Player Moderation. This returns the exact same amount of information as the more generalised `getPlayerModerations`.
|
|
|
|
### Parameters
|
|
|
|
|
|
Name | Type | Description | Required | Notes
|
|
------------- | ------------- | ------------- | ------------- | -------------
|
|
**player_moderation_id** | **String** | | [required] |
|
|
|
|
### Return type
|
|
|
|
[**crate::models::PlayerModeration**](PlayerModeration.md)
|
|
|
|
### Authorization
|
|
|
|
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
|
|
## get_player_moderations
|
|
|
|
> Vec<crate::models::PlayerModeration> get_player_moderations(_type, target_user_id)
|
|
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 | Required | Notes
|
|
------------- | ------------- | ------------- | ------------- | -------------
|
|
**_type** | Option<**String**> | Must be one of PlayerModerationType, except unblock. Unblocking simply removes a block. | |
|
|
**target_user_id** | Option<**String**> | Must be valid UserID. | |
|
|
|
|
### Return type
|
|
|
|
[**Vec<crate::models::PlayerModeration>**](PlayerModeration.md)
|
|
|
|
### Authorization
|
|
|
|
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
|
|
## moderate_user
|
|
|
|
> crate::models::PlayerModeration moderate_user(inline_object12)
|
|
Moderate User
|
|
|
|
Moderate a user, e.g. unmute them or show their avatar.
|
|
|
|
### Parameters
|
|
|
|
|
|
Name | Type | Description | Required | Notes
|
|
------------- | ------------- | ------------- | ------------- | -------------
|
|
**inline_object12** | Option<[**InlineObject12**](InlineObject12.md)> | | |
|
|
|
|
### Return type
|
|
|
|
[**crate::models::PlayerModeration**](PlayerModeration.md)
|
|
|
|
### Authorization
|
|
|
|
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
|
|
## unmoderate_user
|
|
|
|
> crate::models::Success unmoderate_user(inline_object13)
|
|
Unmoderate User
|
|
|
|
Removes a player moderation previously added through `moderateUser`. E.g if you previuosly have shown their avatar, but now want to reset it to default.
|
|
|
|
### Parameters
|
|
|
|
|
|
Name | Type | Description | Required | Notes
|
|
------------- | ------------- | ------------- | ------------- | -------------
|
|
**inline_object13** | Option<[**InlineObject13**](InlineObject13.md)> | | |
|
|
|
|
### Return type
|
|
|
|
[**crate::models::Success**](Success.md)
|
|
|
|
### Authorization
|
|
|
|
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|