2c4cf7d817
* bump: openapi-generator to 7.7.0 * fix: remove empty doc comments to silence clippy * bump: remove unessecary patches fixed by the update * bump: run generate.sh
4.8 KiB
\FriendsApi
All URIs are relative to https://vrchat.com/api/1
| Method | HTTP request | Description |
|---|---|---|
| delete_friend_request | DELETE /user/{userId}/friendRequest | Delete Friend Request |
| friend | POST /user/{userId}/friendRequest | Send Friend Request |
| get_friend_status | GET /user/{userId}/friendStatus | Check Friend Status |
| get_friends | GET /auth/user/friends | List Friends |
| unfriend | DELETE /auth/user/friends/{userId} | Unfriend |
delete_friend_request
models::Success delete_friend_request(user_id) Delete Friend Request
Deletes an outgoing pending friend request to another user. To delete an incoming friend request, use the deleteNotification endpoint instead.
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| user_id | String | Must be a valid user ID. | [required] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
friend
models::Notification friend(user_id) Send Friend Request
Send a friend request to another user.
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| user_id | String | Must be a valid user ID. | [required] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
get_friend_status
models::FriendStatus get_friend_status(user_id) Check Friend Status
Retrieve if the user is currently a friend with a given user, if they have an outgoing friend request, and if they have an incoming friend request. The proper way to receive and accept friend request is by checking if the user has an incoming Notification of type friendRequest, and then accepting that notification.
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| user_id | String | Must be a valid user ID. | [required] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
get_friends
Vecmodels::LimitedUser get_friends(offset, n, offline) List Friends
List information about friends.
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| offset | Option<i32> | A zero-based offset from the default object sorting from where search results start. | ||
| n | Option<i32> | The number of objects to return. | [default to 60] | |
| offline | Option<bool> | Returns only offline users if true, returns only online and active users if false |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
unfriend
models::Success unfriend(user_id) Unfriend
Unfriend a user by ID.
Parameters
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| user_id | String | Must be a valid user ID. | [required] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]