VRChat.Jams (vrchat v1.20.0)

View Source

API calls for all endpoints tagged Jams.

Summary

Functions

Show jam information Returns a jam.

Show jam submissions Returns all submissions of a jam.

Show jams list Lists World Jams or Avatar Jams, both currently running and ones that have ended. isActive is used to select only active or already ended jams. type is used to select only world or avatar jams, and can only take world or avatar. ` ### Parameters -connection(VRChat.Connection): Connection to server -opts(keyword): Optional parameters -:type(String.t): Only show jams of this type (avatarorworld). ### Returns -, ...]}on success -` on failure

Functions

get_jam(connection, jam_id, opts \\ [])

@spec get_jam(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, VRChat.Model.Error.t()}
  | {:ok, VRChat.Model.Jam.t()}
  | {:error, Tesla.Env.t()}

Show jam information Returns a jam.

Parameters

  • connection (VRChat.Connection): Connection to server
  • jam_id (String.t): Must be a valid query ID.
  • opts (keyword): Optional parameters

Returns

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

get_jam_submissions(connection, jam_id, opts \\ [])

@spec get_jam_submissions(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, [VRChat.Model.Submission.t()]}
  | {:ok, VRChat.Model.Error.t()}
  | {:error, Tesla.Env.t()}

Show jam submissions Returns all submissions of a jam.

Parameters

  • connection (VRChat.Connection): Connection to server
  • jam_id (String.t): Must be a valid query ID.
  • opts (keyword): Optional parameters

Returns

  • {:ok, [%Submission{}, ...]} on success
  • {:error, Tesla.Env.t} on failure

get_jams(connection, opts \\ [])

@spec get_jams(
  Tesla.Env.client(),
  keyword()
) :: {:ok, [VRChat.Model.Jam.t()]} | {:error, Tesla.Env.t()}

Show jams list Lists World Jams or Avatar Jams, both currently running and ones that have ended. isActive is used to select only active or already ended jams. type is used to select only world or avatar jams, and can only take world or avatar. ` ### Parameters -connection(VRChat.Connection): Connection to server -opts(keyword): Optional parameters -:type(String.t): Only show jams of this type (avatarorworld). ### Returns -, ...]}on success -` on failure