Class: EntitlementExpirationService

EntitlementExpirationService


new EntitlementExpirationService(player [, options])

EntitlementExpirationService

Checks if entitlements are still valid according to their expiration and handles refreshing of expired entitlements

Parameters:
Name Type Argument Description
player Player

The Player that this class should be attached to.

options Object <optional>

The key/value store of player options.

Extends

  • videojs.Plugin

Members


exposure

exposure

Methods


checkForExpiration()

checkForExpiration


dispose()

dispose


entitlement(value)

get and set entitlement

Parameters:
Name Type Description
value Entitlement
Returns:

Entitlement

Type
Entitlement

errorForReason(reason)

Error for reason

Returns a human readable string for expiration error

Parameters:
Name Type Description
reason string

Error reason

Returns:

Human readable error string

Type
string

hasLicenseExpiration(entitlement)

Checks if the current entitlement has a license expiration

Parameters:
Name Type Description
entitlement Entitlement
Returns:

Bool Does entitlement have an expiration?

Type
boolean

onEntitlementChange( [event], data)

onEntitlementChange

Parameters:
Name Type Argument Description
event EventTarget~Event <optional>
data Object

options(obj)

Set/Get The options

Parameters:
Name Type Description
obj Object
Returns:

options

Type
Object

refreshEntitlement()

Refresh entitlement

Asks the entitlement engine to re-request the entitlement using the previously used data.


start()

start


stop()

stop

Class: EntitlementExpirationService

EntitlementExpirationService


new EntitlementExpirationService(player [, options])

Create the EntitlementExpirationService

Parameters:
Name Type Argument Description
player Player

The Player that this class should be attached to.

options Object <optional>

The key/value store of player options.

Members


exposure

exposure

Methods


checkForExpiration()

checkForExpiration


dispose()

dispose


entitlement(value)

get and set entitlement

Parameters:
Name Type Description
value Entitlement
Returns:

Entitlement

Type
Entitlement

errorForReason(reason)

Error for reason

Returns a human readable string for expiration error

Parameters:
Name Type Description
reason string

Error reason

Returns:

Human readable error string

Type
string

hasLicenseExpiration(entitlement)

Checks if the current entitlement has a license expiration

Parameters:
Name Type Description
entitlement Entitlement
Returns:

Bool Does entitlement have an expiration?

Type
boolean

onEntitlementChange( [event], data)

onEntitlementChange

Parameters:
Name Type Argument Description
event EventTarget~Event <optional>
data Object

options(obj)

Set/Get The options

Parameters:
Name Type Description
obj Object
Returns:

options

Type
Object

refreshEntitlement()

Refresh entitlement

Asks the entitlement engine to re-request the entitlement using the previously used data.


start()

start


stop()

stop