API reference

UserOptions Interface

The user_options configuration is used to specify additional settings for the User. It allows you to customize the response by specifying the time window, maximum number of users, and service providers for which linked accounts should be retrieved.

Signature

interface UserOptions

Properties

maxUsers : Long
[Get]
This field specifies the maximum number of User that should be returned in the response.
Signature
abstract val maxUsers: Long
serviceProviders : List
[Get]
It's an array of ServiceProvider objects that specifies the service providers for which linked accounts should be retrieved.
Signature
abstract val serviceProviders: List<ServiceProvider>
timeWindow : TimeWindow
[Get]
This field specifies the time window in seconds for which the linked accounts should be retrieved.
Signature
abstract val timeWindow: TimeWindow

Methods

addServiceProvider ( value )
Signature
abstract fun addServiceProvider(value: ServiceProvider)
Parameters
value: ServiceProvider
clearServiceProviders ()
Signature
abstract fun clearServiceProviders()

Companion Object

Methods

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

Inner Interface

Builder Interface

Signature

interface Builder

Methods

build ()
Signature
abstract fun build(): UserOptions
Returns
UserOptions
withMaxUsers ( maxUsers )
Signature
abstract fun withMaxUsers(maxUsers: Long): UserOptions.Builder
Parameters
maxUsers: Long
Returns
UserOptions.Builder
withServiceProviders ( serviceProviders )
Signature
abstract fun withServiceProviders(serviceProviders: List<ServiceProvider>): UserOptions.Builder
Parameters
serviceProviders: List
Returns
UserOptions.Builder
withTimeWindow ( timeWindow )
Signature
abstract fun withTimeWindow(timeWindow: TimeWindow): UserOptions.Builder
Parameters
timeWindow: TimeWindow
Returns
UserOptions.Builder