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

DRMAuthenticationCompleteEvent  - AS3

Packageflash.events
Classpublic class DRMAuthenticationCompleteEvent
InheritanceDRMAuthenticationCompleteEvent Inheritance Event Inheritance Object

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

The DRMManager dispatches a DRMAuthenticationCompleteEvent object when a call to the authenticate() 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
  domain : String
The content domain of the media rights server.
DRMAuthenticationCompleteEvent
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
  serverURL : String
The URL of the media rights server.
DRMAuthenticationCompleteEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
  token : ByteArray
The authentication token.
DRMAuthenticationCompleteEvent
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
DRMAuthenticationCompleteEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, inServerURL:String = null, inDomain:String = null, inToken:ByteArray = null)
Creates a new instance of a DRMAuthenticationCompleteEvent object.
DRMAuthenticationCompleteEvent
  
[override] Duplicates an instance of an Event subclass.
DRMAuthenticationCompleteEvent
 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
  AUTHENTICATION_COMPLETE : String = "authenticationComplete"
[static] The string constant to use for the authentication complete event in the type parameter when adding and removing event listeners.
DRMAuthenticationCompleteEvent
Property Detail

domain

property
domain:String

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

The content domain of the media rights server. Here, domain is not a network or Internet domain name.



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

serverURL

property 
serverURL:String

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

The URL of the media rights server.



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

token

property 
token:ByteArray

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

The authentication token.

The authentication is automatically added to the DRMManager session cache. You can save the token and use it to authenticate the user in a future session. Reuse a token with the setAuthenticationToken() method of the DRMManager. Token expiration and other properties are determined by the server generating the token.



Implementation
    public function get token():ByteArray
    public function set token(value:ByteArray):void

Related API Elements

Constructor Detail

DRMAuthenticationCompleteEvent

()Constructor
public function DRMAuthenticationCompleteEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, inServerURL:String = null, inDomain:String = null, inToken:ByteArray = null)

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

Creates a new instance of a DRMAuthenticationCompleteEvent 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
 
inDomain:String (default = null) — the authenticated domain on the logged-in server
 
inToken:ByteArray (default = null) — the authentication token
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

AUTHENTICATION_COMPLETE

Constant
public static const AUTHENTICATION_COMPLETE:String = "authenticationComplete"

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

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