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

InviteOptions

Updated: Oct 30, 2025

InviteOptions

interface InviteOptions
The Invite Option, to be passed in to horizon.platform.grouppresence.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.

Types

NameSummary
interface Builder
Companion
object Companion

Properties

NameSummary
suggestedUsers
abstract val suggestedUsers: List<String>
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.

Functions

NameSummary
addSuggestedUser
abstract fun addSuggestedUser(value: String)
clearSuggestedUsers
abstract fun clearSuggestedUsers()

Companion

object Companion

Functions

NameSummary
builder
fun builder(): InviteOptions.Builder