ListBuilder

const val ACTION_WITH_LABEL = 6: Int

Indicates that an button should be presented with text.

const val ICON_IMAGE = 0: Int

Indicates that an image should be presented as an icon and it can be tinted.

const val INFINITY = -1: Long

Constant representing infinity.

const val LARGE_IMAGE = 2: Int

Indicates that an image presented in a larger size and it shouldn't be tinted.

const val RANGE_MODE_DETERMINATE = 0: Int

Indicates that the progress bar should be presented in determinate mode.

const val RANGE_MODE_INDETERMINATE = 1: Int

Indicates that the progress bar should be presented in indeterminate mode.

const val RANGE_MODE_STAR_RATING = 2: Int

Indicates that the progress bar should be presented as a star rating.

const val RAW_IMAGE_LARGE = 4: Int

Indicates that an image should be presented in its intrinsic size and shouldn't be tinted. If SliceView in the call-site doesn't support RAW_IMAGE, fallback to LARGE_IMAGE instead.

const val RAW_IMAGE_SMALL = 3: Int

Indicates that an image should be presented in its intrinsic size and shouldn't be tinted. If SliceView in the call-site doesn't support RAW_IMAGE, fallback to SMALL_IMAGE instead.

const val SMALL_IMAGE = 1: Int

Indicates that an image should be presented in a smaller size and it shouldn't be tinted.

const val UNKNOWN_IMAGE = 5: Int

Indicates that an image mode is unknown.

@RequiresApi(value = 26)
ListBuilder(context: Context, uri: Uri, ttl: Duration?)

Create a ListBuilder for constructing slice content.

A slice requires an associated time-to-live, i.e. how long the data contained in the slice can remain fresh. If your slice has content that is not time sensitive, set Duration to null and the TTL will be INFINITY.

ListBuilder(context: Context, uri: Uri, ttl: Long)

Create a ListBuilder for constructing slice content.

A slice requires an associated time-to-live, i.e. how long the data contained in the slice can remain fresh. If your slice has content that is not time sensitive, set a TTL of INFINITY.

fun addAction(action: SliceAction): ListBuilder

Adds an action to this list builder.

Actions added with this method are grouped together on the list template and represented as tappable icons or images. These actions may appear differently on the slice depending on how the androidx.slice.widget.SliceView is configured. Generally these actions will be displayed in the order they were added, however, if not all actions can be displayed then actions with a higher priority may be shown first.

These actions are only displayed when the slice is displayed in MODE_LARGE or MODE_SMALL.

These actions differ from a slice's primary action. The primary action is the SliceAction set on the first row of the slice, normally from setPrimaryAction.

fun addGridRow(builder: GridRowBuilder): ListBuilder

Add a grid row to the list builder.

Note that grid rows cannot be the first row in your slice. Adding a grid row first without calling setHeader will result in IllegalStateException when the slice is built.

fun addInputRange(b: ListBuilder.InputRangeBuilder): ListBuilder

Add an input range row to the list builder.

If setValue is not between setMin and setMax, this will throw IllegalArgumentException.

fun addRange(rangeBuilder: ListBuilder.RangeBuilder): ListBuilder

Add a range row to the list builder.

If setValue is not between 0 and setMax, this will throw IllegalArgumentException.

fun addRating(b: ListBuilder.RatingBuilder): ListBuilder

Add an star rating row to the list builder.

If setValue is not between setMin and setMax, this will show all stars as unselected.

fun addRow(builder: ListBuilder.RowBuilder): ListBuilder

Add a row to the list builder.

fun addSelection(selectionBuilder: SelectionBuilder): ListBuilder

Add a selection row to the list builder.

fun build(): Slice

Construct the slice defined by this ListBuilder.

Note that a ListBuilder requires a row containing a piece of text that is not created from a GridRowBuilder. If the first row added does not fulfill this requirement, build the slice will throw IllegalStateException.

Note that a ListBuilder requires a primary action, this can be set on any of the rows added to the list. If a primary action has not been set on any of the rows, building this slice will throw IllegalStateException.

fun setAccentColor(color: @ColorInt Int): ListBuilder

Sets the color to use on tintable items within the list builder. Things that might be tinted are:

• Any SliceActions within your slice.
• UI controls such as android.widget.Switchs or android.widget.SeekBars
• Tinting the MODE_SHORTCUT representation

fun setHeader(builder: ListBuilder.HeaderBuilder): ListBuilder

Sets a header for this list builder. A list can have only one header. Setting a header allows some flexibility in what's displayed in your slice when SliceView displays in MODE_SMALL and MODE_SHORTCUT.

In MODE_SMALL, the header row shown if one has been added. The header will also display the setSummary text if it has been specified, allowing a summary of otherwise hidden content to be shown.

In MODE_SHORTCUT, the primary action set using setPrimaryAction will be used for the shortcut representation.

@RequiresApi(value = 21)
fun setHostExtras(extras: PersistableBundle): ListBuilder

Sets additional information to be passed to the host of the slice.

fun setIsError(isError: Boolean): ListBuilder

Sets whether this slice indicates an error, i.e. the normal contents of this slice are unavailable and instead the slice contains a message indicating an error.

fun setKeywords(keywords: (Mutable)Set<String!>): ListBuilder

Sets keywords to associate with this slice.

fun setLayoutDirection(layoutDirection: Int): ListBuilder

Sets the desired layout direction for this slice.

fun setSeeMoreAction(callback: RemoteCallback): ListBuilder

If all content in a slice cannot be shown, a "see more" affordance may be displayed where the content is cut off. The action added here should take the user to an activity to see all of the content, and will be invoked when the "see more" affordance is tapped.

Only one see more affordance can be added, this throws IllegalStateException if a row or action has been previously added.

fun setSeeMoreAction(intent: PendingIntent): ListBuilder

If all content in a slice cannot be shown, a "see more" affordance may be displayed where the content is cut off. The action added here should take the user to an activity to see all of the content, and will be invoked when the "see more" affordance is tapped.

Only one see more affordance can be added, this throws IllegalStateException if a row or action has been previously added.

fun setSeeMoreRow(builder: ListBuilder.RowBuilder): ListBuilder

If all content in a slice cannot be shown, the row added here may be displayed where the content is cut off. This row should have an affordance to take the user to an activity to see all of the content.

This method should only be used if you want to display a customized row to indicate more content, consider using setSeeMoreAction otherwise. If you do choose to specify a custom row, the row should have a content intent or action end item specified to take the user to an activity to see all of the content. The row added here will only appear when not all content can be displayed and it will not be styled any differently from row built by RowBuilder normally.

Only one see more affordance can be added, this throws IllegalStateException if a row or action has been previously added.