SelectionBuilder

Artifact: androidx.slice:slice-builders

View Source

Added in 1.1.0-alpha02

---

Kotlin |Java

@RequiresApi(value = 19)
class 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 functions
SelectionBuilder!	addOption(optionKey: String!, optionText: CharSequence!) Adds an option to this SelectionBuilder.
SelectionBuilder!	setContentDescription(contentDescription: CharSequence?) Sets the content description.
SelectionBuilder!	setInputAction(inputAction: PendingIntent) Sets the PendingIntent to send when the selection is made or changed.
SelectionBuilder!	setInputAction(inputAction: RemoteCallback) Sets the RemoteCallback to send when the selection is made or changed.
SelectionBuilder!	setLayoutDirection(layoutDirection: Int) Sets the layout direction.
SelectionBuilder!	setPrimaryAction(primaryAction: SliceAction) Sets the primary action for the selection slice.
SelectionBuilder!	setSelectedOption(selectedOption: String!) Sets which option is selected by default.
SelectionBuilder!	setSubtitle(subtitle: CharSequence?) Sets the subtitle.
SelectionBuilder!	setTitle(title: CharSequence?) Sets the title.

Public constructors

SelectionBuilder

Added in 1.1.0-alpha02

SelectionBuilder()

Creates a SelectionBuilder with no options.

Public functions

addOption

Added in 1.1.0-alpha02

fun addOption(optionKey: String!, optionText: CharSequence!): SelectionBuilder!

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

Added in 1.1.0-alpha02

fun setContentDescription(contentDescription: CharSequence?): SelectionBuilder!

Sets the content description.

Parameters
contentDescription: CharSequence?	the content description

Returns
SelectionBuilder!	this SelectionBuilder

setInputAction

Added in 1.1.0-alpha02

fun setInputAction(inputAction: PendingIntent): SelectionBuilder!

Sets the PendingIntent to send when the selection is made or changed. The intent will include an extra with the key 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

setInputAction

Added in 1.1.0-alpha02

fun setInputAction(inputAction: RemoteCallback): SelectionBuilder!

Sets the RemoteCallback to send when the selection is made or changed. The intent will include an extra with the key 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

setLayoutDirection

Added in 1.1.0-alpha02

fun setLayoutDirection(layoutDirection: Int): SelectionBuilder!

Sets the layout direction.

Parameters
layoutDirection: Int	the layout direction

Returns
SelectionBuilder!	this SelectionBuilder

setPrimaryAction

Added in 1.1.0-alpha02

fun setPrimaryAction(primaryAction: SliceAction): SelectionBuilder!

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

Added in 1.1.0-alpha02

fun setSelectedOption(selectedOption: String!): SelectionBuilder!

Sets which option is selected by default.

Parameters
selectedOption: String!	the key of the selected option

Returns
SelectionBuilder!	this SelectionBuilder

setSubtitle

Added in 1.1.0-alpha02

fun setSubtitle(subtitle: CharSequence?): SelectionBuilder!

Sets the subtitle.

Parameters
subtitle: CharSequence?	the subtitle

Returns
SelectionBuilder!	this SelectionBuilder

setTitle

Added in 1.1.0-alpha02

fun setTitle(title: CharSequence?): SelectionBuilder!

Sets the title.

Parameters
title: CharSequence?	the title

Returns
SelectionBuilder!	this SelectionBuilder