mirror of
https://github.com/KeymonSoft/AdditionalLibs.git
synced 2026-04-17 19:36:30 +00:00
532 lines
23 KiB
XML
532 lines
23 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<root>
|
|
<doclet-version-NOT-library-version>1.04</doclet-version-NOT-library-version>
|
|
<class>
|
|
<name>uk.co.martinpearman.b4a.fusedlocationprovider.LocationSettingsStatus</name>
|
|
<shortname>LocationSettingsStatus</shortname>
|
|
<objectwrapper>com.google.android.gms.common.api.Status</objectwrapper>
|
|
<owner>activity</owner>
|
|
<event>ResolutionDialogDismissed(LocationSettingsUpdated As Boolean)</event>
|
|
<method>
|
|
<name>StartResolutionDialog</name>
|
|
<comment>Starts the resolution dialog.
|
|
The user can then enable the location settings required to meet the location request requirements.
|
|
This method must be called from an Activity.
|
|
Raises the event:
|
|
ResolutionDialogDismissed(LocationSettingsUpdated As Boolean)</comment>
|
|
<returntype>void</returntype>
|
|
<parameter>
|
|
<name>ba</name>
|
|
<type>anywheresoftware.b4a.BA</type>
|
|
</parameter>
|
|
<parameter>
|
|
<name>EventName</name>
|
|
<type>java.lang.String</type>
|
|
</parameter>
|
|
</method>
|
|
<method>
|
|
<name>GetStatusCode</name>
|
|
<comment>Returns the status code that describes whether the location settings meet the location request requirements.</comment>
|
|
<returntype>int</returntype>
|
|
</method>
|
|
<method>
|
|
<name>IsInitialized</name>
|
|
<comment></comment>
|
|
<returntype>boolean</returntype>
|
|
</method>
|
|
<field>
|
|
<name>StatusCodes</name>
|
|
<comment>Contains the various StatusCode constants.</comment>
|
|
<returntype>uk.co.martinpearman.b4a.fusedlocationprovider.LocationSettingsStatus.StatusCodes</returntype>
|
|
</field>
|
|
</class>
|
|
<class>
|
|
<name>uk.co.martinpearman.b4a.fusedlocationprovider.LocationSettingsStatus.StatusCodes</name>
|
|
<shortname>StatusCodes</shortname>
|
|
<owner>process</owner>
|
|
<field>
|
|
<name>SETTINGS_CHANGE_UNAVAILABLE</name>
|
|
<comment>Location settings do not meet the location request requirements.
|
|
Location settings can't be changed to meet the location request requirements.
|
|
No resolution dialog is available.</comment>
|
|
<returntype>int</returntype>
|
|
</field>
|
|
<field>
|
|
<name>SUCCESS</name>
|
|
<comment>Location settings meet the location request requirements.</comment>
|
|
<returntype>int</returntype>
|
|
</field>
|
|
<field>
|
|
<name>RESOLUTION_REQUIRED</name>
|
|
<comment>Location settings do not meet the location request requirements.
|
|
Location settings can be changed to meet the location request requirements.
|
|
A resolution dialog is available.</comment>
|
|
<returntype>int</returntype>
|
|
</field>
|
|
</class>
|
|
<class>
|
|
<name>uk.co.martinpearman.b4a.fusedlocationprovider.LocationSettingsStates</name>
|
|
<shortname>LocationSettingsStates</shortname>
|
|
<objectwrapper>com.google.android.gms.location.LocationSettingsStates</objectwrapper>
|
|
<owner>process</owner>
|
|
<method>
|
|
<name>IsGpsPresent</name>
|
|
<comment>Whether GPS provider is present on the device.</comment>
|
|
<returntype>boolean</returntype>
|
|
</method>
|
|
<method>
|
|
<name>IsBlePresent</name>
|
|
<comment>Whether BLE is present on the device.</comment>
|
|
<returntype>boolean</returntype>
|
|
</method>
|
|
<method>
|
|
<name>IsNetworkLocationUsable</name>
|
|
<comment>Whether network location provider is enabled and usable by the app.</comment>
|
|
<returntype>boolean</returntype>
|
|
</method>
|
|
<method>
|
|
<name>IsInitialized</name>
|
|
<comment></comment>
|
|
<returntype>boolean</returntype>
|
|
</method>
|
|
<method>
|
|
<name>IsNetworkLocationPresent</name>
|
|
<comment>Whether network location provider is present on the device.</comment>
|
|
<returntype>boolean</returntype>
|
|
</method>
|
|
<method>
|
|
<name>IsLocationPresent</name>
|
|
<comment>Whether location is present on the device.
|
|
This method returns true when either GPS or network location provider is present.</comment>
|
|
<returntype>boolean</returntype>
|
|
</method>
|
|
<method>
|
|
<name>IsGpsUsable</name>
|
|
<comment>Whether GPS provider is enabled and is usable by the app.</comment>
|
|
<returntype>boolean</returntype>
|
|
</method>
|
|
<method>
|
|
<name>IsLocationUsable</name>
|
|
<comment>Whether location is enabled and is usable by the app.
|
|
This method returns true when either GPS or network location provider is usable.</comment>
|
|
<returntype>boolean</returntype>
|
|
</method>
|
|
<method>
|
|
<name>IsBleusable</name>
|
|
<comment>Whether BLE is enabled and is usable by the app.</comment>
|
|
<returntype>boolean</returntype>
|
|
</method>
|
|
</class>
|
|
<class>
|
|
<name>uk.co.martinpearman.b4a.fusedlocationprovider.LocationSettingsResult</name>
|
|
<shortname>LocationSettingsResult</shortname>
|
|
<objectwrapper>com.google.android.gms.location.LocationSettingsResult</objectwrapper>
|
|
<owner>process</owner>
|
|
<method>
|
|
<name>IsInitialized</name>
|
|
<comment></comment>
|
|
<returntype>boolean</returntype>
|
|
</method>
|
|
<method>
|
|
<name>GetLocationSettingsStates</name>
|
|
<comment>Returns the location settings states.</comment>
|
|
<returntype>uk.co.martinpearman.b4a.fusedlocationprovider.LocationSettingsStates</returntype>
|
|
</method>
|
|
<method>
|
|
<name>GetLocationSettingsStatus</name>
|
|
<comment>Returns the location settings result status.</comment>
|
|
<returntype>uk.co.martinpearman.b4a.fusedlocationprovider.LocationSettingsStatus</returntype>
|
|
</method>
|
|
</class>
|
|
<class>
|
|
<name>uk.co.martinpearman.b4a.fusedlocationprovider.LocationSettingsRequestBuilder</name>
|
|
<shortname>LocationSettingsRequestBuilder</shortname>
|
|
<objectwrapper>com.google.android.gms.location.LocationSettingsRequest.Builder</objectwrapper>
|
|
<owner>process</owner>
|
|
<method>
|
|
<name>Build</name>
|
|
<comment>Creates a LocationSettingsRequest.</comment>
|
|
<returntype>com.google.android.gms.location.LocationSettingsRequest</returntype>
|
|
</method>
|
|
<method>
|
|
<name>SetNeedBle</name>
|
|
<comment>Sets whether the client wants BLE scan to be enabled.
|
|
When this flag is set to true, if the platform supports BLE scan mode and Bluetooth is off, the dialog will prompt the user to enable BLE scan.
|
|
If the platform doesn't support BLE scan mode, the dialog will prompt to enable Bluetooth.</comment>
|
|
<returntype>uk.co.martinpearman.b4a.fusedlocationprovider.LocationSettingsRequestBuilder</returntype>
|
|
<parameter>
|
|
<name>NeedBle</name>
|
|
<type>boolean</type>
|
|
</parameter>
|
|
</method>
|
|
<method>
|
|
<name>AddLocationRequest</name>
|
|
<comment>Adds one LocationRequest that the client is interested in.
|
|
This method can be called multiple times if required to add additional location requests.</comment>
|
|
<returntype>uk.co.martinpearman.b4a.fusedlocationprovider.LocationSettingsRequestBuilder</returntype>
|
|
<parameter>
|
|
<name>LocationRequest1</name>
|
|
<type>com.google.android.gms.location.LocationRequest</type>
|
|
</parameter>
|
|
</method>
|
|
<method>
|
|
<name>SetAlwaysShow</name>
|
|
<comment>Always show the dialog, without the "Never" option to suppress future dialogs from this app.
|
|
When this flag is set to true, the dialog will show up if the location settings do not satisfy the request, even if a user has previously chosen "Never".
|
|
NOTE: Only use this method if your dialog is the result of an explicit user-initiated action that requires location to proceed.
|
|
Cancelling this dialog should also cancel the initiated action.</comment>
|
|
<returntype>uk.co.martinpearman.b4a.fusedlocationprovider.LocationSettingsRequestBuilder</returntype>
|
|
<parameter>
|
|
<name>AlwaysShow</name>
|
|
<type>boolean</type>
|
|
</parameter>
|
|
</method>
|
|
<method>
|
|
<name>IsInitialized</name>
|
|
<comment></comment>
|
|
<returntype>boolean</returntype>
|
|
</method>
|
|
<method>
|
|
<name>Initialize</name>
|
|
<comment></comment>
|
|
<returntype>void</returntype>
|
|
</method>
|
|
</class>
|
|
<class>
|
|
<name>uk.co.martinpearman.b4a.fusedlocationprovider.LocationRequest</name>
|
|
<shortname>LocationRequest</shortname>
|
|
<objectwrapper>com.google.android.gms.location.LocationRequest</objectwrapper>
|
|
<owner>process</owner>
|
|
<method>
|
|
<name>SetExpirationTime</name>
|
|
<comment>Set the request expiration time, in millisecond since boot.</comment>
|
|
<returntype>uk.co.martinpearman.b4a.fusedlocationprovider.LocationRequest</returntype>
|
|
<parameter>
|
|
<name>Millis</name>
|
|
<type>long</type>
|
|
</parameter>
|
|
</method>
|
|
<method>
|
|
<name>SetPriority</name>
|
|
<comment>Set the priority of the request.</comment>
|
|
<returntype>uk.co.martinpearman.b4a.fusedlocationprovider.LocationRequest</returntype>
|
|
<parameter>
|
|
<name>Priority</name>
|
|
<type>int</type>
|
|
</parameter>
|
|
</method>
|
|
<method>
|
|
<name>IsInitialized</name>
|
|
<comment></comment>
|
|
<returntype>boolean</returntype>
|
|
</method>
|
|
<method>
|
|
<name>SetFastestInterval</name>
|
|
<comment>Explicitly set the fastest interval for location updates, in milliseconds.</comment>
|
|
<returntype>uk.co.martinpearman.b4a.fusedlocationprovider.LocationRequest</returntype>
|
|
<parameter>
|
|
<name>Millis</name>
|
|
<type>long</type>
|
|
</parameter>
|
|
</method>
|
|
<method>
|
|
<name>Initialize</name>
|
|
<comment>Initialize the LocationRequest with default parameters.
|
|
Default parameters are for a block accuracy, slowly updated location.</comment>
|
|
<returntype>void</returntype>
|
|
</method>
|
|
<method>
|
|
<name>GetNumUpdates</name>
|
|
<comment>Get the number of updates requested.</comment>
|
|
<returntype>int</returntype>
|
|
</method>
|
|
<method>
|
|
<name>GetSmallestDisplacement</name>
|
|
<comment>Get the minimum displacement between location updates in meters.
|
|
By default this is 0.</comment>
|
|
<returntype>float</returntype>
|
|
</method>
|
|
<method>
|
|
<name>GetFastestInterval</name>
|
|
<comment>Get the fastest interval of this request, in milliseconds.</comment>
|
|
<returntype>long</returntype>
|
|
</method>
|
|
<method>
|
|
<name>GetExpirationTime</name>
|
|
<comment>Get the request expiration time, in milliseconds since boot.</comment>
|
|
<returntype>long</returntype>
|
|
</method>
|
|
<method>
|
|
<name>GetPriority</name>
|
|
<comment>Get the quality of the request.</comment>
|
|
<returntype>int</returntype>
|
|
</method>
|
|
<method>
|
|
<name>SetSmallestDisplacement</name>
|
|
<comment>Set the minimum displacement between location updates in meters.
|
|
By default this is 0.</comment>
|
|
<returntype>uk.co.martinpearman.b4a.fusedlocationprovider.LocationRequest</returntype>
|
|
<parameter>
|
|
<name>SmallestDisplacementMeters</name>
|
|
<type>float</type>
|
|
</parameter>
|
|
</method>
|
|
<method>
|
|
<name>GetInterval</name>
|
|
<comment>Get the desired interval of this request, in milliseconds.</comment>
|
|
<returntype>long</returntype>
|
|
</method>
|
|
<method>
|
|
<name>SetInterval</name>
|
|
<comment>Set the desired interval for active location updates, in milliseconds.</comment>
|
|
<returntype>uk.co.martinpearman.b4a.fusedlocationprovider.LocationRequest</returntype>
|
|
<parameter>
|
|
<name>Millis</name>
|
|
<type>long</type>
|
|
</parameter>
|
|
</method>
|
|
<method>
|
|
<name>SetExpirationDuration</name>
|
|
<comment>Set the duration of this request, in milliseconds.</comment>
|
|
<returntype>uk.co.martinpearman.b4a.fusedlocationprovider.LocationRequest</returntype>
|
|
<parameter>
|
|
<name>Millis</name>
|
|
<type>long</type>
|
|
</parameter>
|
|
</method>
|
|
<method>
|
|
<name>SetNumUpdates</name>
|
|
<comment>Set the number of location updates.</comment>
|
|
<returntype>uk.co.martinpearman.b4a.fusedlocationprovider.LocationRequest</returntype>
|
|
<parameter>
|
|
<name>NumUpdates</name>
|
|
<type>int</type>
|
|
</parameter>
|
|
</method>
|
|
<field>
|
|
<name>Priority</name>
|
|
<comment>Contains the various priority constants.</comment>
|
|
<returntype>uk.co.martinpearman.b4a.fusedlocationprovider.LocationRequest.Priority</returntype>
|
|
</field>
|
|
</class>
|
|
<class>
|
|
<name>uk.co.martinpearman.b4a.fusedlocationprovider.LocationRequest.Priority</name>
|
|
<shortname>Priority</shortname>
|
|
<owner>process</owner>
|
|
<field>
|
|
<name>PRIORITY_HIGH_ACCURACY</name>
|
|
<comment>Used with SetPriority(Int) to request the most accurate locations available.</comment>
|
|
<returntype>int</returntype>
|
|
</field>
|
|
<field>
|
|
<name>PRIORITY_LOW_POWER</name>
|
|
<comment>Used with SetPriority(Int) to request "city" level accuracy.</comment>
|
|
<returntype>int</returntype>
|
|
</field>
|
|
<field>
|
|
<name>PRIORITY_NO_POWER</name>
|
|
<comment>Used with SetPriority(Int) to request the best accuracy possible with zero additional power consumption.</comment>
|
|
<returntype>int</returntype>
|
|
</field>
|
|
<field>
|
|
<name>PRIORITY_BALANCED_POWER_ACCURACY</name>
|
|
<comment>Used with SetPriority(Int) to request "block" level accuracy.</comment>
|
|
<returntype>int</returntype>
|
|
</field>
|
|
</class>
|
|
<class>
|
|
<name>uk.co.martinpearman.b4a.fusedlocationprovider.FusedLocationProviderWrapper</name>
|
|
<shortname>FusedLocationProvider</shortname>
|
|
<objectwrapper>uk.co.martinpearman.b4a.fusedlocationprovider.FusedLocationProvider</objectwrapper>
|
|
<owner>process</owner>
|
|
<event>ConnectionFailed(ConnectionResult1 As Int)</event>
|
|
<event>ConnectionSuccess</event>
|
|
<event>ConnectionSuspended(SuspendedCause1 As Int)</event>
|
|
<event>LocationChanged(Location1 As Location)</event>
|
|
<event>LocationSettingsChecked(LocationSettingsResult1 As LocationSettingsResult)</event>
|
|
<method>
|
|
<name>GetLastKnownLocation</name>
|
|
<comment>Returns the best most recent location currently available.
|
|
Can only be called if the FusedLocationProvider is connected.
|
|
The returned Location object will not be initialized if no last known location is available.</comment>
|
|
<returntype>anywheresoftware.b4a.gps.LocationWrapper</returntype>
|
|
</method>
|
|
<method>
|
|
<name>RemoveLocationUpdates</name>
|
|
<comment>Remove all requests for location updates.</comment>
|
|
<returntype>void</returntype>
|
|
</method>
|
|
<method>
|
|
<name>Connect</name>
|
|
<comment>Attempt to connect to the Location Services.
|
|
Will raise either event:
|
|
ConnectionFailed(ConnectionResult1 As Int)
|
|
ConnectionSuccess</comment>
|
|
<returntype>void</returntype>
|
|
</method>
|
|
<method>
|
|
<name>IsInitialized</name>
|
|
<comment></comment>
|
|
<returntype>boolean</returntype>
|
|
</method>
|
|
<method>
|
|
<name>Initialize</name>
|
|
<comment>Initialize the FusedLocationProvider object.</comment>
|
|
<returntype>void</returntype>
|
|
<parameter>
|
|
<name>pBA</name>
|
|
<type>anywheresoftware.b4a.BA</type>
|
|
</parameter>
|
|
<parameter>
|
|
<name>EventName</name>
|
|
<type>java.lang.String</type>
|
|
</parameter>
|
|
</method>
|
|
<method>
|
|
<name>CheckLocationSettings</name>
|
|
<comment>Checks if the relevant system settings are enabled on the device to carry out the desired location requests.
|
|
Raises the event:
|
|
LocationSettingsChecked(LocationSettingsResult1 As LocationSettingsResult)</comment>
|
|
<returntype>void</returntype>
|
|
<parameter>
|
|
<name>LocationSettingsRequest1</name>
|
|
<type>com.google.android.gms.location.LocationSettingsRequest</type>
|
|
</parameter>
|
|
</method>
|
|
<method>
|
|
<name>RequestLocationUpdates</name>
|
|
<comment>Request for location updates.
|
|
The LocationRequest object defines the criteria for which location updates are requested.</comment>
|
|
<returntype>void</returntype>
|
|
<parameter>
|
|
<name>LocationRequest1</name>
|
|
<type>com.google.android.gms.location.LocationRequest</type>
|
|
</parameter>
|
|
</method>
|
|
<method>
|
|
<name>Disconnect</name>
|
|
<comment>Disconnect from the Location Services.</comment>
|
|
<returntype>void</returntype>
|
|
</method>
|
|
<method>
|
|
<name>IsConnecting</name>
|
|
<comment>Returns whether the FusedLocationProvider is trying to connect to the Location Services.</comment>
|
|
<returntype>boolean</returntype>
|
|
</method>
|
|
<method>
|
|
<name>IsConnected</name>
|
|
<comment>Returns whether the FusedLocationProvider is connected to the Location Services.</comment>
|
|
<returntype>boolean</returntype>
|
|
</method>
|
|
<field>
|
|
<name>ConnectionResult</name>
|
|
<comment>Contains the various ConnectionResult constants.</comment>
|
|
<returntype>uk.co.martinpearman.b4a.fusedlocationprovider.FusedLocationProviderWrapper.ConnectionResult</returntype>
|
|
</field>
|
|
<field>
|
|
<name>SuspendedCause</name>
|
|
<comment>Contains the various SuspendedCause constants.</comment>
|
|
<returntype>uk.co.martinpearman.b4a.fusedlocationprovider.FusedLocationProviderWrapper.SuspendedCause</returntype>
|
|
</field>
|
|
</class>
|
|
<class>
|
|
<name>uk.co.martinpearman.b4a.fusedlocationprovider.FusedLocationProviderWrapper.ConnectionResult</name>
|
|
<shortname>ConnectionResult</shortname>
|
|
<owner>process</owner>
|
|
<field>
|
|
<name>SUCCESS</name>
|
|
<comment>The connection was successful.</comment>
|
|
<returntype>int</returntype>
|
|
</field>
|
|
<field>
|
|
<name>INTERNAL_ERROR</name>
|
|
<comment>An internal error occurred.</comment>
|
|
<returntype>int</returntype>
|
|
</field>
|
|
<field>
|
|
<name>RESOLUTION_REQUIRED</name>
|
|
<comment>Completing the connection requires some form of resolution.</comment>
|
|
<returntype>int</returntype>
|
|
</field>
|
|
<field>
|
|
<name>SERVICE_INVALID</name>
|
|
<comment>The version of the Google Play services installed on this device is not authentic.</comment>
|
|
<returntype>int</returntype>
|
|
</field>
|
|
<field>
|
|
<name>CANCELLED</name>
|
|
<comment>The client cancelled the connection by calling Disconnect().</comment>
|
|
<returntype>int</returntype>
|
|
</field>
|
|
<field>
|
|
<name>INVALID_ACCOUNT</name>
|
|
<comment>The client attempted to connect to the service with an invalid account name specified.</comment>
|
|
<returntype>int</returntype>
|
|
</field>
|
|
<field>
|
|
<name>DEVELOPER_ERROR</name>
|
|
<comment>The application is misconfigured.</comment>
|
|
<returntype>int</returntype>
|
|
</field>
|
|
<field>
|
|
<name>SERVICE_MISSING</name>
|
|
<comment>Google Play services is missing on this device.</comment>
|
|
<returntype>int</returntype>
|
|
</field>
|
|
<field>
|
|
<name>LICENSE_CHECK_FAILED</name>
|
|
<comment>The application is not licensed to the user. This error is not recoverable and will be treated as fatal.</comment>
|
|
<returntype>int</returntype>
|
|
</field>
|
|
<field>
|
|
<name>NETWORK_ERROR</name>
|
|
<comment>A network error occurred. Retrying should resolve the problem.</comment>
|
|
<returntype>int</returntype>
|
|
</field>
|
|
<field>
|
|
<name>SERVICE_DISABLED</name>
|
|
<comment>The installed version of Google Play services has been disabled on this device.</comment>
|
|
<returntype>int</returntype>
|
|
</field>
|
|
<field>
|
|
<name>API_UNAVAILABLE</name>
|
|
<comment>One of the API components you attempted to connect to is not available.</comment>
|
|
<returntype>int</returntype>
|
|
</field>
|
|
<field>
|
|
<name>SERVICE_VERSION_UPDATE_REQUIRED</name>
|
|
<comment>The installed version of Google Play services is out of date.</comment>
|
|
<returntype>int</returntype>
|
|
</field>
|
|
<field>
|
|
<name>SIGN_IN_REQUIRED</name>
|
|
<comment>The client attempted to connect to the service but the user is not signed in.</comment>
|
|
<returntype>int</returntype>
|
|
</field>
|
|
</class>
|
|
<class>
|
|
<name>uk.co.martinpearman.b4a.fusedlocationprovider.FusedLocationProviderWrapper.SuspendedCause</name>
|
|
<shortname>SuspendedCause</shortname>
|
|
<owner>process</owner>
|
|
<field>
|
|
<name>CAUSE_NETWORK_LOST</name>
|
|
<comment>A connection suspended cause informing you that a peer device connection was lost.</comment>
|
|
<returntype>int</returntype>
|
|
</field>
|
|
<field>
|
|
<name>CAUSE_SERVICE_DISCONNECTED</name>
|
|
<comment>A connection suspended cause informing that the service has been killed.</comment>
|
|
<returntype>int</returntype>
|
|
</field>
|
|
</class>
|
|
<version>1.31</version>
|
|
<comment>The FusedLocationProvider intelligently manages the underlying location technology and gives you the best location according to your needs.
|
|
https://developer.android.com/google/play-services/location.html
|
|
This library depends on the Google Play Services library, android-support-v4 library and the GPS library.
|
|
The GPS library is required in order to use it's Location object.</comment>
|
|
<author>Martin Pearman</author>
|
|
<dependsOn>android-support-v4</dependsOn>
|
|
<dependsOn>google-play-services</dependsOn>
|
|
<dependsOn>GPS</dependsOn>
|
|
</root>
|