Package | com.brightcove.api.modules |
Class | public class AuthModule |
Inheritance | AuthModule ![]() ![]() |
Method | Defined By | ||
---|---|---|---|
AuthModule(module:Object)
Constructor. | AuthModule | ||
![]() | addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = true):void [override]
Adds a listener for an event. | APIModule | |
checkStatus():void
Check content status and send AUTH_NEEDED if applicable
| AuthModule | ||
playWithToken(pToken:String, pService:String):void
Sets the media token for the currently loaded content
| AuthModule | ||
![]() | removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void [override]
Removes a listener for an event. | APIModule | |
removeMessage():void
Removes the user message and re-enables the controls
| AuthModule | ||
showMessage(pMessage:String = tve login, pModal:Boolean = true):void
Show the specified message in a player overlay. | AuthModule |
Event | Summary | Defined By | ||
---|---|---|---|---|
AuthModule |
Constant | Defined By | ||
---|---|---|---|
AUTH_CANCEL : String = cancel [static] | AuthModule | ||
AUTH_ERROR : String = error [static] | AuthModule | ||
AUTH_TYPE_ADOBEPASS : String = adobepass [static] | AuthModule | ||
AUTH_TYPE_AIS : String = ais [static] | AuthModule | ||
PASS_REQUESTORID : String = requestorId [static] | AuthModule | ||
PASS_RESOURCEID : String = resourceId [static] | AuthModule |
AuthModule | () | Constructor |
public function AuthModule(module:Object)
Constructor.
Parametersmodule:Object — module to wrap with this API class.
|
checkStatus | () | method |
public function checkStatus():void
Check content status and send AUTH_NEEDED if applicable
playWithToken | () | method |
public function playWithToken(pToken:String, pService:String):void
Sets the media token for the currently loaded content
Parameters
pToken:String — The media token to be used
| |
pService:String — The authentication serice that the token applies to
|
removeMessage | () | method |
public function removeMessage():void
Removes the user message and re-enables the controls
showMessage | () | method |
public function showMessage(pMessage:String = tve login, pModal:Boolean = true):void
Show the specified message in a player overlay.
Parameters
pMessage:String (default = tve login ) — String to be shown to the user
| |
pModal:Boolean (default = true ) — If true, the player controls will be disabled until removeMessage is called
|
authNeeded | Event |
AUTH_CANCEL | Constant |
public static const AUTH_CANCEL:String = cancel
AUTH_ERROR | Constant |
public static const AUTH_ERROR:String = error
AUTH_TYPE_ADOBEPASS | Constant |
public static const AUTH_TYPE_ADOBEPASS:String = adobepass
AUTH_TYPE_AIS | Constant |
public static const AUTH_TYPE_AIS:String = ais
PASS_REQUESTORID | Constant |
public static const PASS_REQUESTORID:String = requestorId
PASS_RESOURCEID | Constant |
public static const PASS_RESOURCEID:String = resourceId