androidx.wear.tiles

Contains androidx.wear.tiles.TileService, which all apps using the Tiles API should extend in order to provide tile data.

Interfaces

ActionBuilders.Action

This interface is deprecated. Deprecated in Java
ActionBuilders.Action.Builder

This interface is deprecated. Deprecated in Java
ActionBuilders.AndroidExtra

This interface is deprecated. Deprecated in Java
ActionBuilders.AndroidExtra.Builder

This interface is deprecated. Deprecated in Java
DimensionBuilders.ContainerDimension

This interface is deprecated. Deprecated in Java
DimensionBuilders.ContainerDimension.Builder

This interface is deprecated. Deprecated in Java
DimensionBuilders.ImageDimension

This interface is deprecated. Deprecated in Java
DimensionBuilders.ImageDimension.Builder

This interface is deprecated. Deprecated in Java
DimensionBuilders.SpacerDimension

This interface is deprecated. Deprecated in Java
DimensionBuilders.SpacerDimension.Builder

This interface is deprecated. Deprecated in Java
LayoutElementBuilders.ArcLayoutElement

This interface is deprecated. Deprecated in Java
LayoutElementBuilders.ArcLayoutElement.Builder

This interface is deprecated. Deprecated in Java
LayoutElementBuilders.LayoutElement

This interface is deprecated. Deprecated in Java
LayoutElementBuilders.LayoutElement.Builder

This interface is deprecated. Deprecated in Java
LayoutElementBuilders.Span

This interface is deprecated. Deprecated in Java
LayoutElementBuilders.Span.Builder

This interface is deprecated. Deprecated in Java
TileUpdateRequester

Interface used for a Tile Service to notify a Tile Renderer that it should fetch a new Timeline from it.

Classes

ActionBuilders

This class is deprecated.

Use androidx.wear.protolayout.ActionBuilders instead.
ActionBuilders.AndroidActivity

This class is deprecated. Deprecated in Java
ActionBuilders.AndroidActivity.Builder

This class is deprecated. Deprecated in Java
ActionBuilders.AndroidBooleanExtra

This class is deprecated. Deprecated in Java
ActionBuilders.AndroidBooleanExtra.Builder

This class is deprecated. Deprecated in Java
ActionBuilders.AndroidDoubleExtra

This class is deprecated. Deprecated in Java
ActionBuilders.AndroidDoubleExtra.Builder

This class is deprecated. Deprecated in Java
ActionBuilders.AndroidIntExtra

This class is deprecated. Deprecated in Java
ActionBuilders.AndroidIntExtra.Builder

This class is deprecated. Deprecated in Java
ActionBuilders.AndroidLongExtra

This class is deprecated. Deprecated in Java
ActionBuilders.AndroidLongExtra.Builder

This class is deprecated. Deprecated in Java
ActionBuilders.AndroidStringExtra

This class is deprecated. Deprecated in Java
ActionBuilders.AndroidStringExtra.Builder

This class is deprecated. Deprecated in Java
ActionBuilders.LaunchAction

This class is deprecated. Deprecated in Java
ActionBuilders.LaunchAction.Builder

This class is deprecated. Deprecated in Java
ActionBuilders.LoadAction

This class is deprecated. Deprecated in Java
ActionBuilders.LoadAction.Builder

This class is deprecated. Deprecated in Java
ActiveTileIdentifier

Tile information containing the tile instance ID and component name for identifying a tile instance.
ColorBuilders

This class is deprecated.

Use androidx.wear.protolayout.ColorBuilders instead.
ColorBuilders.ColorProp

This class is deprecated. Deprecated in Java
ColorBuilders.ColorProp.Builder

This class is deprecated. Deprecated in Java
DeviceParametersBuilders

This class is deprecated.

Use androidx.wear.protolayout.DeviceParametersBuilders instead.
DeviceParametersBuilders.DeviceParameters

This class is deprecated. Deprecated in Java
DeviceParametersBuilders.DeviceParameters.Builder

This class is deprecated. Deprecated in Java
DimensionBuilders

This class is deprecated.

Use androidx.wear.protolayout.DimensionBuilders instead.
DimensionBuilders.DegreesProp

