DRMReturnVoucherCompleteEvent

Package	flash.events
Class	public class DRMReturnVoucherCompleteEvent
Inheritance	DRMReturnVoucherCompleteEvent Event 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

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		bubbles : Boolean [read-only] Indicates whether an event is a bubbling event.	Event
		cancelable : Boolean [read-only] Indicates whether the behavior associated with the event can be prevented.	Event
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		currentTarget : Object [read-only] The object that is actively processing the Event object with an event listener.	Event
		eventPhase : 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
		target : Object [read-only] The event target.	Event
		type : String [read-only] The type of event.	Event

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined 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
		clone():Event [override] Duplicates an instance of an Event subclass.	DRMReturnVoucherCompleteEvent
		formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.	Event
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isDefaultPrevented():Boolean Checks whether the preventDefault() method has been called on the event.	Event
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		preventDefault():void Cancels an event's default behavior if that behavior can be canceled.	Event
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.	Event
		stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.	Event
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns a string containing all the properties of the Event object.	Event
		valueOf():Object Returns the primitive value of the specified object.	Object

Public Constants

Hide Inherited Public Constants

Show Inherited Public Constants

	Constant		Defined 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

flash.net.drm.DRMManager.setAuthenticationToken()

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

()

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

Copy

     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.

DRMReturnVoucherCompleteEvent - AS3

Classes x

licenseID

numberOfVouchersReturned

policyID

serverURL