ComplicationDataSourceInfo
Note: As of July 10, 2024, watch faces must use the Watch Face Format in order to be installed on new watches that launch with Wear OS 5 pre-installed. Learn more about the user-facing changes in this Help Center article.
Additionally, starting in early 2025 (specific date to be announced during Q4 2024), all new watch faces published on Google Play must use the Watch Face Format.
public final class ComplicationDataSourceInfo
Holder of details of a complication data source, for use by watch faces (for example, to show the current complication data source in settings). A ComplicationDataSourceInfoRetriever can be used to obtain references of this class for each of a watch face's complications.
Summary
Public constructors |
|---|
ComplicationDataSourceInfo( |
Public methods |
|
|---|---|
boolean |
|
final @NonNull String |
The name of the application containing the complication data source. |
final ComponentName |
The complication data source's {@link ComponentName}. |
final @NonNull ComplicationData |
Lazily constructed fallback preview |
final @NonNull Icon |
getIcon()The icon for the complication data source. |
final @NonNull String |
getName()The name of the complication data source. |
final @NonNull ComplicationType |
getType()The type of the complication provided by the data source. |
int |
hashCode() |
@NonNull String |
toString() |
Public constructors
ComplicationDataSourceInfo
public ComplicationDataSourceInfo(
@NonNull String appName,
@NonNull String name,
@NonNull Icon icon,
@NonNull ComplicationType type,
ComponentName componentName
)
Public methods
getAppName
public final @NonNull String getAppName()
The name of the application containing the complication data source.
getComponentName
public final ComponentName getComponentName()
The complication data source's {@link ComponentName}.
This field is populated only on Android R and above and it is null otherwise.
getFallbackPreviewData
public final @NonNull ComplicationData getFallbackPreviewData()
Lazily constructed fallback preview ComplicationData based on this ComplicationDataSourceInfo. This is useful when ComplicationDataSourceInfoRetriever.retrievePreviewComplicationData returns null (e.g. on a pre-android R device).
getIcon
public final @NonNull Icon getIcon()
The icon for the complication data source.
getName
public final @NonNull String getName()
The name of the complication data source.
getType
public final @NonNull ComplicationType getType()
The type of the complication provided by the data source.