SportsEvent.Builder

Builder(sportsEvent: SportsEvent)

Constructor with all the existing values.

Builder(
    namespace: String,
    id: String,
    startDate: Instant,
    sport: String,
    homeTeam: SportsTeam,
    awayTeam: SportsTeam
)

Constructor for SportsEvent.Builder.

fun addAlternateName(alternateName: String): T

Adds an alias for the item.

@ExperimentalAppSearchApi
fun addPotentialAction(newPotentialAction: PotentialAction): T

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

fun build(): SportsEvent

Builds a Thing object.

fun build(): Event

Builds a Thing object.

fun build(): Thing

Builds a Thing object.

fun clearAlternateNames(): T

Clears the aliases, if any, for the item.

@ExperimentalAppSearchApi
fun clearPotentialActions(): T

Clear all the potential actions for this document.

fun setAlternateNames(alternateNames: (Mutable)List<String!>?): T

Sets a list of aliases for the item.

fun setAwayTeamAccessoryScore(awayTeamAccessoryScore: String?): T

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.

fun setAwayTeamScore(awayTeamScore: String?): T

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.

fun setAwayTeamWinProbability(awayTeamWinProbability: Double): T

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

fun setCreationTimestampMillis(creationTimestampMillis: Long): T

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.

fun setDescription(description: String?): T

Sets the description for the item.

fun setDocumentScore(documentScore: Int): T

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.

fun setDocumentTtlMillis(documentTtlMillis: Long): T

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.

fun setDuration(duration: Duration?): T

Sets the duration of the event as a Duration.

fun setEndDate(endDate: Instant?): T

Sets the end date of the event as a Instant.

fun setGameTemporalState(gameTemporalState: String?): T

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.

fun setHomeTeamAccessoryScore(homeTeamAccessoryScore: String?): T

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.

fun setHomeTeamScore(homeTeamScore: String?): T

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.

fun setHomeTeamWinProbability(homeTeamWinProbability: Double): T

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

@ExperimentalAppSearchApi
fun setImage(image: String?): T

Sets the URL for an image of the item.

fun setLocation(location: String?): T

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".

fun setLogo(logo: ImageObject?): T

Sets the logo of the event.

fun setName(name: String?): T

Sets the name of the item.

fun setNotableDetail(notableDetail: String?): T

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.

fun setOrganizer(organizer: Organization?): T

Sets the Organization of the sports event.

fun setPlaceHomeTeamAtStart(placeHomeTeamAtStart: Boolean): T

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

@ExperimentalAppSearchApi
fun setPotentialActions(
    newPotentialActions: (Mutable)List<PotentialAction!>?
): T

Sets a list of potential actions for this document.

fun setResult(result: Long): T

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.

fun setSportsEventStatus(sportsEventStatus: Long): T

Sets the status of the sports event.

fun setSportsEventStatusLabel(sportsEventStatusLabel: String?): T

Sets the status label of the sports event.

fun setUrl(url: String?): T

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.