Module com.gluonhq.attach.position

Package com.gluonhq.attach.position.impl

Class IOSPositionService

java.lang.Object

com.gluonhq.attach.position.impl.IOSPositionService

All Implemented Interfaces:

PositionService

public class IOSPositionService
extends Object
implements PositionService

An implementation of the PositionService for the iOS platform. Important note: it requires adding to the info.plist file: <key>NSLocationUsageDescription</key> <string>Reason to use Location Service (iOS 6+)</string> <key>NSLocationWhenInUseUsageDescription</key> <string>Reason to use Location Service (iOS 8+)</string> With Background mode enabled <key>UIBackgroundModes</key> <array> <string>location</string> </array> <key>NSLocationUsageDescription</key> <string>Reason to use Location Service (iOS 6+)</string> <key>NSLocationAlwaysUsageDescription</key> <string>Reason to use Location Service (iOS 8+) in background</string> <key>NSLocationAlwaysAndWhenInUseUsageDescription</key> <string>Reason to use Location Service (iOS 8+) in background</string>

Property Summary

Properties

Type	Property	Description
javafx.beans.property.ReadOnlyObjectProperty<Position>	position	A read-only property containing information about the device's current location on earth.

Field Summary

Fields inherited from interface com.gluonhq.attach.position.PositionService

DEFAULT_PARAMETERS

Constructor Summary

Constructors

Constructor	Description
IOSPositionService()

Method Summary

Modifier and Type	Method	Description
Position	getPosition()	Gets the value of the property position.
javafx.beans.property.ReadOnlyObjectProperty<Position>	positionProperty()	A read-only property containing information about the device's current location on earth.
void	start()	Starts the service with PositionService.DEFAULT_PARAMETERS.
void	start(Parameters parameters)	Starts the service.
void	stop()	Stops the service.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Property Details

position

public javafx.beans.property.ReadOnlyObjectProperty<Position> positionProperty

Specified by:

positionProperty in interface PositionService

Returns:

a read-only object property containing the device's current location

See Also:

• getPosition()

Constructor Details

IOSPositionService

public IOSPositionService()

Method Details

start

public void start()

Description copied from interface: PositionService

Starts the service with PositionService.DEFAULT_PARAMETERS. Developer must call either this method or PositionService.start(com.gluonhq.attach.position.Parameters) to start the service

Specified by:

start in interface PositionService

start

public void start(Parameters parameters)

Description copied from interface: PositionService

Starts the service. Developer must call either this method or PositionService.start() to start the service

Specified by:

start in interface PositionService

Parameters:

parameters - Parameters for configuring the service, including desired accuracy, minimum distance and time interval between notifications, or background mode

stop

public void stop()

Description copied from interface: PositionService

Stops the service. Developer may call this method to stop the service on demand

Specified by:

stop in interface PositionService

positionProperty

public javafx.beans.property.ReadOnlyObjectProperty<Position> positionProperty()

Description copied from interface: PositionService

A read-only property containing information about the device's current location on earth. The property can contain a null object when the position of the device could be determined.

Specified by:

positionProperty in interface PositionService

Returns:

a read-only object property containing the device's current location

See Also:

• getPosition()

getPosition

public Position getPosition()

Gets the value of the property position.

Specified by:

getPosition in interface PositionService

Property description:

Returns:

the current position of the device