ImageObject.Builder

public Builder(@NonNull ImageObject copyFrom)

Copy constructor.

public Builder(@NonNull String namespace, @NonNull String id)

Constructor for an empty Builder.

public @NonNull T addAlternateName(@NonNull String alternateName)

Adds an alias for the item.

public @NonNull Self addKeyword(@NonNull Keyword keyword)

Appends the Keyword.

public @NonNull Self addKeyword(@NonNull String text)

Appends the Keyword as a Text i.e. String.

public @NonNull Self addKeywords(@NonNull Iterable<Keyword> values)

Appends all the values.

@ExperimentalAppSearchApi
public @NonNull T addPotentialAction(@NonNull PotentialAction newPotentialAction)

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

public @NonNull ImageObject build()

Builds a Thing object.

public @NonNull Thing build()

Builds a Thing object.

public @NonNull T clearAlternateNames()

Clears the aliases, if any, for the item.

@ExperimentalAppSearchApi
public @NonNull T clearPotentialActions()

Clear all the potential actions for this document.

public @NonNull T setAlternateNames(@Nullable List<String> alternateNames)

Sets a list of aliases for the item.

public @NonNull Self setBytes(@Nullable byte[] bytes)

Sets the byte representation of this image or video.

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.

public @NonNull T setDescription(@Nullable String description)

Sets the description for the item.

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.

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.

@ExperimentalAppSearchApi
public @NonNull T setImage(@Nullable String image)

Sets the URL for an image of the item.

public @NonNull T setName(@Nullable String name)

Sets the name of the item.

@ExperimentalAppSearchApi
public @NonNull T setPotentialActions(@Nullable List<PotentialAction> newPotentialActions)

Sets a list of potential actions for this document.

public @NonNull Self setSha256(@Nullable String text)

Sets the sha256.

public @NonNull Self setThumbnailSha256(@Nullable String text)

Sets the sha256 of the thumbnail of this image of video.

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.