@ExperimentalAppSearchApi
class Thing.BuilderBase<T : Thing.BuilderBase<T!>?>

Known direct subclasses
Known indirect subclasses

Summary

Public constructors

Constructor for Thing.BuilderBase from existing values in given Thing.
BuilderBase(namespace: String, id: String)

Constructor for Thing.BuilderBase.

Public functions
T
addAlternateName(alternateName: String)

Adds an alias for the item.
T

Add a new action to the list of potential actions for this document.
Thing

Builds a Thing object.
T

Clears the aliases, if any, for the item.
T

Clear all the potential actions for this document.
T
setAlternateNames(alternateNames: (Mutable)List<String!>?)

Sets a list of aliases for the item.
T
setCreationTimestampMillis(creationTimestampMillis: Long)

Sets the creation timestamp for the current AppSearch entity, in milliseconds using the currentTimeMillis time base.
T
setDescription(description: String?)

Sets the description for the item.
T
setDocumentScore(documentScore: Int)

Sets the user-provided opaque document score of the current AppSearch document, which can be used for ranking using RANKING_STRATEGY_DOCUMENT_SCORE.
T
setDocumentTtlMillis(documentTtlMillis: Long)

Sets the time-to-live (TTL) for the current AppSearch document as a duration in milliseconds.
T

Sets the URL for an image of the item.
T
setName(name: String?)

Sets the name of the item.
T

Sets a list of potential actions for this document.
T
setUrl(url: String?)

Sets the deeplink URL of the item.

Protected functions
Unit

If built, make a copy of previous data for every field so that the builder can be reused.

Public constructors

BuilderBase

Added in 1.2.0-alpha02
BuilderBase(thing: Thing)

Constructor for Thing.BuilderBase from existing values in given Thing.

Parameters
thing: Thing

The existing Thing to copy values from.

BuilderBase

Added in 1.2.0-alpha02
BuilderBase(namespace: String, id: String)

Constructor for Thing.BuilderBase.

Parameters
namespace: String

Namespace for the Document. See Document.Namespace.
id: String

Unique identifier for the Document. See Document.Id.

Public functions

addAlternateName

Added in 1.2.0-alpha02
fun addAlternateName(alternateName: String): T

Adds an alias for the item.

addPotentialAction

Added in 1.2.0-alpha02
@ExperimentalAppSearchApi
fun addPotentialAction(newPotentialAction: PotentialAction): T

Add a new action to the list of potential actions for this document.

build

Added in 1.2.0-alpha02
fun build(): Thing

Builds a Thing object.

clearAlternateNames

Added in 1.2.0-alpha02
fun clearAlternateNames(): T

Clears the aliases, if any, for the item.

clearPotentialActions

Added in 1.2.0-alpha02
@ExperimentalAppSearchApi
fun clearPotentialActions(): T

Clear all the potential actions for this document.

setAlternateNames

Added in 1.2.0-alpha02
fun setAlternateNames(alternateNames: (Mutable)List<String!>?): T

Sets a list of aliases for the item.

setCreationTimestampMillis

Added in 1.2.0-alpha02
fun setCreationTimestampMillis(creationTimestampMillis: Long): T

Sets the creation timestamp for the current AppSearch entity, in milliseconds using the currentTimeMillis time base.

This timestamp refers to the creation time of the AppSearch entity, not when the document is written into AppSearch.

If not set, then the current timestamp will be used.

See androidx.appsearch.annotation.Document.CreationTimestampMillis for more information on creation timestamp.

setDescription

Added in 1.2.0-alpha02
fun setDescription(description: String?): T

Sets the description for the item.

setDocumentScore

Added in 1.2.0-alpha02
fun setDocumentScore(documentScore: Int): T

Sets the user-provided opaque document score of the current AppSearch document, which can be used for ranking using RANKING_STRATEGY_DOCUMENT_SCORE.

See androidx.appsearch.annotation.Document.Score for more information on score.

setDocumentTtlMillis

Added in 1.2.0-alpha02
fun setDocumentTtlMillis(documentTtlMillis: Long): T

Sets the time-to-live (TTL) for the current AppSearch document as a duration in milliseconds.

The document will be automatically deleted when the TTL expires.

If not set, then the document will never expire.

See androidx.appsearch.annotation.Document.TtlMillis for more information on TTL.

setImage

Added in 1.2.0-alpha02
@ExperimentalAppSearchApi
fun setImage(image: String?): T

Sets the URL for an image of the item.

setName

Added in 1.2.0-alpha02
fun setName(name: String?): T

Sets the name of the item.

setPotentialActions

Added in 1.2.0-alpha02
@ExperimentalAppSearchApi
fun setPotentialActions(
    newPotentialActions: (Mutable)List<PotentialAction!>?
): T

Sets a list of potential actions for this document.

setUrl

Added in 1.2.0-alpha02
fun setUrl(url: String?): T

Sets the deeplink URL of the item.

If this item can be displayed by any system UI surface, or can be read by another Android package, through one of the androidx.appsearch.app.SetSchemaRequest.Builder methods, this url should act as a deeplink into the activity that can open it. Callers should be able to construct an ACTION_VIEW intent with the url as the setData to view the item inside your application.

See Allowing Other Apps to Start Your Activity for more details on how to make activities in your app open for use by other apps by defining intent filters.

Protected functions

resetIfBuilt

Added in 1.2.0-alpha02
protected fun resetIfBuilt(): Unit

If built, make a copy of previous data for every field so that the builder can be reused.