Class: OfflineProgressUpdateEventProxy¶
Provides event data for OnOfflineProgressUpdate.
Hierarchy¶
-
OfflineProgressUpdateEventProxy
Implements¶
Summary¶
Constructors¶
Properties¶
Class Properties¶
Currently none in this class.
Inherited Properties¶
Currently none inherited from the parent class(es).
Accessors¶
Class Accessors¶
Inherited Accessors¶
Methods¶
Class Methods¶
Currently none in this class.
Inherited Methods¶
Currently none inherited from the parent class(es).
Constructors¶
Constructor¶
+ new OfflineProgressUpdateEventProxy(params: any): OfflineProgressUpdateEventProxy
Overrides EventDataProxy.constructor
Parameters:
| Name | Type |
|---|---|
| params | any |
Returns: OfflineProgressUpdateEventProxy
Accessors¶
currentStepNumber¶
Get Signature¶
▸ getter
Retrieves the current step number.
Example¶
const current = context.getEventData().currentStepNumber; // e.g. 3
Returns¶
number
Retrieves the current step number.
Implementation of IOfflineProgressUpdateEventData.currentStepNumber
message¶
Get Signature¶
▸ getter
Retrieves the progress message.
Example¶
const msg = context.getEventData().message; // e.g. 'Downloading data...'
Returns¶
string
Retrieves the progress message.
Implementation of IOfflineProgressUpdateEventData.message
messageParam1¶
Get Signature¶
▸ getter
Retrieves the first message parameter.
Example¶
const param1 = context.getEventData().messageParam1;
Returns¶
any
Retrieves the first message parameter.
Implementation of IOfflineProgressUpdateEventData.messageParam1
messageParam2¶
Get Signature¶
▸ getter
Retrieves the second message parameter.
Example¶
const param2 = context.getEventData().messageParam2;
Returns¶
any
Retrieves the second message parameter.
Implementation of IOfflineProgressUpdateEventData.messageParam2
step¶
Get Signature¶
▸ getter
Retrieves the current step name.
Example¶
const step = context.getEventData().step; // e.g. 'DownloadingEntityStore'
Returns¶
string
Retrieves the current step name.
Implementation of IOfflineProgressUpdateEventData.step
totalStep¶
Get Signature¶
▸ getter
Retrieves the total number of steps.
Example¶
const total = context.getEventData().totalStep; // e.g. 10
Returns¶
number
Retrieves the total number of steps.
Implementation of IOfflineProgressUpdateEventData.totalStep