java.lang.Object | |
↳ | com.google.android.gms.common.GoogleApiAvailability |
Helper class for verifying that the Google Play services APK is available and up-to-date on this device.
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
String | GOOGLE_PLAY_SERVICES_PACKAGE | Package name for Google Play services. |
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
GOOGLE_PLAY_SERVICES_VERSION_CODE | Google Play services client library version (declared in library's AndroidManifest.xml android:versionCode). |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Checks the availability of the specified APIs.
| |||||||||||
Returns a dialog to address the provided errorCode.
| |||||||||||
Returns a dialog to address the provided errorCode.
| |||||||||||
Returns a PendingIntent to address the provided connection failure.
| |||||||||||
Returns a PendingIntent to address the provided errorCode.
| |||||||||||
Returns a human-readable string of the error code returned from isGooglePlayServicesAvailable(Context).
| |||||||||||
Returns the singleton instance of GoogleApiAvailability.
| |||||||||||
Verifies that Google Play services is installed and enabled on this device, and that the
version installed on this device is no older than the one required by this client.
| |||||||||||
Verifies that Google Play services is installed and enabled on this device, and that the
version installed on this device is no older than the one required by this client or the
version is not older than the one specified in
minApkVersion . | |||||||||||
Determines whether an error can be resolved via user action.
| |||||||||||
Attempts to make Google Play services available on this device.
| |||||||||||
Overrides the default notification channel for Google Play services availability notifications.
| |||||||||||
Displays a DialogFragment for an error code returned by
isGooglePlayServicesAvailable(Context) . | |||||||||||
Displays a DialogFragment for an error code returned by
isGooglePlayServicesAvailable(Context) . | |||||||||||
Displays a notification for an error code returned from
isGooglePlayServicesAvailable(Context) , if it is resolvable by the user. | |||||||||||
Displays a notification for a connection failure, if it is resolvable by the user.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Package name for Google Play services.
Google Play services client library version (declared in library's AndroidManifest.xml android:versionCode).
Checks the availability of the specified APIs.
If at least one of the APIs is unavailable, the task will fail with a AvailabilityException
, which can be queried for individual API availability.
Parameters | |
---|---|
api |
GoogleApi |
apis |
GoogleApi |
Returns | |
---|---|
Task<Void> |
See also:
Returns a dialog to address the provided errorCode. The returned dialog displays a localized message about the error and upon user confirmation (by tapping on dialog) will direct them to the Play Store if Google Play services is out of date or missing, or to system settings if Google Play services is disabled on the device.
Parameters | |
---|---|
activity |
Activity : parent activity for creating the dialog, also used for identifying language to
display dialog in. |
errorCode |
int : error code returned by isGooglePlayServicesAvailable(Context) call.
If errorCode is SUCCESS then null is returned. |
requestCode |
int : The requestCode given when calling startActivityForResult.
|
Returns | |
---|---|
Dialog |
Returns a dialog to address the provided errorCode. The returned dialog displays a localized message about the error and upon user confirmation (by tapping on dialog) will direct them to the Play Store if Google Play services is out of date or missing, or to system settings if Google Play services is disabled on the device.
Parameters | |
---|---|
activity |
Activity : parent activity for creating the dialog, also used for identifying language to
display dialog in. |
errorCode |
int : error code returned by isGooglePlayServicesAvailable(Context) call.
If errorCode is SUCCESS then null is returned. |
requestCode |
int : The requestCode given when calling startActivityForResult. |
cancelListener |
DialogInterface.OnCancelListener : The DialogInterface.OnCancelListener to invoke if
the dialog is canceled.
|
Returns | |
---|---|
Dialog |
Returns a PendingIntent to address the provided connection failure.
If hasResolution()
is true, then getResolution()
will be returned. Otherwise, the returned PendingIntent will
direct the user to either the Play Store if Google Play services is out of date or missing, or
system settings if Google Play services is disabled on the device.
Parameters | |
---|---|
context |
Context : parent context for creating the PendingIntent. |
result |
ConnectionResult : the connection failure. If successful or the error is not resolvable by the user,
null is returned.
|
Returns | |
---|---|
PendingIntent |
Returns a PendingIntent to address the provided errorCode. It will direct the user to either the Play Store if Google Play services is out of date or missing, or system settings if Google Play services is disabled on the device.
Parameters | |
---|---|
context |
Context : parent context for creating the PendingIntent. |
errorCode |
int : error code returned by isGooglePlayServicesAvailable(Context) call.
If errorCode is SUCCESS then null is returned. |
requestCode |
int : The requestCode given when calling startActivityForResult.
|
Returns | |
---|---|
PendingIntent |
Returns a human-readable string of the error code returned from isGooglePlayServicesAvailable(Context).
Parameters | |
---|---|
errorCode |
int |
Returns | |
---|---|
String |
Returns the singleton instance of GoogleApiAvailability.
Returns | |
---|---|
GoogleApiAvailability |
Verifies that Google Play services is installed and enabled on this device, and that the version installed on this device is no older than the one required by this client.
Parameters | |
---|---|
context |
Context |
Returns | |
---|---|
int |
status code indicating whether there was an error. Can be one of following in ConnectionResult : SUCCESS, SERVICE_MISSING, SERVICE_UPDATING,
SERVICE_VERSION_UPDATE_REQUIRED, SERVICE_DISABLED, SERVICE_INVALID
|
Verifies that Google Play services is installed and enabled on this device, and that the
version installed on this device is no older than the one required by this client or the
version is not older than the one specified in minApkVersion
.
Parameters | |
---|---|
context |
Context |
minApkVersion |
int |
Returns | |
---|---|
int |
status code indicating whether there was an error. Can be one of following in ConnectionResult : SUCCESS, SERVICE_MISSING, SERVICE_UPDATING,
SERVICE_VERSION_UPDATE_REQUIRED, SERVICE_DISABLED, SERVICE_INVALID
|
Determines whether an error can be resolved via user action. If true, proceed by calling getErrorDialog(Activity, int, int)
and showing the dialog.
Parameters | |
---|---|
errorCode |
int : error code returned by isGooglePlayServicesAvailable(Context) , or
returned to your application via #onConnectionFailed(ConnectionResult) |
Returns | |
---|---|
boolean |
true if the error is resolvable with getErrorDialog(Activity, int, int)
|
Attempts to make Google Play services available on this device. If Play Services is already
available, the returned Task
may complete immediately.
If it is necessary to display UI in order to complete this request (e.g. sending the user to
the Google Play store) the passed Activity
will be used to display this UI.
It is recommended to call this method from onCreate(Bundle)
. If the passed
Activity
completes before the returned Task
completes, the Task will fail with
a CancellationException
.
This method must be called from the main thread.
Parameters | |
---|---|
activity |
Activity |
Returns | |
---|---|
Task<Void> |
A Task . If this Task completes without throwing an exception, Play Services is
available on this device.
|
Overrides the default notification channel for Google Play services availability notifications.
It is required to register a NotificationChannel
with the notificationChannelId
in NotificationManager
before calling this method. If the NotificationChannel
is not registered AND the platform is at least Android O, then a NullPointerException
will be thrown.
Parameters | |
---|---|
context |
Context : The calling context for setting the notification channel. |
notificationChannelId |
String : The notification channel for Google Play services availability
notifications
|
Displays a DialogFragment for an error code returned by isGooglePlayServicesAvailable(Context)
.
Parameters | |
---|---|
activity |
Activity : parent activity for creating the dialog, also used for identifying language to
display dialog in. |
errorCode |
int : error code returned by isGooglePlayServicesAvailable(Context) call.
If errorCode is SUCCESS then this does nothing. |
requestCode |
int : The requestCode given when calling startActivityForResult. |
Returns | |
---|---|
boolean |
true if the dialog is shown, false otherwise |
Displays a DialogFragment for an error code returned by isGooglePlayServicesAvailable(Context)
.
Parameters | |
---|---|
activity |
Activity : parent activity for creating the dialog, also used for identifying language to
display dialog in. |
errorCode |
int : error code returned by isGooglePlayServicesAvailable(Context) call.
If errorCode is SUCCESS then this does nothing |
requestCode |
int : The requestCode given when calling startActivityForResult. |
cancelListener |
DialogInterface.OnCancelListener : The DialogInterface.OnCancelListener to invoke if
the dialog is canceled. |
Returns | |
---|---|
boolean |
true if the dialog is shown, false otherwise. |
Displays a notification for an error code returned from isGooglePlayServicesAvailable(Context)
, if it is resolvable by the user.
This method is similar to getErrorDialog(Activity, int, int)
, but is provided for
background tasks that cannot or should not display dialogs.
Parameters | |
---|---|
context |
Context : The calling context for displaying the notification. |
errorCode |
int : Error code returned by isGooglePlayServicesAvailable(Context) . For
other values, including SUCCESS , no notification is shown.
|
Displays a notification for a connection failure, if it is resolvable by the user.
Parameters | |
---|---|
context |
Context : The calling context used to display the notification. |
result |
ConnectionResult : The connection failure. If successful or the error is not resolvable by the user,
no notification is shown.
|