|
| 1 | +# JamsApi |
| 2 | + |
| 3 | +All URIs are relative to *https://vrchat.com/api/1* |
| 4 | + |
| 5 | +| Method | HTTP request | Description | |
| 6 | +|------------- | ------------- | -------------| |
| 7 | +| [**getJam**](JamsApi.md#getJam) | **GET** /jams/{jamId} | Show jam information | |
| 8 | +| [**getJamSubmissions**](JamsApi.md#getJamSubmissions) | **GET** /jams/{jamId}/submissions | Show jam submissions | |
| 9 | +| [**getJams**](JamsApi.md#getJams) | **GET** /jams | Show jams list | |
| 10 | + |
| 11 | + |
| 12 | +<a name="getJam"></a> |
| 13 | +# **getJam** |
| 14 | +> Jam getJam(jamId) |
| 15 | +
|
| 16 | +Show jam information |
| 17 | + |
| 18 | +Returns a jam. |
| 19 | + |
| 20 | +### Example |
| 21 | +```java |
| 22 | +// Import classes: |
| 23 | +import io.github.vrchatapi.ApiClient; |
| 24 | +import io.github.vrchatapi.ApiException; |
| 25 | +import io.github.vrchatapi.Configuration; |
| 26 | +import io.github.vrchatapi.auth.*; |
| 27 | +import io.github.vrchatapi.models.*; |
| 28 | +import io.github.vrchatapi.api.JamsApi; |
| 29 | + |
| 30 | +public class Example { |
| 31 | + public static void main(String[] args) { |
| 32 | + ApiClient defaultClient = Configuration.getDefaultApiClient(); |
| 33 | + defaultClient.setBasePath("https://vrchat.com/api/1"); |
| 34 | + |
| 35 | + // Configure API key authorization: authCookie |
| 36 | + ApiKeyAuth authCookie = (ApiKeyAuth) defaultClient.getAuthentication("authCookie"); |
| 37 | + authCookie.setApiKey("YOUR API KEY"); |
| 38 | + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) |
| 39 | + //authCookie.setApiKeyPrefix("Token"); |
| 40 | + |
| 41 | + JamsApi apiInstance = new JamsApi(defaultClient); |
| 42 | + String jamId = "jam_0b7e3f6d-4647-4648-b2a1-1431e76906d9"; // String | Must be a valid query ID. |
| 43 | + try { |
| 44 | + Jam result = apiInstance.getJam(jamId); |
| 45 | + System.out.println(result); |
| 46 | + } catch (ApiException e) { |
| 47 | + System.err.println("Exception when calling JamsApi#getJam"); |
| 48 | + System.err.println("Status code: " + e.getCode()); |
| 49 | + System.err.println("Reason: " + e.getResponseBody()); |
| 50 | + System.err.println("Response headers: " + e.getResponseHeaders()); |
| 51 | + e.printStackTrace(); |
| 52 | + } |
| 53 | + } |
| 54 | +} |
| 55 | +``` |
| 56 | + |
| 57 | +### Parameters |
| 58 | + |
| 59 | +| Name | Type | Description | Notes | |
| 60 | +|------------- | ------------- | ------------- | -------------| |
| 61 | +| **jamId** | **String**| Must be a valid query ID. | | |
| 62 | + |
| 63 | +### Return type |
| 64 | + |
| 65 | +[**Jam**](Jam.md) |
| 66 | + |
| 67 | +### Authorization |
| 68 | + |
| 69 | +[authCookie](../README.md#authCookie) |
| 70 | + |
| 71 | +### HTTP request headers |
| 72 | + |
| 73 | + - **Content-Type**: Not defined |
| 74 | + - **Accept**: application/json |
| 75 | + |
| 76 | +### HTTP response details |
| 77 | +| Status code | Description | Response headers | |
| 78 | +|-------------|-------------|------------------| |
| 79 | +| **200** | Returns a Jam object. | - | |
| 80 | +| **404** | Error response when trying to show information about a non-existent jam. | - | |
| 81 | + |
| 82 | +<a name="getJamSubmissions"></a> |
| 83 | +# **getJamSubmissions** |
| 84 | +> List<Submission> getJamSubmissions(jamId) |
| 85 | +
|
| 86 | +Show jam submissions |
| 87 | + |
| 88 | +Returns all submissions of a jam. |
| 89 | + |
| 90 | +### Example |
| 91 | +```java |
| 92 | +// Import classes: |
| 93 | +import io.github.vrchatapi.ApiClient; |
| 94 | +import io.github.vrchatapi.ApiException; |
| 95 | +import io.github.vrchatapi.Configuration; |
| 96 | +import io.github.vrchatapi.auth.*; |
| 97 | +import io.github.vrchatapi.models.*; |
| 98 | +import io.github.vrchatapi.api.JamsApi; |
| 99 | + |
| 100 | +public class Example { |
| 101 | + public static void main(String[] args) { |
| 102 | + ApiClient defaultClient = Configuration.getDefaultApiClient(); |
| 103 | + defaultClient.setBasePath("https://vrchat.com/api/1"); |
| 104 | + |
| 105 | + // Configure API key authorization: authCookie |
| 106 | + ApiKeyAuth authCookie = (ApiKeyAuth) defaultClient.getAuthentication("authCookie"); |
| 107 | + authCookie.setApiKey("YOUR API KEY"); |
| 108 | + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) |
| 109 | + //authCookie.setApiKeyPrefix("Token"); |
| 110 | + |
| 111 | + JamsApi apiInstance = new JamsApi(defaultClient); |
| 112 | + String jamId = "jam_0b7e3f6d-4647-4648-b2a1-1431e76906d9"; // String | Must be a valid query ID. |
| 113 | + try { |
| 114 | + List<Submission> result = apiInstance.getJamSubmissions(jamId); |
| 115 | + System.out.println(result); |
| 116 | + } catch (ApiException e) { |
| 117 | + System.err.println("Exception when calling JamsApi#getJamSubmissions"); |
| 118 | + System.err.println("Status code: " + e.getCode()); |
| 119 | + System.err.println("Reason: " + e.getResponseBody()); |
| 120 | + System.err.println("Response headers: " + e.getResponseHeaders()); |
| 121 | + e.printStackTrace(); |
| 122 | + } |
| 123 | + } |
| 124 | +} |
| 125 | +``` |
| 126 | + |
| 127 | +### Parameters |
| 128 | + |
| 129 | +| Name | Type | Description | Notes | |
| 130 | +|------------- | ------------- | ------------- | -------------| |
| 131 | +| **jamId** | **String**| Must be a valid query ID. | | |
| 132 | + |
| 133 | +### Return type |
| 134 | + |
| 135 | +[**List<Submission>**](Submission.md) |
| 136 | + |
| 137 | +### Authorization |
| 138 | + |
| 139 | +[authCookie](../README.md#authCookie) |
| 140 | + |
| 141 | +### HTTP request headers |
| 142 | + |
| 143 | + - **Content-Type**: Not defined |
| 144 | + - **Accept**: application/json |
| 145 | + |
| 146 | +### HTTP response details |
| 147 | +| Status code | Description | Response headers | |
| 148 | +|-------------|-------------|------------------| |
| 149 | +| **200** | Returns a list of Submission objects. | - | |
| 150 | +| **404** | Error response when trying to show information about a non-existent jam. | - | |
| 151 | + |
| 152 | +<a name="getJams"></a> |
| 153 | +# **getJams** |
| 154 | +> List<Jam> getJams(type) |
| 155 | +
|
| 156 | +Show jams list |
| 157 | + |
| 158 | +Lists World Jams or Avatar Jams, both currently running and ones that have ended. `isActive` is used to select only active or already ended jams. `type` is used to select only world or avatar jams, and can only take `world` or `avatar`. `` |
| 159 | + |
| 160 | +### Example |
| 161 | +```java |
| 162 | +// Import classes: |
| 163 | +import io.github.vrchatapi.ApiClient; |
| 164 | +import io.github.vrchatapi.ApiException; |
| 165 | +import io.github.vrchatapi.Configuration; |
| 166 | +import io.github.vrchatapi.auth.*; |
| 167 | +import io.github.vrchatapi.models.*; |
| 168 | +import io.github.vrchatapi.api.JamsApi; |
| 169 | + |
| 170 | +public class Example { |
| 171 | + public static void main(String[] args) { |
| 172 | + ApiClient defaultClient = Configuration.getDefaultApiClient(); |
| 173 | + defaultClient.setBasePath("https://vrchat.com/api/1"); |
| 174 | + |
| 175 | + // Configure API key authorization: authCookie |
| 176 | + ApiKeyAuth authCookie = (ApiKeyAuth) defaultClient.getAuthentication("authCookie"); |
| 177 | + authCookie.setApiKey("YOUR API KEY"); |
| 178 | + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) |
| 179 | + //authCookie.setApiKeyPrefix("Token"); |
| 180 | + |
| 181 | + JamsApi apiInstance = new JamsApi(defaultClient); |
| 182 | + String type = "avatar"; // String | Only show jams of this type (`avatar` or `world`). |
| 183 | + try { |
| 184 | + List<Jam> result = apiInstance.getJams(type); |
| 185 | + System.out.println(result); |
| 186 | + } catch (ApiException e) { |
| 187 | + System.err.println("Exception when calling JamsApi#getJams"); |
| 188 | + System.err.println("Status code: " + e.getCode()); |
| 189 | + System.err.println("Reason: " + e.getResponseBody()); |
| 190 | + System.err.println("Response headers: " + e.getResponseHeaders()); |
| 191 | + e.printStackTrace(); |
| 192 | + } |
| 193 | + } |
| 194 | +} |
| 195 | +``` |
| 196 | + |
| 197 | +### Parameters |
| 198 | + |
| 199 | +| Name | Type | Description | Notes | |
| 200 | +|------------- | ------------- | ------------- | -------------| |
| 201 | +| **type** | **String**| Only show jams of this type (`avatar` or `world`). | [optional] | |
| 202 | + |
| 203 | +### Return type |
| 204 | + |
| 205 | +[**List<Jam>**](Jam.md) |
| 206 | + |
| 207 | +### Authorization |
| 208 | + |
| 209 | +[authCookie](../README.md#authCookie) |
| 210 | + |
| 211 | +### HTTP request headers |
| 212 | + |
| 213 | + - **Content-Type**: Not defined |
| 214 | + - **Accept**: application/json |
| 215 | + |
| 216 | +### HTTP response details |
| 217 | +| Status code | Description | Response headers | |
| 218 | +|-------------|-------------|------------------| |
| 219 | +| **200** | Returns a list of Jam objects. | - | |
| 220 | + |
0 commit comments