mapbox-maps-android/com.mapbox.maps.plugin/Plugin

Plugin

sealed class Plugin

Class describing plugin instance.

For Mapbox plugins it is enough to provide plugin id from this class without plugin instance. For user-defined plugins both unique id and plugin instance must be provided.

Types

Companion

object Companion

Static ids for Mapbox plugins.

Custom

class Custom(val id: String, val instance: MapPlugin) : Plugin

Should be used to create custom user-defined plugins.

Mapbox

class Mapbox(val id: String) : Plugin

Should be used to create Mapbox official plugins.

Functions

equals

open operator override fun equals(other: Any?): Boolean

Equals implementation taking only id into account.

hashCode

open override fun hashCode(): Int

Hash code implementation taking only id into account.

toString

open override fun toString(): String

toString implementation.

Properties

val id: String

Unique plugin id.

instance

val instance: MapPlugin?

Plugin instance implementing MapPlugin. Must be non-null for user-defined plugins or RuntimeException will occur when trying to initiate such plugin.

Inheritors

Mapbox

Custom