Summary: Ctors | Methods | Inherited Methods

SelectionBuilder

Kotlin |Java

public class SelectionBuilder
extends Object

java.lang.Object
↳	androidx.slice.builders.SelectionBuilder

Builder to construct a selection which can be added to a ListBuilder. A selection presents a list of options to the user and allows the user to select exactly one option.

Summary

Public constructors
`SelectionBuilder()` Creates a SelectionBuilder with no options.

Public methods
`SelectionBuilder`	`addOption(String optionKey, CharSequence optionText)` Adds an option to this SelectionBuilder.
`SelectionBuilder`	`setContentDescription(CharSequence contentDescription)` Sets the content description.
`SelectionBuilder`	`setInputAction(RemoteCallback inputAction)` Sets the `RemoteCallback` to send when the selection is made or changed.
`SelectionBuilder`	`setInputAction(PendingIntent inputAction)` Sets the `PendingIntent` to send when the selection is made or changed.
`SelectionBuilder`	`setLayoutDirection(int layoutDirection)` Sets the layout direction.
`SelectionBuilder`	`setPrimaryAction(SliceAction primaryAction)` Sets the primary action for the selection slice.
`SelectionBuilder`	`setSelectedOption(String selectedOption)` Sets which option is selected by default.
`SelectionBuilder`	`setSubtitle(CharSequence subtitle)` Sets the subtitle.
`SelectionBuilder`	`setTitle(CharSequence title)` Sets the title.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()`
`boolean`	`equals(Object arg0)`
`void`	`finalize()`
`final Class<?>`	`getClass()`
`int`	`hashCode()`
`final void`	`notify()`
`final void`	`notifyAll()`
`String`	`toString()`
`final void`	`wait(long arg0, int arg1)`
`final void`	`wait(long arg0)`
`final void`	`wait()`

Public constructors

SelectionBuilder

public SelectionBuilder ()

Creates a SelectionBuilder with no options.

Public methods

addOption

public SelectionBuilder addOption (String optionKey, 
                CharSequence optionText)

Adds an option to this SelectionBuilder. The new option will be appended to the list of options.

Parameters
`optionKey`	`String`: the key that will be returned if the user selects this option
`optionText`	`CharSequence`: the text that will be displayed to the user for this option

Returns
`SelectionBuilder`	this SelectionBuilder

setContentDescription

public SelectionBuilder setContentDescription (CharSequence contentDescription)

Sets the content description.

Parameters
`contentDescription`	`CharSequence`: the content description

Returns
`SelectionBuilder`	this SelectionBuilder

setInputAction

public SelectionBuilder setInputAction (RemoteCallback inputAction)

Sets the RemoteCallback to send when the selection is made or changed. The intent will include an extra with the key Slice.EXTRA_SELECTION and a String value containing the key of the key of the selected option.

Parameters
`inputAction`	`RemoteCallback`: the intent to send when the user makes or changes the selection

Returns
`SelectionBuilder`	this SelectionBuilder

setInputAction

public SelectionBuilder setInputAction (PendingIntent inputAction)

Sets the PendingIntent to send when the selection is made or changed. The intent will include an extra with the key Slice.EXTRA_SELECTION and a String value containing the key of the key of the selected option.

Parameters
`inputAction`	`PendingIntent`: the intent to send when the user makes or changes the selection

Returns
`SelectionBuilder`	this SelectionBuilder

setLayoutDirection

public SelectionBuilder setLayoutDirection (int layoutDirection)

Sets the layout direction.

Parameters
`layoutDirection`	`int`: the layout direction

Returns
`SelectionBuilder`	this SelectionBuilder

setPrimaryAction

public SelectionBuilder setPrimaryAction (SliceAction primaryAction)

Sets the primary action for the selection slice. The action specified here will be sent when the whole slice is clicked, or when the app presenting the slice is not capable of rendering a selection interface.

Parameters
`primaryAction`	`SliceAction`: the action to trigger when the user clicks the whole slice

Returns
`SelectionBuilder`	this SelectionBuilder

setSelectedOption

public SelectionBuilder setSelectedOption (String selectedOption)

Sets which option is selected by default.

Parameters
`selectedOption`	`String`: the key of the selected option

Returns
`SelectionBuilder`	this SelectionBuilder

setSubtitle

public SelectionBuilder setSubtitle (CharSequence subtitle)

Sets the subtitle.

Parameters
`subtitle`	`CharSequence`: the subtitle

Returns
`SelectionBuilder`	this SelectionBuilder

setTitle

public SelectionBuilder setTitle (CharSequence title)

Sets the title.

Parameters
`title`	`CharSequence`: the title

Returns
`SelectionBuilder`	this SelectionBuilder