BaseGoogleLocationClient (Yakhont 0.9.19 API)

java.lang.Object
- akha.yakhont.location.BaseGoogleLocationClient

All Implemented Interfaces:

LocationCallbacks.LocationClient, LocationListener

Direct Known Subclasses:

GoogleLocationClient, GoogleLocationClientNew
```
public abstract class BaseGoogleLocationClient
extends Object
implements LocationCallbacks.LocationClient, LocationListener
```
The base class for clients to work with Google Play Services Location APIs.

See Also:
GoogleLocationClient, GoogleLocationClientNew

Constructor Summary

Constructors
Modifier Constructor and Description

protected BaseGoogleLocationClient()
Initialises a newly created BaseGoogleLocationClient object.

Constructors
Modifier	Constructor and Description
`protected`	`BaseGoogleLocationClient()` Initialises a newly created `BaseGoogleLocationClient` object.

Method Summary

Methods
Modifier and Type	Method and Description
`protected abstract void`	`buildClient(Activity activity)` Builds the client to work with Google Play Services Location APIs.
`LocationRequest`	`createNewLocationRequest()` Creates new `LocationRequest`.
`Location`	`getCurrentLocation()` Please refer to the base method description.
`protected void`	`getFromBundle(Bundle savedInstanceState)` Updates fields based on data stored in the bundle.
`Date`	`getLastUpdateTime()` Please refer to the base method description.
`void`	`onCreate(Activity activity, Bundle savedInstanceState)` Please refer to the base method description.
`void`	`onDestroy(Activity activity)` Please refer to the base method description.
`void`	`onLocationChanged(Location location)` Please refer to the base method description.
`void`	`onPause(Activity activity)` Please refer to the base method description.
`void`	`onResume(Activity activity)` Please refer to the base method description.
`void`	`onSaveInstanceState(Activity activity, Bundle savedInstanceState)` Please refer to the base method description.
`void`	`onStart(Activity activity)` Please refer to the base method description.
`void`	`onStop(Activity activity)` Please refer to the base method description.
`protected void`	`requestLocationUpdates(Activity activity, LocationRequest locationRequest)` Requests location updates.
`protected void`	`setLocation(Location location)` Sets the current location.
`void`	`setLocationCallbacks(LocationCallbacks locationCallbacks)` Please refer to the base method description.
`BaseGoogleLocationClient`	`setLocationUpdatesParameters(boolean requestingLocationUpdates, boolean highAccuracy)` Sets the requesting location updates parameters.
`BaseGoogleLocationClient`	`setLocationUpdatesParameters(boolean requestingLocationUpdates, int priority, long interval, long fastestInterval)` Sets the requesting location updates parameters.
`BaseGoogleLocationClient`	`setLocationUpdatesParameters(boolean requestingLocationUpdates, int priority, long interval, long fastestInterval, Long expirationDuration, Long expirationTime, Long maxWaitTime, Integer numUpdates, Float smallestDisplacement)` Sets the requesting location updates parameters.
`void`	`setUniqueUpdates(boolean value)` Sets the flag indicating whether the location updates callbacks should be called for changed values only.
`protected void`	`startLocationUpdates(Activity activity)` Starts location updates.
`protected void`	`stopLocationUpdates(Activity activity)` Stops location updates.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface akha.yakhont.location.LocationCallbacks.LocationClient
onActivityResult

- Constructor Detail
  - BaseGoogleLocationClient
```
protected BaseGoogleLocationClient()
```
    Initialises a newly created BaseGoogleLocationClient object.
- Method Detail
  - setUniqueUpdates
```
public void setUniqueUpdates(boolean value)
```
    Sets the flag indicating whether the location updates callbacks should be called for changed values only. The default value is true.
    
    Parameters:
    value - true for changed values only location updates, false otherwise
  - getCurrentLocation
```
public Location getCurrentLocation()
```
    Please refer to the base method description.
    
    Specified by:
    
    getCurrentLocation in interface LocationCallbacks.LocationClient
    
    Returns:
    The current location
  - getLastUpdateTime
```
public Date getLastUpdateTime()
```
    Please refer to the base method description.
    
    Specified by:
    
    getLastUpdateTime in interface LocationCallbacks.LocationClient
    
    Returns:
    The last update time
  - setLocationCallbacks
```
public void setLocationCallbacks(LocationCallbacks locationCallbacks)
```
    Please refer to the base method description.
    
    Specified by:
    
    setLocationCallbacks in interface LocationCallbacks.LocationClient
    
    Parameters:
    locationCallbacks - The locationCallbacks
  - onSaveInstanceState
```
@CallSuper
public void onSaveInstanceState(Activity activity,
                                 Bundle savedInstanceState)
```
    Please refer to the base method description.
    
    Specified by:
    
    onSaveInstanceState in interface LocationCallbacks.LocationClient
    
    Parameters:
    activity - The Activity
    savedInstanceState - The last saved instance state of the Activity, or null
  - onCreate
```
@CallSuper
public void onCreate(Activity activity,
                      Bundle savedInstanceState)
```
    Please refer to the base method description.
    
    Specified by:
    
    onCreate in interface LocationCallbacks.LocationClient
    
    Parameters:
    activity - The Activity
    savedInstanceState - The last saved instance state of the Activity, or null
  - onStart
```
public void onStart(Activity activity)
```
    Please refer to the base method description.
    
    Specified by:
    
    onStart in interface LocationCallbacks.LocationClient
    
    Parameters:
    activity - The Activity
  - onResume
