API reference

RosterOptions Interface

The roster option, to be passed into 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.

Signature

interface RosterOptions

Properties

suggestedUsers : List
[Get]
Passing in these users will add them to the invitable users list. From the GroupPresence.launchRosterPanel, 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(): RosterOptions.Builder
Returns
RosterOptions.Builder

Inner Interface

Builder Interface

Signature

interface Builder

Methods

build ()
Signature
abstract fun build(): RosterOptions
Returns
RosterOptions
withSuggestedUsers ( suggestedUsers )
Signature
abstract fun withSuggestedUsers(suggestedUsers: List<String>): RosterOptions.Builder
Parameters
suggestedUsers: List
Returns
RosterOptions.Builder