View Source VRChat.Api.Users (VRChat v1.7.2)
API calls for all endpoints tagged Users.
Link to this section Summary
Functions
Get User by ID Get public user information about a specific user using their ID.
Get User by Username Get public user information about a specific user using their name.
Search All Users Search and list any users by text query
Update User Info Update a users information such as the email and birthday.
Link to this section Functions
@spec get_user(Tesla.Env.client(), String.t(), keyword()) :: {:ok, VRChat.Model.User.t()} | {:ok, VRChat.Model.Error.t()} | {:error, Tesla.Env.t()}
Get User by ID Get public user information about a specific user using their ID.
parameters
Parameters
- connection (VRChat.Connection): Connection to server
- user_id (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
@spec get_user_by_name(Tesla.Env.client(), String.t(), keyword()) :: {:ok, VRChat.Model.User.t()} | {:ok, VRChat.Model.Error.t()} | {:error, Tesla.Env.t()}
Get User by Username Get public user information about a specific user using their name.
parameters
Parameters
- connection (VRChat.Connection): Connection to server
- username (String.t):
- opts (KeywordList): [optional] Optional parameters
returns
Returns
on success {:error, Tesla.Env.t} on failure
@spec search_users( Tesla.Env.client(), keyword() ) :: {:ok, VRChat.Model.Error.t()} | {:ok, [VRChat.Model.LimitedUser.t()]} | {:error, Tesla.Env.t()}
Search All Users Search and list any users by text query
parameters
Parameters
- connection (VRChat.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
- :search (String.t): Searches by
displayName. Will return empty array if search query is empty or missing. - :developer_type (String.t): Active user by developer type, none for normal users and internal for moderators
- :n (integer()): The number of objects to return.
- :offset (integer()): A zero-based offset from the default object sorting from where search results start.
- :search (String.t): Searches by
returns
Returns
, ...]} on success {:error, Tesla.Env.t} on failure
@spec update_user(Tesla.Env.client(), String.t(), keyword()) :: {:ok, VRChat.Model.CurrentUser.t()} | {:error, Tesla.Env.t()}
Update User Info Update a users information such as the email and birthday.
parameters
Parameters
- connection (VRChat.Connection): Connection to server
- user_id (String.t):
- opts (KeywordList): [optional] Optional parameters
- :body (UpdateUserRequest):
returns
Returns
on success {:error, Tesla.Env.t} on failure