|
| 1 | +# Invite |
| 2 | + |
| 3 | +## Invite User |
| 4 | +Sends an invite to a user. Returns the Notification of type `invite` that was sent. |
| 5 | + |
| 6 | +> Missing coverage. |
| 7 | +## Invite User with photo |
| 8 | +Sends an photo invite to a user. Returns the Notification of type `invite` that was sent. |
| 9 | + |
| 10 | +> Missing coverage. |
| 11 | +## Invite Myself To Instance |
| 12 | +Sends self an invite to an instance |
| 13 | + |
| 14 | +* [inviteMyselfTo](./invitemyselfto.md) |
| 15 | +## Request Invite |
| 16 | +Requests an invite from a user. Returns the Notification of type `requestInvite` that was sent. |
| 17 | + |
| 18 | +> Missing coverage. |
| 19 | +## Request Invite with photo |
| 20 | +Requests with photo an invite from a user. Returns the Notification of type `requestInvite` that was sent. |
| 21 | + |
| 22 | +> Missing coverage. |
| 23 | +## Respond Invite |
| 24 | +Respond to an invite or invite request without accepting it. `:notificationId` is the ID of the requesting notification. |
| 25 | + |
| 26 | +In case the notification being replied to is an invite, the `responseSlot` refers to a response message from the the `message` collection. |
| 27 | +In case the notification is an invite request, it will refer to one from the `requestResponse` collection instead. |
| 28 | + |
| 29 | +> Missing coverage. |
| 30 | +## Respond Invite with photo |
| 31 | +Respond with photo to an invite or invite request without accepting it. `:notificationId` is the ID of the requesting notification. |
| 32 | + |
| 33 | +In case the notification being replied to is an invite, the `responseSlot` refers to a response message from the the `message` collection. |
| 34 | +In case the notification is an invite request, it will refer to one from the `requestResponse` collection instead.' |
| 35 | + |
| 36 | +> Missing coverage. |
| 37 | +## List Invite Messages |
| 38 | +Returns a list of all the users Invite Messages. Admin Credentials are required to view messages of other users! |
| 39 | + |
| 40 | +Message type refers to a different collection of messages, used during different types of responses. |
| 41 | + |
| 42 | +* `message` = Message during a normal invite |
| 43 | +* `response` = Message when replying to a message |
| 44 | +* `request` = Message when requesting an invite |
| 45 | +* `requestResponse` = Message when replying to a request for invite |
| 46 | + |
| 47 | +* [getInviteMessages](./getinvitemessages.md) |
| 48 | +## Reset Invite Message |
| 49 | +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! |
| 50 | + |
| 51 | +Resetting a message respects the rate-limit, so it is not possible to reset within the 60 minutes countdown. |
| 52 | +Resetting it does however not set the rate-limit to 60 like when editing it. |
| 53 | +It is possible to edit it right after resetting it. |
| 54 | +Trying to edit a message before the cooldown timer expires results in a 429 "Too Fast Error". |
| 55 | + |
| 56 | +Message type refers to a different collection of messages, used during different types of responses. |
| 57 | + |
| 58 | +* `message` = Message during a normal invite |
| 59 | +* `response` = Message when replying to a message |
| 60 | +* `request` = Message when requesting an invite |
| 61 | +* `requestResponse` = Message when replying to a request for invite |
| 62 | + |
| 63 | +The DELETE endpoint does not have/require any request body. |
| 64 | + |
| 65 | +* [resetInviteMessage message slot 0 reset](./resetinvitemessage-message-slot-0-reset.md) |
| 66 | +* [resetInviteMessage message slot 0 reset rate limited](./resetinvitemessage-message-slot-0-reset-rate-limited.md) |
| 67 | +## Get Invite Message |
| 68 | +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! |
| 69 | + |
| 70 | +Message type refers to a different collection of messages, used during different types of responses. |
| 71 | + |
| 72 | +* `message` = Message during a normal invite |
| 73 | +* `response` = Message when replying to a message |
| 74 | +* `request` = Message when requesting an invite |
| 75 | +* `requestResponse` = Message when replying to a request for invite |
| 76 | + |
| 77 | +* [getInviteMessage](./getinvitemessage.md) |
| 78 | +## Update Invite Message |
| 79 | +Updates a single Invite Message and then returns a list of all of them. Admin Credentials are required to update messages of other users! |
| 80 | + |
| 81 | +Updating a message automatically sets the cooldown timer to 60 minutes. |
| 82 | +Trying to edit a message before the cooldown timer expires results in a 429 "Too Fast Error". |
| 83 | + |
| 84 | +Message type refers to a different collection of messages, used during different types of responses. |
| 85 | + |
| 86 | +* `message` = Message during a normal invite |
| 87 | +* `response` = Message when replying to a message |
| 88 | +* `request` = Message when requesting an invite |
| 89 | +* `requestResponse` = Message when replying to a request for invite |
| 90 | + |
| 91 | +* [updateInviteMessage message slot 0 update](./updateinvitemessage-message-slot-0-update.md) |
| 92 | +* [updateInviteMessage message slot 0 update rate limited](./updateinvitemessage-message-slot-0-update-rate-limited.md) |
| 93 | + |
0 commit comments