TilePreviewData
public final class TilePreviewData
Container class storing data required to render previews for methods annotated with Preview.
| See also | |
|---|---|
singleTimelineEntryTileBuilder |
Summary
Public constructors |
|---|
TilePreviewData( |
Public methods |
|
|---|---|
boolean |
|
final @NonNull Function1<@NonNull RequestBuilders.TileRequest, @NonNull TileBuilders.Tile> |
callback that provides the |
final @NonNull Function1<@NonNull RequestBuilders.ResourcesRequest, @NonNull ResourceBuilders.Resources> |
an optional callback that provides a |
final PlatformDataValues |
allows overriding platform data values for any |
int |
hashCode() |
@NonNull String |
toString() |
Public constructors
TilePreviewData
public TilePreviewData(
@NonNull Function1<@NonNull RequestBuilders.ResourcesRequest, @NonNull ResourceBuilders.Resources> onTileResourceRequest,
PlatformDataValues platformDataValues,
@NonNull Function1<@NonNull RequestBuilders.TileRequest, @NonNull TileBuilders.Tile> onTileRequest
)
| Parameters | |
|---|---|
@NonNull Function1<@NonNull RequestBuilders.ResourcesRequest, @NonNull ResourceBuilders.Resources> onTileResourceRequest |
an optional callback that provides a |
PlatformDataValues platformDataValues |
allows overriding platform data values for any |
@NonNull Function1<@NonNull RequestBuilders.TileRequest, @NonNull TileBuilders.Tile> onTileRequest |
callback that provides the |
Public methods
getOnTileRequest
public final @NonNull Function1<@NonNull RequestBuilders.TileRequest, @NonNull TileBuilders.Tile> getOnTileRequest()
callback that provides the TileBuilders.Tile to be previewed. It will be called before rendering the preview.
getOnTileResourceRequest
public final @NonNull Function1<@NonNull RequestBuilders.ResourcesRequest, @NonNull ResourceBuilders.Resources> getOnTileResourceRequest()
an optional callback that provides a Resources. If the layout provided in onTileRequest uses automatic resource registration (either from androidx.wear.protolayout.material3.materialScopeWithResources or other methods from androidx.wear.protolayout.ProtoLayoutScope), this callback will not be needed and, if provided, will be ignored. In other cases, it will be called before rendering the preview of the TileBuilders.Tile. By default, this callback will return resources automatically collected from the rendered tile via androidx.wear.protolayout.ProtoLayoutScope if they exist, or Resources with the version "0" otherwise.
getPlatformDataValues
public final PlatformDataValues getPlatformDataValues()
allows overriding platform data values for any PlatformDataKey. Default platform data values will be set for all platform health sources that have not been overridden.