SnapshotApi

public interface SnapshotApi

This interface is deprecated.
use getSnapshotClient(Activity)

Deprecated entry point for the Awareness Snapshot API using GoogleApiClient.

The methods must be used in conjunction with a GoogleApiClient instance. For example:

     new GoogleApiClient.Builder(context)
             .addApi(Awareness.API)
             .addConnectionCallbacks(this)
             .addOnConnectionFailedListener(this)
             .build()
 

See Also

• Awareness API Guide

Public Method Summary

abstract PendingResult<BeaconStateResult>	getBeaconState(GoogleApiClient client, Collection<BeaconState.TypeFilter> beaconTypes) This method is deprecated. use getBeaconState(BeaconState.TypeFilter...).
abstract PendingResult<BeaconStateResult>	getBeaconState(GoogleApiClient client, TypeFilter... beaconTypes) This method is deprecated. use getBeaconState(BeaconState.TypeFilter...).
abstract PendingResult<DetectedActivityResult>	getDetectedActivity(GoogleApiClient client) This method is deprecated. use getDetectedActivity().
abstract PendingResult<HeadphoneStateResult>	getHeadphoneState(GoogleApiClient client) This method is deprecated. use getHeadphoneState().
abstract PendingResult<LocationResult>	getLocation(GoogleApiClient client) This method is deprecated. use getLocation().
abstract PendingResult<PlacesResult>	getPlaces(GoogleApiClient client) This method is deprecated. This method is deprecated as of August 07, 2019, and will be turned off by October 30, 2019. Continued use of these signals is restricted to customers with existing implementations, through October 30, 2019. New implementations must use the Places SDK for Android instead of the Places contextual signal.
abstract PendingResult<TimeIntervalsResult>	getTimeIntervals(GoogleApiClient client) This method is deprecated. use getTimeIntervals().
abstract PendingResult<WeatherResult>	getWeather(GoogleApiClient client) This method is deprecated. This method is deprecated as of August 07, 2019, and will be turned off on January 31, 2020. Google does not offer alternate functionality for the Weather contextual signal.

Public Methods

public abstract PendingResult<BeaconStateResult> getBeaconState (GoogleApiClient client, Collection<BeaconState.TypeFilter> beaconTypes)

This method is deprecated.
use getBeaconState(BeaconState.TypeFilter...).

Get the current information about nearby beacons. Note that beacon snapshots are only available on devices running API level 18 or higher. If calling from a device running API level 17 or earlier, getStatus() will return status code API_NOT_AVAILABLE.

To use this method, your app must declare the android.permission.ACCESS_FINE_LOCATION permission in AndroidManifest.xml, and the user must provide consent at runtime.

Parameters

client	A GoogleApiClient instance.
beaconTypes	The types of beacon attachments to return. See Beacons for details about beacon attachments.

Returns

• a PendingResult with BeaconStateResult. Check the status via getStatus() to determine success or failure. If successful, use getBeaconState() to get data on the nearby beacons.

Throws

SecurityException	Thrown if a required permission is missing.

public abstract PendingResult<BeaconStateResult> getBeaconState (GoogleApiClient client, TypeFilter... beaconTypes)

This method is deprecated.
use getBeaconState(BeaconState.TypeFilter...).

Get the current information about nearby beacons. Note that beacon snapshots are only available on API level 18 or higher. If calling from a device prior to API level 18, getStatus() will return status code API_NOT_AVAILABLE.

To use this method, your app must declare the android.permission.ACCESS_FINE_LOCATION permission in AndroidManifest.xml, and the user must provide consent at runtime.

Parameters

client	A GoogleApiClient instance.
beaconTypes	The types of beacon attachments to return. See Beacons for details about beacon attachments.

Returns

• a PendingResult with BeaconStateResult. Check the status via getStatus() to determine success or failure. If successful, use getBeaconState() to get data on the nearby beacons.

Throws

SecurityException	Thrown if a required permission is missing.

public abstract PendingResult<DetectedActivityResult> getDetectedActivity (GoogleApiClient client)

This method is deprecated.
use getDetectedActivity().

