SportsEvent.Builder

public Builder(@NonNull SportsEvent sportsEvent)

Constructor with all the existing values.

public Builder(
    @NonNull String namespace,
    @NonNull String id,
    @NonNull Instant startDate,
    @NonNull String sport,
    @NonNull SportsTeam homeTeam,
    @NonNull SportsTeam awayTeam
)

Constructor for SportsEvent.Builder.

public @NonNull T addAlternateName(@NonNull String alternateName)

Adds an alias for the item.

@ExperimentalAppSearchApi
public @NonNull T addPotentialAction(@NonNull PotentialAction newPotentialAction)

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

public @NonNull SportsEvent build()

Builds a Thing object.

public @NonNull Event build()

Builds a Thing object.

public @NonNull Thing build()

Builds a Thing object.

public @NonNull T clearAlternateNames()

Clears the aliases, if any, for the item.

@ExperimentalAppSearchApi
public @NonNull T clearPotentialActions()

Clear all the potential actions for this document.

public @NonNull T setAlternateNames(@Nullable List<String> alternateNames)

Sets a list of aliases for the item.

public @NonNull T setAwayTeamAccessoryScore(@Nullable String awayTeamAccessoryScore)

Sets the away team accessory score of the sports event. Format should be an additional contextual score that is used in some sports, e.g., like penalties in Soccer, overs in Cricket, etc.

public @NonNull T setAwayTeamScore(@Nullable String awayTeamScore)

Sets the away team score of the sports event. Format should be a score of the away team, e.g., "100" for Basketball, "3" for American Baseball, etc.

public @NonNull T setAwayTeamWinProbability(double awayTeamWinProbability)

Sets the away team win probability of the sports event. Must be a range from 0 to 1.

public @NonNull T setCreationTimestampMillis(long creationTimestampMillis)

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.

public @NonNull T setDescription(@Nullable String description)

Sets the description for the item.

public @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.

See androidx.appsearch.annotation.Document.Score for more information on score.

public @NonNull T setDocumentTtlMillis(long documentTtlMillis)

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.

public @NonNull T setDuration(@Nullable Duration duration)

Sets the duration of the event as a Duration.

public @NonNull T setEndDate(@Nullable Instant endDate)

Sets the end date of the event as a Instant.

public @NonNull T setGameTemporalState(@Nullable String gameTemporalState)

Sets the game temporal state of the sports event. Format should be a temporal state of the game, e.g. "Quarter 1 - 10:00" for Basketball, "Halftime" for Soccer, "9th inning" for American Baseball, etc.

public @NonNull T setHomeTeamAccessoryScore(@Nullable String homeTeamAccessoryScore)

Sets the home team accessory score of the sports event. Format should be an additional contextual score that is used in some sports, e.g., like penalties in Soccer, overs in Cricket, etc.

public @NonNull T setHomeTeamScore(@Nullable String homeTeamScore)

Sets the home team score of the sports event. Format should be a score of the home team, e.g., "100" for basketball, "3" for American Baseball, etc.

public @NonNull T setHomeTeamWinProbability(double homeTeamWinProbability)

Sets the home team win probability of the sports event. Must be a range from 0 to 1.

@ExperimentalAppSearchApi
public @NonNull T setImage(@Nullable String image)

Sets the URL for an image of the item.

public @NonNull T setLocation(@Nullable String location)

Sets the location of the event. A freeform string describing the Event location. This could be a venue name, a string representation of a street address, or a string representation of a latitude/longitude pair. For example, "Some Place" or "123 Main Street, Anytown, CA" or "37.7749,-122.4194".

public @NonNull T setLogo(@Nullable ImageObject logo)

Sets the logo of the event.

public @NonNull T setName(@Nullable String name)

Sets the name of the item.

public @NonNull T setNotableDetail(@Nullable String notableDetail)

Sets the most recent notable detail of the sports event. Format should be a most recent notable detail of the sports event, e.g. "2 outs, 2 balls, 1 strike" in American Baseball.

public @NonNull T setOrganizer(@Nullable Organization organizer)

Sets the Organization of the sports event.

public @NonNull T setPlaceHomeTeamAtStart(boolean placeHomeTeamAtStart)

Sets whether the home team should be placed at the start for a visual representation of the sports event.

@ExperimentalAppSearchApi
public @NonNull T setPotentialActions(@Nullable List<PotentialAction> newPotentialActions)

Sets a list of potential actions for this document.

public @NonNull T setResult(long result)

Sets whether the home team won the sports event. During the course of the game, the value of this field should not be considered. The value of this field should only be set after the sports event has ended @{link SportsEventStatus.STATUS_COMPLETE} or has been cancelled @{link SportsEventStatus.STATUS_CANCELLED}, or any other terminal state.

public @NonNull T setSportsEventStatus(long sportsEventStatus)

Sets the status of the sports event.

public @NonNull T setSportsEventStatusLabel(@Nullable String sportsEventStatusLabel)

Sets the status label of the sports event.

public @NonNull T setUrl(@Nullable String url)

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.