ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
flash.events 

DRMReturnVoucherErrorEvent  - AS3

Packageflash.events
Classpublic class DRMReturnVoucherErrorEvent
InheritanceDRMReturnVoucherErrorEvent Inheritance ErrorEvent Inheritance TextEvent Inheritance Event Inheritance Object

Language Version: ActionScript 3.0
Runtime Versions: AIR 3.8, Flash Player 11.8

The DRMManager dispatches a DRMReturnVoucherErrorEvent object when a call to the returnVoucher() method of the DRMManager object fails.



Public Properties
 PropertyDefined By
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
[read-only] Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcurrentTarget : Object
[read-only] The object that is actively processing the Event object with an event listener.
Event
 InheritederrorID : int
[read-only] Contains the reference number associated with the specific error.
ErrorEvent
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
  licenseID : String
The license ID that was passed into the returnVoucher() call that resulted in this error.
DRMReturnVoucherErrorEvent
  policyID : String
The policy ID that was passed into the returnVoucher() call that resulted in this error.
DRMReturnVoucherErrorEvent
  serverURL : String
The URL of the media rights server for this return Voucher attempt.
DRMReturnVoucherErrorEvent
  subErrorID : int
A more detailed error code.
DRMReturnVoucherErrorEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtext : String
For a textInput event, the character or sequence of characters entered by the user.
TextEvent
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
DRMReturnVoucherErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, inDetail:String = "", inErrorID:int = 0, inSubErrorID:int = 0, inServerURL:String = null, inLicenseID:String = null, inPolicyID:String = null)
Creates a new instance of a DRMReturnVoucherErrorEvent object.
DRMReturnVoucherErrorEvent
  
[override] Creates a copy of the ErrorEvent object and sets the value of each property to match that of the original.
DRMReturnVoucherErrorEvent
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
[override] Returns a string that contains all the properties of the ErrorEvent object.
ErrorEvent
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  RETURN_VOUCHER_ERROR : String = "returnVoucherError"
[static] The string constant to use for the return voucher error event in the type parameter when adding and removing event listeners.
DRMReturnVoucherErrorEvent
Property Detail

licenseID

property
licenseID:String

Language Version: ActionScript 3.0
Runtime Versions: AIR 3.8, Flash Player 11.8

The license ID that was passed into the returnVoucher() call that resulted in this error.



Implementation
    public function get licenseID():String
    public function set licenseID(value:String):void

policyID

property 
policyID:String

Language Version: ActionScript 3.0
Runtime Versions: AIR 3.8, Flash Player 11.8

The policy ID that was passed into the returnVoucher() call that resulted in this error.



Implementation
    public function get policyID():String
    public function set policyID(value:String):void

serverURL

property 
serverURL:String

Language Version: ActionScript 3.0
Runtime Versions: AIR 3.8, Flash Player 11.8

The URL of the media rights server for this return Voucher attempt.



Implementation
    public function get serverURL():String
    public function set serverURL(value:String):void

subErrorID

property 
subErrorID:int

Language Version: ActionScript 3.0
Runtime Versions: AIR 3.8, Flash Player 11.8

A more detailed error code.



Implementation
    public function get subErrorID():int
    public function set subErrorID(value:int):void
Constructor Detail

DRMReturnVoucherErrorEvent

()Constructor
public function DRMReturnVoucherErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, inDetail:String = "", inErrorID:int = 0, inSubErrorID:int = 0, inServerURL:String = null, inLicenseID:String = null, inPolicyID:String = null)

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.5, Flash Player 10.1

Creates a new instance of a DRMReturnVoucherErrorEvent object.

Parameters
type:String — the event type string
 
bubbles:Boolean (default = false) — whether the event bubbles up the display list
 
cancelable:Boolean (default = false) — whether the event can be canceled
 
inDetail:String (default = "") — The error description
 
inErrorID:int (default = 0) — The ID of the general type of error
 
inSubErrorID:int (default = 0) — The ID indicating the specific error within its type
 
inServerURL:String (default = null) — the URL of the logged-in server
 
inLicenseID:String (default = null) — the authenticated domain on the logged-in server
 
inPolicyID:String (default = null)
Method Detail

clone

()method
override public function clone():Event

Creates a copy of the ErrorEvent object and sets the value of each property to match that of the original.

Returns
Event — A new ErrorEvent object with property values that match those of the original.
Constant Detail

RETURN_VOUCHER_ERROR

Constant
public static const RETURN_VOUCHER_ERROR:String = "returnVoucherError"

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.5, Flash Player 10.1

The string constant to use for the return voucher error event in the type parameter when adding and removing event listeners.