Module: playerapi/navigation/NavigationContext

Methods

<inner> firstPage(options)

Shows the first page in the current path.

Parameters:

Name	Type	Argument	Description
options	Object	<optional>	for future use

<inner> getCurrentPage() → {module:SequencePageMetadata}

Gets the current page.

Returns:

Type

module:SequencePageMetadata

<inner> getCurrentPath() → {module:SequencePath}

Gets the current path.

Returns:

Type

module:SequencePath

<inner> gotoPage(page, options)

Shows a desired page.

Parameters:

Name	Type	Argument	Description
page	module:playerapi/page/PageMetadata		The target page
options	Object	<optional>	for future use

<inner> gotoPageById(pageId, options)

Shows a desired page by the id.

Parameters:

Name	Type	Argument	Description
pageId	String		The target page id
options	Object	<optional>	for future use

<inner> isInFilmMode() → {Boolean}

Checks if the current play mode is film

Returns:

Type

Boolean

<inner> isInInteractiveMode() → {Boolean}

Checks if the current play mode is interactive

Returns:

Type

Boolean

<inner> isInPresentationMode() → {Boolean}

Checks if the current play mode is presentation

Returns:

Type

Boolean

<inner> lastPage(options)

Shows the last page in the current path.

Parameters:

Name	Type	Argument	Description
options	Object	<optional>	for future use

<inner> nextPage(options)

Shows the next page in the current path.

Parameters:

Name	Type	Argument	Description
options	Object	<optional>	for future use

<inner> nextSection(options)

Jumps to the first page in the next section.

Parameters:

Name	Type	Argument	Description
options	Object	<optional>	for future use

<inner> previousPage(options)

Shows the previous page in the current path.

Parameters:

Name	Type	Argument	Description
options	Object	<optional>	for future use

<inner> previousSection(options)

Jumps to the first page in the previous section.

Parameters:

Name	Type	Argument	Description
options	Object	<optional>	for future use

<inner> repeat()

Repeats all animations and sounds in the current page (step).

<inner> switchToFilmMode()

Switches to film mode.

<inner> switchToInteractiveMode()

Switches to interactive mode.

<inner> switchToPresentationMode()

Switches to presentation mode.

<inner> terminate()

Terminates the eLearning without prompting the user for confirmation.