flash.events.DRMStatusEvent - Adobe® Flex® 4 Language Reference (Flex 4)

Package	flash.events
Class	public class DRMStatusEvent
Inheritance	DRMStatusEvent Event Object

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 1.0

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.

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
		contentData : DRMContentData A DRMContentData object containing the information necessary to obtain a voucher for viewing the DRM-protected content.	DRMStatusEvent
		currentTarget : Object [read-only] The object that is actively processing the Event object with an event listener.	Event
		detail : String A string explaining the context of the status event.	DRMStatusEvent
		eventPhase : uint [read-only] The current phase in the event flow.	Event
		isAnonymous : Boolean Indicates whether the content, protected with digital rights management (DRM) encryption, is available without requiring a user to provide authentication credentials, in which case the value is true.	DRMStatusEvent
		isAvailableOffline : Boolean Indicates whether the content, protected with digital rights management (DRM) encryption, is available offline, in which case the value is true.	DRMStatusEvent
		isLocal : Boolean Indicates whether the voucher is cached in the local voucher store.	DRMStatusEvent
		offlineLeasePeriod : uint The remaining number of days that content can be viewed offline.	DRMStatusEvent
		policies : Object A custom object of the DRM status event.	DRMStatusEvent
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		target : Object [read-only] The event target.	Event
		type : String [read-only] The type of event.	Event
		voucher : DRMVoucher A DRMVoucher object for the content.	DRMStatusEvent
		voucherEndDate : Date The absolute date on which the voucher expires and the content can no longer be viewed by users.	DRMStatusEvent

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		DRMStatusEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, inPolicies:Object = null, inDetail:String = "", inAvailableOffline:Boolean = false, inAnonymous:Boolean = false, inVoucherEndDate:int = 0, inOfflineLeasePeriod:int = 0, 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
		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 [override] Returns a string that contains all the properties of the DRMStatusEvent object.	DRMStatusEvent
		valueOf():Object Returns the primitive value of the specified object.	Object

Public Constants

Hide Inherited Public Constants

Show Inherited Public Constants

	Constant		Defined By
		ACTIVATE : String = "activate" [static] The ACTIVATE constant defines the value of the type property of an activate event object.	Event
		ADDED : String = "added" [static] The Event.ADDED constant defines the value of the type property of an added event object.	Event
		ADDED_TO_STAGE : String = "addedToStage" [static] The Event.ADDED_TO_STAGE constant defines the value of the type property of an addedToStage event object.	Event
		CANCEL : String = "cancel" [static] The Event.CANCEL constant defines the value of the type property of a cancel event object.	Event
		CHANGE : String = "change" [static] The Event.CHANGE constant defines the value of the type property of a change event object.	Event
		CLEAR : String = "clear" [static] The Event.CLEAR constant efines the value of the type property of a clear event object.	Event
		CLOSE : String = "close" [static] The Event.CLOSE constant defines the value of the type property of a close event object.	Event
		CLOSING : String = "closing" [static] The Event.CLOSING constant defines the value of the type property of a closing event object.	Event
		COMPLETE : String = "complete" [static] The Event.COMPLETE constant defines the value of the type property of a complete event object.	Event
		CONNECT : String = "connect" [static] The Event.CONNECT constant defines the value of the type property of a connect event object.	Event
		COPY : String = "copy" [static] Defines the value of the type property of a copy event object.	Event
		CUT : String = "cut" [static] Defines the value of the type property of a cut event object.	Event
		DEACTIVATE : String = "deactivate" [static] The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.	Event
		DISPLAYING : String = "displaying" [static] The Event.DISPLAYING constant defines the value of the type property of a displaying event object.	Event
		DRM_STATUS : String = "drmStatus" [static] The DRMStatusEvent.DRM_STATUS constant defines the value of the type property of a drmStatus event object.	DRMStatusEvent
		ENTER_FRAME : String = "enterFrame" [static] The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.	Event
		EXIT_FRAME : String = "exitFrame" [static] The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.	Event
		EXITING : String = "exiting" [static] The Event.EXITING constant defines the value of the type property of an exiting event object.	Event
		FRAME_CONSTRUCTED : String = "frameConstructed" [static] The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object.	Event
		FULLSCREEN : String = "fullScreen" [static] The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.	Event
		HTML_BOUNDS_CHANGE : String = "htmlBoundsChange" [static] The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.	Event
		HTML_DOM_INITIALIZE : String = "htmlDOMInitialize" [static] The Event.HTML_DOM_INITIALIZE constant defines the value of the type property of an htmlDOMInitialize event object.	Event
		HTML_RENDER : String = "htmlRender" [static] The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.	Event
		ID3 : String = "id3" [static] The Event.ID3 constant defines the value of the type property of an id3 event object.	Event
		INIT : String = "init" [static] The Event.INIT constant defines the value of the type property of an init event object.	Event
		LOCATION_CHANGE : String = "locationChange" [static] The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.	Event
		MOUSE_LEAVE : String = "mouseLeave" [static] The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object.	Event
		NETWORK_CHANGE : String = "networkChange" [static] The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.	Event
		OPEN : String = "open" [static] The Event.OPEN constant defines the value of the type property of an open event object.	Event
		PASTE : String = "paste" [static] The Event.PASTE constant defines the value of the type property of a paste event object.	Event
		REMOVED : String = "removed" [static] The Event.REMOVED constant defines the value of the type property of a removed event object.	Event
		REMOVED_FROM_STAGE : String = "removedFromStage" [static] The Event.REMOVED_FROM_STAGE constant defines the value of the type property of a removedFromStage event object.	Event
		RENDER : String = "render" [static] The Event.RENDER constant defines the value of the type property of a render event object.	Event
		RESIZE : String = "resize" [static] The Event.RESIZE constant defines the value of the type property of a resize event object.	Event
		SCROLL : String = "scroll" [static] The Event.SCROLL constant defines the value of the type property of a scroll event object.	Event
		SELECT : String = "select" [static] The Event.SELECT constant defines the value of the type property of a select event object.	Event
		SELECT_ALL : String = "selectAll" [static] The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.	Event
		SOUND_COMPLETE : String = "soundComplete" [static] The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.	Event
		TAB_CHILDREN_CHANGE : String = "tabChildrenChange" [static] The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.	Event
		TAB_ENABLED_CHANGE : String = "tabEnabledChange" [static] The Event.TAB_ENABLED_CHANGE constant defines the value of the type property of a tabEnabledChange event object.	Event
		TAB_INDEX_CHANGE : String = "tabIndexChange" [static] The Event.TAB_INDEX_CHANGE constant defines the value of the type property of a tabIndexChange event object.	Event
		UNLOAD : String = "unload" [static] The Event.UNLOAD constant defines the value of the type property of an unload event object.	Event
		USER_IDLE : String = "userIdle" [static] The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.	Event
		USER_PRESENT : String = "userPresent" [static] The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object.	Event

