SportsTeam.BuilderBase

Artifact: androidx.appsearch:appsearch-builtin-types

Kotlin |Java

@ExperimentalAppSearchApi
public class SportsTeam.BuilderBase<T extends SportsTeam.BuilderBase<T>> extends SportsOrganization.BuilderBase

java.lang.Object
↳	androidx.appsearch.builtintypes.Thing.BuilderBase
	↳	androidx.appsearch.builtintypes.Organization.BuilderBase
		↳	androidx.appsearch.builtintypes.SportsOrganization.BuilderBase
			↳	androidx.appsearch.builtintypes.SportsTeam.BuilderBase

Known direct subclasses

SportsTeam.Builder

SportsTeam.Builder

Builder for SportsTeam.

Summary

Public constructors
`BuilderBase(@NonNull SportsTeam sportsTeam)` Constructor for `SportsTeam.BuilderBase` with all the existing values.
`BuilderBase( @NonNull String namespace, @NonNull String id, @NonNull String sport )` Constructor for `SportsTeam.BuilderBase`.

Public methods
`@NonNull SportsTeam`	`build()` Builds a `Thing` object.
`@NonNull T`	`setFormattedRecord(@Nullable String formattedRecord)` Sets the formatted record of the sports team. eg: "10 - 5", "10 - 5 (3 - 2)", "10 - 5 (3 - 2) - 1 OT" depending on the sport.
`@NonNull T`	`setLosses(long losses)` Sets the number of losses of the sports team.
`@NonNull T`	`setOvertimeLosses(long overtimeLosses)` Sets the number of overtime losses of the sports team.
`@NonNull T`	`setOvertimeWins(long overtimeWins)` Sets the number of overtime wins of the sports team.
`@NonNull T`	`setTies(long ties)` Sets the number of ties of the sports team.
`@NonNull T`	`setWins(long wins)` Sets the number of wins of the sports team.

Inherited methods

From androidx.appsearch.builtintypes.Organization.BuilderBase

`@NonNull Organization`	`build()` Builds a `Thing` object.
`@NonNull T`	`setLogo(@Nullable ImageObject logo)` Sets the logo of the organization.

From androidx.appsearch.builtintypes.SportsOrganization.BuilderBase

@NonNull T

setAccentColor(@Nullable Color accentColor)

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

From androidx.appsearch.builtintypes.Thing.BuilderBase

`@NonNull T`	`addAlternateName(@NonNull String alternateName)` Adds an alias for the item.
`@NonNull T`	`@ExperimentalAppSearchApi addPotentialAction(@NonNull PotentialAction newPotentialAction)` Add a new action to the list of potential actions for this document.
`@NonNull Thing`	`build()` Builds a `Thing` object.
`@NonNull T`	`clearAlternateNames()` Clears the aliases, if any, for the item.
`@NonNull T`	`@ExperimentalAppSearchApi clearPotentialActions()` Clear all the potential actions for this document.
`void`	`resetIfBuilt()` If built, make a copy of previous data for every field so that the builder can be reused.
`@NonNull T`	`setAlternateNames(@Nullable List<String> alternateNames)` Sets a list of aliases for the item.
`@NonNull T`	`setCreationTimestampMillis(long creationTimestampMillis)` Sets the creation timestamp for the current AppSearch entity, in milliseconds using the `currentTimeMillis` time base.
`@NonNull T`	`setDescription(@Nullable String description)` Sets the description for the item.
`@NonNull T`	`setDocumentScore(int documentScore)` Sets the user-provided opaque document score of the current AppSearch document, which can be used for ranking using `RANKING_STRATEGY_DOCUMENT_SCORE`.
`@NonNull T`	`setDocumentTtlMillis(long documentTtlMillis)` Sets the time-to-live (TTL) for the current AppSearch document as a duration in milliseconds.
`@NonNull T`	`@ExperimentalAppSearchApi setImage(@Nullable String image)` Sets the URL for an image of the item.
`@NonNull T`	`setName(@Nullable String name)` Sets the name of the item.
`@NonNull T`	`@ExperimentalAppSearchApi setPotentialActions(@Nullable List<PotentialAction> newPotentialActions)` Sets a list of potential actions for this document.
`@NonNull T`	`setUrl(@Nullable String url)` Sets the deeplink URL of the item.

Public constructors

BuilderBase

Added in 1.2.0-alpha02

public BuilderBase(@NonNull SportsTeam sportsTeam)

Constructor for SportsTeam.BuilderBase with all the existing values.

Parameters
`@NonNull SportsTeam sportsTeam`	The existing `SportsTeam` to copy values from.

BuilderBase

public BuilderBase(
    @NonNull String namespace,
    @NonNull String id,
    @NonNull String sport
)

Constructor for SportsTeam.BuilderBase.

Parameters
`@NonNull String namespace`	Namespace for the Document. See `Document.Namespace`.
`@NonNull String id`	The unique identifier for the Document.
`@NonNull String sport`	The sport of the sports team.

Public methods

build

public @NonNull SportsTeam build()

Builds a Thing object.

setFormattedRecord

Added in 1.2.0-alpha02

public @NonNull T setFormattedRecord(@Nullable String formattedRecord)

Sets the formatted record of the sports team. eg: "10 - 5", "10 - 5 (3 - 2)", "10 - 5 (3 - 2) - 1 OT" depending on the sport.

Parameters
`@Nullable String formattedRecord`	The formatted record of the sports team.

setLosses

Added in 1.2.0-alpha02

public @NonNull T setLosses(long losses)

Sets the number of losses of the sports team.

Parameters
`long losses`	The number of losses of the sports team.

setOvertimeLosses

Added in 1.2.0-alpha02

public @NonNull T setOvertimeLosses(long overtimeLosses)

Sets the number of overtime losses of the sports team.

Parameters
`long overtimeLosses`	The number of overtime losses of the sports team.

setOvertimeWins

Added in 1.2.0-alpha02

public @NonNull T setOvertimeWins(long overtimeWins)

Sets the number of overtime wins of the sports team.

Parameters
`long overtimeWins`	The number of overtime wins of the sports team.

setTies

Added in 1.2.0-alpha02

public @NonNull T setTies(long ties)

Sets the number of ties of the sports team.

Parameters
`long ties`	The number of ties of the sports team.

setWins

Added in 1.2.0-alpha02

public @NonNull T setWins(long wins)

Sets the number of wins of the sports team.

Parameters
`long wins`	The number of wins of the sports team.