```
public void onResume(Activity activity)
```
    Please refer to the base method description.
    
    Specified by:
    
    onResume in interface LocationCallbacks.LocationClient
    
    Parameters:
    activity - The Activity
  - onPause
```
public void onPause(Activity activity)
```
    Please refer to the base method description.
    
    Specified by:
    
    onPause in interface LocationCallbacks.LocationClient
    
    Parameters:
    activity - The Activity
  - onStop
```
public void onStop(Activity activity)
```
    Please refer to the base method description.
    
    Specified by:
    
    onStop in interface LocationCallbacks.LocationClient
    
    Parameters:
    activity - The Activity
  - onDestroy
```
public void onDestroy(Activity activity)
```
    Please refer to the base method description.
    
    Specified by:
    
    onDestroy in interface LocationCallbacks.LocationClient
    
    Parameters:
    activity - The Activity
  - setLocationUpdatesParameters
```
public BaseGoogleLocationClient setLocationUpdatesParameters(boolean requestingLocationUpdates,
                                                    boolean highAccuracy)
```
    Sets the requesting location updates parameters.
    
    Parameters:
    requestingLocationUpdates - true for requesting location updates, false otherwise
    highAccuracy - true for high accuracy location updates, false otherwise
    
    Returns:
    This BaseGoogleLocationClient object, so that setters can be chained
    See Also:
    LocationRequest
  - setLocationUpdatesParameters
```
public BaseGoogleLocationClient setLocationUpdatesParameters(boolean requestingLocationUpdates,
                                                    int priority,
                                                    long interval,
                                                    long fastestInterval)
```
    Sets the requesting location updates parameters.
    
    Parameters:
    requestingLocationUpdates - true for requesting location updates, false otherwise
    priority - Sets the priority of the request
    interval - Sets the desired interval for active location updates, in milliseconds
    fastestInterval - Explicitly sets the fastest interval for location updates, in milliseconds
    
    Returns:
    This BaseGoogleLocationClient object, so that setters can be chained
    See Also:
    LocationRequest
  - setLocationUpdatesParameters
```
public BaseGoogleLocationClient setLocationUpdatesParameters(boolean requestingLocationUpdates,
                                                    int priority,
                                                    long interval,
                                                    long fastestInterval,
                                                    Long expirationDuration,
                                                    Long expirationTime,
                                                    Long maxWaitTime,
                                                    Integer numUpdates,
                                                    Float smallestDisplacement)
```
    Sets the requesting location updates parameters.
    
    Parameters:
    requestingLocationUpdates - true for requesting location updates, false otherwise
    priority - Sets the priority of the request
    interval - Sets the desired interval for active location updates, in milliseconds
    fastestInterval - Explicitly sets the fastest interval for location updates, in milliseconds
    expirationDuration - Sets the duration of this request, in milliseconds
    expirationTime - Sets the request expiration time, in millisecond since boot
    maxWaitTime - Sets the maximum wait time in milliseconds for location updates
    numUpdates - Sets the number of location updates
    smallestDisplacement - Sets the minimum displacement between location updates (in meters)
    
    Returns:
    This BaseGoogleLocationClient object, so that setters can be chained
    See Also:
    LocationRequest
  - getFromBundle
```
@CallSuper
protected void getFromBundle(Bundle savedInstanceState)
```
    Updates fields based on data stored in the bundle.
    
    Parameters:
    savedInstanceState - The activity state saved in the Bundle
  - onLocationChanged
```
public void onLocationChanged(Location location)
```
    Please refer to the base method description.
    
    Specified by:
    
    onLocationChanged in interface LocationListener
  - setLocation
```
protected void setLocation(Location location)
```
    Sets the current location.
    
    Parameters:
    location - The current location
  - buildClient
```
protected abstract void buildClient(@NonNull
               Activity activity)
```
    Builds the client to work with Google Play Services Location APIs.
    
    Parameters:
    activity - The activity
  - createNewLocationRequest
```
public LocationRequest createNewLocationRequest()
```
    Creates new LocationRequest.
    
    Returns:
    The LocationRequest
  - startLocationUpdates
```
protected void startLocationUpdates(@NonNull
                        Activity activity)
```
    Starts location updates.
    
    Parameters:
    activity - The activity
  - requestLocationUpdates
```
protected void requestLocationUpdates(@NonNull
                          Activity activity,
                          @NonNull
                          LocationRequest locationRequest)
```
    Requests location updates.
    
    Parameters:
    activity - The activity
    locationRequest - The LocationRequest
  - stopLocationUpdates
```
protected void stopLocationUpdates(Activity activity)
```
    Stops location updates.
    
    Parameters:
    activity - The activity

Copyright © 2015-2017 akha, a.k.a. Alexander Kharitonov

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Class BaseGoogleLocationClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface akha.yakhont.location.LocationCallbacks.LocationClient

Constructor Detail

BaseGoogleLocationClient

Method Detail

setUniqueUpdates

getCurrentLocation

getLastUpdateTime

setLocationCallbacks

onSaveInstanceState

onCreate

onStart

onResume

onPause

onStop

onDestroy

setLocationUpdatesParameters

setLocationUpdatesParameters

setLocationUpdatesParameters

getFromBundle

onLocationChanged

setLocation

buildClient

createNewLocationRequest

startLocationUpdates

requestLocationUpdates

stopLocationUpdates