ImageObject.BuilderBase

Artifact: androidx.appsearch:appsearch-builtin-types

View Source

Added in 1.2.0-alpha02

---

Kotlin |Java

@ExperimentalAppSearchApi
class ImageObject.BuilderBase<T : ImageObject.BuilderBase<T!>?> : Thing.BuilderBase

kotlin.Any
↳	androidx.appsearch.builtintypes.Thing.BuilderBase
	↳	androidx.appsearch.builtintypes.ImageObject.BuilderBase

Known direct subclasses

ImageObject.Builder

ImageObject.Builder

Builder for ImageObject.

---

Summary

Public constructors
BuilderBase(copyFrom: ImageObject) Constructor for ImageObject.BuilderBase with all the existing values.
BuilderBase(namespace: String, id: String) Constructor for ImageObject.BuilderBase.

Public functions
T	addKeyword(keyword: Keyword) Appends the Keyword.
T	addKeyword(text: String) Appends the Keyword as a Text i.e. String.
T	addKeywords(values: (Mutable)Iterable<Keyword!>) Appends all the values.
ImageObject	build() Builds a Thing object.
T	setBytes(bytes: ByteArray<Byte>?) Sets the byte representation of this image or video.
T	setSha256(text: String?) Sets the sha256.
T	setThumbnailSha256(text: String?) Sets the sha256 of the thumbnail of this image of video.

Inherited functions

From androidx.appsearch.builtintypes.Thing.BuilderBase T addAlternateName(alternateName: String) Adds an alias for the item. T @ExperimentalAppSearchApi addPotentialAction(newPotentialAction: PotentialAction) Add a new action to the list of potential actions for this document. T clearAlternateNames() Clears the aliases, if any, for the item. T @ExperimentalAppSearchApi clearPotentialActions() Clear all the potential actions for this document. Unit resetIfBuilt() If built, make a copy of previous data for every field so that the builder can be reused. 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 @ExperimentalAppSearchApi setImage(image: String?) Sets the URL for an image of the item. T setName(name: String?) Sets the name of the item. T @ExperimentalAppSearchApi setPotentialActions(     newPotentialActions: (Mutable)List<PotentialAction!>? ) Sets a list of potential actions for this document. T setUrl(url: String?) Sets the deeplink URL of the item.

Public constructors

BuilderBase

Added in 1.2.0-alpha02

BuilderBase(copyFrom: ImageObject)

Constructor for ImageObject.BuilderBase with all the existing values.

Parameters
copyFrom: ImageObject	The existing ImageObject to copy values from.

BuilderBase

BuilderBase(namespace: String, id: String)

Constructor for ImageObject.BuilderBase.

Parameters
namespace: String	Namespace for the Document. See Document.Namespace.
id: String	Unique identifier for the Document. See Document.Id.

Public functions

addKeyword

Added in 1.2.0-alpha02

fun addKeyword(keyword: Keyword): T

Appends the Keyword.

addKeyword

Added in 1.2.0-alpha02

fun addKeyword(text: String): T

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

addKeywords

Added in 1.2.0-alpha02

fun addKeywords(values: (Mutable)Iterable<Keyword!>): T

Appends all the values.

build

fun build(): ImageObject

Builds a Thing object.

setBytes

Added in 1.2.0-alpha02

fun setBytes(bytes: ByteArray<Byte>?): T

Sets the byte representation of this image or video.

setSha256

Added in 1.2.0-alpha02

fun setSha256(text: String?): T

Sets the sha256.

setThumbnailSha256

Added in 1.2.0-alpha02

fun setThumbnailSha256(text: String?): T

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