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

RosterOptions

Updated: Oct 30, 2025

RosterOptions

interface RosterOptions
The roster option, to be passed into horizon.platform.grouppresence.GroupPresence.launchRosterPanel which is used to launch the panel displaying the current users in the roster/party. You can read more about rosters in our docs.

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.launchRosterPanel, the horizon.platform.users.models.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(): RosterOptions.Builder