Stay organized with collections
Save and categorize content based on your preferences.
public abstract class ResultTransform
<R extends Result
, S extends Result
>
Transforms a Result
by making a subsequent API call.
Summary
Public methods
public @ NonNull
Status
onFailure
(@ NonNull
Status
status)
Called when the PendingResult to be transformed returns a failure. Default implementation simply propagates the failure, but subclasses may override for custom failure handling. This method is called on the main thread, unless overridden by setHandler
.
@ WorkerThread
public abstract @ Nullable
PendingResult
<S> onSuccess
(@ NonNull
R result)
Transforms the result of a successful API call. This method is called on a background thread and should not access UI elements.
The result of the transformation. Normally the result of another API call. To shortcut execution and directly yield a failure, return either:
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-31 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-31 UTC."],[[["\u003cp\u003e\u003ccode\u003eResultTransform\u003c/code\u003e enables chaining API calls by transforming the result of one call into a subsequent call.\u003c/p\u003e\n"],["\u003cp\u003eIt provides methods for handling success (\u003ccode\u003eonSuccess\u003c/code\u003e) and failure (\u003ccode\u003eonFailure\u003c/code\u003e) scenarios during the transformation process.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eonSuccess\u003c/code\u003e allows you to define the transformation logic, potentially making another API call based on the initial result.\u003c/p\u003e\n"],["\u003cp\u003eIf errors occur during transformation, \u003ccode\u003ecreateFailedResult\u003c/code\u003e can be used to generate a failed result with a specific status.\u003c/p\u003e\n"]]],["`ResultTransform` is an abstract class that transforms a `Result` by executing a subsequent API call. It offers `onSuccess` to transform a successful API call result on a background thread, returning a `PendingResult`. `createFailedResult` generates a failed result with a given `Status`, for use in `onSuccess` in the case of an error. `onFailure` handles a failure status and returns a transformation status. There is a `ResultTransform()` constructor to initialize the class.\n"],null,["# ResultTransform\n===============\n\n[Kotlin](/android/reference/kotlin/com/google/android/gms/common/api/ResultTransform \"View this page in Kotlin\") \\|Java \n\n\n```\npublic abstract class ResultTransform\u003cR extends Result, S extends Result\u003e\n```\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nTransforms a [Result](/android/reference/com/google/android/gms/common/api/Result) by making a subsequent API call. \n\n| See also |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| [then](/android/reference/com/google/android/gms/common/api/PendingResult#then(com.google.android.gms.common.api.ResultTransform\u003c? super R,? extends S\u003e)) | |\n\nSummary\n-------\n\n| ### Public constructors |\n|---------------------------------------------------------------------------------------------------------------|\n| [ResultTransform](/android/reference/com/google/android/gms/common/api/ResultTransform#ResultTransform())`()` |\n\n| ### Public methods |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `final @`[NonNull](https://developer.android.com/reference/androidx/annotation/NonNull.html)` `[PendingResult](/android/reference/com/google/android/gms/common/api/PendingResult)`\u003cS\u003e` | [createFailedResult](/android/reference/com/google/android/gms/common/api/ResultTransform#createFailedResult(com.google.android.gms.common.api.Status))`(@`[NonNull](https://developer.android.com/reference/androidx/annotation/NonNull.html)` `[Status](/android/reference/com/google/android/gms/common/api/Status)` status)` Creates a failed result with the given [Status](/android/reference/com/google/android/gms/common/api/Status). |\n| `@`[NonNull](https://developer.android.com/reference/androidx/annotation/NonNull.html)` `[Status](/android/reference/com/google/android/gms/common/api/Status) | [onFailure](/android/reference/com/google/android/gms/common/api/ResultTransform#onFailure(com.google.android.gms.common.api.Status))`(@`[NonNull](https://developer.android.com/reference/androidx/annotation/NonNull.html)` `[Status](/android/reference/com/google/android/gms/common/api/Status)` status)` Called when the PendingResult to be transformed returns a failure. |\n| `abstract @`[Nullable](https://developer.android.com/reference/androidx/annotation/Nullable.html)` `[PendingResult](/android/reference/com/google/android/gms/common/api/PendingResult)`\u003cS\u003e` | `@`[WorkerThread](https://developer.android.com/reference/androidx/annotation/WorkerThread.html) [onSuccess](/android/reference/com/google/android/gms/common/api/ResultTransform#onSuccess(R))`(@`[NonNull](https://developer.android.com/reference/androidx/annotation/NonNull.html)` R result)` Transforms the result of a successful API call. |\n\nPublic constructors\n-------------------\n\n### ResultTransform\n\n```\npublic ResultTransform()\n``` \n\nPublic methods\n--------------\n\n### createFailedResult\n\n```\npublic final @NonNull PendingResult\u003cS\u003e createFailedResult(@NonNull Status status)\n```\n\nCreates a failed result with the given [Status](/android/reference/com/google/android/gms/common/api/Status). In the event of an error during [onSuccess](/android/reference/com/google/android/gms/common/api/ResultTransform#onSuccess(R)), call this method and return the failed result.\n\nNote: the [PendingResult](/android/reference/com/google/android/gms/common/api/PendingResult) generated by this method must be returned directly from [onSuccess](/android/reference/com/google/android/gms/common/api/ResultTransform#onSuccess(R)). It is an error to call any methods on this PendingResult. \n\n### onFailure\n\n```\npublic @NonNull Status onFailure(@NonNull Status status)\n```\n\nCalled when the PendingResult to be transformed returns a failure. Default implementation simply propagates the failure, but subclasses may override for custom failure handling. This method is called on the main thread, unless overridden by [setHandler](/android/reference/com/google/android/gms/common/api/GoogleApiClient.Builder#setHandler(android.os.Handler)). \n\n| Parameters |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------|\n| `@`[NonNull](https://developer.android.com/reference/androidx/annotation/NonNull.html)` `[Status](/android/reference/com/google/android/gms/common/api/Status)` status` | The status of the failure. |\n\n| Returns |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------|\n| `@`[NonNull](https://developer.android.com/reference/androidx/annotation/NonNull.html)` `[Status](/android/reference/com/google/android/gms/common/api/Status) | The status of the result of the transformation. Must not be success or null. |\n\n### onSuccess\n\n```\n@WorkerThread\npublic abstract @Nullable PendingResult\u003cS\u003e onSuccess(@NonNull R result)\n```\n\nTransforms the result of a successful API call. This method is called on a background thread and should not access UI elements. \n\n| Parameters |\n|---------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `@`[NonNull](https://developer.android.com/reference/androidx/annotation/NonNull.html)` R result` | The successful result to be transformed. Never null. If this result is it will be automatically released after this transform is applied; it is not necessary to release the result inside onSuccess. It is an error to set callbacks on this result. Any callbacks set on this result will be overridden and will not be called. |\n\n| Returns |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `@`[Nullable](https://developer.android.com/reference/androidx/annotation/Nullable.html)` `[PendingResult](/android/reference/com/google/android/gms/common/api/PendingResult)`\u003cS\u003e` | The result of the transformation. Normally the result of another API call. To shortcut execution and directly yield a failure, return either: - `null`, which is translated into a [Status](/android/reference/com/google/android/gms/common/api/Status) with code [ERROR](/android/reference/com/google/android/gms/common/api/CommonStatusCodes#ERROR()); or - a specific failure created using [createFailedResult](/android/reference/com/google/android/gms/common/api/ResultTransform#createFailedResult(com.google.android.gms.common.api.Status)). |"]]
