WebPage.Builder

Builder(webpage: WebPage)

Constructs WebPage.Builder from existing values in given WebPage.

Builder(namespace: String, id: String)

Constructs WebPage.Builder with given namespace and id

fun addAlternateName(alternateName: String): T

Adds an alias for the item.

@ExperimentalAppSearchApi
fun addPotentialAction(newPotentialAction: PotentialAction): T

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

fun build(): WebPage

Builds the WebPage.

fun build(): Thing

Builds a Thing object.

fun clearAlternateNames(): T

Clears the aliases, if any, for the item.

@ExperimentalAppSearchApi
fun clearPotentialActions(): T

Clear all the potential actions for this document.

fun setAlternateNames(alternateNames: (Mutable)List<String!>?): T

Sets a list of aliases for the item.

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.

fun setDescription(description: String?): T

Sets the description for the item.

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.

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.

fun setFavicon(favicon: ImageObject?): Self

Returns a favicon that represents the web page.

@ExperimentalAppSearchApi
fun setImage(image: String?): T

Sets the URL for an image of the item.

fun setName(name: String?): T

Sets the name of the item.

@ExperimentalAppSearchApi
fun setPotentialActions(
    newPotentialActions: (Mutable)List<PotentialAction!>?
): T

Sets a list of potential actions for this document.

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.