TileBuilders.Tile.Builder

public final class TileBuilders.Tile.Builder


Builder for Tile

Summary

Public constructors

Public methods

@NonNull TileBuilders.Tile

Builds an instance from accumulated values.

@NonNull TileBuilders.Tile.Builder
setFreshnessIntervalMillis(long freshnessIntervalMillis)

Sets how many milliseconds of elapsed time (**not** wall clock time) this tile can be considered to be "fresh".

@NonNull TileBuilders.Tile.Builder
setResourcesVersion(@NonNull String resourcesVersion)

Sets the resource version required for these tiles.

@NonNull TileBuilders.Tile.Builder

Sets androidx.wear.protolayout.StateBuilders.State for this tile.

@NonNull TileBuilders.Tile.Builder

Sets the androidx.wear.protolayout.TimelineBuilders.Timeline containing the layouts for the tiles to show in the carousel, along with their validity periods.

@NonNull TileBuilders.Tile.Builder

This method is deprecated.

Use setTileTimeline instead.

Public constructors

Builder

Added in 1.0.0
public Builder()

Public methods

build

Added in 1.0.0
public @NonNull TileBuilders.Tile build()

Builds an instance from accumulated values.

setFreshnessIntervalMillis

Added in 1.0.0
public @NonNull TileBuilders.Tile.Builder setFreshnessIntervalMillis(long freshnessIntervalMillis)

Sets how many milliseconds of 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#getRequester).

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.

1.0

setResourcesVersion

Added in 1.0.0
public @NonNull TileBuilders.Tile.Builder setResourcesVersion(@NonNull String resourcesVersion)

Sets the resource version required for these tiles. This can be any developer-defined string; it is only used to cache resources, and is passed in if the system does not have a copy of the specified resource version.

1.0

setTileTimeline

Added in 1.2.0
public @NonNull TileBuilders.Tile.Builder setTileTimeline(@NonNull TimelineBuilders.Timeline tileTimeline)

Sets the androidx.wear.protolayout.TimelineBuilders.Timeline containing the layouts for the tiles to show in the carousel, along with their validity periods.

1.0

setTimeline

Added in 1.0.0
Deprecated in 1.2.0
public @NonNull TileBuilders.Tile.Builder setTimeline(@NonNull TimelineBuilders.Timeline timeline)

Sets the androidx.wear.tiles.TimelineBuilders.Timeline containing the layouts for the tiles to show in the carousel, along with their validity periods.

1.0