Module: playerapi/path/LearningPathMetadata

Methods

<inner> getId() → {string}

Gets the id of the path.

Returns:

The id of the path.

Type
string

<inner> getPages() → {Array.<module:playerapi/page/PageMetadata>}

Gets meta data for all pages in the path.

Returns:
Type
Array.<module:playerapi/page/PageMetadata>

<inner> getPathElements() → {Array.<module:playerapi/path/PathElementMetadata>}

Gets all available paths. In HTML5 the returned array will only contains the main path.

Returns:
Type
Array.<module:playerapi/path/PathElementMetadata>

<inner> getTitle() → {string}

Gets the title of the path.

Returns:

The title of the path. An empty string if the path is the main path or the path has no title.

Type
string

<inner> isMainLearningPath() → {Boolean}

Determines that the path is the main learning path.

Returns:

This value is true if the path is the main learning path, otherwise false.

Type
Boolean