API reference

ApplicationInvite Interface

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 User.presenceLobbySessionId and User.presenceMatchSessionId from the inviter's viewer context.

Signature

interface ApplicationInvite

Properties

destination : Destination? [Get]	The destination to which the recipient is invited. Signature abstract val destination: Destination?
id : String [Get]	The ID of the application invite. Signature abstract val id: String
isActive : Boolean? [Get]	A boolean value indicating whether the invite is still active or not. Signature abstract val isActive: Boolean?
lobbySessionId : String? [Get]	The lobby session id to which the recipient is invited. You can retrieve this by calling User.presenceLobbySessionId from the inviter's viewer context. Signature abstract val lobbySessionId: String?
matchSessionId : String? [Get]	The match session id to which the recipient is invited. You can retrieve this by calling User.presenceMatchSessionId from the inviter's viewer context. Signature abstract val matchSessionId: String?
recipient : User? [Get]	The recipient's user information, such as their ID and alias. You can get the ID of an user by calling User.id. Signature abstract val recipient: User?