The Group Presence Option, to be passed in to 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.

Signature

interface GroupPresenceOptions

Properties

deeplinkMessageOverride : String [Get]	Use GroupPresenceOptions.lobbySessionId or GroupPresenceOptions.matchSessionId to specify the session. Use the deeplink message override for any additional data in whatever format you wish to aid in bringing users together. If not specified, the deeplink_message for the user will default to the one on the destination. Signature abstract val deeplinkMessageOverride: String
destinationApiName : String [Get]	This the unique API Name that refers to an in-app destination Signature abstract val destinationApiName: String
isJoinable : Boolean [Get]	Set whether or not the person is shown as joinable or not to others. A user that is joinable can invite others to join them. Set this to false if other users would not be able to join this user. For example: the current session is full, or only the host can invite others and the current user is not the host. Signature abstract val isJoinable: Boolean
lobbySessionId : String [Get]	This is a session that represents a closer group/squad/party of users. It is expected that all users with the same lobby session id can see or hear each other. Users with the same lobby session id in their group presence will show up in the roster and will show up as "Recently Played With" for future invites if they aren't already Oculus friends. This must be set in addition to is_joinable being true for a user to use invites. Signature abstract val lobbySessionId: String
matchSessionId : String [Get]	This is a session that represents all the users that are playing a specific instance of a map, game mode, round, etc. This can include users from multiple different lobbies that joined together and the users may or may not remain together after the match is over. Users with the same match session id in their group presence will not show up in the Roster, but will show up as "Recently Played with" for future invites. Signature abstract val matchSessionId: String

Companion Object

Companion Object Functions

builder ()

Signature

fun builder(): GroupPresenceOptions.Builder

Returns

                GroupPresenceOptions.Builder
            

Inner Interface

Builder Interface

Signature

interface Builder

Functions

build ()	Signature abstract fun build(): GroupPresenceOptions Returns GroupPresenceOptions
withDeeplinkMessageOverride ( deeplinkMessageOverride )	Signature abstract fun withDeeplinkMessageOverride(deeplinkMessageOverride: String): GroupPresenceOptions.Builder Parameters deeplinkMessageOverride: String Returns GroupPresenceOptions.Builder
withDestinationApiName ( destinationApiName )	Signature abstract fun withDestinationApiName(destinationApiName: String): GroupPresenceOptions.Builder Parameters destinationApiName: String Returns GroupPresenceOptions.Builder
withIsJoinable ( isJoinable )	Signature abstract fun withIsJoinable(isJoinable: Boolean): GroupPresenceOptions.Builder Parameters isJoinable: Boolean Returns GroupPresenceOptions.Builder
withLobbySessionId ( lobbySessionId )	Signature abstract fun withLobbySessionId(lobbySessionId: String): GroupPresenceOptions.Builder Parameters lobbySessionId: String Returns GroupPresenceOptions.Builder
withMatchSessionId ( matchSessionId )	Signature abstract fun withMatchSessionId(matchSessionId: String): GroupPresenceOptions.Builder Parameters matchSessionId: String Returns GroupPresenceOptions.Builder