Module: playerapi/page/PageMetadata

This module provides data according to the page scope.

Methods

<inner> anykeyIsAvailable() → {Boolean}

Returns true, if the page can solved with anykey.

Returns:
Type
Boolean

<inner> continueOnlyOnNextButton() → {Boolean}

Returns wether an anyclick is allowed to get to the next page or if only a click over the next page button switches to the
next page.

Returns:

true: Switch to next page only over a designated button;
false: Switch to next page over a designated button or any key;

Type
Boolean

<inner> getId() → {string}

Gets the id of the page.

Returns:

The id of the page.

Type
string

<inner> getIndividualPlayMode() → {String}

Gets the play mode that that the author intended for the page (individual playmode).
See also: metadata.stage.getAvailablePlaymodes() and metadata.stage.getDefaultPlaymode()

Returns:

interactive, presentation, film or none

Type
String

<inner> getQuestion() → {module:playerapi/quiz/QuestionMetadata}

Gets the metadata for the page question .

Returns:

The question metadata. null if the page has no quiz question.

Type
module:playerapi/quiz/QuestionMetadata

<inner> getTitle() → {string}

Gets the title of the page.

Returns:

The title of the page.

Type
string

<inner> hasQuestion() → {Boolean}

Checks the page for a quiz question.

Returns:

true if the page has a question, otherwise false.

Type
Boolean