(Beta)
| Package | flash.events |
| Class | public class DRMStatusEvent |
| Inheritance | DRMStatusEvent  Event Object |
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | AIR 1.0, Flash Player 10.1 |
More examples
Related API Elements
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 [read-only]
A string explaining the context of the status event. | DRMStatusEvent | ||
| eventPhase : 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 | ||
| 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 [read-only]
The absolute date on which the voucher expires and the content can no longer be viewed by users. | DRMStatusEvent | ||
Public Methods
| Method | Defined 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 | ||
[override]
Creates a copy of the DRMStatusEvent object and sets the value of each property to match
that of the original. | DRMStatusEvent | ||
|
A utility function for implementing the toString() method in custom
ActionScript 3.0 Event classes. | Event | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Checks whether the preventDefault() method has been called on the event. | Event | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Cancels an event's default behavior if that behavior can be canceled. | Event | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Prevents processing of any event listeners in the current node and any subsequent nodes in
the event flow. | Event | |
|
Prevents processing of any event listeners in nodes subsequent to the current node in the
event flow. | Event | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
[override]
Returns a string that contains all the properties of the DRMStatusEvent object. | DRMStatusEvent | ||
|
Returns the primitive value of the specified object. | Object | |
Public Constants
| Constant | Defined 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 |
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():BooleanisLocal | property |
offlineLeasePeriod | property |
policies | property |
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 |
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.
Parameterstype:String (default = NaN)type property. There is only one type of DRMAuthenticate event: DRMAuthenticateEvent.DRM_AUTHENTICATE.
| |
bubbles:Boolean (default = false)bubbles property.
| |
cancelable:Boolean (default = false)cancelable property.
| |
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.
ReturnsEvent — A new DRMStatusEvent object with property values that match those of the original.
|
toString | () | method |
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:
| 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 |
Wed Nov 21 2018, 06:34 AM -08:00