This class is deprecated. Deprecated in Java
DimensionBuilders.DegreesProp.Builder

This class is deprecated. Deprecated in Java
DimensionBuilders.DpProp

This class is deprecated. Deprecated in Java
DimensionBuilders.DpProp.Builder

This class is deprecated. Deprecated in Java
DimensionBuilders.EmProp

This class is deprecated. Deprecated in Java
DimensionBuilders.EmProp.Builder

This class is deprecated. Deprecated in Java
DimensionBuilders.ExpandedDimensionProp

This class is deprecated. Deprecated in Java
DimensionBuilders.ExpandedDimensionProp.Builder

This class is deprecated. Deprecated in Java
DimensionBuilders.ProportionalDimensionProp

This class is deprecated. Deprecated in Java
DimensionBuilders.ProportionalDimensionProp.Builder

This class is deprecated. Deprecated in Java
DimensionBuilders.SpProp

This class is deprecated. Deprecated in Java
DimensionBuilders.SpProp.Builder

This class is deprecated. Deprecated in Java
DimensionBuilders.WrappedDimensionProp

This class is deprecated. Deprecated in Java
DimensionBuilders.WrappedDimensionProp.Builder

This class is deprecated. Deprecated in Java
EventBuilders

Builders for messages used when events happen in the Tiles system.
EventBuilders.TileAddEvent

Event fired when a tile has been added to the carousel.
EventBuilders.TileAddEvent.Builder

Builder for TileAddEvent
EventBuilders.TileEnterEvent

