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

DRMReturnVoucherCompleteEvent  - AS3

Packageflash.events
Classpublic class DRMReturnVoucherCompleteEvent
InheritanceDRMReturnVoucherCompleteEvent Inheritance Event Inheritance Object

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

The DRMManager dispatches a DRMVoucherReturnCompleteEvent object when a call to the returnVoucher() method of the DRMManager object succeeds.



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
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
  licenseID : String
The license ID that was passed into the DRMManager.returnVoucher() call.
DRMReturnVoucherCompleteEvent
  numberOfVouchersReturned : int
The number of vouchers that matches the criterion passed into DRMManager.returnVoucher() and subsequently returned.
DRMReturnVoucherCompleteEvent
  policyID : String
The policyID that was passed into the DRMManager.returnVoucher() call.
DRMReturnVoucherCompleteEvent
  serverURL : String
The URL of the media rights server.
DRMReturnVoucherCompleteEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
DRMReturnVoucherCompleteEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, inServerURL:String = null, inLicenseID:String = null, inPolicyID:String = null, inNumberOfVouchersReturned:int = 0)
Creates a new instance of a DRMReturnVoucherCompleteEvent object.
DRMReturnVoucherCompleteEvent
  
[override] Duplicates an instance of an Event subclass.
DRMReturnVoucherCompleteEvent
 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
Returns a string containing all the properties of the Event object.
Event
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  RETURN_VOUCHER_COMPLETE : String = "returnVoucherComplete"
[static] The string constant to use for the return voucher complete event in the type parameter when adding and removing event listeners.
DRMReturnVoucherCompleteEvent
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 DRMManager.returnVoucher() call.



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

numberOfVouchersReturned

property 
numberOfVouchersReturned:int

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

The number of vouchers that matches the criterion passed into DRMManager.returnVoucher() and subsequently returned.



Implementation
    public function get numberOfVouchersReturned():int
    public function set numberOfVouchersReturned(value:int):void

Related API Elements

policyID

property 
policyID:String

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

The policyID that was passed into the DRMManager.returnVoucher() call.



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.



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

DRMReturnVoucherCompleteEvent

()Constructor
public function DRMReturnVoucherCompleteEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, inServerURL:String = null, inLicenseID:String = null, inPolicyID:String = null, inNumberOfVouchersReturned:int = 0)

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

Creates a new instance of a DRMReturnVoucherCompleteEvent 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
 
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) — the authentication token
 
inNumberOfVouchersReturned:int (default = 0)
Method Detail

clone

()method
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.

In this example, PingEvent is a subclass of Event and therefore implements its own version of clone().

     class PingEvent extends Event {
         var URL:String;
         
     public override function clone():Event {
              return new PingEvent(type, bubbles, cancelable, URL);
        }
     }
     

Returns
Event — A new Event object that is identical to the original.
Constant Detail

RETURN_VOUCHER_COMPLETE

Constant
public static const RETURN_VOUCHER_COMPLETE:String = "returnVoucherComplete"

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

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