compass-core/dev.jordond.compass

Package-level declarations

Types

Altitude

class Altitude(val meters: Double, val accuracy: Float?)

Object representing the altitude of the user.

Azimuth

class Azimuth(val degrees: Float, val accuracy: Float?)

Object representing the users azimuth.

Coordinates

class Coordinates(val latitude: Double, val longitude: Double)

A geographic location represented by latitude and longitude.

InternalCompassApi

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.PROPERTY, AnnotationTarget.FUNCTION, AnnotationTarget.TYPEALIAS])

annotation class InternalCompassApi

Location

class Location(val coordinates: Coordinates, val accuracy: Double, val azimuth: Azimuth?, val speed: Speed?, val altitude: Altitude?, val timestampMillis: Long)

Object representing a user's location.

Place

class Place(val coordinates: Coordinates, val name: String?, val street: String?, val isoCountryCode: String?, val country: String?, val postalCode: String?, val administrativeArea: String?, val subAdministrativeArea: String?, val locality: String?, val subLocality: String?, val thoroughfare: String?, val subThoroughfare: String?)

Represents a place on Earth.

Priority

enum Priority : Enum<Priority>

Represents the priority of a location request.

Speed

class Speed(val mps: Float, val accuracy: Float?)

Object representing the speed of the user.