View Source VRChat.Favorites (vrchat v1.11.1)
API calls for all endpoints tagged Favorites
.
Link to this section Summary
Functions
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 Clear ALL contents of a specific favorite group.
Show Favorite Return information about a specific Favorite.
Show Favorite Group Fetch information about a specific favorite group.
List Favorite Groups
Return a list of favorite groups owned by a user. Returns the same information as getFavoriteGroups
.
List Favorites Returns a list of favorites.
Remove Favorite Remove a favorite from your favorites list.
Update Favorite Group Update information about a specific favorite group.
Link to this section Functions
@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
Parameters
connection
(VRChat.Connection): Connection to serveropts
(keyword): Optional parameters:body
(AddFavoriteRequest):
returns
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 \\ [])
View Source@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
Parameters
connection
(VRChat.Connection): Connection to serverfavorite_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
Returns
{:ok, VRChat.Model.Success.t}
on success{:error, Tesla.Env.t}
on failure
@spec get_favorite(Tesla.Env.client(), String.t(), keyword()) :: {:ok, VRChat.Model.Error.t()} | {:ok, VRChat.Model.Favorite.t()} | {:error, Tesla.Env.t()}
Show Favorite Return information about a specific Favorite.
parameters
Parameters
connection
(VRChat.Connection): Connection to serverfavorite_id
(String.t): Must be a valid favorite ID.opts
(keyword): Optional parameters
returns
Returns
{:ok, VRChat.Model.Favorite.t}
on success{:error, Tesla.Env.t}
on failure
get_favorite_group(connection, favorite_group_type, favorite_group_name, user_id, opts \\ [])
View Source@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
Parameters
connection
(VRChat.Connection): Connection to serverfavorite_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
Returns
{:ok, VRChat.Model.FavoriteGroup.t}
on success{:error, Tesla.Env.t}
on failure
@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
Parameters
connection
(VRChat.Connection): Connection to serveropts
(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.:ownerId
(String.t): The owner of whoms favorite groups to return. Must be a UserID.
returns
Returns
{:ok, [%FavoriteGroup{}, ...]}
on success{:error, Tesla.Env.t}
on failure
@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
Parameters
connection
(VRChat.Connection): Connection to serveropts
(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
Returns
{:ok, [%Favorite{}, ...]}
on success{:error, Tesla.Env.t}
on failure
@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
Parameters
connection
(VRChat.Connection): Connection to serverfavorite_id
(String.t): Must be a valid favorite ID.opts
(keyword): Optional parameters
returns
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 \\ [])
View Source@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
Parameters
connection
(VRChat.Connection): Connection to serverfavorite_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
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure