mirror of
https://github.com/mii443/vrchatapi-rust.git
synced 2025-08-22 23:55:33 +00:00
229 lines
7.3 KiB
Markdown
229 lines
7.3 KiB
Markdown
# \InviteApi
|
|
|
|
All URIs are relative to *https://api.vrchat.cloud/api/1*
|
|
|
|
Method | HTTP request | Description
|
|
------------- | ------------- | -------------
|
|
[**get_invite_message**](InviteApi.md#get_invite_message) | **GET** /message/{userId}/message/{messageId} | Get Invite Messages
|
|
[**get_invite_messages**](InviteApi.md#get_invite_messages) | **GET** /message/{userId}/message | List Invite Messages
|
|
[**invite_user**](InviteApi.md#invite_user) | **POST** /invite/{userId} | Invite User
|
|
[**request_invite**](InviteApi.md#request_invite) | **POST** /requestInvite/{userId} | Request Invite
|
|
[**reset_invite_message**](InviteApi.md#reset_invite_message) | **DELETE** /message/{userId}/message/{messageId} | Reset Invite Message
|
|
[**respond_invite**](InviteApi.md#respond_invite) | **POST** /invite/{notificationId}/response | Respond Invite
|
|
[**update_invite_message**](InviteApi.md#update_invite_message) | **PUT** /message/{userId}/message/{messageId} | Update Invite Message
|
|
|
|
|
|
|
|
## get_invite_message
|
|
|
|
> crate::models::InviteMessage get_invite_message(user_id, message_id)
|
|
Get Invite Messages
|
|
|
|
Returns a single Invite Message. This returns the exact same information but less than `getInviteMessages`. Admin Credentials are required to view messages of other users!
|
|
|
|
### Parameters
|
|
|
|
|
|
Name | Type | Description | Required | Notes
|
|
------------- | ------------- | ------------- | ------------- | -------------
|
|
**user_id** | **String** | | [required] |
|
|
**message_id** | **i32** | | [required] |
|
|
|
|
### Return type
|
|
|
|
[**crate::models::InviteMessage**](InviteMessage.md)
|
|
|
|
### Authorization
|
|
|
|
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
|
|
## get_invite_messages
|
|
|
|
> Vec<crate::models::InviteMessage> get_invite_messages(user_id)
|
|
List Invite Messages
|
|
|
|
Returns a list of all that users Invite Messages. Admin Credentials are required to view messages of other users!
|
|
|
|
### Parameters
|
|
|
|
|
|
Name | Type | Description | Required | Notes
|
|
------------- | ------------- | ------------- | ------------- | -------------
|
|
**user_id** | **String** | | [required] |
|
|
|
|
### Return type
|
|
|
|
[**Vec<crate::models::InviteMessage>**](InviteMessage.md)
|
|
|
|
### Authorization
|
|
|
|
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
|
|
## invite_user
|
|
|
|
> crate::models::Notification invite_user(user_id)
|
|
Invite User
|
|
|
|
Sends an invite to a user. Returns the Notification of type `invite` that was sent.
|
|
|
|
### Parameters
|
|
|
|
|
|
Name | Type | Description | Required | Notes
|
|
------------- | ------------- | ------------- | ------------- | -------------
|
|
**user_id** | **String** | | [required] |
|
|
|
|
### Return type
|
|
|
|
[**crate::models::Notification**](Notification.md)
|
|
|
|
### Authorization
|
|
|
|
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
|
|
## request_invite
|
|
|
|
> crate::models::Notification request_invite(user_id)
|
|
Request Invite
|
|
|
|
Requests an invite from a user. Returns the Notification of type `requestInvite` that was sent.
|
|
|
|
### Parameters
|
|
|
|
|
|
Name | Type | Description | Required | Notes
|
|
------------- | ------------- | ------------- | ------------- | -------------
|
|
**user_id** | **String** | | [required] |
|
|
|
|
### Return type
|
|
|
|
[**crate::models::Notification**](Notification.md)
|
|
|
|
### Authorization
|
|
|
|
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
|
|
## reset_invite_message
|
|
|
|
> Vec<crate::models::InviteMessage> reset_invite_message(user_id, message_id)
|
|
Reset Invite Message
|
|
|
|
Resets a single Invite Message back to it's original message, and then returns a list of all of them. Admin Credentials are required to update messages of other users! Resetting a message respects the rate-limit, but resetting it does not set the rate-limit to 60 like when editing it. It is possible to edit it right after resetting it. Trying to edit a message before the cooldown timer expires results in a 429 Too Fast Error.
|
|
|
|
### Parameters
|
|
|
|
|
|
Name | Type | Description | Required | Notes
|
|
------------- | ------------- | ------------- | ------------- | -------------
|
|
**user_id** | **String** | | [required] |
|
|
**message_id** | **i32** | | [required] |
|
|
|
|
### Return type
|
|
|
|
[**Vec<crate::models::InviteMessage>**](InviteMessage.md)
|
|
|
|
### Authorization
|
|
|
|
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
|
|
## respond_invite
|
|
|
|
> crate::models::Notification respond_invite(notification_id)
|
|
Respond Invite
|
|
|
|
Sends a world invite to a user.
|
|
|
|
### Parameters
|
|
|
|
|
|
Name | Type | Description | Required | Notes
|
|
------------- | ------------- | ------------- | ------------- | -------------
|
|
**notification_id** | **String** | | [required] |
|
|
|
|
### Return type
|
|
|
|
[**crate::models::Notification**](Notification.md)
|
|
|
|
### Authorization
|
|
|
|
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|
|
|
|
## update_invite_message
|
|
|
|
> Vec<crate::models::InviteMessage> update_invite_message(user_id, message_id)
|
|
Update Invite Message
|
|
|
|
Updates a single Invite Message and then returns a list of all of them. Admin Credentials are required to update messages of other users! Updating a message automatically sets the cooldown timer to 60 minutes. Trying to edit a message before the cooldown timer expires results in a 429 Too Fast Error.
|
|
|
|
### Parameters
|
|
|
|
|
|
Name | Type | Description | Required | Notes
|
|
------------- | ------------- | ------------- | ------------- | -------------
|
|
**user_id** | **String** | | [required] |
|
|
**message_id** | **i32** | | [required] |
|
|
|
|
### Return type
|
|
|
|
[**Vec<crate::models::InviteMessage>**](InviteMessage.md)
|
|
|
|
### Authorization
|
|
|
|
[apiKeyCookie](../README.md#apiKeyCookie), [authCookie](../README.md#authCookie)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|