SportsTeam.Builder
@Document.BuilderProducer
class SportsTeam.Builder
Summary
Public constructors |
|---|
Builder(sportsTeam: SportsTeam)Constructor with all the existing values. |
|
Constructor for |
Public functions |
|
|---|---|
T |
addAlternateName(alternateName: String)Adds an alias for the item. |
T |
@ExperimentalAppSearchApiAdd a new action to the list of potential actions for this document. |
SportsTeam |
build()Builds a |
SportsOrganization |
build()Builds a |
Organization |
build()Builds a |
Thing |
build()Builds a |
T |
Clears the aliases, if any, for the item. |
T |
Clear all the potential actions for this document. |
T |
setAccentColor(accentColor: Color?)Sets the accent color of the sports organization as a |
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 |
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 |
T |
setDocumentTtlMillis(documentTtlMillis: Long)Sets the time-to-live (TTL) for the current AppSearch document as a duration in milliseconds. |
T |
setFormattedRecord(formattedRecord: String?)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. |
T |
@ExperimentalAppSearchApiSets the URL for an image of the item. |
T |
setLogo(logo: ImageObject?)Sets the logo of the organization. |
T |
Sets the number of losses of the sports team. |
T |
Sets the name of the item. |
T |
setOvertimeLosses(overtimeLosses: Long)Sets the number of overtime losses of the sports team. |
T |
setOvertimeWins(overtimeWins: Long)Sets the number of overtime wins of the sports team. |
T |
@ExperimentalAppSearchApiSets a list of potential actions for this document. |
T |
Sets the number of ties of the sports team. |
T |
Sets the deeplink URL of the item. |
T |
Sets the number of wins of the sports team. |
Protected properties |
|
|---|---|
Color? |
|
(Mutable)List<String!>! |
|
Long |
|
String! |
|
Int |
|
Long |
|
String? |
|
String! |
|
String! |
|
ImageObject? |
|
Long |
|
String! |
|
String! |
|
Long |
|
Long |
|
(Mutable)List<PotentialAction!>! |
|
String |
|
Long |
|
String! |
|
Long |
Public constructors
Builder
Builder(sportsTeam: SportsTeam)
Constructor with all the existing values.
Builder
Builder(namespace: String, id: String, sport: String)
Constructor for SportsTeam.Builder.
| Parameters | |
|---|---|
namespace: String |
Namespace for the Document. See |
id: String |
The unique identifier for the Document. |
sport: String |
The sport of the sports team. |
Public functions
addAlternateName
fun addAlternateName(alternateName: String): T
Adds an alias for the item.
addPotentialAction
@ExperimentalAppSearchApi
fun addPotentialAction(newPotentialAction: PotentialAction): T
Add a new action to the list of potential actions for this document.
clearAlternateNames
fun clearAlternateNames(): T
Clears the aliases, if any, for the item.
clearPotentialActions
@ExperimentalAppSearchApi
fun clearPotentialActions(): T
Clear all the potential actions for this document.
setAccentColor
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. |
setAlternateNames
fun setAlternateNames(alternateNames: (Mutable)List<String!>?): T
Sets a list of aliases for the item.
setCreationTimestampMillis
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.
setDescription
fun setDescription(description: String?): T
Sets the description for the item.
setDocumentScore
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.
setDocumentTtlMillis
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.
setFormattedRecord
fun setFormattedRecord(formattedRecord: String?): T
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 | |
|---|---|
formattedRecord: String? |
The formatted record of the sports team. |
setImage
@ExperimentalAppSearchApi
fun setImage(image: String?): T
Sets the URL for an image of the item.
setLogo
fun setLogo(logo: ImageObject?): T
Sets the logo of the organization.
setLosses
fun setLosses(losses: Long): T
Sets the number of losses of the sports team.
| Parameters | |
|---|---|
losses: Long |
The number of losses of the sports team. |
setOvertimeLosses
fun setOvertimeLosses(overtimeLosses: Long): T
Sets the number of overtime losses of the sports team.
| Parameters | |
|---|---|
overtimeLosses: Long |
The number of overtime losses of the sports team. |
setOvertimeWins
fun setOvertimeWins(overtimeWins: Long): T
Sets the number of overtime wins of the sports team.
| Parameters | |
|---|---|
overtimeWins: Long |
The number of overtime wins of the sports team. |
setPotentialActions
@ExperimentalAppSearchApi
fun setPotentialActions(
newPotentialActions: (Mutable)List<PotentialAction!>?
): T
Sets a list of potential actions for this document.
setTies
fun setTies(ties: Long): T
Sets the number of ties of the sports team.
| Parameters | |
|---|---|
ties: Long |
The number of ties of the sports team. |
setUrl
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.
setWins
fun setWins(wins: Long): T
Sets the number of wins of the sports team.
| Parameters | |
|---|---|
wins: Long |
The number of wins of the sports team. |