SystemApi class

Constructors

SystemApi(Dio _dio)
const

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

getConfig({CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<APIConfig>>
Fetch API Config API config contains configuration that the clients needs to work properly. Currently the most important value here is `clientApiKey` which is used for all other API endpoints.
getCSS({String? variant = 'public', String? branch = 'main', CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<String>>
Download CSS Fetches the CSS code to the frontend React website.
getCurrentOnlineUsers({CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<int>>
Current Online Users Returns the current number of online users. NOTE: The response type is not a JSON object, but a simple JSON integer.
getHealth({CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<APIHealth>>
Check API Health Gets the overall health status, the server name, and the current build version tag of the API. DEPRECATED: VRChat has suddenly restricted this endpoint for unknown reasons, and now always return 401 Unauthorized.
getInfoPush({String? require, String? include, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<List<InfoPush>>>
Show Information Notices IPS (Info Push System) is a system for VRChat to push out dynamic information to the client. This is primarily used by the Quick-Menu info banners, but can also be used to e.g. alert you to update your game to the latest version. `include` is used to query what Information Pushes should be included in the response. If include is missing or empty, then no notices will normally be returned. This is an &quot;any of&quot; search. `require` is used to limit what Information Pushes should be included in the response. This is usually used in combination with `include`, and is an &quot;all of&quot; search.
getJavaScript({String? variant = 'public', String? branch = 'main', CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<String>>
Download JavaScript Fetches the JavaScript code to the frontend React website.
getSystemTime({CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<DateTime>>
Current System Time Returns the current time of the API server. NOTE: The response type is not a JSON object, but a simple JSON string.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited