WemapCoreSDK/com.getwemap.sdk.core.model.entities/PointOfInterest

PointOfInterest

@Serializable(with = PointOfInterestSerializer::class)

data class PointOfInterest : CompactStringConvertible

A point of interest located on a map.

Constructors

PointOfInterest

constructor(name: String, coordinate: Coordinate, type: PointOfInterestType = PointOfInterestType.CATEGORY, description: String? = null, address: String? = null, imageUrl: String? = null, tags: List<String> = emptyList(), mediaThumbnailUrl: String? = null, mediaUrl: String? = null, mediaType: String? = null, extraMedias: List<PointOfInterest.ExtraMedia> = emptyList(), externalData: JsonElement? = null)

Creates a point of interest with a generated unique identifier.

Types

@Serializable

data class ExtraMedia(val type: String, val url: String)

An additional media associated with a point of interest.

Properties

val address: String?

Postal address of the point of interest.

val coordinate: Coordinate

Coordinate of the point of interest.

val description: String?

Textual description of the point of interest.

val externalData: JsonElement?

Arbitrary external data attached to the point of interest.

val extraMedias: List<PointOfInterest.ExtraMedia>

List of extra medias associated with the point of interest.

val id: Int

Unique identifier of the point of interest.

val imageUrl: String?

URL of the image representing the point of interest. Used for POI of type PointOfInterestType.CATEGORY.

mediaThumbnailUrl

val mediaThumbnailUrl: String?

URL of the thumbnail image representing the point of interest. Used for POI of type PointOfInterestType.VIDEO.

val mediaType: String?

MIME type of the media associated with the point of interest.

val mediaUrl: String?

URL of the media representing the point of interest. Used for POI of type PointOfInterestType.PICTURE.

val name: String

Name of the point of interest.

val tags: List<String>

Tags associated with the point of interest.

val type: PointOfInterestType

Type of the point of interest.

Functions

toCompactString

open override fun toCompactString(): String

Returns a compact, human-readable representation of this value.