VRChat.Favorites (vrchat v1.20.0)

View Source

API calls for all endpoints tagged Favorites.

Summary

Functions

add_favorite(connection, opts \\ [])

Add Favorite Add a new favorite. Friend groups are named group_0 through group_3. Avatar and World groups are named avatars1 to avatars4 and worlds1 to worlds4. You cannot add people whom you are not friends with to your friends list. Destroying a friendship removes the person as favorite on both sides.

clear_favorite_group(connection, favorite_group_type, favorite_group_name, user_id, opts \\ [])

Clear Favorite Group Clear ALL contents of a specific favorite group.

get_favorite_group(connection, favorite_group_type, favorite_group_name, user_id, opts \\ [])

Show Favorite Group Fetch information about a specific favorite group.

get_favorite_groups(connection, opts \\ [])

List Favorite Groups Return a list of favorite groups owned by a user. Returns the same information as getFavoriteGroups.

get_favorite_limits(connection, opts \\ [])

Get Favorite Limits Return information about a specific Favorite.

get_favorites(connection, opts \\ [])

List Favorites Returns a list of favorites.

remove_favorite(connection, favorite_id, opts \\ [])

Remove Favorite Remove a favorite from your favorites list.

update_favorite_group(connection, favorite_group_type, favorite_group_name, user_id, opts \\ [])

Update Favorite Group Update information about a specific favorite group.

Functions

add_favorite(connection, opts \\ [])

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

Add Favorite Add a new favorite. Friend groups are named group_0 through group_3. Avatar and World groups are named avatars1 to avatars4 and worlds1 to worlds4. You cannot add people whom you are not friends with to your friends list. Destroying a friendship removes the person as favorite on both sides.

Parameters

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

Returns

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

clear_favorite_group(connection, favorite_group_type, favorite_group_name, user_id, opts \\ [])

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

Clear Favorite Group Clear ALL contents of a specific favorite group.

Parameters

  • connection (VRChat.Connection): Connection to server
  • favorite_group_type (String.t): The type of group to fetch, must be a valid FavoriteType.
  • favorite_group_name (String.t): The name of the group to fetch, must be a name of a FavoriteGroup.
  • user_id (String.t): Must be a valid user ID.
  • opts (keyword): Optional parameters

Returns

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

get_favorite_group(connection, favorite_group_type, favorite_group_name, user_id, opts \\ [])

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

Show Favorite Group Fetch information about a specific favorite group.

Parameters

  • connection (VRChat.Connection): Connection to server
  • favorite_group_type (String.t): The type of group to fetch, must be a valid FavoriteType.
  • favorite_group_name (String.t): The name of the group to fetch, must be a name of a FavoriteGroup.
  • user_id (String.t): Must be a valid user ID.
  • opts (keyword): Optional parameters

Returns

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

get_favorite_groups(connection, opts \\ [])

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

List Favorite Groups Return a list of favorite groups owned by a user. Returns the same information as getFavoriteGroups.

Parameters

  • connection (VRChat.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :n (integer()): The number of objects to return.
    • :offset (integer()): A zero-based offset from the default object sorting from where search results start.
    • :userId (String.t): Target user to see information on, admin-only.
    • :ownerId (String.t): The owner of whoms favorite groups to return. Must be a UserID.

Returns

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

get_favorite_limits(connection, opts \\ [])

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

Get Favorite Limits Return information about a specific Favorite.

Parameters

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

Returns

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

get_favorites(connection, opts \\ [])

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

List Favorites Returns a list of favorites.

Parameters

  • connection (VRChat.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :n (integer()): The number of objects to return.
    • :offset (integer()): A zero-based offset from the default object sorting from where search results start.
    • :type (String.t): The type of favorites to return, FavoriteType.
    • :tag (String.t): Tags to include (comma-separated). Any of the tags needs to be present.

Returns

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

remove_favorite(connection, favorite_id, opts \\ [])

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

Remove Favorite Remove a favorite from your favorites list.

Parameters

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

Returns

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

update_favorite_group(connection, favorite_group_type, favorite_group_name, user_id, opts \\ [])

@spec update_favorite_group(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Update Favorite Group Update information about a specific favorite group.

Parameters

  • connection (VRChat.Connection): Connection to server
  • favorite_group_type (String.t): The type of group to fetch, must be a valid FavoriteType.
  • favorite_group_name (String.t): The name of the group to fetch, must be a name of a FavoriteGroup.
  • user_id (String.t): Must be a valid user ID.
  • opts (keyword): Optional parameters
    • :body (UpdateFavoriteGroupRequest):

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure