@Document.BuilderProducer
public final class Thing.Builder

Builder for Thing.

Summary

Protected fields
List<String>
long
String
int
long
final String
String
String
final String
List<PotentialAction>
String

Public constructors

Constructs Thing.Builder from existing values in given Thing.
Builder(@NonNull String namespace, @NonNull String id)

Constructs Thing.Builder with given namespace and id

Public methods
@NonNull T

Adds an alias for the item.
@NonNull T

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

Builds a Thing object.
@NonNull T

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

Clear all the potential actions for this document.
@NonNull T

Sets a list of aliases for the item.
@NonNull T
setCreationTimestampMillis(long creationTimestampMillis)

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

Sets the description for the item.
@NonNull T
setDocumentScore(int documentScore)

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

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

Sets the URL for an image of the item.
@NonNull T

Sets the name of the item.
@NonNull T

Sets a list of potential actions for this document.
@NonNull T

Sets the deeplink URL of the item.

Protected fields

mAlternateNames

protected List<String> mAlternateNames

mCreationTimestampMillis

protected long mCreationTimestampMillis

mDescription

protected String mDescription

mDocumentScore

protected int mDocumentScore

mDocumentTtlMillis

protected long mDocumentTtlMillis

mId

protected final String mId

mImage

protected String mImage

mName

protected String mName

mNamespace

protected final String mNamespace

mPotentialActions

protected List<PotentialAction> mPotentialActions

mUrl

protected String mUrl

Public constructors

Builder

Added in 1.1.0-alpha06
public Builder(@NonNull Thing thing)

Constructs Thing.Builder from existing values in given Thing.

Builder

Added in 1.1.0-alpha06
public Builder(@NonNull String namespace, @NonNull String id)

Constructs Thing.Builder with given namespace and id

Public methods

addAlternateName

Added in 1.1.0-alpha06
public @NonNull T addAlternateName(@NonNull String alternateName)

Adds an alias for the item.

addPotentialAction

Added in 1.1.0-alpha06
public @NonNull T addPotentialAction(@NonNull PotentialAction newPotentialAction)

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

build

Added in 1.1.0-alpha06
public @NonNull Thing build()

Builds a Thing object.

clearAlternateNames

Added in 1.1.0-alpha06
public @NonNull T clearAlternateNames()

Clears the aliases, if any, for the item.

clearPotentialActions

Added in 1.1.0-alpha06
public @NonNull T clearPotentialActions()

Clear all the potential actions for this document.

setAlternateNames

Added in 1.1.0-alpha06
public @NonNull T setAlternateNames(@Nullable List<String> alternateNames)

Sets a list of aliases for the item.

setCreationTimestampMillis

Added in 1.1.0-alpha06
public @NonNull T setCreationTimestampMillis(long creationTimestampMillis)

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.1.0-alpha06
public @NonNull T setDescription(@Nullable String description)

Sets the description for the item.

setDocumentScore

Added in 1.1.0-alpha06
public @NonNull T setDocumentScore(int documentScore)

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.1.0-alpha06
public @NonNull T setDocumentTtlMillis(long documentTtlMillis)

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.1.0-alpha06
public @NonNull T setImage(@Nullable String image)

Sets the URL for an image of the item.

setName

Added in 1.1.0-alpha06
public @NonNull T setName(@Nullable String name)

Sets the name of the item.

setPotentialActions

Added in 1.1.0-alpha06
public @NonNull T setPotentialActions(@Nullable List<PotentialAction> newPotentialActions)

Sets a list of potential actions for this document.

setUrl

Added in 1.1.0-alpha06
public @NonNull T setUrl(@Nullable String url)

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.