flash.net.drm.VoucherAccessInfo - Adobe® Flex® 4 Language Reference (Flex 4)

Package	flash.net.drm
Class	public final class VoucherAccessInfo
Inheritance	VoucherAccessInfo Object

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 2, Flash Player 10.1

A VoucherAccessInfo object presents the information that is required to successfully retrieve and consume a voucher, such as the type of authentication and the content domain of the media rights server.

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		authenticationMethod : String [read-only] The type of authentication required to obtain a voucher for the associated content.	VoucherAccessInfo
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		displayName : String [read-only] A user-friendly string that you can use to refer to the specified VoucherAccessInfo object in the user interface.	VoucherAccessInfo
		domain : String [read-only] The content domain of the media rights server to which the user must be authenticated to obtain the voucher for the associated content.	VoucherAccessInfo
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		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
		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
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object

Property Detail

authenticationMethod

property

authenticationMethod:String [read-only]

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 2, Flash Player 10.1

The type of authentication required to obtain a voucher for the associated content.

The supported types of authentication are:

AuthenticationMethod.ANONYMOUS — anyone can obtain a voucher.
AuthenticationMethod.USERNAME_AND_PASSWORD — the user must supply a valid username and password of an account that is authorized to view the associated content.

The AuthenticationMethod class provides string constants to use with the authenticationMethod property.

Implementation
public function get authenticationMethod():String

displayName

property

displayName:String [read-only]

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 2, Flash Player 10.1

A user-friendly string that you can use to refer to the specified VoucherAccessInfo object in the user interface.

If the metadata file for a piece of media content has multiple vouchers, each with its own VoucherAccessInfo object, the user might need to decide which voucher to authenticate to. For example, you might have a subscription-level voucher with high privileges for viewing content, as well as a basic-level voucher with lower privileges. To distinguish between these two vouchers, use the descriptive string in the displayName property. The string is set by the media packager tool (the tool that packages and encrypts media in preparation for distribution with a media rights server, such as Flash Access).

For applications that are localized, you can use this property as an identifier. The application can detect the locale and localize the strings accordingly.

Implementation
public function get displayName():String

domain

property

domain:String [read-only]

Language Version:

ActionScript 3.0

Runtime Versions:

AIR 2, Flash Player 10.1

The content domain of the media rights server to which the user must be authenticated to obtain the voucher for the associated content.

If authentication is to the default domain or no authentication is required, the value of domainName is null.

Note: The domain returned by this property has nothing to do with network or Internet domain names. In this case, a domain is a group of content or user accounts. For example, a single server could support several domains, each with its own set of content channels and subscribers.

Implementation
public function get domain():String