WebPage.BuilderBase

Artifact: androidx.appsearch:appsearch-builtin-types

Kotlin |Java

@ExperimentalAppSearchApi
public class WebPage.BuilderBase<T extends WebPage.BuilderBase<T>> extends Thing.BuilderBase

java.lang.Object
↳	androidx.appsearch.builtintypes.Thing.BuilderBase
	↳	androidx.appsearch.builtintypes.WebPage.BuilderBase

Known direct subclasses

WebPage.Builder

WebPage.Builder

Builder for WebPage.

Summary

Public constructors
`BuilderBase(@NonNull WebPage webPage)` Constructor for `WebPage.BuilderBase` with all the existing values.
`BuilderBase(@NonNull String namespace, @NonNull String id)` Constructor for `WebPage.BuilderBase`.

Public methods
`@NonNull WebPage`	`build()` Builds the `WebPage`.
`@NonNull T`	`setFavicon(@Nullable ImageObject favicon)` Sets the favicon that represents the web page.
`@NonNull T`	`@ExperimentalAppSearchApi setSource(@Nullable String type)` Sets the source of how the web page was accessed in CamelCase.

Inherited methods

From androidx.appsearch.builtintypes.Thing.BuilderBase

`@NonNull T`	`addAlternateName(@NonNull String alternateName)` Adds an alias for the item.
`@NonNull T`	`@ExperimentalAppSearchApi addPotentialAction(@NonNull PotentialAction newPotentialAction)` Add a new action to the list of potential actions for this document.
`@NonNull T`	`clearAlternateNames()` Clears the aliases, if any, for the item.
`@NonNull T`	`@ExperimentalAppSearchApi clearPotentialActions()` Clear all the potential actions for this document.
`void`	`resetIfBuilt()` If built, make a copy of previous data for every field so that the builder can be reused.
`@NonNull T`	`setAlternateNames(@Nullable List<String> alternateNames)` 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`	`setDescription(@Nullable String description)` 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`	`@ExperimentalAppSearchApi setImage(@Nullable String image)` Sets the URL for an image of the item.
`@NonNull T`	`setName(@Nullable String name)` Sets the name of the item.
`@NonNull T`	`@ExperimentalAppSearchApi setPotentialActions(@Nullable List<PotentialAction> newPotentialActions)` Sets a list of potential actions for this document.
`@NonNull T`	`setUrl(@Nullable String url)` Sets the deeplink URL of the item.

Public constructors

BuilderBase

Added in 1.2.0-alpha02

public BuilderBase(@NonNull WebPage webPage)

Constructor for WebPage.BuilderBase with all the existing values.

Parameters
`@NonNull WebPage webPage`	The existing `WebPage` to copy values from.

BuilderBase

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

Constructor for WebPage.BuilderBase.

Parameters
`@NonNull String namespace`	Namespace for the Document. See `Document.Namespace`.
`@NonNull String id`	Unique identifier for the Document. See `Document.Id`.

Public methods

build

public @NonNull WebPage build()

Builds the WebPage.

setFavicon

Added in 1.2.0-alpha02

public @NonNull T setFavicon(@Nullable ImageObject favicon)

Sets the favicon that represents the web page.

setSource

Added in 1.2.0-alpha02

@ExperimentalAppSearchApi
public @NonNull T setSource(@Nullable String type)

Sets the source of how the web page was accessed in CamelCase. (e.g. Tab, CustomTab)