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

DRMStatusEvent  - AS3

Packageflash.events
Classpublic class DRMStatusEvent
InheritanceDRMStatusEvent Inheritance Event Inheritance Object

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

A NetStream object dispatches a DRMStatusEvent object when the content protected using digital rights management (DRM) begins playing successfully (when the voucher is verified, and when the user is authenticated and authorized to view the content). The DRMStatusEvent object contains information related to the voucher, such as whether the content can be made available offline or when the voucher will expire and the content can no longer be viewed. The application can use this data to inform the user of the status of her policy and permissions.

More examples

Related API Elements



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
  contentData : DRMContentData
A DRMContentData object containing the information necessary to obtain a voucher for viewing the DRM-protected content.
DRMStatusEvent
 InheritedcurrentTarget : Object
[read-only] The object that is actively processing the Event object with an event listener.
Event
      detail : String
[read-only] A string explaining the context of the status event.
DRMStatusEvent
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
      isAnonymous : Boolean
[read-only] Indicates whether the content, protected with digital rights management (DRM) encryption, is available without requiring a user to provide authentication credentials.
DRMStatusEvent
      isAvailableOffline : Boolean
[read-only] Indicates whether the content, protected with digital rights management (DRM) encryption, is available offline.
DRMStatusEvent
  isLocal : Boolean
Indicates whether the voucher is cached in the local voucher store.
DRMStatusEvent
      offlineLeasePeriod : uint
[read-only] The remaining number of days that content can be viewed offline.
DRMStatusEvent
      policies : Object
[read-only] A custom object of the DRM status event.
DRMStatusEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
  voucher : DRMVoucher
A DRMVoucher object for the content.
DRMStatusEvent
      voucherEndDate : Date
[read-only] The absolute date on which the voucher expires and the content can no longer be viewed by users.
DRMStatusEvent
Public Methods
 MethodDefined By
  
DRMStatusEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, inMetadata:DRMContentData = null, inVoucher:DRMVoucher = null, inLocal:Boolean = false)
Creates an Event object that contains specific information about DRM status events.
DRMStatusEvent
  
    clone():Event
[override] Creates a copy of the DRMStatusEvent object and sets the value of each property to match that of the original.
DRMStatusEvent
 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
  
    toString():String
[override] Returns a string that contains all the properties of the DRMStatusEvent object.
DRMStatusEvent
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  DRM_STATUS : String = "drmStatus"
[static] The DRMStatusEvent.DRM_STATUS constant defines the value of the type property of a drmStatus event object.
DRMStatusEvent
Property Detail

contentData

property
contentData:DRMContentData

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

A DRMContentData object containing the information necessary to obtain a voucher for viewing the DRM-protected content.



Implementation
    public function get contentData():DRMContentData
    public function set contentData(value:DRMContentData):void
    

detail

property 
detail:String  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

A string explaining the context of the status event.



Implementation
    public function get detail():String
    

isAnonymous

property 
isAnonymous:Boolean  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

Indicates whether the content, protected with digital rights management (DRM) encryption, is available without requiring a user to provide authentication credentials. If so, the value is true. Otherwise, the value is false, and a user must provide a username and password that matches the one known and expected by the content provider.



Implementation
    public function get isAnonymous():Boolean
    

isAvailableOffline

property 
isAvailableOffline:Boolean  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

Indicates whether the content, protected with digital rights management (DRM) encryption, is available offline. If so, the value is true. Otherwise, the value is false.

In order for digitally protected content to be available offline, its voucher must be cached to the user's local machine. (The application decides where to store the content locally in order for it to be available offline.)



Implementation
    public function get isAvailableOffline():Boolean

isLocal

property 
isLocal:Boolean

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

Indicates whether the voucher is cached in the local voucher store.



Implementation
    public function get isLocal():Boolean
    public function set isLocal(value:Boolean):void
    

offlineLeasePeriod

property 
offlineLeasePeriod:uint  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

The remaining number of days that content can be viewed offline.



Implementation
    public function get offlineLeasePeriod():uint
    

policies

property 
policies:Object  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

A custom object of the DRM status event.



Implementation
    public function get policies():Object

voucher

property 
voucher:DRMVoucher

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

A DRMVoucher object for the content.



Implementation
    public function get voucher():DRMVoucher
    public function set voucher(value:DRMVoucher):void
    

voucherEndDate

property 
voucherEndDate:Date  [read-only]

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

The absolute date on which the voucher expires and the content can no longer be viewed by users.



Implementation
    public function get voucherEndDate():Date
Constructor Detail

DRMStatusEvent

()Constructor
public function DRMStatusEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, inMetadata:DRMContentData = null, inVoucher:DRMVoucher = null, inLocal:Boolean = false)

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

Creates an Event object that contains specific information about DRM status events. Event objects are passed as parameters to event listeners.

Parameters
type:String (default = NaN) — The type of the event. Event listeners can access this information through the inherited type property. There is only one type of DRMAuthenticate event: DRMAuthenticateEvent.DRM_AUTHENTICATE.
 
bubbles:Boolean (default = false) — Determines whether the Event object participates in the bubbling stage of the event flow. Event listeners can access this information through the inherited bubbles property.
 
cancelable:Boolean (default = false) — Determines whether the Event object can be canceled. Event listeners can access this information through the inherited cancelable property.
 
inMetadata:DRMContentData (default = null) — The custom object that contains custom DRM properties.
 
inVoucher:DRMVoucher (default = null) — The context of the Event.
 
inLocal:Boolean (default = false) — Indicates if content can be viewed offline.
Method Detail

    clone

()method
override public function clone():Event

Language Version: ActionScript 3.0
Runtime Versions: AIR 1.0

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

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

    toString

()method 
override public function toString():String

Runtime Versions: AIR 1.0

Returns a string that contains all the properties of the DRMStatusEvent object.

Returns
String — A string that contains all the properties of the DRMStatusEvent object.
Constant Detail

DRM_STATUS

Constant
public static const DRM_STATUS:String = "drmStatus"

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

The DRMStatusEvent.DRM_STATUS constant defines the value of the type property of a drmStatus event object.

This event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
detailA string explaining the context of the status event.
isAnonymousIndicates whether the content protected with DRM encryption is available without requiring a user to provide authentication credentials.
isAvailableOfflineIndicates whether the content protected with DRM encryption is available offline.
offlineLeasePeriodThe remaining number of days that content can be viewed offline.
policiesA custom object of the DRM status event.
targetThe NetStream object.
voucherEndDateThe absolute date on which the voucher expires and the content can no longer be viewed by users
contentDataThe DRMContentData for the content
voucherThe DRMVoucher object for the content.
isLocalIndicates whether the content is stored on the local file system