ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
com.adobe.gravity.service.progress 

IProgressReporter  - AS3 ADEP Client Component
Packagecom.adobe.gravity.service.progress
Interfacepublic interface IProgressReporter

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Returned by IProgressService.startOperation() for in-progress operation reporting.


Public Methods
 MethodDefined By
  
endOperation():void
Call this method when the operation is complete.
IProgressReporter
  
progress(current:Number, total:Number, description:String = null):void
Call this method for each progress event.
IProgressReporter
Method Detail

endOperation

()method
public function endOperation():void

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Call this method when the operation is complete.

progress

()method 
public function progress(current:Number, total:Number, description:String = null):void

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Experience Services - Client Component Framework 10
Runtime Versions: AIR 1.1, Flash Player 9

Call this method for each progress event.

Parameters

current:Number — The current progress; for example, if loading a file, this might be the number of bytes loaded so far.
 
total:Number — The maximum value; for example, if loading a file, this might be the total number of bytes in the file.
 
description:String (default = null) — A string describing the current progress to potentially be displayed to an end-user. Can be null.



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy