VRChat.Users (vrchat v1.20.0)

View Source

API calls for all endpoints tagged Users.

Summary

Functions

Add User Tags Adds tags to the user's profile

Check User Persistence Exists Checks whether the user has persistence data for a given world

Delete User Persistence Deletes the user's persistence data for a given world

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 Feedback Get user's submitted feedback

Get User Group Instances Returns a list of group instances for a user

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

Get User Note Get a particular user note

Get User Notes Get recently updated user notes

Get user's current represented group Returns the current group that the user is currently representing

Remove User Tags Removes tags from the user's profile

Search All Users Search and list any users by text query

Update User Info Update a users information such as the email and birthday.

Update User Note Updates the currently authenticated user's note on a user

Functions

add_tags(connection, user_id, change_user_tags_request, opts \\ [])

Add User Tags Adds tags to the user's profile

Parameters

  • connection (VRChat.Connection): Connection to server
  • user_id (String.t): Must be a valid user ID.
  • change_user_tags_request (ChangeUserTagsRequest):
  • opts (keyword): Optional parameters

Returns

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

check_user_persistence_exists(connection, user_id, world_id, opts \\ [])

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

Check User Persistence Exists Checks whether the user has persistence data for a given world

Parameters

  • connection (VRChat.Connection): Connection to server
  • user_id (String.t): Must be a valid user ID.
  • world_id (String.t): Must be a valid world ID.
  • opts (keyword): Optional parameters

Returns

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

delete_user_persistence(connection, user_id, world_id, opts \\ [])

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

Delete User Persistence Deletes the user's persistence data for a given world

Parameters

  • connection (VRChat.Connection): Connection to server
  • user_id (String.t): Must be a valid user ID.
  • world_id (String.t): Must be a valid world ID.
  • opts (keyword): Optional parameters

Returns

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

get_user(connection, user_id, opts \\ [])

@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

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

Returns

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

get_user_by_name(connection, username, opts \\ [])

@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

  • connection (VRChat.Connection): Connection to server
  • username (String.t): Username of the user
  • opts (keyword): Optional parameters

Returns

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

get_user_feedback(connection, user_id, opts \\ [])

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

Get User Feedback Get user's submitted feedback

Parameters

  • connection (VRChat.Connection): Connection to server
  • user_id (String.t): Must be a valid user ID.
  • opts (keyword): Optional parameters
    • :contentId (boolean()): Filter for users' previously submitted feedback, e.g., a groupId, useeId, avatarId, etc.
    • :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

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

get_user_group_instances(connection, user_id, opts \\ [])

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

Get User Group Instances Returns a list of group instances for a user

Parameters

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

Returns

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

get_user_group_requests(connection, user_id, opts \\ [])

@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

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

Returns

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

get_user_groups(connection, user_id, opts \\ [])

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

Get User Groups Get user's public groups

Parameters

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

Returns

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

get_user_note(connection, user_note_id, opts \\ [])

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

Get User Note Get a particular user note

Parameters

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

Returns

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

get_user_notes(connection, opts \\ [])

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

Get User Notes Get recently updated user notes

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.

Returns

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

get_user_represented_group(connection, user_id, opts \\ [])

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

Get user's current represented group Returns the current group that the user is currently representing

Parameters

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

Returns

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

remove_tags(connection, user_id, change_user_tags_request, opts \\ [])

Remove User Tags Removes tags from the user's profile

Parameters

  • connection (VRChat.Connection): Connection to server
  • user_id (String.t): Must be a valid user ID.
  • change_user_tags_request (ChangeUserTagsRequest):
  • opts (keyword): Optional parameters

Returns

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

search_users(connection, opts \\ [])

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

Search All Users Search and list any users by text query

Parameters

  • connection (VRChat.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :search (String.t): Searches by displayName. 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

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

update_badge(connection, user_id, badge_id, update_user_badge_request, opts \\ [])

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

Update User Badge Updates a user's badge

Parameters

  • connection (VRChat.Connection): Connection to server
  • user_id (String.t): Must be a valid user ID.
  • badge_id (String.t): Must be a valid badge ID.
  • update_user_badge_request (UpdateUserBadgeRequest):
  • opts (keyword): Optional parameters

Returns

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

update_user(connection, user_id, opts \\ [])

@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

  • connection (VRChat.Connection): Connection to server
  • user_id (String.t): Must be a valid user ID.
  • opts (keyword): Optional parameters
    • :body (UpdateUserRequest):

Returns

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

update_user_note(connection, update_user_note_request, opts \\ [])

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

Update User Note Updates the currently authenticated user's note on a user

Parameters

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

Returns

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