SportsOrganization.BuilderBase


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

Known indirect subclasses

Builder for SportsOrganization.

Summary

Public constructors

BuilderBase(sportsOrganization: SportsOrganization)

Constructor for SportsOrganization.BuilderBase with all the existing values.

BuilderBase(namespace: String, id: String, sport: String)

Constructor for SportsOrganization.BuilderBase.

Public functions

SportsOrganization

Builds a Thing object.

T
setAccentColor(accentColor: Color?)

Sets the accent color of the sports organization as a Color.

Inherited functions

From androidx.appsearch.builtintypes.Organization.BuilderBase
T

Sets the logo of the organization.

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.

Thing

Builds a Thing object.

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(sportsOrganization: SportsOrganization)

Constructor for SportsOrganization.BuilderBase with all the existing values.

Parameters
sportsOrganization: SportsOrganization

The existing SportsOrganization to copy values from.

BuilderBase

Added in 1.2.0-alpha02
BuilderBase(namespace: String, id: String, sport: String)

Constructor for SportsOrganization.BuilderBase.

Parameters
namespace: String

Namespace for the Document. See Document.Namespace.

id: String

The unique identifier for the Document.

sport: String

The sport of the sports organization.

Public functions

build

fun build(): SportsOrganization

Builds a Thing object.

setAccentColor

Added in 1.2.0-alpha02
fun setAccentColor(accentColor: Color?): T

Sets the accent color of the sports organization as a Color.

Parameters
accentColor: Color?

The accent color of the sports organization.