SpaceKit Android SDK v0.9.4/com.dentreality.spacekit.ext

Package com.dentreality.spacekit.ext

Types

AnchorIcon

interface AnchorIcon

Describes the anchor icon we need to display as a marker on the map in order to give user more venue details.

ArrivedAtDestinationEvent

data class ArrivedAtDestinationEvent(val distanceThreshold: Double, val onFulfill: () -> Unit) : SubscriptionEvent

Destination

interface Destination

Describes the data we need to locate an item on the map and show it as the next item in the HyperView. Intended to be used as an item in the user's shopping list.

DestinationPriority

enum DestinationPriority : Enum<DestinationPriority>

EnterLevelEvent

data class EnterLevelEvent(val leveIdentifier: String, val onFulfill: () -> Unit) : SubscriptionEvent

EnterSectionEvent

data class EnterSectionEvent(val sectionIdentifier: String, val onFulfill: () -> Unit) : SubscriptionEvent

HeatMap

class HeatMap(aliases_: List<String>, threshold_: Double)

HeatMapEvent

data class HeatMapEvent(val alias: String, val timestamp: Long)

InfoViewConfig

interface InfoViewConfig

ItemProximityEvent

data class ItemProximityEvent( val itemIdentifier: String, val distanceThreshold: Double, val onFulfill: () -> Unit) : SubscriptionEvent

LevelSwitcherConfig

interface LevelSwitcherConfig

LevelSwitcherConfigCallback

interface LevelSwitcherConfigCallback

ListListener

interface ListListener<Item : Destination>

Listener for updates to the user's shopping list of items, ordered by route order

LiveModeStatus

enum LiveModeStatus : Enum<LiveModeStatus>

LocalVenue

interface LocalVenue

Local venue as returned by VenueManager.findLocalVenues

MapReadyCallback

typealias MapReadyCallback = (VenueInformation) -> Unit

NodeState

enum NodeState : Enum<NodeState>

NodeTapListener

interface NodeTapListener

Listener for node taps events

PathProximityEvent

data class PathProximityEvent( val itemIdentifier: String, val distanceThreshold: Double, val onFulfill: () -> Unit) : SubscriptionEvent

RecenterButtonConfig

interface RecenterButtonConfig

RecenterButtonConfigCallback

interface RecenterButtonConfigCallback

Requisite

enum Requisite : Enum<Requisite>

Describes permissions or other modes that are required for the correct functioning of SpaceKitUIFragment

Requisites

object Requisites

RoutingOptions

data class RoutingOptions(val traversalOptions: Set<TraversalOption> = TraversalOption.values().toSet())

Options for SpaceKit to use when planning routes.

ScanListener

interface ScanListener

Listener for barcode scan results

ScanResult

data class ScanResult(val scanValue: String, val type: ScanType)

Represents a scan result from the HyperView barcode/QR scanner

ScanType

enum ScanType : Enum<ScanType>

These types include all those specified by the client as supported by their current solution. They broadly coincide with the barcode types found in com.google.mlkit.vision.barcode.common.Barcode. The only exception being that while there is support for CODE-39 barcodes, there doesn't appear to be de-facto support for the "Mod 43" variant. It's unclear whether this could be easily enabled, nor whether it is required so this will need to be assessed.

SectionIcon

interface SectionIcon

Describes the section icon we need to display as a marker on the map in order to give user more venue details.

SectionProximityEvent

data class SectionProximityEvent( val sectionIdentifier: String, val distanceThreshold: Double, val onFulfill: () -> Unit) : SubscriptionEvent

SpaceKitContext

interface SpaceKitContext

SpaceKitContextFactory

object SpaceKitContextFactory

SpaceKitOptions

class SpaceKitOptions

SpaceKit global flags

SpaceKitStaticMap

class SpaceKitStaticMap(val destination: Destination? = null, val onMapClickedListener: () -> Unit = {}) : SpaceKitMapConfiguration

The user can zoom or rotate the map to understand the destination's location in the venue, but not pan the map.

SpaceKitUI

interface SpaceKitUI

SpaceKitVenue

data class SpaceKitVenue(val absolutePath: String) : Venue, SpaceKitKoinComponent

An opaque container for SpaceKit venue data.

SubscriptionEvent

abstract class SubscriptionEvent

TraversalOption

enum TraversalOption : Enum<TraversalOption>

Venue

interface Venue

The Venue contains all specific Venue-related data. At a base level only VenueMetaData is supported, with further data access methods available in the platform-specific object models.

VenueId

typealias VenueId = String

VenueId is a string, rendered as a typealias for type safety.

VenueInformation

data class VenueInformation(val levels: List<String>)

VenueManager

interface VenueManager

VenueManagerComponent

class VenueManagerComponent(val configuration: VenueManagerConfiguration) : VenueManager, SpaceKitKoinComponent

VenueManagerConfiguration

data class VenueManagerConfiguration(val organizationIdentifier: String)

VenueMetaData

interface VenueMetaData

Encompasses metadata about a single Venue.