API reference
API reference
Select your platform
No SDKs available
No versions available

ApplicationInvite

Updated: Aug 26, 2025

ApplicationInvite

interface ApplicationInvite
An Application Invite contains information about the invite, including the application ID, destination, activity status, the lobby session id, the match session id, and recipient’s user id or user alias. If the invite is generated from rich presence, the lobby/match session id will be auto populated by calling horizon.platform.users.models.User.presenceLobbySessionId and horizon.platform.users.models.User.presenceMatchSessionId from the inviter’s viewer context.

Properties

NameSummary
destination
abstract val destination: Destination?
The destination to which the recipient is invited.
id
abstract val id: String
The ID of the application invite.
isActive
abstract val isActive: Boolean?
A boolean value indicating whether the invite is still active or not.
json
open val json: String
lobbySessionId
abstract val lobbySessionId: String?
The lobby session id to which the recipient is invited. You can retrieve this by calling horizon.platform.users.models.User.presenceLobbySessionId from the inviter’s viewer context.
matchSessionId
abstract val matchSessionId: String?
The match session id to which the recipient is invited. You can retrieve this by calling horizon.platform.users.models.User.presenceMatchSessionId from the inviter’s viewer context.
recipient
abstract val recipient: User?
The recipient’s user information, such as their ID and alias. You can get the ID of an user by calling horizon.platform.users.models.User.id.
Did you find this page helpful?
Thumbs up icon
Thumbs down icon