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

horizon.platform.grouppresence

Updated: Jul 24, 2025

Package-level declarations

Types

NameSummary
class GroupPresence
The Group Presence API currently supports immersive apps and is designed to update the platform with a user’s current Destination::GetApiName() and status, including whether they are ovr_GroupPresenceOptions_SetIsJoinable(), their ovr_GroupPresenceOptions_SetLobbySessionId(), and ovr_GroupPresenceOptions_SetMatchSessionId(). This allows a user’s location to be displayed both in VR and outside of it on social platforms, and highlights popular destinations in your app. "Joinable" indicates that a user is in an area of your app that supports other users interacting with them. Note These APIs are currently supported only for immersive mode. For non-immersive apps, such as regular Android-based panel apps or 2D experiences, this functionality is not yet supported.
class GroupPresenceException(requestName: String, msg: Message) : Exception
data class GroupPresenceJSON(var deeplinkMessageOverride: String = "", var destinationApiName: String = "", var isJoinable: Boolean? = null, var lobbySessionId: String = "", var matchSessionId: String = "")
data class GroupPresenceOptions(var deeplinkMessageOverride: String, var destinationApiName: String, var isJoinable: Boolean, var lobbySessionId: String, var matchSessionId: String)
The Group Presence Option, to be passed in to horizon.platform.group_presence.GroupPresence.set, is a set of fields that allows developers to specify the presence of a user in a group/squad/party. It provides a way for developers to create a more immersive and social experience for their users by allowing them to join and interact with other users.
interface InviteOptions
The Invite Option, to be passed in to GroupPresence.get_invitable_users() and GroupPresence.launch_invite_panel(), is a field that allows developers to specify a list of suggested users to be added to the invitable users list, making it easier for users to connect with others and create a more social experience.
interface UserArray
Did you find this page helpful?
Thumbs up icon
Thumbs down icon