vrchat
v1.11.1

View Source VRChat.Permissions (vrchat v1.11.1)

API calls for all endpoints tagged Permissions.

Link to this section Summary

Functions

get_assigned_permissions(connection, opts \\ [])

Get Assigned Permissions Returns a list of all permissions currently granted by the user. Permissions are assigned e.g. by subscribing to VRC+.

get_permission(connection, permission_id, opts \\ [])

Get Permission Returns a single permission. This endpoint is pretty useless, as it returns the exact same information as /auth/permissions.

Link to this section Functions

Link to this function

get_assigned_permissions(connection, opts \\ [])

View Source 
@spec get_assigned_permissions(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, [VRChat.Model.Permission.t()]}
  | {:ok, VRChat.Model.Error.t()}
  | {:error, Tesla.Env.t()}

Get Assigned Permissions Returns a list of all permissions currently granted by the user. Permissions are assigned e.g. by subscribing to VRC+.

parameters

 Parameters

  • connection (VRChat.Connection): Connection to server
  • opts (keyword): Optional parameters

returns

 Returns

  • {:ok, [%Permission{}, ...]} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

get_permission(connection, permission_id, opts \\ [])

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

Get Permission Returns a single permission. This endpoint is pretty useless, as it returns the exact same information as /auth/permissions.

parameters

 Parameters

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

returns

 Returns

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