Stay organized with collections
Save and categorize content based on your preferences.
Google.Play.AppUpdate.AppUpdateRequest
A CustomYieldInstruction used to monitor an ongoing in-app update.
Summary
Inheritance
Inherits from: CustomYieldInstruction
Events
|
Completed = delegate { }
|
Event indicating that the request has completed.
|
Properties
|
BytesDownloaded
|
ulong
Returns the total number of bytes already downloaded for the update.
|
DownloadProgress
|
float
Returns a value between 0 and 1 indicating the overall download progress of a flexible update flow.
|
Error
|
Returns the error that prevented this request from completing successfully.
|
IsDone
|
bool
Returns true if this request has finished, false otherwise.
|
Status
|
Returns the status of this request, for example AppUpdateStatus.Pending.
|
TotalBytesToDownload
|
ulong
Returns the total number of bytes to download for the update.
|
keepWaiting
|
override bool
|
Events
Completed
Action< AppUpdateRequest > Completed = delegate { }
Event indicating that the request has completed.
If an event handler is registered after the operation has completed, and thus after this event has been invoked, then the handler will be called synchronously.
Properties
BytesDownloaded
ulong BytesDownloaded
Returns the total number of bytes already downloaded for the update.
DownloadProgress
float DownloadProgress
Returns a value between 0 and 1 indicating the overall download progress of a flexible update flow.
Note: If this value is 1, it doesn't mean that the update has completed, only that the Downloading stage has finished.
Note: always returns 0 for an immediate update flow.
Error
AppUpdateErrorCode Error
Returns the error that prevented this request from completing successfully.
This will be AppUpdateErrorCode.NoError in the case of a pending request or a successful update.
IsDone
bool IsDone
Returns true if this request has finished, false otherwise.
Status
AppUpdateStatus Status
Returns the status of this request, for example AppUpdateStatus.Pending.
This will be AppUpdateStatus.Failed if an error occurred.
TotalBytesToDownload
ulong TotalBytesToDownload
Returns the total number of bytes to download for the update.
keepWaiting
override bool keepWaiting
Protected functions
InvokeCompletedEvent
void InvokeCompletedEvent()
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2021-03-29 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 2021-03-29 UTC."],[],[],null,["# Google.Play.AppUpdate.AppUpdateRequest Class Reference\n\nGoogle.Play.AppUpdate.AppUpdateRequest\n======================================\n\nA [CustomYieldInstruction](https://docs.unity3d.com/ScriptReference/CustomYieldInstruction.html) used to monitor an ongoing in-app update.\n\nSummary\n-------\n\n### Inheritance\n\nInherits from: CustomYieldInstruction\n\n| ### Events ||\n|------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [Completed](#classGoogle_1_1Play_1_1AppUpdate_1_1AppUpdateRequest_1a49f76fffbebe0d59be801acdc07e0163)` = delegate { }` | `Action\u003c `[AppUpdateRequest](/reference/unity/class/Google/Play/AppUpdate/AppUpdateRequest#classGoogle_1_1Play_1_1AppUpdate_1_1AppUpdateRequest)` \u003e` Event indicating that the request has completed. |\n\n| ### Properties ||\n|------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [BytesDownloaded](#classGoogle_1_1Play_1_1AppUpdate_1_1AppUpdateRequest_1a2af4b706265de176b7e4b97dc5e24c77) | `ulong` Returns the total number of bytes already downloaded for the update. |\n| [DownloadProgress](#classGoogle_1_1Play_1_1AppUpdate_1_1AppUpdateRequest_1a6da9752dd14e55004dcd3556471f4d83) | `float` Returns a value between 0 and 1 indicating the overall download progress of a flexible update flow. |\n| [Error](#classGoogle_1_1Play_1_1AppUpdate_1_1AppUpdateRequest_1a48d3affb41acea36c81a25be097c244e) | [AppUpdateErrorCode](/reference/unity/namespace/Google/Play/AppUpdate#namespaceGoogle_1_1Play_1_1AppUpdate_1a2efd4be14a91cfac4e689974efaad205) Returns the error that prevented this request from completing successfully. |\n| [IsDone](#classGoogle_1_1Play_1_1AppUpdate_1_1AppUpdateRequest_1a4f50b4aef39b8c0629b84a3dd607dfcf) | `bool` Returns true if this request has finished, false otherwise. |\n| [Status](#classGoogle_1_1Play_1_1AppUpdate_1_1AppUpdateRequest_1a34779e2a2f205994356801d4ed4c8201) | [AppUpdateStatus](/reference/unity/namespace/Google/Play/AppUpdate#namespaceGoogle_1_1Play_1_1AppUpdate_1a2b21b28507548425a6bd61d49d04a08a) Returns the status of this request, for example AppUpdateStatus.Pending. |\n| [TotalBytesToDownload](#classGoogle_1_1Play_1_1AppUpdate_1_1AppUpdateRequest_1a535db5cdcd437633df86a52a9a726a96) | `ulong` Returns the total number of bytes to download for the update. |\n| [keepWaiting](#classGoogle_1_1Play_1_1AppUpdate_1_1AppUpdateRequest_1a1fc586754b3ea0ad5f1a27388e26d3ef) | `override bool` Implements the [CustomYieldInstruction.keepWaiting](https://docs.unity3d.com/ScriptReference/CustomYieldInstruction-keepWaiting.html) property so that this request can be yielded on in a coroutine. |\n\n| ### Protected functions ||\n|----------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [InvokeCompletedEvent](#classGoogle_1_1Play_1_1AppUpdate_1_1AppUpdateRequest_1a5dd79b39652d46c674d140639d8d9e9b)`()` | `void` Invokes the [Completed](/reference/unity/class/Google/Play/AppUpdate/AppUpdateRequest#classGoogle_1_1Play_1_1AppUpdate_1_1AppUpdateRequest_1a49f76fffbebe0d59be801acdc07e0163) event. |\n\nEvents\n------\n\n### Completed\n\n```c#\nAction\u003c AppUpdateRequest \u003e Completed = delegate { }\n``` \nEvent indicating that the request has completed.\n\nIf an event handler is registered after the operation has completed, and thus after this event has been invoked, then the handler will be called synchronously.\n\nProperties\n----------\n\n### BytesDownloaded\n\n```c#\nulong BytesDownloaded\n``` \nReturns the total number of bytes already downloaded for the update. \n\n### DownloadProgress\n\n```c#\nfloat DownloadProgress\n``` \nReturns a value between 0 and 1 indicating the overall download progress of a flexible update flow.\n\nNote: If this value is 1, it doesn't mean that the update has completed, only that the Downloading stage has finished.\n\nNote: always returns 0 for an immediate update flow. \n\n### Error\n\n```c#\nAppUpdateErrorCode Error\n``` \nReturns the error that prevented this request from completing successfully.\n\nThis will be AppUpdateErrorCode.NoError in the case of a pending request or a successful update. \n\n### IsDone\n\n```c#\nbool IsDone\n``` \nReturns true if this request has finished, false otherwise. \n\n### Status\n\n```c#\nAppUpdateStatus Status\n``` \nReturns the status of this request, for example AppUpdateStatus.Pending.\n\nThis will be AppUpdateStatus.Failed if an error occurred. \n\n### TotalBytesToDownload\n\n```c#\nulong TotalBytesToDownload\n``` \nReturns the total number of bytes to download for the update. \n\n### keepWaiting\n\n```c#\noverride bool keepWaiting\n``` \nImplements the [CustomYieldInstruction.keepWaiting](https://docs.unity3d.com/ScriptReference/CustomYieldInstruction-keepWaiting.html) property so that this request can be yielded on in a coroutine.\n\nProtected functions\n-------------------\n\n### InvokeCompletedEvent\n\n```c#\nvoid InvokeCompletedEvent()\n``` \nInvokes the [Completed](/reference/unity/class/Google/Play/AppUpdate/AppUpdateRequest#classGoogle_1_1Play_1_1AppUpdate_1_1AppUpdateRequest_1a49f76fffbebe0d59be801acdc07e0163) event."]]
