Google.
A CustomYieldInstruction used to monitor an ongoing in-app update.
Summary
Inheritance
Inherits from: CustomYieldInstruction
Events |
|
|---|---|
Completed = delegate { }
|
Action< AppUpdateRequest >
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
Implements the CustomYieldInstruction.keepWaiting property so that this request can be yielded on in a coroutine.
|
Protected functions |
|
|---|---|
InvokeCompletedEvent()
|
void
Invokes the Completed event.
|
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
Implements the CustomYieldInstruction.keepWaiting property so that this request can be yielded on in a coroutine.