BBjGeolocation::getMaximumAge

Description

In BBj 11.0 and higher, this method returns the maximumAge value that will be used in subsequent requests for geolocation information.

Syntax

Return Value

Method

double

getMaximumAge()

Parameters

None.

Return Value

Returns the maximum age in seconds of any cached position (0 to acquire a current position).

Remarks

The "maximumAge" attribute indicates that the application is willing to accept a cached position whose age is no greater than the specified time in seconds. If maximumAge is set to 0, the implementation must immediately attempt to acquire a new position object. If an implementation does not have a cached position available whose age is no greater than the specified maximumAge, then it must acquire a new position object. In case of a watchPosition(), the maximumAge refers to the first position object returned by the implementation.

Example

rem ' BBjGeolocation getMaximumAge

sysgui! = bbjapi().openSysGui("X0")
geo! = sysgui!.getGeolocation()
geo!.setMaximumAge(30)
maximumAge = geo!.getMaximumAge()
i = msgbox("getMaximumAge: "+str(maximumAge),0,"BBjGeolocation")
release

See Also

Geolocation API Specification

BBj Object Diagram for an illustration of the relationship between BBjObjects.