Skip to content

Latest commit

 

History

History
156 lines (106 loc) · 4.38 KB

PrintsApi.md

File metadata and controls

156 lines (106 loc) · 4.38 KB

vrchat_dart_generated.api.PrintsApi

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
deletePrint DELETE /prints/{printId} Delete Print
getPrint GET /prints/{printId} Get Print
getUserPrints GET /prints/user/{userId} Get Own Prints

deletePrint

deletePrint(printId)

Delete Print

Returns a print.

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().getPrintsApi();
final String printId = prnt_0a0aa0a0-85ea-42eb-b2f7-4840d7f341fa; // String | Print ID.

try {
    api.deletePrint(printId);
} catch on DioException (e) {
    print('Exception when calling PrintsApi->deletePrint: $e\n');
}

Parameters

Name Type Description Notes
printId String Print ID.

Return type

void (empty response body)

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]

getPrint

Print getPrint(printId)

Get Print

Returns a print.

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().getPrintsApi();
final String printId = prnt_0a0aa0a0-85ea-42eb-b2f7-4840d7f341fa; // String | Print ID.

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

Parameters

Name Type Description Notes
printId String Print ID.

Return type

Print

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]

getUserPrints

List getUserPrints(userId)

Get Own Prints

Returns a list of all prints of the user. User id has to be your own userId, as you can't request other user's prints.

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().getPrintsApi();
final String userId = userId_example; // String | Must be a valid user ID.

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

Parameters

Name Type Description Notes
userId String Must be a valid user ID.

Return type

List<Print>

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]