android-sdk-core/com.mapsted.positioning/CoreApi/Setup

Setup

interface Setup

Access/manage core-related setup

Functions

addLocationServicesListener

abstract fun addLocationServicesListener(listener: CoreApi.LocationServicesCallback): Boolean

addRoleAccessChangeListener

abstract fun addRoleAccessChangeListener(listener: CoreApi.RoleAccessChangeListener): Boolean

areLocationServicesRunning

abstract fun areLocationServicesRunning(): Boolean

Checks whether or not the location services are currently running

getActiveAccessLevelId

@NonNull

abstract fun getActiveAccessLevelId(propertyId: Int): String

Active access level for a property.

getCoreParams

@Nullable

abstract fun getCoreParams(): CoreParams

Get the CoreParams that were used for initialization

getSessionId

abstract fun getSessionId(): String

Returns a UID which represents the current SDK session

getUserId

abstract fun getUserId(): String

Returns a UID which represents the current user

getUserRoleAccess

@NonNull

abstract fun getUserRoleAccess(): UserRoleAccess

Retrieves the current user role access mapping.

initialize

abstract fun initialize(@Nullable params: CoreParams, @Nullable callback: CoreApi.CoreInitCallback)

Initialize method that gets the SDK ready.

isInitialized

abstract fun isInitialized(): Boolean

Returns if Mapsted Positioning API is initialized or not.

removeLocationServicesListener

abstract fun removeLocationServicesListener(listener: CoreApi.LocationServicesCallback): Boolean

Unregister a persistent location services listener

removeRoleAccessChangeListener

abstract fun removeRoleAccessChangeListener(listener: CoreApi.RoleAccessChangeListener): Boolean

Unregister a listener for role access changes

restrictOffPremiseBackgroundLocationScanning

abstract fun restrictOffPremiseBackgroundLocationScanning(restrict: Boolean)

Restricts to reduced background location scanning.

setAppForegroundBackgroundListener

abstract fun setAppForegroundBackgroundListener(listener: AppForegroundBackgroundListener)

set listener to get notified when app moves from foreground to background and viceversa.

setUserRoleAccess

abstract fun setUserRoleAccess(@NonNull userRoleAccess: UserRoleAccess)

Sets the current user role access mapping.

startLocationServices

abstract fun startLocationServices(@NonNull context: Context, @NonNull callback: CoreApi.LocationServicesCallback)

Start location services and foreground service (if not running).

stopLocationServices

abstract fun stopLocationServices(@NonNull context: Context, @NonNull callback: CoreApi.LocationServicesCallback)

Stop location services (if running)

updateForegroundServiceDetails

abstract fun updateForegroundServiceDetails(@NonNull details: MapstedForegroundServiceDetails)

Update the foreground service details (text, icons, return activity)