View Source VRChat.Api.Instances (VRChat v1.7.2)
API calls for all endpoints tagged Instances.
Link to this section Summary
Functions
Get Instance Returns an instance. Please read Instances Tutorial for more information on Instances. If an invalid instanceId is provided, this endpoint will simply return "null"!
Get Instance Short Name Returns an instance short name.
Send Self Invite Sends an invite to the instance to yourself.
Link to this section Functions
@spec get_instance(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, VRChat.Model.Instance.t()} | {:ok, VRChat.Model.Error.t()} | {:error, Tesla.Env.t()}
Get Instance Returns an instance. Please read Instances Tutorial for more information on Instances. If an invalid instanceId is provided, this endpoint will simply return "null"!
parameters
Parameters
- connection (VRChat.Connection): Connection to server
- world_id (String.t):
- instance_id (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
@spec get_short_name(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, VRChat.Model.Error.t()} | {:ok, String.t()} | {:error, Tesla.Env.t()}
Get Instance Short Name Returns an instance short name.
parameters
Parameters
- connection (VRChat.Connection): Connection to server
- world_id (String.t):
- instance_id (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
@spec send_self_invite(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, VRChat.Model.Success.t()} | {:ok, VRChat.Model.Error.t()} | {:error, Tesla.Env.t()}
Send Self Invite Sends an invite to the instance to yourself.
parameters
Parameters
- connection (VRChat.Connection): Connection to server
- world_id (String.t):
- instance_id (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure