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

InviteOptions Interface

The Invite Option, to be passed in to GroupPresence.getInvitableUsers and horizon.platform.grouppresence.GroupPresence.launchInvitePanel, 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.

Signature

interface InviteOptions

Properties

suggestedUsers : List
[Get]
Passing in these users will add them to the invitable users list. From the horizon.platform.grouppresence.GroupPresence.launchInvitePanel, the user can open the invite list, where the suggested users will be added.
Signature 
abstract val suggestedUsers: List<String>

Methods

addSuggestedUser ( value )
Signature 
abstract fun addSuggestedUser(value: String)
Parameters
value: String
clearSuggestedUsers ()
Signature 
abstract fun clearSuggestedUsers()

Companion Object

Methods

builder ()
Signature 
fun builder(): InviteOptions.Builder
Returns
InviteOptions.Builder

Inner Interface

Builder Interface

Signature

interface Builder

Methods

build ()
Signature 
abstract fun build(): InviteOptions
Returns
InviteOptions
withSuggestedUsers ( suggestedUsers )
Signature 
abstract fun withSuggestedUsers(suggestedUsers: List<String>): InviteOptions.Builder
Parameters
suggestedUsers: List
Returns
InviteOptions.Builder
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta