sdk/com.mapbox.search/SearchResultMetadata

SearchResultMetadata

class SearchResultMetadata : Parcelable

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

See also

Types

Link copied to clipboard
class Builder

Builder for creating instances of SearchResultMetadata.

Functions

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

Properties

Link copied to clipboard
val averageRating: Double?

Deprecated Average rating, associated with the search result. Use rating instead. This will be removed in v3.0.0 Available only for resolved com.mapbox.search.result.SearchResult.

Link copied to clipboard
val children: List<ChildMetadata>?

Child metadata for POI.

Link copied to clipboard
val countryIso1: String?

The country code in ISO 3166-1. Available for both com.mapbox.search.result.SearchSuggestion and com.mapbox.search.result.SearchResult.

Link copied to clipboard
val countryIso2: String?

The country code and its country subdivision code in ISO 3166-2. Available for both com.mapbox.search.result.SearchSuggestion and com.mapbox.search.result.SearchResult.

Link copied to clipboard
val cpsJson: String?

Raw CPS Specific Metadata for given search result, represented as a JSON string. Available only for resolved com.mapbox.search.result.SearchResult.

Link copied to clipboard
val delivery: Boolean?

Indicates whether the location offers delivery services

Link copied to clipboard
val description: String?

Description of given search result. Available only for resolved com.mapbox.search.result.SearchResult.

Link copied to clipboard
val driveThrough: Boolean?

Indicates whether the location has a drive-through service.

Link copied to clipboard
val email: String?

The email address associated with the location.

Link copied to clipboard
val extraData: Map<String, String>

Raw extra data, e.g. the data that is not available via the remaining properties of this class.

Link copied to clipboard
val facebookId: String?

The Facebook ID associated with the feature.

Link copied to clipboard
val fax: String?

The fax number associated with the location.

Link copied to clipboard
val instagram: String?

The Instagram handle associated with the location.

Link copied to clipboard
val openHours: OpenHours?

Information about time periods, when given search result is opened or closed. Available only for resolved com.mapbox.search.result.SearchResult.

Link copied to clipboard
val otherPhotos: List<ImageInfo>?

List of search result's other (non-primary) photos. Available only for resolved com.mapbox.search.result.SearchResult.

Link copied to clipboard
val parking: ParkingData?

Parking information for given search result. Available only for resolved com.mapbox.search.result.SearchResult.

Link copied to clipboard
val parkingAvailable: Boolean?

Indicates whether parking is available at the location.

Link copied to clipboard
val phone: String?

Phone number, associated with the search result. Available only for resolved com.mapbox.search.result.SearchResult.

Link copied to clipboard
val popularity: Float?

A popularity score for the location, calculated based on user engagement and review counts. The value scales from 0 to 1, 1 being the most popular.

Link copied to clipboard
val priceLevel: String?

The price level of the location, represented by a string including dollar signs. The values scale from Cheap "$" to Most Expensive "$$$$".

Link copied to clipboard
val primaryPhotos: List<ImageInfo>?

List of search result's primary photos. Available only for resolved com.mapbox.search.result.SearchResult.

Link copied to clipboard
val rating: Float?

The average rating of the location, on a scale from 1 to 5.

Link copied to clipboard
val reservable: Boolean?

Indicates whether the location accepts reservations.

Link copied to clipboard
val reviewCount: Int?

Review count for associated search result. Available only for resolved com.mapbox.search.result.SearchResult.

Link copied to clipboard
val servesBeer: Boolean?

Indicates whether beer is served.

Link copied to clipboard
val servesBreakfast: Boolean?

Indicates whether breakfast is served.

Link copied to clipboard
val servesBrunch: Boolean?

Indicates whether brunch is served.

Link copied to clipboard
val servesDinner: Boolean?

Indicates whether dinner is served.

Link copied to clipboard
val servesLunch: Boolean?

Indicates whether lunch is served.

Link copied to clipboard
val servesVegan: Boolean?

Indicates whether vegan diet options are available.

Link copied to clipboard
val servesVegetarian: Boolean?

Indicates whether vegetarian diet options are available.

Link copied to clipboard
val servesWine: Boolean?

Indicates whether wine is served.

Link copied to clipboard
val streetParking: Boolean?

Indicates the availability of street parking near the location.

Link copied to clipboard
val takeout: Boolean?

Indicates whether takeout services are available.

Link copied to clipboard
val twitter: String?

The Twitter handle associated with the location.

Link copied to clipboard
val valetParking: Boolean?

Indicates whether valet parking services are offered.

Link copied to clipboard
val website: String?

Website, associated with the search result. Available only for resolved com.mapbox.search.result.SearchResult.

Link copied to clipboard
val wheelchairAccessible: Boolean?

Indicates whether the location is accessible by wheelchair.