View Source VRChat.Users (vrchat v1.11.1)
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. DEPRECATED: VRChat API no longer return usernames of other users. See issue by Tupper for more information. This endpoint now require Admin Credentials.
Get User Group Requests Returns a list of Groups the user has requested to be invited into.
Get User Groups Get user's public groups
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 serveruser_id(String.t): Must be a valid user ID.opts(keyword): Optional parameters
returns
Returns
{:ok, VRChat.Model.User.t}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. DEPRECATED: VRChat API no longer return usernames of other users. See issue by Tupper for more information. This endpoint now require Admin Credentials.
parameters
Parameters
connection(VRChat.Connection): Connection to serverusername(String.t): Username of the useropts(keyword): Optional parameters
returns
Returns
{:ok, VRChat.Model.User.t}on success{:error, Tesla.Env.t}on failure
@spec get_user_group_requests(Tesla.Env.client(), String.t(), keyword()) :: {:ok, [VRChat.Model.Group.t()]} | {:ok, VRChat.Model.Error.t()} | {:error, Tesla.Env.t()}
Get User Group Requests Returns a list of Groups the user has requested to be invited into.
parameters
Parameters
connection(VRChat.Connection): Connection to serveruser_id(String.t): Must be a valid user ID.opts(keyword): Optional parameters
returns
Returns
{:ok, [%Group{}, ...]}on success{:error, Tesla.Env.t}on failure
@spec get_user_groups(Tesla.Env.client(), String.t(), keyword()) :: {:ok, [VRChat.Model.Group.t()]} | {:ok, VRChat.Model.Error.t()} | {:error, Tesla.Env.t()}
Get User Groups Get user's public groups
parameters
Parameters
connection(VRChat.Connection): Connection to serveruser_id(String.t): Must be a valid user ID.opts(keyword): Optional parameters
returns
Returns
{:ok, [%Group{}, ...]}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 serveropts(keyword): Optional parameters:search(String.t): Searches bydisplayName. Will return empty array if search query is empty or missing.:developerType(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.
returns
Returns
{:ok, [%LimitedUser{}, ...]}on success{:error, Tesla.Env.t}on failure
@spec update_user(Tesla.Env.client(), String.t(), keyword()) :: {:ok, VRChat.Model.CurrentUser.t()} | {:ok, VRChat.Model.Error.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 serveruser_id(String.t): Must be a valid user ID.opts(keyword): Optional parameters:body(UpdateUserRequest):
returns
Returns
{:ok, VRChat.Model.CurrentUser.t}on success{:error, Tesla.Env.t}on failure