Thing

Artifact: androidx.appsearch:appsearch-builtin-types

View Source

Added in 1.1.0-alpha07

---

Kotlin |Java

@Document(name = "builtin:Thing")
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 class Thing.Builder Builder for Thing.

Public functions
(Mutable)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.
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.
String	getId() Returns the unique identifier for this item.
String?	@ExperimentalAppSearchApi getImage() Returns the URL for an image of this item.
String?	getName() Returns the name of this item.
String	getNamespace() Returns the namespace (or logical grouping) for this item.
(Mutable)List<PotentialAction!>	@ExperimentalAppSearchApi getPotentialActions() Returns the actions that can be taken on this object.
String?	getUrl() Returns the deeplink URL of this item.

Public functions

getAlternateNames

Added in 1.1.0-alpha07

fun getAlternateNames(): (Mutable)List<String!>

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

getCreationTimestampMillis

Added in 1.1.0-alpha07

fun getCreationTimestampMillis(): Long

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

getDescription

Added in 1.1.0-alpha07

fun getDescription(): String?

Returns a description of this item.

getDocumentScore

Added in 1.1.0-alpha07

fun getDocumentScore(): Int

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

getDocumentTtlMillis

Added in 1.1.0-alpha07

fun getDocumentTtlMillis(): Long

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

getId

Added in 1.1.0-alpha07

fun getId(): String

Returns the unique identifier for this item.

getImage

Added in 1.1.0-alpha07

@ExperimentalAppSearchApi
fun getImage(): String?

Returns the URL for an image of this item.

getName

Added in 1.1.0-alpha07

fun getName(): String?

Returns the name of this item.

getNamespace

Added in 1.1.0-alpha07

fun getNamespace(): String

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

getPotentialActions

Added in 1.1.0-alpha07

@ExperimentalAppSearchApi
fun getPotentialActions(): (Mutable)List<PotentialAction!>

Returns the actions that can be taken on this object.

getUrl

Added in 1.1.0-alpha07

fun getUrl(): String?

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