androidx.slice.builders

Kotlin |Java

Classes

CellBuilderDsl	Helper class annotated with @SliceMarker, which is annotated with @DslMarker.
GridRowBuilder	Builder to construct a grid row which may be added as a row to `ListBuilder`.
GridRowBuilderDsl	Helper class annotated with @SliceMarker, which is annotated with @DslMarker.
HeaderBuilderDsl	Helper class annotated with @SliceMarker, which is annotated with @DslMarker.
InputRangeBuilderDsl	Helper class annotated with @SliceMarker, which is annotated with @DslMarker.
ListBuilder	Builder for constructing slices composed of rows of content.
ListBuilderDsl	Helper class annotated with @SliceMarker, which is annotated with @DslMarker.
RangeBuilderDsl	Helper class annotated with @SliceMarker, which is annotated with @DslMarker.
RowBuilderDsl	Helper class annotated with @SliceMarker, which is annotated with @DslMarker.
SelectionBuilder	Builder to construct a selection which can be added to a `ListBuilder`.
SliceAction	Class representing an action, supports tappable icons, custom toggle icons, and default toggles, as well as date and time pickers.
TemplateSliceBuilder	Base class of builders of various template types.

Annotations

SliceMarker

Top-level functions summary

Slice	`list(context: Context, uri: Uri, ttl: Long, addRows: ListBuilderDsl.() -> Unit)` Reduces verbosity required to build a Slice in Kotlin.
SliceAction	`tapSliceAction(pendingIntent: PendingIntent, icon: IconCompat, imageMode: Int = ICON_IMAGE, title: CharSequence)` Factory method to build a tappable SliceAction.
SliceAction	`toggleSliceAction(pendingIntent: PendingIntent, icon: IconCompat? = null, title: CharSequence, isChecked: Boolean)` Factory method to build a toggleable SliceAction.

Extension functions summary

For GridRowBuilderDsl
GridRowBuilder	`GridRowBuilderDsl.cell(buildCell: CellBuilderDsl.() -> Unit)`
GridRowBuilder	`GridRowBuilderDsl.seeMoreCell(buildCell: CellBuilderDsl.() -> Unit)`

For ListBuilderDsl
ListBuilder	`ListBuilderDsl.gridRow(buildGrid: GridRowBuilderDsl.() -> Unit)`
ListBuilder	`ListBuilderDsl.header(buildHeader: HeaderBuilderDsl.() -> Unit)`
ListBuilder	`ListBuilderDsl.inputRange(buildInputRange: InputRangeBuilderDsl.() -> Unit)`
ListBuilder	`ListBuilderDsl.range(buildRange: RangeBuilderDsl.() -> Unit)`
ListBuilder	`ListBuilderDsl.row(buildRow: RowBuilderDsl.() -> Unit)`
ListBuilder	`ListBuilderDsl.seeMoreRow(buildRow: RowBuilderDsl.() -> Unit)`

Top-level functions

list

inline fun list(
    context: Context, 
    uri: Uri, 
    ttl: Long, 
    addRows: ListBuilderDsl.() -> Unit
): Slice

Reduces verbosity required to build a Slice in Kotlin. Usage example:

See Also

ListBuilder.build

tapSliceAction

fun tapSliceAction(
    pendingIntent: PendingIntent, 
    icon: IconCompat, 
    imageMode: Int = ICON_IMAGE, 
    title: CharSequence
): SliceAction

Factory method to build a tappable SliceAction.

toggleSliceAction

fun toggleSliceAction(
    pendingIntent: PendingIntent, 
    icon: IconCompat? = null, 
    title: CharSequence, 
    isChecked: Boolean
): SliceAction

Factory method to build a toggleable SliceAction.

Extension functions

cell

inline fun GridRowBuilderDsl.cell(buildCell: CellBuilderDsl.() -> Unit): GridRowBuilder

See Also

GridRowBuilder.addCell

gridRow

inline fun ListBuilderDsl.gridRow(buildGrid: GridRowBuilderDsl.() -> Unit): ListBuilder

See Also

ListBuilder.addGridRow

inline fun ListBuilderDsl.header(buildHeader: HeaderBuilderDsl.() -> Unit): ListBuilder

See Also

ListBuilder.setHeader

inputRange

inline fun ListBuilderDsl.inputRange(buildInputRange: InputRangeBuilderDsl.() -> Unit): ListBuilder

See Also

ListBuilder.addInputRange

range

inline fun ListBuilderDsl.range(buildRange: RangeBuilderDsl.() -> Unit): ListBuilder

See Also

ListBuilder.addRange

row

inline fun ListBuilderDsl.row(buildRow: RowBuilderDsl.() -> Unit): ListBuilder

See Also

ListBuilder.addRow

seeMoreCell

inline fun GridRowBuilderDsl.seeMoreCell(buildCell: CellBuilderDsl.() -> Unit): GridRowBuilder

See Also

GridRowBuilder.setSeeMoreCell

seeMoreRow

inline fun ListBuilderDsl.seeMoreRow(