Event fired when a tile is swiped to by the user (i.e. it's visible on screen).
EventBuilders.TileEnterEvent.Builder

Builder for TileEnterEvent
EventBuilders.TileInteractionEvent

Event reported when a user interacts with a tile (e.g. entering or leaving a tile).
EventBuilders.TileInteractionEvent.Builder

Builder for TileInteractionEvent
EventBuilders.TileLeaveEvent

Event fired when a tile is swiped away from by the user (i.e. it's no longer visible on screen).
EventBuilders.TileLeaveEvent.Builder

Builder for TileLeaveEvent
EventBuilders.TileRemoveEvent

Event fired when a tile has been removed from the carousel.
EventBuilders.TileRemoveEvent.Builder

Builder for TileRemoveEvent
LayoutElementBuilders

This class is deprecated.

Use androidx.wear.protolayout.LayoutElementBuilders instead.
LayoutElementBuilders.Arc

This class is deprecated. Deprecated in Java
LayoutElementBuilders.Arc.Builder

This class is deprecated. Deprecated in Java
LayoutElementBuilders.ArcAdapter

This class is deprecated. Deprecated in Java
LayoutElementBuilders.ArcAdapter.Builder

This class is deprecated. Deprecated in Java
LayoutElementBuilders.ArcAnchorTypeProp

This class is deprecated. Deprecated in Java
LayoutElementBuilders.ArcAnchorTypeProp.Builder

This class is deprecated. Deprecated in Java
LayoutElementBuilders.ArcLine

This class is deprecated. Deprecated in Java
LayoutElementBuilders.ArcLine.Builder

This class is deprecated. Deprecated in Java
LayoutElementBuilders.ArcSpacer

This class is deprecated. Deprecated in Java
LayoutElementBuilders.ArcSpacer.Builder

This class is deprecated. Deprecated in Java
LayoutElementBuilders.ArcText

This class is deprecated. Deprecated in Java
LayoutElementBuilders.ArcText.Builder

This class is deprecated. Deprecated in Java
LayoutElementBuilders.Box

This class is deprecated. Deprecated in Java
LayoutElementBuilders.Box.Builder

This class is deprecated. Deprecated in Java
LayoutElementBuilders.ColorFilter

This class is deprecated. Deprecated in Java
LayoutElementBuilders.ColorFilter.Builder

This class is deprecated. Deprecated in Java
LayoutElementBuilders.Column

This class is deprecated. Deprecated in Java
LayoutElementBuilders.Column.Builder

This class is deprecated. Deprecated in Java
LayoutElementBuilders.ContentScaleModeProp

This class is deprecated. Deprecated in Java
LayoutElementBuilders.ContentScaleModeProp.Builder

This class is deprecated. Deprecated in Java
LayoutElementBuilders.FontStyle

This class is deprecated. Deprecated in Java
LayoutElementBuilders.FontStyle.Builder

This class is deprecated. Deprecated in Java
LayoutElementBuilders.FontStyles

This class is deprecated. Deprecated in Java
LayoutElementBuilders.FontVariantProp

This class is deprecated. Deprecated in Java
LayoutElementBuilders.FontVariantProp.Builder

This class is deprecated. Deprecated in Java
LayoutElementBuilders.FontWeightProp

This class is deprecated. Deprecated in Java
LayoutElementBuilders.FontWeightProp.Builder

This class is deprecated. Deprecated in Java
LayoutElementBuilders.HorizontalAlignmentProp

This class is deprecated. Deprecated in Java
LayoutElementBuilders.HorizontalAlignmentProp.Builder

This class is deprecated. Deprecated in Java
LayoutElementBuilders.Image

This class is deprecated. Deprecated in Java
LayoutElementBuilders.Image.Builder

This class is deprecated. Deprecated in Java
LayoutElementBuilders.Layout

This class is deprecated. Deprecated in Java
LayoutElementBuilders.Layout.Builder

This class is deprecated. Deprecated in Java
LayoutElementBuilders.Row

This class is deprecated. Deprecated in Java
LayoutElementBuilders.Row.Builder

This class is deprecated. Deprecated in Java
LayoutElementBuilders.Spacer

This class is deprecated. Deprecated in Java
LayoutElementBuilders.Spacer.Builder

This class is deprecated. Deprecated in Java
LayoutElementBuilders.SpanImage

This class is deprecated. Deprecated in Java
LayoutElementBuilders.SpanImage.Builder

This class is deprecated. Deprecated in Java
LayoutElementBuilders.SpanText

This class is deprecated. Deprecated in Java
LayoutElementBuilders.SpanText.Builder

This class is deprecated. Deprecated in Java
LayoutElementBuilders.SpanVerticalAlignmentProp

This class is deprecated. Deprecated in Java
LayoutElementBuilders.SpanVerticalAlignmentProp.Builder

This class is deprecated. Deprecated in Java
LayoutElementBuilders.Spannable

This class is deprecated. Deprecated in Java
LayoutElementBuilders.Spannable.Builder

This class is deprecated. Deprecated in Java
LayoutElementBuilders.Text

This class is deprecated. Deprecated in Java
LayoutElementBuilders.Text.Builder

This class is deprecated. Deprecated in Java
LayoutElementBuilders.TextAlignmentProp

This class is deprecated. Deprecated in Java
LayoutElementBuilders.TextAlignmentProp.Builder

This class is deprecated. Deprecated in Java
LayoutElementBuilders.TextOverflowProp

This class is deprecated. Deprecated in Java
LayoutElementBuilders.TextOverflowProp.Builder

This class is deprecated. Deprecated in Java
LayoutElementBuilders.VerticalAlignmentProp

This class is deprecated. Deprecated in Java
LayoutElementBuilders.VerticalAlignmentProp.Builder

This class is deprecated. Deprecated in Java
Material3TileService

Base class for a service providing data for an app's tile that includes ProtoLayoutScope for automatic resource registration and opinionated MaterialScope for Material3 styling of components and layout.
ModifiersBuilders

This class is deprecated.

Use androidx.wear.protolayout.ModifiersBuilders instead.
ModifiersBuilders.ArcModifiers

This class is deprecated. Deprecated in Java
ModifiersBuilders.ArcModifiers.Builder

This class is deprecated. Deprecated in Java
ModifiersBuilders.Background

This class is deprecated. Deprecated in Java
ModifiersBuilders.Background.Builder

This class is deprecated. Deprecated in Java
ModifiersBuilders.Border

This class is deprecated. Deprecated in Java
ModifiersBuilders.Border.Builder

This class is deprecated. Deprecated in Java
ModifiersBuilders.Clickable

This class is deprecated. Deprecated in Java
ModifiersBuilders.Clickable.Builder

This class is deprecated. Deprecated in Java
ModifiersBuilders.Corner

This class is deprecated. Deprecated in Java
ModifiersBuilders.Corner.Builder

This class is deprecated. Deprecated in Java
ModifiersBuilders.ElementMetadata

This class is deprecated. Deprecated in Java
ModifiersBuilders.ElementMetadata.Builder

This class is deprecated. Deprecated in Java
ModifiersBuilders.Modifiers

This class is deprecated. Deprecated in Java
ModifiersBuilders.Modifiers.Builder

This class is deprecated. Deprecated in Java
ModifiersBuilders.Padding

This class is deprecated. Deprecated in Java
ModifiersBuilders.Padding.Builder

This class is deprecated. Deprecated in Java
ModifiersBuilders.Semantics

This class is deprecated. Deprecated in Java
ModifiersBuilders.Semantics.Builder

This class is deprecated. Deprecated in Java
ModifiersBuilders.SpanModifiers

This class is deprecated. Deprecated in Java
ModifiersBuilders.SpanModifiers.Builder

This class is deprecated. Deprecated in Java
RequestBuilders

Builders for request messages used to fetch tiles and resources.
RequestBuilders.ResourcesRequest

Parameters passed to a androidx.wear.tiles.TileBuilders.Tile Service when the renderer is requesting a specific resource version.
RequestBuilders.ResourcesRequest.Builder

Builder for ResourcesRequest
RequestBuilders.TileRequest

Parameters passed to a androidx.wear.tiles.TileBuilders.Tile Service when the renderer is requesting a new version of the tile.
RequestBuilders.TileRequest.Builder

Builder for TileRequest
ResourceBuilders

This class is deprecated.

Use androidx.wear.protolayout.ResourceBuilders instead.
ResourceBuilders.AndroidImageResourceByResId

This class is deprecated. Deprecated in Java
ResourceBuilders.AndroidImageResourceByResId.Builder

This class is deprecated. Deprecated in Java
ResourceBuilders.ImageResource

This class is deprecated. Deprecated in Java
ResourceBuilders.ImageResource.Builder

This class is deprecated. Deprecated in Java
ResourceBuilders.InlineImageResource

This class is deprecated. Deprecated in Java
ResourceBuilders.InlineImageResource.Builder

This class is deprecated. Deprecated in Java
ResourceBuilders.Resources

This class is deprecated. Deprecated in Java
ResourceBuilders.Resources.Builder

This class is deprecated. Deprecated in Java
StateBuilders

This class is deprecated.

Use androidx.wear.protolayout.StateBuilders instead.
StateBuilders.State

This class is deprecated. Deprecated in Java
StateBuilders.State.Builder

This class is deprecated. Deprecated in Java
TileBuilders

Builders for the components of a tile that can be rendered by a tile renderer.
TileBuilders.Tile

A holder for a tile.
TileBuilders.Tile.Builder

Builder for Tile
TileService

Base class for a service providing data for an app tile.
TimelineBuilders

This class is deprecated.

Use androidx.wear.protolayout.TimelineBuilders instead.
TimelineBuilders.TimeInterval

This class is deprecated. Deprecated in Java
TimelineBuilders.TimeInterval.Builder

This class is deprecated. Deprecated in Java
TimelineBuilders.Timeline

This class is deprecated. Deprecated in Java
TimelineBuilders.Timeline.Builder

This class is deprecated. Deprecated in Java
TimelineBuilders.TimelineEntry

This class is deprecated. Deprecated in Java
TimelineBuilders.TimelineEntry.Builder

This class is deprecated. Deprecated in Java
TypeBuilders

This class is deprecated.

Use androidx.wear.protolayout.TypeBuilders instead.
TypeBuilders.BoolProp

This class is deprecated. Deprecated in Java
TypeBuilders.BoolProp.Builder

This class is deprecated. Deprecated in Java
TypeBuilders.FloatProp

This class is deprecated. Deprecated in Java
TypeBuilders.FloatProp.Builder

This class is deprecated. Deprecated in Java
TypeBuilders.Int32Prop

This class is deprecated. Deprecated in Java
TypeBuilders.Int32Prop.Builder

This class is deprecated. Deprecated in Java
TypeBuilders.StringProp

This class is deprecated. Deprecated in Java
TypeBuilders.StringProp.Builder

This class is deprecated. Deprecated in Java

Annotations

TilesExperimental

Denotes that this API surface is experimental.

Top-level functions summary

TileBuilders.Tile
tile(
    timeline: TimelineBuilders.Timeline,
    freshness: Duration?,
    @RequiresSchemaVersion(major = 1, minor = 200) state: StateBuilders.State?,
    resourcesVersion: String?
)

Creates a tile from the defined parameters and layout components defined in the Timeline that can be rendered by a tile renderer.
TimelineBuilders.TimeInterval
timeInterval(start: Duration, end: Duration)

Creates a time interval, typically used to describe the validity period of a TimelineEntry.
TimelineBuilders.Timeline

Creates a Timeline as a collection of TimelineEntry items.
TimelineBuilders.TimelineEntry

Creates one piece of renderable content along with the time that it is valid for.

Top-level functions

tile

fun tile(
    timeline: TimelineBuilders.Timeline,
    freshness: Duration? = null,
    @RequiresSchemaVersion(major = 1, minor = 200) state: StateBuilders.State? = null,
    resourcesVersion: String? = null
): TileBuilders.Tile

Creates a tile from the defined parameters and layout components defined in the Timeline that can be rendered by a tile renderer.

Example of usage to create a tile from the given LayoutElement for 1 entry: tile(timeline = timeline(timelineEntry(tileLayout()))). For more Kotlin friendly support and automatic, more performant resources handling, see Material3TileService.

Parameters
timeline: TimelineBuilders.Timeline

The Timeline containing the layouts for the tiles to show in the carousel, along with their validity periods.
freshness: Duration? = null

How many elapsed time (not wall clock time) this tile can be considered to be "fresh". The platform will attempt to refresh your tile at some point in the future after this interval has lapsed. A value of 0 here signifies that auto-refreshes should not be used (i.e. you will manually request updates via TileService.getUpdater. This mechanism should not be used to update your tile more frequently than once a minute, and the system may throttle your updates if you request updates faster than this interval. This interval is also inexact; the system will generally update your tile if it is on-screen, or about to be on-screen, although this is not guaranteed due to system-level optimizations. Negative values will be ignored and considered as 0.
@RequiresSchemaVersion(major = 1, minor = 200) state: StateBuilders.State? = null

The State for this tile
resourcesVersion: String? = null

The resource version for tile's resources used for caching the resources in system. When using better resources handling via androidx.wear.protolayout.ProtoLayoutScope this can be omitted.

timeInterval

fun timeInterval(start: Duration, end: Duration): TimelineBuilders.TimeInterval

Creates a time interval, typically used to describe the validity period of a TimelineEntry.

Parameters
start: Duration

The starting point of the time interval, since the Unix epoch
end: Duration

The end point of the time interval, since the Unix epoch

timeline

fun timeline(vararg entries: TimelineBuilders.TimelineEntry): TimelineBuilders.Timeline

Creates a Timeline as a collection of TimelineEntry items.

TimelineEntry items can be used to update a tile layout on-screen at known times, without having to explicitly update a layout. This allows for cases where, say, a calendar can be used to show the next event, and automatically switch to showing the next event when one has passed.

The active TimelineEntry is switched, at most, once a minute. In the case where the validity periods of TimelineEntry items overlap, the item with the shortest* validity period will be shown. This allows a layout provider to show a "default" layout, and override it at set points without having to explicitly insert the default layout between the "override" layout.

Parameters
vararg entries: TimelineBuilders.TimelineEntry

The list of one or more TimelineEntry. If your tile only has 1 TimelineEntry, cleaner helper method to use instead of this one is Timeline.fromLayoutElement where LayoutElement can be passed in directly.

timelineEntry

fun timelineEntry(
    layout: LayoutElementBuilders.LayoutElement,
    validity: TimelineBuilders.TimeInterval? = null
): TimelineBuilders.TimelineEntry

Creates one piece of renderable content along with the time that it is valid for.

Parameters
layout: LayoutElementBuilders.LayoutElement

The contents of this timeline entry, root LayoutElement of tile
validity: TimelineBuilders.TimeInterval? = null

The validity period for this timeline entry. If not set, this entry doesn't expire.