class ImageObject.Builder


Builder for ImageObject.

Summary

Public constructors

Builder(copyFrom: ImageObject)

Copy constructor.

Builder(namespace: String, id: String)

Constructor for an empty Builder.

Public functions

T
addAlternateName(alternateName: String)

Adds an alias for the item.

Self
addKeyword(keyword: Keyword)

Appends the Keyword.

Self

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

Self

Appends all the values.

T
addPotentialAction(newPotentialAction: PotentialAction)

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

ImageObject

Builds a Thing object.

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
setImage(image: String?)

Sets the URL for an image of the item.

T
setName(name: String?)

Sets the name of the item.

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

Sets a list of potential actions for this document.

Self
setSha256(text: String?)

Sets the sha256.

Self

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

T
setUrl(url: String?)

Sets the deeplink URL of the item.

Public constructors

Builder

Added in 1.1.0-alpha06
Builder(copyFrom: ImageObject)

Copy constructor.

Builder

Added in 1.1.0-alpha06
Builder(namespace: String, id: String)

Constructor for an empty Builder.

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.1.0-alpha06
fun addAlternateName(alternateName: String): T

Adds an alias for the item.

addKeyword

Added in 1.1.0-alpha06
fun addKeyword(keyword: Keyword): Self

Appends the Keyword.

addKeyword

Added in 1.1.0-alpha06
fun addKeyword(text: String): Self

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

addKeywords

Added in 1.1.0-alpha06
fun addKeywords(values: (Mutable)Iterable<Keyword!>): Self

Appends all the values.

addPotentialAction

Added in 1.1.0-alpha06
fun addPotentialAction(newPotentialAction: PotentialAction): T

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

build

Added in 1.1.0-alpha06
fun build(): ImageObject

Builds a Thing object.

build

Added in 1.1.0-alpha06
fun build(): Thing

Builds a Thing object.

clearAlternateNames

Added in 1.1.0-alpha06
fun clearAlternateNames(): T

Clears the aliases, if any, for the item.

clearPotentialActions

Added in 1.1.0-alpha06
fun clearPotentialActions(): T

Clear all the potential actions for this document.

setAlternateNames

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

Sets a list of aliases for the item.

setCreationTimestampMillis

Added in 1.1.0-alpha06
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.1.0-alpha06
fun setDescription(description: String?): T

Sets the description for the item.

setDocumentScore

Added in 1.1.0-alpha06
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.1.0-alpha06
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.1.0-alpha06
fun setImage(image: String?): T

Sets the URL for an image of the item.

setName

Added in 1.1.0-alpha06
fun setName(name: String?): T

Sets the name of the item.

setPotentialActions

Added in 1.1.0-alpha06
fun setPotentialActions(
    newPotentialActions: (Mutable)List<PotentialAction!>?
): T

Sets a list of potential actions for this document.

setSha256

Added in 1.1.0-alpha06
fun setSha256(text: String?): Self

Sets the sha256.

setThumbnailSha256

Added in 1.1.0-alpha06
fun setThumbnailSha256(text: String?): Self

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

setUrl

Added in 1.1.0-alpha06
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 properties

mAlternateNames

protected val mAlternateNames: (Mutable)List<String!>!

mCreationTimestampMillis

protected val mCreationTimestampMillisLong

mDescription

protected val mDescriptionString!

mDocumentScore

protected val mDocumentScoreInt

mDocumentTtlMillis

protected val mDocumentTtlMillisLong

mId

protected val mIdString!

mImage

protected val mImageString!

mKeywords

protected val mKeywords: (Mutable)List<Keyword!>

mName

protected val mNameString!

mNamespace

protected val mNamespaceString!

mPotentialActions

protected val mPotentialActions: (Mutable)List<PotentialAction!>!

mSha256

protected val mSha256String?

mThumbnailSha256

protected val mThumbnailSha256String?

mUrl

protected val mUrlString!