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

FOvrApplicationInvite Struct

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 field FOvrUser::PresenceLobbySessionId and field FOvrUser::PresenceMatchSessionId from the inviter's viewer context.

Constructors

FOvrApplicationInvite ()
This is the default constructor for the struct, which initializes the ::ovrApplicationInviteHandle and TOvrMessageHandlePtr to their default values.
Signature
FOvrApplicationInvite::FOvrApplicationInvite()
FOvrApplicationInvite ( OvrHandle , MessageHandlePtr )
Copying values from an OVR handle to the array, and the originating message to prevent the handle from being freed.
Signature
FOvrApplicationInvite::FOvrApplicationInvite(ovrApplicationInviteHandle OvrHandle, TOvrMessageHandlePtr MessageHandlePtr)
Parameters
OvrHandle: ovrApplicationInviteHandle
MessageHandlePtr: TOvrMessageHandlePtr

Fields

Destination : FOvrDestination
The destination to which the recipient is invited.
Signature
FOvrDestination FOvrApplicationInvite::Destination
ID : FOvrId
The ID of the application invite.
Signature
FOvrId FOvrApplicationInvite::ID
IsActive : bool
A boolean value indicating whether the invite is still active or not.
Signature
bool FOvrApplicationInvite::IsActive
LobbySessionId : FString
The lobby session id to which the recipient is invited. You can retrieve this by calling field FOvrUser::PresenceLobbySessionId from the inviter's viewer context.
Signature
FString FOvrApplicationInvite::LobbySessionId
MatchSessionId : FString
The match session id to which the recipient is invited. You can retrieve this by calling field FOvrUser::PresenceMatchSessionId from the inviter's viewer context.
Signature
FString FOvrApplicationInvite::MatchSessionId
Recipient : FOvrUser
The recipient's user information, such as their ID and alias. You can get the ID of an user by calling field FOvrUser::ID.
Signature
FOvrUser FOvrApplicationInvite::Recipient

Member Functions

Clear ()
Setting all values to their defaults, effectively clearing the struct.
Signature
void FOvrApplicationInvite::Clear()
Returns
void
Update ( OvrHandle , MessageHandlePtr )
Updating values from an OVR handle to the array, and the originating message to prevent the handle from being freed.
Signature
void FOvrApplicationInvite::Update(ovrApplicationInviteHandle OvrHandle, TOvrMessageHandlePtr MessageHandlePtr)
Parameters
OvrHandle: ovrApplicationInviteHandle
MessageHandlePtr: TOvrMessageHandlePtr
Returns
void