ListBuilder

Kotlin |Java

@RequiresApi(value = 19)
public class ListBuilder extends TemplateSliceBuilder

java.lang.Object
↳	androidx.slice.builders.TemplateSliceBuilder
	↳	androidx.slice.builders.ListBuilder

Known direct subclasses

ListBuilderDsl

ListBuilderDsl

Helper class annotated with @SliceMarker, which is annotated with @DslMarker.

Builder for constructing slices composed of rows of content.

A slice is a piece of templated app content that can be presented outside of the app providing the slice in a androidx.slice.widget.SliceView. To provide a slice you should implement a androidx.slice.SliceProvider and use ListBuilder to construct your slice when onBindSlice is called.

ListBuilder allows you to construct a slice made up of rows of content. The row types that ListBuilder supports are:

HeaderBuilder - The first row of your slice should be a header. The header supports a title, subtitle, and tappable row action. A header can also have a summary of the contents of the slice which can be shown when not all of the slice can be displayed.
RowBuilder - A basic row supports title, subtitle, timestamps, and various action types.
GridRowBuilder - A grid row supports cells of vertically laid out content displayed in a single row.
RangeBuilder - A range row supports displaying a horizontal progress indicator.
InputRangeBuilder - An input range row supports displaying a horizontal slider allowing slider input (e.g. brightness or volume slider).
RatingBuilder - An star rating row supports displaying a horizontal star rating input (e.g. rating 4/5 stars)

Handling modes

Slices are meant to be presented outside of the app providing them, the slice presenter could be an Android system surface or another application. The presenter will normally use a androidx.slice.widget.SliceView to display a slice. SliceView supports a couple of different modes. These modes are not controlled by the app providing the slice, but rather by the surface that is presenting the slice. To ensure your slice is presented correctly you should consider the different modes SliceView supports:

MODE_SMALL - Only the first row of content is displayed in small format, normally this will be the header. If no header was set, then the first row will be used and may appear differently depending on the row type and the configuration of androidx.slice.widget.SliceView.
MODE_LARGE - As many rows of content are shown as possible. If the presenter of the slice allows scrolling then all rows of content will be displayed in a scrollable view.
MODE_SHORTCUT - In shortcut mode only a tappable image is displayed. The image and action used to represent this will be the primary action of your slice, i.e. setPrimaryAction.

Specifying actions

In addition to rows of content, ListBuilder can also have SliceActions added to it. These actions may appear differently on your slice depending on how androidx.slice.widget.SliceView is configured. Normally the actions appear as icons in the header of the slice.

How much content to add

There is no limit to the number of rows added to ListBuilder, however, the contents of a slice should be related to a primary task, action, or set of information. For example: it might make sense for a slice to manage wi-fi state to have a row for each available network, this might result in a large number of rows but each of these rows serve utility for the primary purpose of the slice which is managing wi-fi.

Note that scrolling on SliceView can be disabled, in which case only the header and one or two rows of content may be shown for your slice. If your slice contains many rows of content to scroll through (e.g. list of wifi networks), consider using setSeeMoreAction to provide a link to open the activity associated with the content.

See also
`ListBuilder.HeaderBuilder`
`ListBuilder.RowBuilder`
`GridRowBuilder`
`ListBuilder.RangeBuilder`
`ListBuilder.InputRangeBuilder`
`ListBuilder.RatingBuilder`
`SliceAction`
`SliceProvider`
`onBindSlice`
`SliceView`

Summary

Nested types
`public class ListBuilder.HeaderBuilder` Builder to construct a header row.
`public class ListBuilder.InputRangeBuilder` Builder to construct a input range row.
`public class ListBuilder.RangeBuilder` Builder to construct a range row which can be added to a `ListBuilder`.
`public final class ListBuilder.RatingBuilder` Builder to construct a input star rating.
`public class ListBuilder.RowBuilder` Builder to construct a row.

Constants
`static final int`	`ACTION_WITH_LABEL = 6` Indicates that an button should be presented with text.
`static final int`	`ICON_IMAGE = 0` Indicates that an image should be presented as an icon and it can be tinted.
`static final long`	`INFINITY = -1` Constant representing infinity.
`static final int`	`LARGE_IMAGE = 2` Indicates that an image presented in a larger size and it shouldn't be tinted.
`static final int`	`RANGE_MODE_DETERMINATE = 0` Indicates that the progress bar should be presented in determinate mode.
`static final int`	`RANGE_MODE_INDETERMINATE = 1` Indicates that the progress bar should be presented in indeterminate mode.
`static final int`	`RANGE_MODE_STAR_RATING = 2` Indicates that the progress bar should be presented as a star rating.
`static final int`	`RAW_IMAGE_LARGE = 4` Indicates that an image should be presented in its intrinsic size and shouldn't be tinted.
`static final int`	`RAW_IMAGE_SMALL = 3` Indicates that an image should be presented in its intrinsic size and shouldn't be tinted.
`static final int`	`SMALL_IMAGE = 1` Indicates that an image should be presented in a smaller size and it shouldn't be tinted.
`static final int`	`UNKNOWN_IMAGE = 5` Indicates that an image mode is unknown.

