Quick Invites
Updated: Jul 22, 2024
Quick Invite is a travel API that allows developers to integrate invites into the app experience without needing to show a Meta Quest overlay. This makes it easier for users to connect with one another and have multiplayer experiences in Meta Quest.
Note Users cannot see invites from, or send invites to, users they have blocked.
The Quick Invite API is available once Invite to App has been implemented in an app. The Quick Invite API allows apps to display cross-platform users because the UX is managed by developers.
Age-based feature limitations
When developing your apps, consider the following limitations related to age:
- Child users under 13 (10-12 year olds): Regardless of your app’s self-certification status, child users under 13 cannot access this Platform SDK feature. Implement error-handling for this unsupported feature to maintain a safe and pleasant experience for child users.
Get list of invitable users This method returns a list of users that are invitable, including any users who are offline at the time of the invite. To join after receiving an invite an online user must have their presence set with a destination, lobby session ID, and have joinable set to true.
GroupPresence.GetInvitableUsers(InviteOptions options);
If no error occurs, this method returns a list of invitable user IDs and aliases.
Example response:
{
"data": [
{
"id": "7801349",
"alias": "oculususer"
},
{
"id": "2345678",
"alias": "oculususer2"
}
]
}
The method sends an application invite from the current user to the specified user IDs. A client-side toast will pop up notifying the user that the invite was sent to those people.
GroupPresence.SendInvites(userIDs[]);
If no error occurs, this method returns a list of all the successful invites that were created. Each item in the list contains the invite id paired with its recipient.
Example response:
{
"invites": [
{
"id": "7801349",
"recipient": {
"id": "7292834"
}
}
]
}
This method will return a list of app invites and users that the current user has sent an invite to in the last hour. The current user must have their destination, lobby session ID, and joinable set to true.
GroupPresence.GetSentInvites();
If no error occurs, this method returns a list of invites, invited user ids, and whether there is an active invite for the user and therefore the invite action should be hidden.
Example response:
{
"data": [
{
"destination": {
"api_name": "MY_DEV_API",
"display_name": "Application Name",
"deeplink_message": "deeplink_message_here",
"id": "90000003265"
},
"recipient": {
"id":"914000003306",
"alias": "user_alias"
},
"is_active": true,
"lobby_session_id": "123",
"match_session_id": "ABC",
"id":"914000003300"
}
]
}
