Thing

Artifact: androidx.appsearch:appsearch-builtin-types

View Source

Added in 1.1.0-rc01

---

Kotlin |Java

@Document(name = "builtin:Thing")
public class Thing

Known direct subclasses

AlarmInstance, Alarm, ContactPoint, ImageObject, MobileApplication, Person, StopwatchLap, Stopwatch, Timer, WebPage

AlarmInstance	AppSearch document representing an AlarmInstance entity.
Alarm	AppSearch document representing an Alarm entity.
ContactPoint	A group of contact information corresponding to a label such as "Home" or "Work".
ImageObject	Represents an image file.
MobileApplication	Represents an installed app to enable searching using names, nicknames, and package names.
Person	AppSearch document representing a Person entity modeled after Person.
StopwatchLap	An AppSearch document representing a StopwatchLap entity.
Stopwatch	An AppSearch document representing a Stopwatch entity.
Timer	AppSearch document representing a Timer entity.
WebPage	AppSearch document representing a WebPage entity.

---

AppSearch document representing a Thing, the most generic type of an item.

Summary

Nested types
@Document.BuilderProducer public final class Thing.Builder Builder for Thing.

Public methods
@NonNull List<String>	getAlternateNames() Returns an unmodifiable list of aliases, if any, for this item.
long	getCreationTimestampMillis() Returns the creation timestamp, in milliseconds since Unix epoch, of this item.
@Nullable String	getDescription() Returns a description of this item.
int	getDocumentScore() Returns the intrinsic score (or importance) of this item.
long	getDocumentTtlMillis() Returns the time-to-live timestamp, in milliseconds since getCreationTimestampMillis, for this item.
@NonNull String	getId() Returns the unique identifier for this item.
@Nullable String	@ExperimentalAppSearchApi getImage() Returns the URL for an image of this item.
@Nullable String	getName() Returns the name of this item.
@NonNull String	getNamespace() Returns the namespace (or logical grouping) for this item.
@NonNull List<PotentialAction>	@ExperimentalAppSearchApi getPotentialActions() Returns the actions that can be taken on this object.
@Nullable String	getUrl() Returns the deeplink URL of this item.

Public methods

getAlternateNames

Added in 1.1.0-rc01

public @NonNull List<String> getAlternateNames()

Returns an unmodifiable list of aliases, if any, for this item.

getCreationTimestampMillis

Added in 1.1.0-rc01

public long getCreationTimestampMillis()

Returns the creation timestamp, in milliseconds since Unix epoch, of this item.

getDescription

Added in 1.1.0-rc01

public @Nullable String getDescription()

Returns a description of this item.

getDocumentScore

Added in 1.1.0-rc01

public int getDocumentScore()

Returns the intrinsic score (or importance) of this item.

getDocumentTtlMillis

Added in 1.1.0-rc01

public long getDocumentTtlMillis()

Returns the time-to-live timestamp, in milliseconds since getCreationTimestampMillis, for this item.

getId

Added in 1.1.0-rc01

public @NonNull String getId()

Returns the unique identifier for this item.

getImage

Added in 1.1.0-rc01

@ExperimentalAppSearchApi
public @Nullable String getImage()

Returns the URL for an image of this item.

getName

Added in 1.1.0-rc01

public @Nullable String getName()

Returns the name of this item.

getNamespace

Added in 1.1.0-rc01

public @NonNull String getNamespace()

Returns the namespace (or logical grouping) for this item.

getPotentialActions

Added in 1.1.0-rc01

@ExperimentalAppSearchApi
public @NonNull List<PotentialAction> getPotentialActions()

Returns the actions that can be taken on this object.

getUrl

Added in 1.1.0-rc01

public @Nullable String getUrl()

Returns the deeplink URL of this item.

This item can be opened (or viewed) by creating an ACTION_VIEW intent with this URL as the setData uri.

See also
Intent Structure