IVRChat Class
Namespace: VRChat.API.Client
Inherited: System.Object
A generic interface for communicating against VRChat's API.
Methods
public TryLoginAsync(System.Threading.CancellationToken ct)
Parameters
| Type |
Name |
Description |
System.Threading.CancellationToken |
ct |
Cancellation token for cancelling any asynchronous operations |
Return
| Type |
Description |
| A Boolean specifying if the current client is logged in successfully. |
Tries to login as the currently configured user, and returns a Boolean with the result.
public LoginAsync(bool throwOnFail, System.Threading.CancellationToken ct)
Parameters
| Type |
Name |
Description |
bool |
throwOnFail |
If you are simply checking for valid authentication, leave this as false |
System.Threading.CancellationToken |
ct |
Cancellation token for cancelling any asynchronous operations |
Return
| Type |
Description |
| A CurrentUser with the currently logged in user, if successful. |
Logs in as the currently configured user. Will throw an exception unless throwOnFail is set to true.
If successful, the CurrentUser will be returned, otherwise null (if throwOnFail is false).
Properties
public Files
The Files API for VRChat.
The Files API provides access to creating, deleting, uploading, and managing files for avatars, worlds, thumbnails, and user profiles on VRChat.
public Users
The Users API for VRChat.
The Users API provides access to searching for, querying, and updating user information on VRChat.
public System
The System API for VRChat.
The System API for VRChat provides access to fetching configurations, system informations, and other general system tasks.
Operations include:- Fetch API configuration
- Download CSS or JavaScript files
- Get remote system time
- Get currently online users
public Worlds
The Worlds API for VRChat.
The Worlds API provides access to querying, creating, updating, and general world resource management on VRChat.
public Invites
The Invites API for VRChat.
The Invites API provides access to requesting invites, listing invites, sending invites, and managing invites on VRChat.
public Avatars
The Avatars API for VRChat.
The Avatars API provides access to querying, creating, updating, and general avatar resource management on VRChat.
public Economy
The Economy API for VRChat.
The Economy API provides access to information on the current user's transactions toward VRChat Inc.
public Friends
The Friends API for VRChat.
The Friends API provides access to managing relationships with other users on VRChat.
public Instances
The Instances API for VRChat.
The Instances API provides access to querying instance information and requesting instance access on VRChat.
public Favorites
The Favorites API for VRChat.
The Favorites API provides access to managing avatar and world favorites, and favorite groups with VRChat.
public Permissions
The Permissions API for VRChat.
The Permissions API provides access to querying permissions & assigned permissions on VRChat
This API is used for managing VRChat+ related permissions (inferred).
public Notifications
The Notifications API for VRChat.
The Notifications API provides access to listing, deleting, acknowledging, and clearning notifications on VRChat.
An important use-case of this API is to accept a friend request notification.
public Moderations
The Moderations API for VRChat.
The Moderations API provides access to blocking/unblocking users, muting users, and managing general moderations on VRChat.
public Authentication
The Authentication API for VRChat.
The Authentication API provides access to basic authentication (login/logout), 2FA access, user deletion, and checking for taken usernames/emails.
public IsLoggedIn
Will be true if the current client is successfully logged in as a user.
Otherwise, this will return false.
This property automatically updates when calling TryLoginAsync or LoginAsync