Skip to content

Latest commit

 

History

History
157 lines (107 loc) · 4.65 KB

JamsApi.md

File metadata and controls

157 lines (107 loc) · 4.65 KB
Raw

vrchat_dart_generated.api.JamsApi

Load the API package

import 'package:vrchat_dart_generated/api.dart';

All URIs are relative to https://api.vrchat.cloud/api/1

Method HTTP request Description
getJam GET /jams/{jamId} Show jam information
getJamSubmissions GET /jams/{jamId}/submissions Show jam submissions
getJams GET /jams Show jams list

getJam

Jam getJam(jamId)

Show jam information

Returns a jam.

Example

import 'package:vrchat_dart_generated/api.dart';
// TODO Configure API key authorization: authCookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKeyPrefix = 'Bearer';

final api = VrchatDartGenerated().getJamsApi();
final String jamId = jam_0b7e3f6d-4647-4648-b2a1-1431e76906d9; // String | Must be a valid query ID.

try {
    final response = api.getJam(jamId);
    print(response);
} catch on DioException (e) {
    print('Exception when calling JamsApi->getJam: $e\n');
}

Parameters

Name Type Description Notes
jamId String Must be a valid query ID.

Return type

Jam

Authorization

authCookie

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getJamSubmissions

List getJamSubmissions(jamId)

Show jam submissions

Returns all submissions of a jam.

Example

import 'package:vrchat_dart_generated/api.dart';
// TODO Configure API key authorization: authCookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKeyPrefix = 'Bearer';

final api = VrchatDartGenerated().getJamsApi();
final String jamId = jam_0b7e3f6d-4647-4648-b2a1-1431e76906d9; // String | Must be a valid query ID.

try {
    final response = api.getJamSubmissions(jamId);
    print(response);
} catch on DioException (e) {
    print('Exception when calling JamsApi->getJamSubmissions: $e\n');
}

Parameters

Name Type Description Notes
jamId String Must be a valid query ID.

Return type

List<Submission>

Authorization

authCookie

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getJams

List getJams(type)

Show jams list

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. ``

Example

import 'package:vrchat_dart_generated/api.dart';
// TODO Configure API key authorization: authCookie
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('authCookie').apiKeyPrefix = 'Bearer';

final api = VrchatDartGenerated().getJamsApi();
final String type = avatar; // String | Only show jams of this type (`avatar` or `world`).

try {
    final response = api.getJams(type);
    print(response);
} catch on DioException (e) {
    print('Exception when calling JamsApi->getJams: $e\n');
}

Parameters

Name Type Description Notes
type String Only show jams of this type (avatar or world). [optional]

Return type

List<Jam>

Authorization

authCookie

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]