Property Detail

contentData

property

contentData:DRMContentData

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 1.5

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

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
public function set detail(value:String):void

isAnonymous

property

isAnonymous:Boolean

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, in which case 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
public function set isAnonymous(value:Boolean):void

isAvailableOffline

property

isAvailableOffline:Boolean

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 1.0

Indicates whether the content, protected with digital rights management (DRM) encryption, is available offline, in which case 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
public function set isAvailableOffline(value:Boolean):void

isLocal

property

isLocal:Boolean

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 1.5

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

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
public function set offlineLeasePeriod(value:uint):void

policies

property

policies:Object

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 1.0

A custom object of the DRM status event.

Implementation
public function get policies():Object
public function set policies(value:Object):void

voucher

property

voucher:DRMVoucher

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 1.5

A DRMVoucher object for the content.

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

voucherEndDate

property

voucherEndDate:Date

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
public function set voucherEndDate(value:Date):void

Constructor Detail

DRMStatusEvent

()

Constructor

public function DRMStatusEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, inPolicies:Object = null, inDetail:String = "", inAvailableOffline:Boolean = false, inAnonymous:Boolean = false, inVoucherEndDate:int = 0, inOfflineLeasePeriod:int = 0, inMetadata:DRMContentData = null, inVoucher:DRMVoucher = null, inLocal:Boolean = false)

Language Version:

ActionScript 3.0

Runtime Versions:

Flash Player 9, AIR 1.0

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.

	`inPolicies:Object` (default = `null`) — The custom object that contains custom DRM properties.

	`inDetail:String` (default = "") — The context of the Event.

	`inAvailableOffline:Boolean` (default = `false`) — Indicates if content can be viewed offline.

	`inAnonymous:Boolean` (default = `false`) — Indicates whether content is accessible to anonymous users.

	`inVoucherEndDate:int` (default = `0`) — The date when the content voucher expires, expressed as an epoch value.

	`inOfflineLeasePeriod:int` (default = `0`) — The number of days remaining for user to view content offline.

	`inMetadata:DRMContentData` (default = `null`)

	`inVoucher:DRMVoucher` (default = `null`)

	`inLocal:Boolean` (default = `false`)

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

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

This event has the following properties:

Property	Value
`bubbles`	`false`
`cancelable`	`false`; there is no default behavior to cancel.
`detail`	A string explaining the context of the status event.
`isAnonymous`	Indicates whether the content protected with DRM encryption is available without requiring a user to provide authentication credentials.
`isAvailableOffline`	Indicates whether the content protected with DRM encryption is available offline.
`offlineLeasePeriod`	The remaining number of days that content can be viewed offline.
`policies`	A custom object of the DRM status event.
`target`	The NetStream object.
`voucherEndDate`	The absolute date on which the voucher expires and the content can no longer be viewed by users
`contentData`	The DRMContentData for the content
`voucher`	The DRMVoucher object for the content.
`isLocal`	Indicates whether the content is stored on the local file system