Get the user's current activity (e.g., running, walking, biking, driving, etc.).

To use this method, your app must declare the com.google.android.gms.permission.ACTIVITY_RECOGNITION permission in AndroidManifest.xml, and the user must provide consent at runtime.

Parameters

client	A GoogleApiClient instance.

Returns

• a PendingResult with DetectedActivityResult. Check the status via getStatus() to determine success or failure. If successful, then use getActivityRecognitionResult() to get the current activity.

Throws

SecurityException	Thrown if a required permission is missing.

public abstract PendingResult<HeadphoneStateResult> getHeadphoneState (GoogleApiClient client)

This method is deprecated.
use getHeadphoneState().

Report whether headphones are plugged into the device.

Parameters

client	A GoogleApiClient instance.

Returns

• a PendingResult with HeadphoneStateResult. Check the status via getStatus() to determine success or failure. If successful, use getHeadphoneState() to get the current headphone state.

public abstract PendingResult<LocationResult> getLocation (GoogleApiClient client)

This method is deprecated.
use getLocation().

Get the device's current location (lat/lng).

To use this method, your app must declare the android.permission.ACCESS_FINE_LOCATION permission in AndroidManifest.xml, and the user must provide consent at runtime.

Parameters

client	A GoogleApiClient instance.

Returns

• a PendingResult with LocationResult. Check the status via getStatus() to determine success or failure. If successful, then use getLocation() to get the current device location.

Throws

SecurityException	Thrown if a required permission is missing.

public abstract PendingResult<PlacesResult> getPlaces (GoogleApiClient client)

This method is deprecated.
This method is deprecated as of August 07, 2019, and will be turned off by October 30, 2019. Continued use of these signals is restricted to customers with existing implementations, through October 30, 2019. New implementations must use the Places SDK for Android instead of the Places contextual signal.

Get the device's current semantic location, or "place", which can include a name, place type, and address.

To use this method, your app must declare the android.permission.ACCESS_FINE_LOCATION permission in AndroidManifest.xml, and the user must provide consent at runtime.

Parameters

client	A GoogleApiClient instance.

Returns

• a PendingResult with PlacesResult. Check the status via getStatus() to determine success or failure. If successful, then use getPlaceLikelihoods() to get the current place information.

Throws

SecurityException	Thrown if a required permission is missing.

public abstract PendingResult<TimeIntervalsResult> getTimeIntervals (GoogleApiClient client)

This method is deprecated.
use getTimeIntervals().

Get the semantic time intervals for the to the current time and location. As examples, some attributes are: TIME_INTERVAL_MORNING, TIME_INTERVAL_AFTERNOON, TIME_INTERVAL_EVENING, TIME_INTERVAL_NIGHT, TIME_INTERVAL_WEEKDAY, TIME_INTERVAL_WEEKEND, TIME_INTERVAL_HOLIDAY.

To use this method, your app must declare the android.permission.ACCESS_FINE_LOCATION permission in AndroidManifest.xml, and the user must provide consent at runtime.

Parameters

client	A GoogleApiClient instance.

Returns

• a PendingResult with TimeIntervalsResult. Check the status via getStatus() to determine success or failure. If successful, then use getTimeIntervals() to get the attributes of the current day and time.

Throws

SecurityException	Thrown if a required permission is missing.

public abstract PendingResult<WeatherResult> getWeather (GoogleApiClient client)

This method is deprecated.
This method is deprecated as of August 07, 2019, and will be turned off on January 31, 2020. Google does not offer alternate functionality for the Weather contextual signal.

Get the current weather conditions (temperature, feels-like temperature, dewpoint, humidity, etc.) at the current device location.

To use this method, your app must declare the android.permission.ACCESS_FINE_LOCATION permission in AndroidManifest.xml, and the user must provide consent at runtime.

Parameters

client	A GoogleApiClient instance.

Returns

• a PendingResult with WeatherResult. Check the status via getStatus() to determine success or failure. If successful, then use getWeather() to get the current weather state.

Throws

SecurityException	Thrown if a required permission is missing.