VRChat.Invite (vrchat v1.20.0)
View SourceAPI calls for all endpoints tagged Invite
.
Summary
Functions
Get Invite Message
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! Message type refers to a different collection of messages, used during different types of responses. message
= Message during a normal invite response
= Message when replying to a message request
= Message when requesting an invite requestResponse
= Message when replying to a request for invite
List Invite Messages
Returns a list of all the users Invite Messages. Admin Credentials are required to view messages of other users! Message type refers to a different collection of messages, used during different types of responses. message
= Message during a normal invite response
= Message when replying to a message request
= Message when requesting an invite requestResponse
= Message when replying to a request for invite
Invite Myself To Instance Sends self an invite to an instance
Invite User
Sends an invite to a user. Returns the Notification of type invite
that was sent.
Invite User with photo
Sends an photo invite to a user. Returns the Notification of type invite
that was sent.
Request Invite
Requests an invite from a user. Returns the Notification of type requestInvite
that was sent.
Request Invite with photo
Requests with photo an invite from a user. Returns the Notification of type requestInvite
that was sent.
Reset Invite Message
Resets a single Invite Message back to its 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, so it is not possible to reset within the 60 minutes countdown. Resetting it does however 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". Message type refers to a different collection of messages, used during different types of responses. message
= Message during a normal invite response
= Message when replying to a message request
= Message when requesting an invite requestResponse
= Message when replying to a request for invite The DELETE endpoint does not have/require any request body.
Respond Invite
Respond to an invite or invite request without accepting it. :notificationId
is the ID of the requesting notification. In case the notification being replied to is an invite, the responseSlot
refers to a response message from the the message
collection. In case the notification is an invite request, it will refer to one from the requestResponse
collection instead.
Respond Invite with photo
Respond with photo to an invite or invite request without accepting it. :notificationId
is the ID of the requesting notification. In case the notification being replied to is an invite, the responseSlot
refers to a response message from the the message
collection. In case the notification is an invite request, it will refer to one from the requestResponse
collection instead.'
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". Message type refers to a different collection of messages, used during different types of responses. message
= Message during a normal invite response
= Message when replying to a message request
= Message when requesting an invite requestResponse
= Message when replying to a request for invite
Functions
@spec get_invite_message( Tesla.Env.client(), String.t(), VRChat.Model.InviteMessageType.t(), integer(), keyword() ) :: {:ok, VRChat.Model.InviteMessage.t()} | {:ok, VRChat.Model.Error.t()} | {:error, Tesla.Env.t()}
Get Invite Message
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! Message type refers to a different collection of messages, used during different types of responses. message
= Message during a normal invite response
= Message when replying to a message request
= Message when requesting an invite requestResponse
= Message when replying to a request for invite
Parameters
connection
(VRChat.Connection): Connection to serveruser_id
(String.t): Must be a valid user ID.message_type
(InviteMessageType): The type of message to fetch, must be a valid InviteMessageType.slot
(integer()): The message slot to fetch of a given message type.opts
(keyword): Optional parameters
Returns
{:ok, VRChat.Model.InviteMessage.t}
on success{:error, Tesla.Env.t}
on failure
@spec get_invite_messages( Tesla.Env.client(), String.t(), VRChat.Model.InviteMessageType.t(), keyword() ) :: {:ok, VRChat.Model.Error.t()} | {:ok, [VRChat.Model.InviteMessage.t()]} | {:error, Tesla.Env.t()}
List Invite Messages
Returns a list of all the users Invite Messages. Admin Credentials are required to view messages of other users! Message type refers to a different collection of messages, used during different types of responses. message
= Message during a normal invite response
= Message when replying to a message request
= Message when requesting an invite requestResponse
= Message when replying to a request for invite
Parameters
connection
(VRChat.Connection): Connection to serveruser_id
(String.t): Must be a valid user ID.message_type
(InviteMessageType): The type of message to fetch, must be a valid InviteMessageType.opts
(keyword): Optional parameters
Returns
{:ok, [%InviteMessage{}, ...]}
on success{:error, Tesla.Env.t}
on failure
@spec invite_myself_to(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, VRChat.Model.SentNotification.t()} | {:ok, VRChat.Model.Error.t()} | {:error, Tesla.Env.t()}
Invite Myself To Instance Sends self an invite to an instance
Parameters
connection
(VRChat.Connection): Connection to serverworld_id
(String.t): Must be a valid world ID.instance_id
(String.t): Must be a valid instance ID.opts
(keyword): Optional parameters
Returns
{:ok, VRChat.Model.SentNotification.t}
on success{:error, Tesla.Env.t}
on failure
@spec invite_user( Tesla.Env.client(), String.t(), VRChat.Model.InviteRequest.t(), keyword() ) :: {:ok, VRChat.Model.SentNotification.t()} | {:ok, VRChat.Model.Error.t()} | {:error, Tesla.Env.t()}
Invite User
Sends an invite to a user. Returns the Notification of type invite
that was sent.
Parameters
connection
(VRChat.Connection): Connection to serveruser_id
(String.t): Must be a valid user ID.invite_request
(InviteRequest): Slot number of the Invite Message to use when inviting a user.opts
(keyword): Optional parameters
Returns
{:ok, VRChat.Model.SentNotification.t}
on success{:error, Tesla.Env.t}
on failure
@spec invite_user_with_photo( Tesla.Env.client(), String.t(), String.t(), VRChat.Model.InviteRequest.t(), keyword() ) :: {:ok, VRChat.Model.SentNotification.t()} | {:ok, VRChat.Model.Error.t()} | {:error, Tesla.Env.t()}
Invite User with photo
Sends an photo invite to a user. Returns the Notification of type invite
that was sent.
Parameters
connection
(VRChat.Connection): Connection to serveruser_id
(String.t): Must be a valid user ID.image
(String.t): The binary blob of the png file.data
(VRChat.Model.InviteRequest.t):opts
(keyword): Optional parameters
Returns
{:ok, VRChat.Model.SentNotification.t}
on success{:error, Tesla.Env.t}
on failure
@spec request_invite(Tesla.Env.client(), String.t(), keyword()) :: {:ok, VRChat.Model.Notification.t()} | {:ok, VRChat.Model.Error.t()} | {:error, Tesla.Env.t()}
Request Invite
Requests an invite from a user. Returns the Notification of type requestInvite
that was sent.
Parameters
connection
(VRChat.Connection): Connection to serveruser_id
(String.t): Must be a valid user ID.opts
(keyword): Optional parameters:body
(RequestInviteRequest): Slot number of the Request Message to use when request an invite.
Returns
{:ok, VRChat.Model.Notification.t}
on success{:error, Tesla.Env.t}
on failure
@spec request_invite_with_photo( Tesla.Env.client(), String.t(), String.t(), VRChat.Model.RequestInviteRequest.t(), keyword() ) :: {:ok, VRChat.Model.Notification.t()} | {:ok, VRChat.Model.Error.t()} | {:error, Tesla.Env.t()}
Request Invite with photo
Requests with photo an invite from a user. Returns the Notification of type requestInvite
that was sent.
Parameters
connection
(VRChat.Connection): Connection to serveruser_id
(String.t): Must be a valid user ID.image
(String.t): The binary blob of the png file.data
(VRChat.Model.RequestInviteRequest.t):opts
(keyword): Optional parameters
Returns
{:ok, VRChat.Model.Notification.t}
on success{:error, Tesla.Env.t}
on failure
@spec reset_invite_message( Tesla.Env.client(), String.t(), VRChat.Model.InviteMessageType.t(), integer(), keyword() ) :: {:ok, VRChat.Model.Error.t()} | {:ok, [VRChat.Model.InviteMessage.t()]} | {:error, Tesla.Env.t()}
Reset Invite Message
Resets a single Invite Message back to its 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, so it is not possible to reset within the 60 minutes countdown. Resetting it does however 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". Message type refers to a different collection of messages, used during different types of responses. message
= Message during a normal invite response
= Message when replying to a message request
= Message when requesting an invite requestResponse
= Message when replying to a request for invite The DELETE endpoint does not have/require any request body.
Parameters
connection
(VRChat.Connection): Connection to serveruser_id
(String.t): Must be a valid user ID.message_type
(InviteMessageType): The type of message to fetch, must be a valid InviteMessageType.slot
(integer()): The message slot to fetch of a given message type.opts
(keyword): Optional parameters
Returns
{:ok, [%InviteMessage{}, ...]}
on success{:error, Tesla.Env.t}
on failure
@spec respond_invite( Tesla.Env.client(), String.t(), VRChat.Model.InviteResponse.t(), keyword() ) :: {:ok, VRChat.Model.Notification.t()} | {:ok, VRChat.Model.Error.t()} | {:error, Tesla.Env.t()}
Respond Invite
Respond to an invite or invite request without accepting it. :notificationId
is the ID of the requesting notification. In case the notification being replied to is an invite, the responseSlot
refers to a response message from the the message
collection. In case the notification is an invite request, it will refer to one from the requestResponse
collection instead.
Parameters
connection
(VRChat.Connection): Connection to servernotification_id
(String.t): Must be a valid notification ID.invite_response
(InviteResponse): Slot number of the Response Message to use when responding to a user.opts
(keyword): Optional parameters
Returns
{:ok, VRChat.Model.Notification.t}
on success{:error, Tesla.Env.t}
on failure
@spec respond_invite_with_photo( Tesla.Env.client(), String.t(), String.t(), VRChat.Model.InviteResponse.t(), keyword() ) :: {:ok, VRChat.Model.Notification.t()} | {:ok, VRChat.Model.Error.t()} | {:error, Tesla.Env.t()}
Respond Invite with photo
Respond with photo to an invite or invite request without accepting it. :notificationId
is the ID of the requesting notification. In case the notification being replied to is an invite, the responseSlot
refers to a response message from the the message
collection. In case the notification is an invite request, it will refer to one from the requestResponse
collection instead.'
Parameters
connection
(VRChat.Connection): Connection to servernotification_id
(String.t): Must be a valid notification ID.image
(String.t): The binary blob of the png file.data
(VRChat.Model.InviteResponse.t):opts
(keyword): Optional parameters
Returns
{:ok, VRChat.Model.Notification.t}
on success{:error, Tesla.Env.t}
on failure
@spec update_invite_message( Tesla.Env.client(), String.t(), VRChat.Model.InviteMessageType.t(), integer(), keyword() ) :: {:ok, VRChat.Model.Error.t()} | {:ok, [VRChat.Model.InviteMessage.t()]} | {:error, Tesla.Env.t()}
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". Message type refers to a different collection of messages, used during different types of responses. message
= Message during a normal invite response
= Message when replying to a message request
= Message when requesting an invite requestResponse
= Message when replying to a request for invite
Parameters
connection
(VRChat.Connection): Connection to serveruser_id
(String.t): Must be a valid user ID.message_type
(InviteMessageType): The type of message to fetch, must be a valid InviteMessageType.slot
(integer()): The message slot to fetch of a given message type.opts
(keyword): Optional parameters:body
(UpdateInviteMessageRequest): Message of what to set the invite message to.
Returns
{:ok, [%InviteMessage{}, ...]}
on success{:error, Tesla.Env.t}
on failure