Organization.BuilderBase


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


Builder for Organization.

Summary

Public constructors

BuilderBase(organization: Organization)

Constructor for Organization.BuilderBase with all the existing values.

BuilderBase(namespace: String, id: String)

Constructor for Organization.BuilderBase.

Public functions

Organization

Builds a Thing object.

T

Sets the logo of the organization.

Inherited functions

From androidx.appsearch.builtintypes.Thing.BuilderBase
T
addAlternateName(alternateName: String)

Adds an alias for the item.

T

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

T

Clears the aliases, if any, for the item.

T

Clear all the potential actions for this document.

Unit

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

Sets the URL for an image of the item.

T
setName(name: String?)

Sets the name of the item.

T

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(organization: Organization)

Constructor for Organization.BuilderBase with all the existing values.

Parameters
organization: Organization

The existing Organization to copy values from.

BuilderBase

BuilderBase(namespace: String, id: String)

Constructor for Organization.BuilderBase.

Parameters
namespace: String

Namespace for the Document. See Document.Namespace.

id: String

The unique identifier for the Document.

Public functions

build

fun build(): Organization

Builds a Thing object.

setLogo

Added in 1.2.0-alpha02
fun setLogo(logo: ImageObject?): T

Sets the logo of the organization.