Public constructors
`@RequiresApi(value = 26) ListBuilder( @NonNull Context context, @NonNull Uri uri, @Nullable Duration ttl )` Create a ListBuilder for constructing slice content.
`ListBuilder(@NonNull Context context, @NonNull Uri uri, long ttl)` Create a ListBuilder for constructing slice content.

Public methods
`@NonNull ListBuilder`	`addAction(@NonNull SliceAction action)` Adds an action to this list builder.
`@NonNull ListBuilder`	`addGridRow(@NonNull GridRowBuilder builder)` Add a grid row to the list builder.
`@NonNull ListBuilder`	`addInputRange(@NonNull ListBuilder.InputRangeBuilder b)` Add an input range row to the list builder.
`@NonNull ListBuilder`	`addRange(@NonNull ListBuilder.RangeBuilder rangeBuilder)` Add a range row to the list builder.
`@NonNull ListBuilder`	`addRating(@NonNull ListBuilder.RatingBuilder b)` Add an star rating row to the list builder.
`@NonNull ListBuilder`	`addRow(@NonNull ListBuilder.RowBuilder builder)` Add a row to the list builder.
`@NonNull ListBuilder`	`addSelection(@NonNull SelectionBuilder selectionBuilder)` Add a selection row to the list builder.
`@NonNull Slice`	`build()` Construct the slice defined by this ListBuilder.
`@NonNull ListBuilder`	`setAccentColor(@ColorInt int color)` Sets the color to use on tintable items within the list builder.
`@NonNull ListBuilder`	`setHeader(@NonNull ListBuilder.HeaderBuilder builder)` Sets a header for this list builder.
`@NonNull ListBuilder`	`@RequiresApi(value = 21) setHostExtras(@NonNull PersistableBundle extras)` Sets additional information to be passed to the host of the slice.
`@NonNull ListBuilder`	`setIsError(boolean isError)` 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.
`@NonNull ListBuilder`	`setKeywords(@NonNull Set<String> keywords)` Sets keywords to associate with this slice.
`@NonNull ListBuilder`	`setLayoutDirection(int layoutDirection)` Sets the desired layout direction for this slice.
`@NonNull ListBuilder`	`setSeeMoreAction(@NonNull RemoteCallback callback)` If all content in a slice cannot be shown, a "see more" affordance may be displayed where the content is cut off.
`@NonNull ListBuilder`	`setSeeMoreAction(@NonNull PendingIntent intent)` If all content in a slice cannot be shown, a "see more" affordance may be displayed where the content is cut off.
`@NonNull ListBuilder`	`setSeeMoreRow(@NonNull ListBuilder.RowBuilder builder)` If all content in a slice cannot be shown, the row added here may be displayed where the content is cut off.

Parameters
`@NonNull Uri uri`	Uri to tag for this slice.
`@Nullable Duration ttl`	the `Duration` that the content in this slice can live for.

Parameters
`@NonNull Uri uri`	Uri to tag for this slice.
`long ttl`	the length in milliseconds that the content in this slice can live for.

See also
`setPrimaryAction`
`setPrimaryAction`
`setPrimaryAction`
`setPrimaryAction`
`setPrimaryAction`

ListBuilder

Summary

Nested types

Constants

Public constructors

Public methods

Constants

ACTION_WITH_LABEL

ICON_IMAGE

INFINITY

LARGE_IMAGE

RANGE_MODE_DETERMINATE

RANGE_MODE_INDETERMINATE

RANGE_MODE_STAR_RATING

RAW_IMAGE_LARGE

RAW_IMAGE_SMALL

SMALL_IMAGE

UNKNOWN_IMAGE

Public constructors

ListBuilder

ListBuilder

Public methods

addAction

addGridRow

addInputRange

addRange

addRating

addRow

addSelection

build

setAccentColor

setHeader

setHostExtras

setIsError

setKeywords

setLayoutDirection

setSeeMoreAction

setSeeMoreAction

setSeeMoreRow