# SportsTeam

Artifact: [androidx.appsearch:appsearch-builtin-types](https://developer.android.com/jetpack/androidx/releases/appsearch) [View Source](https://cs.android.com/search?q=file:androidx/appsearch/builtintypes/SportsTeam.java+class:androidx.appsearch.builtintypes.SportsTeam) Added in [1.2.0-alpha02](https://developer.android.com/jetpack/androidx/releases/appsearch#1.2.0-alpha02)

*** ** * ** ***


```
@Document(name = "builtin:SportsTeam")
public class SportsTeam extends SportsOrganization
```

<br />

|---|---|---|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object.html) |||||
| ↳ | [androidx.appsearch.builtintypes.Thing](https://developer.android.com/reference/androidx/appsearch/builtintypes/Thing) ||||
|   | ↳ | [androidx.appsearch.builtintypes.Organization](https://developer.android.com/reference/androidx/appsearch/builtintypes/Organization) |||
|   |   | ↳ | [androidx.appsearch.builtintypes.SportsOrganization](https://developer.android.com/reference/androidx/appsearch/builtintypes/SportsOrganization) ||
|   |   |   | ↳ | [androidx.appsearch.builtintypes.SportsTeam](https://developer.android.com/reference/androidx/appsearch/builtintypes/SportsTeam) |

*** ** * ** ***

AppSearch document representing a `https://developer.android.com/reference/androidx/appsearch/builtintypes/SportsTeam` entity.

## Summary

| ### Nested types |
|---|
| `@https://developer.android.com/reference/androidx/appsearch/annotation/Document.BuilderProducer public final class https://developer.android.com/reference/androidx/appsearch/builtintypes/SportsTeam.Builder extends https://developer.android.com/reference/androidx/appsearch/builtintypes/SportsTeam.BuilderBase<https://developer.android.com/reference/androidx/appsearch/builtintypes/SportsTeam.Builder>` |
| `@https://developer.android.com/reference/androidx/appsearch/app/ExperimentalAppSearchApi public class https://developer.android.com/reference/androidx/appsearch/builtintypes/SportsTeam.BuilderBase<T extends https://developer.android.com/reference/androidx/appsearch/builtintypes/SportsTeam.BuilderBase<T>> extends https://developer.android.com/reference/androidx/appsearch/builtintypes/SportsOrganization.BuilderBase<T>` Builder for `https://developer.android.com/reference/androidx/appsearch/builtintypes/SportsTeam`. |

| ### Public constructors |
|---|
| `@https://developer.android.com/reference/androidx/appsearch/app/ExperimentalAppSearchApi https://developer.android.com/reference/androidx/appsearch/builtintypes/SportsTeam#SportsTeam(androidx.appsearch.builtintypes.SportsTeam.BuilderBase<?>)(@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/appsearch/builtintypes/SportsTeam.BuilderBase<@https://developer.android.com/reference/androidx/annotation/NonNull ?> builder)` Constructor for `https://developer.android.com/reference/androidx/appsearch/builtintypes/SportsTeam`. |

| ### Public methods |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/appsearch/builtintypes/SportsTeam#getFormattedRecord()()` Returns the formatted record of the sports team. eg: "10 - 5", "10 - 5 (3 - 2)", "10 - 5 (3 - 2) - 1 OT" depending on the sport. |
| `long` | `https://developer.android.com/reference/androidx/appsearch/builtintypes/SportsTeam#getLosses()()` Returns the number of losses of the sports team. |
| `long` | `https://developer.android.com/reference/androidx/appsearch/builtintypes/SportsTeam#getOvertimeLosses()()` Returns the number of overtime losses of the sports team. |
| `long` | `https://developer.android.com/reference/androidx/appsearch/builtintypes/SportsTeam#getOvertimeWins()()` Returns the number of overtime wins of the sports team. |
| `long` | `https://developer.android.com/reference/androidx/appsearch/builtintypes/SportsTeam#getTies()()` Returns the number of ties of the sports team. |
| `long` | `https://developer.android.com/reference/androidx/appsearch/builtintypes/SportsTeam#getWins()()` Returns the number of wins of the sports team. |

### Inherited methods

From [androidx.appsearch.builtintypes.Organization](https://developer.android.com/reference/androidx/appsearch/builtintypes/Organization) `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/appsearch/builtintypes/ImageObject` `https://developer.android.com/reference/androidx/appsearch/builtintypes/Organization#getLogo()()`

Returns the logo of the organization, if set.
From [androidx.appsearch.builtintypes.SportsOrganization](https://developer.android.com/reference/androidx/appsearch/builtintypes/SportsOrganization) `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/android/graphics/Color.html` `https://developer.android.com/reference/androidx/appsearch/builtintypes/SportsOrganization#getAccentColor()()`

Returns the accent colors of the sports organization as a `https://developer.android.com/reference/android/graphics/Color.html`, if set.
`@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/lang/String.html` `https://developer.android.com/reference/androidx/appsearch/builtintypes/SportsOrganization#getSport()()`

Returns the sport of the sports organization, if set.
From [androidx.appsearch.builtintypes.Thing](https://developer.android.com/reference/androidx/appsearch/builtintypes/Thing) `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/util/List.html<https://developer.android.com/reference/java/lang/String.html>` `https://developer.android.com/reference/androidx/appsearch/builtintypes/Thing#getAlternateNames()()`

Returns an unmodifiable list of aliases, if any, for this item.
`long` `https://developer.android.com/reference/androidx/appsearch/builtintypes/Thing#getCreationTimestampMillis()()`

Returns the creation timestamp, in milliseconds since Unix epoch, of this item.
`@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/java/lang/String.html` `https://developer.android.com/reference/androidx/appsearch/builtintypes/Thing#getDescription()()`

Returns a description of this item.
`int` `https://developer.android.com/reference/androidx/appsearch/builtintypes/Thing#getDocumentScore()()`

Returns the intrinsic score (or importance) of this item.
`long` `https://developer.android.com/reference/androidx/appsearch/builtintypes/Thing#getDocumentTtlMillis()()`

Returns the time-to-live timestamp, in milliseconds since `https://developer.android.com/reference/androidx/appsearch/builtintypes/Thing#getCreationTimestampMillis()`, for this item.
`@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/lang/String.html` `https://developer.android.com/reference/androidx/appsearch/builtintypes/Thing#getId()()`

Returns the unique identifier for this item.
`@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/java/lang/String.html` `@https://developer.android.com/reference/androidx/appsearch/app/ExperimentalAppSearchApi
https://developer.android.com/reference/androidx/appsearch/builtintypes/Thing#getImage()()`

Returns the URL for an image of this item.
`@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/java/lang/String.html` `https://developer.android.com/reference/androidx/appsearch/builtintypes/Thing#getName()()`

Returns the name of this item.
`@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/lang/String.html` `https://developer.android.com/reference/androidx/appsearch/builtintypes/Thing#getNamespace()()`

Returns the namespace (or logical grouping) for this item.
`@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/util/List.html<https://developer.android.com/reference/androidx/appsearch/builtintypes/PotentialAction>` `@https://developer.android.com/reference/androidx/appsearch/app/ExperimentalAppSearchApi
https://developer.android.com/reference/androidx/appsearch/builtintypes/Thing#getPotentialActions()()`

Returns the actions that can be taken on this object.
`@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/java/lang/String.html` `https://developer.android.com/reference/androidx/appsearch/builtintypes/Thing#getUrl()()`

Returns the deeplink URL of this item.

## Public constructors

### SportsTeam

Added in [1.2.0-alpha02](https://developer.android.com/jetpack/androidx/releases/appsearch#1.2.0-alpha02)

```
@ExperimentalAppSearchApi
public SportsTeam(@NonNull SportsTeam.BuilderBase<@NonNull ?> builder)
```

Constructor for `https://developer.android.com/reference/androidx/appsearch/builtintypes/SportsTeam`.

| Parameters |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/appsearch/builtintypes/SportsTeam.BuilderBase<@https://developer.android.com/reference/androidx/annotation/NonNull ?> builder` | The builder to construct the `https://developer.android.com/reference/androidx/appsearch/builtintypes/SportsTeam` from. |

## Public methods

### getFormattedRecord

Added in [1.2.0-alpha02](https://developer.android.com/jetpack/androidx/releases/appsearch#1.2.0-alpha02)

```
public @Nullable String getFormattedRecord()
```

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

### getLosses

Added in [1.2.0-alpha02](https://developer.android.com/jetpack/androidx/releases/appsearch#1.2.0-alpha02)

```
public long getLosses()
```

Returns the number of losses of the sports team.

### getOvertimeLosses

Added in [1.2.0-alpha02](https://developer.android.com/jetpack/androidx/releases/appsearch#1.2.0-alpha02)

```
public long getOvertimeLosses()
```

Returns the number of overtime losses of the sports team.

### getOvertimeWins

Added in [1.2.0-alpha02](https://developer.android.com/jetpack/androidx/releases/appsearch#1.2.0-alpha02)

```
public long getOvertimeWins()
```

Returns the number of overtime wins of the sports team.

### getTies

Added in [1.2.0-alpha02](https://developer.android.com/jetpack/androidx/releases/appsearch#1.2.0-alpha02)

```
public long getTies()
```

Returns the number of ties of the sports team.

### getWins

Added in [1.2.0-alpha02](https://developer.android.com/jetpack/androidx/releases/appsearch#1.2.0-alpha02)

```
public long getWins()
```

Returns the number of wins of the sports team.