Represents the results of work.
Inherited Constant Summary
Field Summary
public static final Creator<Status> | CREATOR |
Public Constructor Summary
Status(int
statusCode)
Creates a representation of the status resulting from a GoogleApiClient
operation.
|
|
Status(int statusCode, String
statusMessage, PendingIntent
pendingIntent)
Creates a representation of the status resulting from a GoogleApiClient
operation.
|
|
Status(ConnectionResult
connectionResult, String
statusMessage)
Creates a failed API call status due to a failure to connect to Google Play
services.
|
Public Method Summary
boolean | |
ConnectionResult |
getConnectionResult()
Returns a failed
ConnectionResult ,
if applicable.
|
PendingIntent |
getResolution()
A pending intent to resolve the failure.
|
Status |
getStatus()
Returns the status of this result.
|
int |
getStatusCode()
Indicates the status of the operation.
|
String |
getStatusMessage()
Returns the
statusMessage
|
boolean |
hasResolution()
Returns true if calling
startResolutionForResult(Activity, int) will start any intents
requiring user interaction.
|
int |
hashCode()
|
boolean |
isCanceled()
Returns true if the operation was canceled.
|
boolean |
isInterrupted()
Returns true if the operation was interrupted.
|
boolean |
isSuccess()
Returns true if the operation was successful.
|
void |
startResolutionForResult(Activity
activity, int requestCode)
Resolves an error by starting any intents requiring user interaction.
|
void |
startResolutionForResult(ActivityResultLauncher<IntentSenderRequest>
activityResultLauncher)
Resolves an error by starting any intents requiring user interaction.
|
String |
toString()
|
void |
writeToParcel(Parcel out, int
flags)
|
Inherited Method Summary
Fields
Public Constructors
public Status (int statusCode)
Creates a representation of the status resulting from a GoogleApiClient operation.
Parameters
statusCode | The status code. |
---|
public Status (int statusCode, String statusMessage)
Creates a representation of the status resulting from a GoogleApiClient operation.
Parameters
statusCode | The status code. |
---|---|
statusMessage | The message associated with this status, or null. |
public Status (int statusCode, String statusMessage, PendingIntent pendingIntent)
Creates a representation of the status resulting from a GoogleApiClient operation.
Parameters
statusCode | The status code. |
---|---|
statusMessage | The message associated with this status, or null. |
pendingIntent | A pending intent that will resolve the issue when started, or null. |
public Status (ConnectionResult connectionResult, String statusMessage)
Creates a failed API call status due to a failure to connect to Google Play services.
Public Methods
public boolean equals (Object obj)
public ConnectionResult getConnectionResult ()
Returns a failed ConnectionResult
,
if applicable.
If the Status
is successful, or the failure was not due to an issue
with the connection to Google Play services, this returns null
.
public PendingIntent getResolution ()
A pending intent to resolve the failure. This intent can be started with
Activity.startIntentSenderForResult(IntentSender, int, Intent, int, int,
int)
to present UI to solve the issue.
Returns
- The pending intent to resolve the failure.
public Status getStatus ()
Returns the status of this result. Use Status.isSuccess()
to determine whether the call was successful, and Status.getStatusCode()
to determine what the error cause was.
Certain errors are due to failures that can be resolved by launching a particular
intent. The resolution intent is available via Status.getResolution()
.
public int getStatusCode ()
Indicates the status of the operation.
Returns
- Status code resulting from the operation. The value is one of the constants in
CommonStatusCodes
or specific to the APIs added to theGoogleApiClient
.
public String getStatusMessage ()
Returns the statusMessage
public boolean hasResolution ()
Returns true if calling
startResolutionForResult(Activity, int)
will start any intents requiring
user interaction.
Returns
- true if there is a resolution that can be started.
public int hashCode ()
public boolean isCanceled ()
Returns true if the operation was canceled.
public boolean isInterrupted ()
Returns true if the operation was interrupted.
public boolean isSuccess ()
Returns true if the operation was successful.
Returns
- true if the operation was successful, false if there was an error.
public void startResolutionForResult (Activity activity, int requestCode)
Resolves an error by starting any intents requiring user interaction. See
CommonStatusCodes.SIGN_IN_REQUIRED
, and
CommonStatusCodes.RESOLUTION_REQUIRED
.
This method follows the
Activity.startActivityForResult(Intent, int)
and
Activity.onActivityResult(int, int, Intent)
API pattern. Consider migrating
to
startResolutionForResult(ActivityResultLauncher)
as the ActivityResultContracts
API is the recommended approach.
Parameters
activity | An Activity context to use to resolve the issue. The activity's
onActivityResult method will be invoked after the user is done. If the resultCode
is Activity.RESULT_OK ,
the application should try to connect again. |
---|---|
requestCode | The request code to pass to onActivityResult. |
Throws
IntentSender.SendIntentException | If the resolution intent has been canceled or is no longer able to execute the request. |
---|
public void startResolutionForResult (ActivityResultLauncher<IntentSenderRequest> activityResultLauncher)
Resolves an error by starting any intents requiring user interaction. See
CommonStatusCodes.SIGN_IN_REQUIRED
, and
CommonStatusCodes.RESOLUTION_REQUIRED
.
Parameters
activityResultLauncher | The ActivityResultLauncher
to invoke when the error resolution, if any, completes. |
---|