sdk/com.mapbox.search.record/FavoriteRecord

FavoriteRecord

class FavoriteRecord(    val id: String,     val name: String,     val descriptionText: String?,     val address: SearchAddress?,     val routablePoints: List<RoutablePoint>?,     val categories: List<String>?,     val makiIcon: String?,     val coordinate: Point,     val type: SearchResultType,     val metadata: SearchResultMetadata?) : IndexableRecord, Parcelable

Favorite indexable record.

See also

Constructors

Link copied to clipboard
fun FavoriteRecord(    id: String,     name: String,     descriptionText: String?,     address: SearchAddress?,     routablePoints: List<RoutablePoint>?,     categories: List<String>?,     makiIcon: String?,     coordinate: Point,     type: SearchResultType,     metadata: SearchResultMetadata?)

Functions

Link copied to clipboard
fun copy(    id: String = this.id,     name: String = this.name,     descriptionText: String? = this.descriptionText,     address: SearchAddress? = this.address,     routablePoints: List<RoutablePoint>? = this.routablePoints,     categories: List<String>? = this.categories,     makiIcon: String? = this.makiIcon,     coordinate: Point = this.coordinate,     type: SearchResultType = this.type,     metadata: SearchResultMetadata? = this.metadata): FavoriteRecord

Creates new FavoriteRecord from current instance.

Link copied to clipboard
abstract fun describeContents(): Int
Link copied to clipboard
abstract fun writeToParcel(p0: Parcel, p1: Int)

Properties

Link copied to clipboard
open override val address: SearchAddress?

Record address.

Link copied to clipboard
open override val categories: List<String>?

Record categories.

Link copied to clipboard
open override val coordinate: Point

Record coordinate.

Link copied to clipboard
open override val descriptionText: String?

Additional description for the record.

Link copied to clipboard
open override val id: String

Record unique identifier.

Link copied to clipboard
open override val indexTokens: List<String>

Additional string literals that should be included in search index. For example, you may provide non-official names to force search engine match them.

Link copied to clipboard
open override val makiIcon: String?

Mapbox Maki icon id.

Link copied to clipboard
open override val metadata: SearchResultMetadata?

Search result metadata containing geo place's detailed information if available.

Link copied to clipboard
open override val name: String

Record name.

Link copied to clipboard
open override val routablePoints: List<RoutablePoint>?

List of points near coordinate, that represents entries to associated building.

Link copied to clipboard
open override val type: SearchResultType

Type of the search result represented by the record.