236 lines
5.6 KiB
Markdown
236 lines
5.6 KiB
Markdown
# PropsApi
|
|
|
|
All URIs are relative to *https://api.vrchat.cloud/api/1*
|
|
|
|
| Method | HTTP request | Description |
|
|
|------------- | ------------- | -------------|
|
|
| [**createProp**](PropsApi.md#createProp) | **POST** /props | Create Prop |
|
|
| [**deleteProp**](PropsApi.md#deleteProp) | **DELETE** /props/{propId} | Delete Prop |
|
|
| [**getProp**](PropsApi.md#getProp) | **GET** /props/{propId} | Get Prop |
|
|
| [**getPropPublishStatus**](PropsApi.md#getPropPublishStatus) | **GET** /props/{propId}/publish | Get Prop Publish Status |
|
|
| [**listProps**](PropsApi.md#listProps) | **GET** /props | List Props |
|
|
| [**publishProp**](PropsApi.md#publishProp) | **PUT** /props/{propId}/publish | Publish Prop |
|
|
| [**unpublishProp**](PropsApi.md#unpublishProp) | **DELETE** /props/{propId}/publish | Unpublish Prop |
|
|
| [**updateProp**](PropsApi.md#updateProp) | **PUT** /props/{propId} | Update Prop |
|
|
|
|
|
|
<a name="createProp"></a>
|
|
# **createProp**
|
|
> Prop createProp(CreatePropRequest)
|
|
|
|
Create Prop
|
|
|
|
Create a Prop and return the new Prop object.
|
|
|
|
### Parameters
|
|
|
|
|Name | Type | Description | Notes |
|
|
|------------- | ------------- | ------------- | -------------|
|
|
| **CreatePropRequest** | [**CreatePropRequest**](../Models/CreatePropRequest.md)| | |
|
|
|
|
### Return type
|
|
|
|
[**Prop**](../Models/Prop.md)
|
|
|
|
### Authorization
|
|
|
|
[authCookie](../README.md#authCookie)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: application/json
|
|
|
|
<a name="deleteProp"></a>
|
|
# **deleteProp**
|
|
> deleteProp(propId)
|
|
|
|
Delete Prop
|
|
|
|
Delete a Prop.
|
|
|
|
### Parameters
|
|
|
|
|Name | Type | Description | Notes |
|
|
|------------- | ------------- | ------------- | -------------|
|
|
| **propId** | **String**| Prop ID. | [default to null] |
|
|
|
|
### Return type
|
|
|
|
null (empty response body)
|
|
|
|
### Authorization
|
|
|
|
[authCookie](../README.md#authCookie)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
<a name="getProp"></a>
|
|
# **getProp**
|
|
> Prop getProp(propId)
|
|
|
|
Get Prop
|
|
|
|
Returns a Prop object.
|
|
|
|
### Parameters
|
|
|
|
|Name | Type | Description | Notes |
|
|
|------------- | ------------- | ------------- | -------------|
|
|
| **propId** | **String**| Prop ID. | [default to null] |
|
|
|
|
### Return type
|
|
|
|
[**Prop**](../Models/Prop.md)
|
|
|
|
### Authorization
|
|
|
|
[authCookie](../README.md#authCookie)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
<a name="getPropPublishStatus"></a>
|
|
# **getPropPublishStatus**
|
|
> PropPublishStatus getPropPublishStatus(propId)
|
|
|
|
Get Prop Publish Status
|
|
|
|
Returns a PropPublishStatus object.
|
|
|
|
### Parameters
|
|
|
|
|Name | Type | Description | Notes |
|
|
|------------- | ------------- | ------------- | -------------|
|
|
| **propId** | **String**| Prop ID. | [default to null] |
|
|
|
|
### Return type
|
|
|
|
[**PropPublishStatus**](../Models/PropPublishStatus.md)
|
|
|
|
### Authorization
|
|
|
|
[authCookie](../README.md#authCookie)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
<a name="listProps"></a>
|
|
# **listProps**
|
|
> List listProps(authorId, n, offset)
|
|
|
|
List Props
|
|
|
|
Returns a list Prop objects.
|
|
|
|
### Parameters
|
|
|
|
|Name | Type | Description | Notes |
|
|
|------------- | ------------- | ------------- | -------------|
|
|
| **authorId** | **String**| Must be a valid user ID. | [default to null] |
|
|
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
|
|
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
|
|
|
|
### Return type
|
|
|
|
[**List**](../Models/Prop.md)
|
|
|
|
### Authorization
|
|
|
|
[authCookie](../README.md#authCookie)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
<a name="publishProp"></a>
|
|
# **publishProp**
|
|
> PropPublishStatus publishProp(propId)
|
|
|
|
Publish Prop
|
|
|
|
Publish a Prop and return the updated PropPublishStatus object.
|
|
|
|
### Parameters
|
|
|
|
|Name | Type | Description | Notes |
|
|
|------------- | ------------- | ------------- | -------------|
|
|
| **propId** | **String**| Prop ID. | [default to null] |
|
|
|
|
### Return type
|
|
|
|
[**PropPublishStatus**](../Models/PropPublishStatus.md)
|
|
|
|
### Authorization
|
|
|
|
[authCookie](../README.md#authCookie)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
<a name="unpublishProp"></a>
|
|
# **unpublishProp**
|
|
> PropPublishStatus unpublishProp(propId)
|
|
|
|
Unpublish Prop
|
|
|
|
Unpublish a Prop and return the updated PropPublishStatus object.
|
|
|
|
### Parameters
|
|
|
|
|Name | Type | Description | Notes |
|
|
|------------- | ------------- | ------------- | -------------|
|
|
| **propId** | **String**| Prop ID. | [default to null] |
|
|
|
|
### Return type
|
|
|
|
[**PropPublishStatus**](../Models/PropPublishStatus.md)
|
|
|
|
### Authorization
|
|
|
|
[authCookie](../README.md#authCookie)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
<a name="updateProp"></a>
|
|
# **updateProp**
|
|
> Prop updateProp(propId, UpdatePropRequest)
|
|
|
|
Update Prop
|
|
|
|
Updates a Prop and returns the updated Prop object. When updating the asset bundle, all of `name`, `assetUrl`, `platform`, `unityVersion`, `assetVersion`, `spawnType`, and `worldPlacementMask` must be present, as well as `propSignature` if this value is not blank.
|
|
|
|
### Parameters
|
|
|
|
|Name | Type | Description | Notes |
|
|
|------------- | ------------- | ------------- | -------------|
|
|
| **propId** | **String**| Prop ID. | [default to null] |
|
|
| **UpdatePropRequest** | [**UpdatePropRequest**](../Models/UpdatePropRequest.md)| | |
|
|
|
|
### Return type
|
|
|
|
[**Prop**](../Models/Prop.md)
|
|
|
|
### Authorization
|
|
|
|
[authCookie](../README.md#authCookie)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: application/json
|
|
|