qnx.events.WebDownloadFinishedEvent

WebDownloadFinishedEvent

Properties | Methods | Constants


Packageqnx.events
Classpublic class WebDownloadFinishedEvent
InheritanceWebDownloadFinishedEvent Inheritance flash.events.Event

A QNXStageWebView object dispatches a WebDownloadFinishedEvent object when a download operation has completed.

There is only one type of WebDownloadFinishedEvent:

  • WebDownloadFinishedEvent.DOWNLOAD_FINISHED: dispatched when a download is done. Cannot be cancelled.


Class information:
PlayBook Tablet OS Version:   1.0.6

See also

QNXStageWebView



Public Properties

 PropertyDefined By
  downloadId : uint
The identifier of the download.
WebDownloadFinishedEvent
  result : String
The result of the download.
WebDownloadFinishedEvent

Public Methods

 MethodDefined By
  
WebDownloadFinishedEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, downloadId:uint = 0, result:String)
Creates a WebDownloadFinishedEvent object.
WebDownloadFinishedEvent
  
clone():Event
[override] Duplicates an instance of an Event subclass.
WebDownloadFinishedEvent
  
toString():String
[override] Returns a string that contains all the properties of the WebDownloadFinishedEvent object.
WebDownloadFinishedEvent

Public Constants

 ConstantDefined By
  DOWNLOAD_FINISHED : String = downloadFinished
[static] Signals that the download has started.
WebDownloadFinishedEvent
  RESULT_CANCELLED : String = resultCancelled
[static] Signals that the download was cancelled.
WebDownloadFinishedEvent
  RESULT_NETWORK_ERROR : String = resultNetworkError
[static] Signals that the download was cancelled because a network error occurred.
WebDownloadFinishedEvent
  RESULT_SUCCESS : String = resultSuccess
[static] Signals that the download completed successfully.
WebDownloadFinishedEvent

Property Detail

downloadId


downloadId:uint

The identifier of the download. Used to refer to this download in future events and in API calls.


Implementation

public function get downloadId():uint
public function set downloadId(value:uint):void

result


result:String

The result of the download.


Implementation

public function get result():String
public function set result(value:String):void

Constructor Detail

WebDownloadFinishedEvent()


public function WebDownloadFinishedEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, downloadId:uint = 0, result:String)

Creates a WebDownloadFinishedEvent object.

Parameters

type:String
bubbles:Boolean (default = false)
cancelable:Boolean (default = false)
downloadId:uint (default = 0)
result:String

Method Detail

clone()


override public function clone():Event

Duplicates an instance of an Event subclass.

Returns a new Event object that is a copy of the original instance of the Event object. You do not normally call clone(); the EventDispatcher class calls it automatically when you redispatch an event—that is, when you call dispatchEvent(event) from a handler that is handling event.

The new Event object includes all the properties of the original.

When creating your own custom Event class, you must override the inherited Event.clone() method in order for it to duplicate the properties of your custom class. If you do not set all the properties that you add in your event subclass, those properties will not have the correct values when listeners handle the redispatched event.

Returns

Event

toString()


override public function toString():String

Returns a string that contains all the properties of the WebDownloadFinishedEvent object. The string is in the following format:

[WebDownloadFinishedEvent type=value bubbles=value cancelable=value eventPhase=value downloadId=value result=value

Returns

String

Constant Detail

DOWNLOAD_FINISHED


public static const DOWNLOAD_FINISHED:String = downloadFinished

Signals that the download has started.

RESULT_CANCELLED


public static const RESULT_CANCELLED:String = resultCancelled

Signals that the download was cancelled.

RESULT_NETWORK_ERROR


public static const RESULT_NETWORK_ERROR:String = resultNetworkError

Signals that the download was cancelled because a network error occurred.

RESULT_SUCCESS


public static const RESULT_SUCCESS:String = resultSuccess

Signals that the download completed successfully.