View Source VRChat.Instances (vrchat v1.11.1)

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 By Short Name Returns an instance. Please read Instances Tutorial for more information on Instances.

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

Link to this function

get_instance(connection, world_id, instance_id, opts \\ [])

View Source
@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): Must be a valid world ID.
  • instance_id (String.t): Must be a valid instance ID.
  • opts (keyword): Optional parameters

returns

Returns

  • {:ok, VRChat.Model.Instance.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

get_instance_by_short_name(connection, short_name, opts \\ [])

View Source
@spec get_instance_by_short_name(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, VRChat.Model.Instance.t()}
  | {:ok, VRChat.Model.Error.t()}
  | {:error, Tesla.Env.t()}

Get Instance By Short Name Returns an instance. Please read Instances Tutorial for more information on Instances.

parameters

Parameters

  • connection (VRChat.Connection): Connection to server
  • short_name (String.t): Must be a valid instance short name.
  • opts (keyword): Optional parameters

returns

Returns

  • {:ok, VRChat.Model.Instance.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

get_short_name(connection, world_id, instance_id, opts \\ [])

View Source
@spec get_short_name(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, VRChat.Model.InstanceShortNameResponse.t()}
  | {:ok, VRChat.Model.Error.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): Must be a valid world ID.
  • instance_id (String.t): Must be a valid instance ID.
  • opts (keyword): Optional parameters

returns

Returns

  • {:ok, VRChat.Model.InstanceShortNameResponse.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

send_self_invite(connection, world_id, instance_id, opts \\ [])

View Source
@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): Must be a valid world ID.
  • instance_id (String.t): Must be a valid instance ID.
  • opts (keyword): Optional parameters

returns

Returns

  • {:ok, VRChat.Model.Success.t} on success
  • {:error, Tesla.Env.t} on failure