SmartComponents

Module: playerapi/stage/StageTriggerContext

This context provides methods to handle events in the stage scope.

Methods

<inner> isLocked(actorId) → {Boolean}

Returns the lock state for a specific actor.

Parameters:
Name Type Description
actorId String

The id of the actor.
Returns:

true if the navigation is locked for the actor, otherwise false.

Type
Boolean

<inner> lock(actorId) → {Boolean}

Locks the stage for an actor. That means, that all other components are permitted to process navigation events.
If the return value is false the stage may be already locked by an other actor.

Parameters:
Name Type Description
actorId String

The id of the actor.
Returns:

true if the stage navigation is successfully locked, otherwise false.

Type
Boolean

<inner> unlock(actorId)

Unlocks the stage for an actor.

Parameters:
Name Type Description
actorId String

The id of the actor.