@caspingus/lt

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>Assessment/Activity - Learnosity Toolkit - Docs</title> <meta name="description" content="Documentation for the Learnosity Toolkit JavaScript library." /> <meta name="keywords" content="Learnosity" /> <meta name="keyword" content="Learnosity" /> <script src="scripts/prettify/prettify.js"></script> <script src="scripts/prettify/lang-css.js"></script>  <link type="text/css" rel="stylesheet" href="styles/prettify.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc.css"> <link type="text/css" rel="stylesheet" href="styles/custom.css"> <script src="scripts/nav.js" defer></script> <meta name="viewport" content="width=device-width, initial-scale=1.0"> </head> <body> <input type="checkbox" id="nav-trigger" class="nav-trigger" /> <label for="nav-trigger" class="navicon-button x"> <div class="navicon"></div> </label> <label for="nav-trigger" class="overlay"></label> <nav > <input type="text" id="nav-search" placeholder="Search" autofocus autocomplete="on" /> <h2><a href="index.html">Home</a></h2><h2><a href="https://github.com/michaelsharman/LT" target="_blank" class="" id="" >Github</a></h2><h3>Modules</h3><ul><li><h3>Items API</h3></li><li><a href="module-Assessment_Activity.html">Activity</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.activity">activity</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.activityId">activityId</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.activitySubTitle">activitySubTitle</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.activityTags">activityTags</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.activityTemplateId">activityTemplateId</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.activityTitle">activityTitle</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.adaptiveType">adaptiveType</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.annotationsConfig">annotationsConfig</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.autoSaveConfig">autoSaveConfig</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.elapsedTime">elapsedTime</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.hasActivityTemplate">hasActivityTemplate</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.hasAnnotations">hasAnnotations</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.hasAnswerMasking">hasAnswerMasking</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.hasAutoSave">hasAutoSave</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.hasEvents">hasEvents</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.hasItemPool">hasItemPool</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.hasLineReader">hasLineReader</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.hasResourceItems">hasResourceItems</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.hasSections">hasSections</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.hasShuffledItems">hasShuffledItems</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.hasTryAgain">hasTryAgain</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.isAdaptive">isAdaptive</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.isResuming">isResuming</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.itemBank">itemBank</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.itemPool">itemPool</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.maxTime">maxTime</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.region">region</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.resourceItems">resourceItems</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.sessionId">sessionId</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.state">state</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.timeRemaining">timeRemaining</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.totalItems">totalItems</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Activity.html#.userId">userId</a></li></ul></li><li><a href="module-Assessment_App.html">App</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Assessment_App.html#.annotationsApp">annotationsApp</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_App.html#.appInstance">appInstance</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_App.html#.assessApp">assessApp</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_App.html#.eventsApp">eventsApp</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_App.html#.init">init</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_App.html#.questionsApp">questionsApp</a></li></ul></li><li><a href="module-Assessment_Diagnostics.html">Diagnostics</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Assessment_Diagnostics.html#.diagnostics">diagnostics</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Diagnostics.html#.filterEvent">filterEvent</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Diagnostics.html#.listen">listen</a></li></ul></li><li><a href="module-Assessment_Items.html">Items</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Assessment_Items.html#.dynamic">dynamic</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Items.html#.flag">flag</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Items.html#.isDynamicItem">isDynamicItem</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Items.html#.isFirstItem">isFirstItem</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Items.html#.isFlagged">isFlagged</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Items.html#.isItemFullyAttempted">isItemFullyAttempted</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Items.html#.isLastItem">isLastItem</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Items.html#.isMaskingEnabled">isMaskingEnabled</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Items.html#.item">item</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Items.html#.itemAttemptStatus">itemAttemptStatus</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Items.html#.itemByResponseId">itemByResponseId</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Items.html#.itemElement">itemElement</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Items.html#.itemPosition">itemPosition</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Items.html#.itemReference">itemReference</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Items.html#.itemTags">itemTags</a></li></ul></li><li><a href="module-Assessment_Player.html">Player</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Assessment_Player.html#.answerMasking">answerMasking</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Player.html#.dialog">dialog</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Player.html#.hideDialog">hideDialog</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Player.html#.isResponsiveMode">isResponsiveMode</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Player.html#.isReviewScreen">isReviewScreen</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Player.html#.lineReader">lineReader</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Player.html#.navigate">navigate</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Player.html#.next">next</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Player.html#.previous">previous</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Player.html#.review">review</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Player.html#.submit">submit</a></li></ul></li><li><a href="module-Assessment_Questions.html">Questions</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Assessment_Questions.html#.hasCheckAnswer">hasCheckAnswer</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Questions.html#.isAutoScorable">isAutoScorable</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Questions.html#.question">question</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Questions.html#.questionInstance">questionInstance</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Questions.html#.questionResponse">questionResponse</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Questions.html#.questionResponseIds">questionResponseIds</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Questions.html#.questionScore">questionScore</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Questions.html#.questions">questions</a></li></ul></li><li><a href="module-Assessment_Sections.html">Sections</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Assessment_Sections.html#.isFirstItemInSection">isFirstItemInSection</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Sections.html#.isLastItemInSection">isLastItemInSection</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Sections.html#.section">section</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Sections.html#.sectionHasShuffledItems">sectionHasShuffledItems</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Sections.html#.sectionIndex">sectionIndex</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Sections.html#.sectionItemPosition">sectionItemPosition</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Sections.html#.sections">sections</a></li><li data-type='method' style='display: none;'><a href="module-Assessment_Sections.html#.totalItemsInSection">totalItemsInSection</a></li></ul></li><li><h3>Author API</h3></li><li><a href="module-Authoring_App.html">App</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Authoring_App.html#.appInstance">appInstance</a></li><li data-type='method' style='display: none;'><a href="module-Authoring_App.html#.init">init</a></li><li data-type='method' style='display: none;'><a href="module-Authoring_App.html#.questionEditorApp">questionEditorApp</a></li></ul></li><li><a href="module-Authoring_Diagnostics.html">Diagnostics</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Authoring_Diagnostics.html#.diagnostics">diagnostics</a></li><li data-type='method' style='display: none;'><a href="module-Authoring_Diagnostics.html#.filterEvent">filterEvent</a></li><li data-type='method' style='display: none;'><a href="module-Authoring_Diagnostics.html#.listen">listen</a></li></ul></li><li><a href="module-Authoring_Navigation.html">Navigation</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Authoring_Navigation.html#.routingHash">routingHash</a></li></ul></li><li><a href="module-Authoring_Widgets.html">Widgets</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Authoring_Widgets.html#.type">type</a></li></ul></li><li><h3>Extensions - Items API</h3></li><li><a href="module-Extensions_Assessment_ariaCountOnNav.html">ariaCountOnNav</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_ariaCountOnNav.html#.run">run</a></li></ul></li><li><a href="module-Extensions_Assessment_blockGrammarChecks.html">blockGrammarChecks</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_blockGrammarChecks.html#.run">run</a></li></ul></li><li><a href="module-Extensions_Assessment_checkAnswerValidation.html">checkAnswerValidation</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_checkAnswerValidation.html#.run">run</a></li></ul></li><li><a href="module-Extensions_Assessment_columnResizer.html">columnResizer</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_columnResizer.html#.run">run</a></li></ul></li><li><a href="module-Extensions_Assessment_contentTabs.html">contentTabs</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_contentTabs.html#.run">run</a></li></ul></li><li><a href="module-Extensions_Assessment_disableOnValidate.html">disableOnValidate</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_disableOnValidate.html#.run">run</a></li></ul></li><li><a href="module-Extensions_Assessment_essayLimitByCharacter.html">essayLimitByCharacter</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_essayLimitByCharacter.html#.run">run</a></li></ul></li><li><a href="module-Extensions_Assessment_hideAlternatives.html">hideAlternatives</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_hideAlternatives.html#.run">run</a></li><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_hideAlternatives.html#~shuffleArrayWithSeed">shuffleArrayWithSeed</a></li></ul></li><li><a href="module-Extensions_Assessment_keyboardShortcuts.html">keyboardShortcuts</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_keyboardShortcuts.html#.run">run</a></li></ul></li><li><a href="module-Extensions_Assessment_magnifier.html">magnifier</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_magnifier.html#.run">run</a></li><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_magnifier.html#.setupButtons">setupButtons</a></li><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_magnifier.html#.toggle">toggle</a></li></ul></li><li><a href="module-Extensions_Assessment_mcqLabelPrefix.html">mcqLabelPrefix</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_mcqLabelPrefix.html#.run">run</a></li></ul></li><li><a href="module-Extensions_Assessment_networkStatus.html">networkStatus</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_networkStatus.html#.run">run</a></li></ul></li><li><a href="module-Extensions_Assessment_pageOverlay.html">pageOverlay</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_pageOverlay.html#.halt">halt</a></li><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_pageOverlay.html#.run">run</a></li></ul></li><li><a href="module-Extensions_Assessment_renderPDF.html">renderPDF</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_renderPDF.html#.run">run</a></li></ul></li><li><a href="module-Extensions_Assessment_resetResponse.html">resetResponse</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_resetResponse.html#.run">run</a></li></ul></li><li><a href="module-Extensions_Assessment_themes_canvas.html">themes/canvas</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_themes_canvas.html#.run">run</a></li></ul></li><li><a href="module-Extensions_Assessment_themes_juniorQuest.html">themes/juniorQuest</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_themes_juniorQuest.html#.run">run</a></li></ul></li><li><a href="module-Extensions_Assessment_toggleTimer.html">toggleTimer</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_toggleTimer.html#.run">run</a></li><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_toggleTimer.html#.toggle">toggle</a></li></ul></li><li><a href="module-Extensions_Assessment_whiteNoise.html">whiteNoise</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_whiteNoise.html#.launchPlayer">launchPlayer</a></li><li data-type='method' style='display: none;'><a href="module-Extensions_Assessment_whiteNoise.html#.run">run</a></li></ul></li><li><h3>Extensions - Author API</h3></li><li><a href="module-Extensions_Authoring_contentTabs.html">contentTabs</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Authoring_contentTabs.html#.addContentTabs">addContentTabs</a></li><li data-type='method' style='display: none;'><a href="module-Extensions_Authoring_contentTabs.html#.run">run</a></li></ul></li><li><a href="module-Extensions_Authoring_createTags.html">createTags</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Authoring_createTags.html#.run">run</a></li></ul></li><li><a href="module-Extensions_Authoring_dynamicContent.html">dynamicContent</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Authoring_dynamicContent.html#.run">run</a></li></ul></li><li><a href="module-Extensions_Authoring_essayMaxLength.html">essayMaxLength</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Authoring_essayMaxLength.html#.run">run</a></li></ul></li><li><a href="module-Extensions_Authoring_imageUploader.html">imageUploader</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Authoring_imageUploader.html#.run">run</a></li></ul></li><li><a href="module-Extensions_Authoring_languageTextDirection.html">languageTextDirection</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Authoring_languageTextDirection.html#.addLanguageAttribute">addLanguageAttribute</a></li><li data-type='method' style='display: none;'><a href="module-Extensions_Authoring_languageTextDirection.html#.run">run</a></li></ul></li><li><a href="module-Extensions_Authoring_nativeTabs.html">nativeTabs</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Authoring_nativeTabs.html#.run">run</a></li></ul></li><li><a href="module-Extensions_Authoring_renderPDF.html">renderPDF</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Authoring_renderPDF.html#.run">run</a></li></ul></li><li><a href="module-Extensions_Authoring_singleQuestion.html">singleQuestion</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Authoring_singleQuestion.html#.run">run</a></li></ul></li><li><a href="module-Extensions_Authoring_ssmlEditor.html">ssmlEditor</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Extensions_Authoring_ssmlEditor.html#.launchSsmlEditor">launchSsmlEditor</a></li><li data-type='method' style='display: none;'><a href="module-Extensions_Authoring_ssmlEditor.html#.run">run</a></li></ul></li><li><h3>Utils</h3></li><li><a href="module-Utils_Dom.html">Dom</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Utils_Dom.html#.waitForElement">waitForElement</a></li></ul></li><li><a href="module-Utils_Logger.html">Logger</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Utils_Logger.html#.debug">debug</a></li><li data-type='method' style='display: none;'><a href="module-Utils_Logger.html#.error">error</a></li><li data-type='method' style='display: none;'><a href="module-Utils_Logger.html#.info">info</a></li><li data-type='method' style='display: none;'><a href="module-Utils_Logger.html#.log">log</a></li><li data-type='method' style='display: none;'><a href="module-Utils_Logger.html#.warn">warn</a></li></ul></li><li><a href="module-Utils_Styling.html">Styling</a></li><li><a href="module-Utils_Validation.html">Validation</a><ul class='methods'><li data-type='method' style='display: none;'><a href="module-Utils_Validation.html#.hasValue">hasValue</a></li><li data-type='method' style='display: none;'><a href="module-Utils_Validation.html#.isEmptyObject">isEmptyObject</a></li></ul></li></ul> </nav> <div id="main" role="main"> <h1 class="page-title">Assessment/Activity</h1> <section> <header> </header> <article> <div class="container-overview"> <p>Everything relating to the activity currently loaded by Items API.</p> <dl class="details"> </dl> </div> <h3 class="subsection-title">Methods</h3> <h4 class="name" id=".activity">activity<span class="signature">()</span><span class="type-signature"> → {object}</span></h4> <p>The activity configuration object, including anything overridden at runtime if using activity templates.</p> <dl class="details"> <dt class="tag-since"><h5>Since</h5></dt> <dd class="tag-since">0.1.0</dd> </dl> <h5 class="h5-returns">Returns</h5> <dl class="param-type"> <dt> <span class="sr-only">Type</span> </dt> <dd> (<span class="param-type">object</span>) </dd> </dl> <h4 class="name" id=".activityId">activityId<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> <p>The activity id used for this activity instance used to group related sessions.</p> <dl class="details"> <dt class="tag-since"><h5>Since</h5></dt> <dd class="tag-since">0.1.0</dd> </dl> <h5 class="h5-returns">Returns</h5> <dl class="param-type"> <dt> <span class="sr-only">Type</span> </dt> <dd> (<span class="param-type">string</span>) </dd> </dl> <h4 class="name" id=".activitySubTitle">activitySubTitle<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> <p>The visible subtitle from the configuration object.</p> <dl class="details"> <dt class="tag-since"><h5>Since</h5></dt> <dd class="tag-since">0.1.0</dd> </dl> <h5 class="h5-returns">Returns</h5> <dl class="param-type"> <dt> <span class="sr-only">Type</span> </dt> <dd> (<span class="param-type">string</span>) </dd> </dl> <h4 class="name" id=".activityTags">activityTags<span class="signature">()</span><span class="type-signature"> → {array}</span></h4> <p>All tags that have been set against items in the activity. Requires <code>retrieve_tags</code> to be set to <code>true</code> in the Items API configuration.</p> <dl class="details"> <dt class="tag-since"><h5>Since</h5></dt> <dd class="tag-since">2.9.0</dd> </dl> <h5 class="h5-returns">Returns</h5> <dl class="param-type"> <dt> <span class="sr-only">Type</span> </dt> <dd> (<span class="param-type">array</span>) </dd> </dl> <h4 class="name" id=".activityTemplateId">activityTemplateId<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> <p>The <code>activity_template_id</code> if templates are used. Returns '' if templates aren't being used.</p> <dl class="details"> <dt class="tag-since"><h5>Since</h5></dt> <dd class="tag-since">0.1.0</dd> </dl> <h5 class="h5-returns">Returns</h5> <dl class="param-type"> <dt> <span class="sr-only">Type</span> </dt> <dd> (<span class="param-type">string</span>) </dd> </dl> <h4 class="name" id=".activityTitle">activityTitle<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> <p>The visible title from the configuration object.</p> <dl class="details"> <dt class="tag-since"><h5>Since</h5></dt> <dd class="tag-since">0.1.0</dd> </dl> <h5 class="h5-returns">Returns</h5> <dl class="param-type"> <dt> <span class="sr-only">Type</span> </dt> <dd> (<span class="param-type">string</span>) </dd> </dl> <h4 class="name" id=".adaptiveType">adaptiveType<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> <p>The adaptive type as defined in the configuration. Returns '' if the activity isn't adaptive.</p> <dl class="details"> <dt class="tag-since"><h5>Since</h5></dt> <dd class="tag-since">0.1.0</dd> </dl> <h5 class="h5-returns">Returns</h5> <dl class="param-type"> <dt> <span class="sr-only">Type</span> </dt> <dd> (<span class="param-type">string</span>) </dd> </dl> <h4 class="name" id=".annotationsConfig">annotationsConfig<span class="signature">()</span><span class="type-signature"> → {object}</span></h4> <p>The annotations configuration object.</p> <dl class="details"> <dt class="tag-since"><h5>Since</h5></dt> <dd class="tag-since">0.1.0</dd> </dl> <h5 class="h5-returns">Returns</h5> <dl class="param-type"> <dt> <span class="sr-only">Type</span> </dt> <dd> (<span class="param-type">object</span>) </dd> </dl> <h4 class="name" id=".autoSaveConfig">autoSaveConfig<span class="signature">()</span><span class="type-signature"> → {boolean|object}</span></h4> <p>The auto-save configuration object. Returns <code>true</code> or an object based on what was in the configuration.</p> <dl class="details"> <dt class="tag-since"><h5>Since</h5></dt> <dd class="tag-since">0.1.0</dd> </dl> <h5 class="h5-returns">Returns</h5> <dl class="param-type"> <dt> <span class="sr-only">Type</span> </dt> <dd> (<span class="param-type">boolean</span> | <span class="param-type">object</span>) </dd> </dl> <h4 class="name" id=".elapsedTime">elapsedTime<span class="signature">()</span><span class="type-signature"> → {number}</span></h4> <p>The current elapsed time for the session. Returns whether the timer is visible or not.</p> <dl class="details"> <dt class="tag-since"><h5>Since</h5></dt> <dd class="tag-since">2.6.0</dd> </dl> <h5 class="h5-returns">Returns</h5> <dl class="param-type"> <dt> <span class="sr-only">Type</span> </dt> <dd> (<span class="param-type">number</span>) </dd> </dl> <h4 class="name" id=".hasActivityTemplate">hasActivityTemplate<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <p>Whether this activity was loaded from an activity template.</p> <dl class="details"> <dt class="tag-since"><h5>Since</h5></dt> <dd class="tag-since">0.1.0</dd> </dl> <h5 class="h5-returns">Returns</h5> <dl class="param-type"> <dt> <span class="sr-only">Type</span> </dt> <dd> (<span class="param-type">boolean</span>) </dd> </dl> <h4 class="name" id=".hasAnnotations">hasAnnotations<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <p>Whether annotations have been configured with this activity.</p> <dl class="details"> <dt class="tag-since"><h5>Since</h5></dt> <dd class="tag-since">0.1.0</dd> </dl> <h5 class="h5-returns">Returns</h5> <dl class="param-type"> <dt> <span class="sr-only">Type</span> </dt> <dd> (<span class="param-type">boolean</span>) </dd> </dl> <h4 class="name" id=".hasAnswerMasking">hasAnswerMasking<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <p>Whether this activity contains answer masking enabled.</p> <dl class="details"> <dt class="tag-since"><h5>Since</h5></dt> <dd class="tag-since">2.15.0</dd> </dl> <h5 class="h5-returns">Returns</h5> <dl class="param-type"> <dt> <span class="sr-only">Type</span> </dt> <dd> (<span class="param-type">boolean</span>) </dd> </dl> <h4 class="name" id=".hasAutoSave">hasAutoSave<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <p>Whether auto-save is configured with this activity.</p> <dl class="details"> <dt class="tag-since"><h5>Since</h5></dt> <dd class="tag-since">0.1.0</dd> </dl> <h5 class="h5-returns">Returns</h5> <dl class="param-type"> <dt> <span class="sr-only">Type</span> </dt> <dd> (<span class="param-type">boolean</span>) </dd> </dl> <h4 class="name" id=".hasEvents">hasEvents<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <p>Whether events have been configured with this activity.</p> <dl class="details"> <dt class="tag-since"><h5>Since</h5></dt> <dd class="tag-since">0.1.0</dd> </dl> <h5 class="h5-returns">Returns</h5> <dl class="param-type"> <dt> <span class="sr-only">Type</span> </dt> <dd> (<span class="param-type">boolean</span>) </dd> </dl> <h4 class="name" id=".hasItemPool">hasItemPool<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <p>Whether an item pool has been configured with this activity.</p> <dl class="details"> <dt class="tag-since"><h5>Since</h5></dt> <dd class="tag-since">0.1.0</dd> </dl> <h5 class="h5-returns">Returns</h5> <dl class="param-type"> <dt> <span class="sr-only">Type</span> </dt> <dd> (<span class="param-type">boolean</span>) </dd> </dl> <h4 class="name" id=".hasLineReader">hasLineReader<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <p>Whether this activity contains the line reader at the player level.</p> <dl class="details"> <dt class="tag-since"><h5>Since</h5></dt> <dd class="tag-since">2.15.0</dd> </dl> <h5 class="h5-returns">Returns</h5> <dl class="param-type"> <dt> <span class="sr-only">Type</span> </dt> <dd> (<span class="param-type">boolean</span>) </dd> </dl> <h4 class="name" id=".hasResourceItems">hasResourceItems<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <p>Whether this activity contains resource item(s).</p> <dl class="details"> <dt class="tag-since"><h5>Since</h5></dt> <dd class="tag-since">0.1.0</dd> </dl> <h5 class="h5-returns">Returns</h5> <dl class="param-type"> <dt> <span class="sr-only">Type</span> </dt> <dd> (<span class="param-type">boolean</span>) </dd> </dl> <h4 class="name" id=".hasSections">hasSections<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <p>Whether this activity contains sections.</p> <dl class="details"> <dt class="tag-since"><h5>Since</h5></dt> <dd class="tag-since">0.1.0</dd> </dl> <h5 class="h5-returns">Returns</h5> <dl class="param-type"> <dt> <span class="sr-only">Type</span> </dt> <dd> (<span class="param-type">boolean</span>) </dd> </dl> <h4 class="name" id=".hasShuffledItems">hasShuffledItems<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <p>Whether items have been shuffled within this activity.</p> <dl class="details"> <dt class="tag-since"><h5>Since</h5></dt> <dd class="tag-since">0.1.0</dd> </dl> <h5 class="h5-returns">Returns</h5> <dl class="param-type"> <dt> <span class="sr-only">Type</span> </dt> <dd> (<span class="param-type">boolean</span>) </dd> </dl> <h4 class="name" id=".hasTryAgain">hasTryAgain<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <p>Whether the activity has try again enabled.</p> <dl class="details"> <dt class="tag-since"><h5>Since</h5></dt> <dd class="tag-since">1.4.0</dd> </dl> <h5 class="h5-returns">Returns</h5> <dl class="param-type"> <dt> <span class="sr-only">Type</span> </dt> <dd> (<span class="param-type">boolean</span>) </dd> </dl> <h4 class="name" id=".isAdaptive">isAdaptive<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <p>Whether this activity is adaptive.</p> <dl class="details"> <dt class="tag-since"><h5>Since</h5></dt> <dd class="tag-since">0.1.0</dd> </dl> <h5 class="h5-returns">Returns</h5> <dl class="param-type"> <dt> <span class="sr-only">Type</span> </dt> <dd> (<span class="param-type">boolean</span>) </dd> </dl> <h4 class="name" id=".isResuming">isResuming<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <p>Whether the user is resuming the session.</p> <dl class="details"> <dt class="tag-since"><h5>Since</h5></dt> <dd class="tag-since">0.1.0</dd> </dl> <h5 class="h5-returns">Returns</h5> <dl class="param-type"> <dt> <span class="sr-only">Type</span> </dt> <dd> (<span class="param-type">boolean</span>) </dd> </dl> <h4 class="name" id=".itemBank">itemBank<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> <p>The global <code>organisation_id</code> used for this activity instance.</p> <dl class="details"> <dt class="tag-since"><h5>Since</h5></dt> <dd class="tag-since">0.1.0</dd> </dl> <h5 class="h5-returns">Returns</h5> <dl class="param-type"> <dt> <span class="sr-only">Type</span> </dt> <dd> (<span class="param-type">string</span>) </dd> </dl> <h4 class="name" id=".itemPool">itemPool<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> <p>The <code>item_pool_id</code> used for this activity instance.</p> <dl class="details"> <dt class="tag-since"><h5>Since</h5></dt> <dd class="tag-since">0.1.0</dd> </dl> <h5 class="h5-returns">Returns</h5> <dl class="param-type"> <dt> <span class="sr-only">Type</span> </dt> <dd> (<span class="param-type">string</span>) </dd> </dl> <h4 class="name" id=".maxTime">maxTime<span class="signature">()</span><span class="type-signature"> → {number}</span></h4> <p>The maximum time allowed for this session. If <code>0</code>, it means unlimited time.</p> <dl class="details"> <dt class="tag-since"><h5>Since</h5></dt> <dd class="tag-since">2.6.0</dd> </dl> <h5 class="h5-returns">Returns</h5> <dl class="param-type"> <dt> <span class="sr-only">Type</span> </dt> <dd> (<span class="param-type">number</span>) </dd> </dl> <h4 class="name" id=".region">region<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> <p>Which UI region the session was set up with. Values include:</p> <ul> <li><code>main</code></li> <li><code>horizontal</code></li> <li><code>horizontal-fixed</code></li> </ul> <p><code>undefined</code> will mean that no <code>regions</code> key was found in the Items API configuration, meaning the player defaults to the legacy UI region (not recommended).</p> <dl class="details"> <dt class="tag-since"><h5>Since</h5></dt> <dd class="tag-since">1.1.0</dd> </dl> <h5 class="h5-returns">Returns</h5> <dl class="param-type"> <dt> <span class="sr-only">Type</span> </dt> <dd> (<span class="param-type">string</span>) </dd> </dl> <h4 class="name" id=".resourceItems">resourceItems<span class="signature">()</span><span class="type-signature"> → {array}</span></h4> <p>The resource item references used for this activity instance.</p> <dl class="details"> <dt class="tag-since"><h5>Since</h5></dt> <dd class="tag-since">0.1.0</dd> </dl> <h5 class="h5-returns">Returns</h5> <dl class="param-type"> <dt> <span class="sr-only">Type</span> </dt> <dd> (<span class="param-type">array</span>) </dd> </dl> <h4 class="name" id=".sessionId">sessionId<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> <p>The <code>session_id</code> used for this activity instance.</p> <dl class="details"> <dt class="tag-since"><h5>Since</h5></dt> <dd class="tag-since">0.1.0</dd> </dl> <h5 class="h5-returns">Returns</h5> <dl class="param-type"> <dt> <span class="sr-only">Type</span> </dt> <dd> (<span class="param-type">string</span>) </dd> </dl> <h4 class="name" id=".state">state<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> <p>The current <code>state</code> of this activity instance. Possible values:</p> <ul> <li><code>initial</code></li> <li><code>resume</code></li> <li><code>review</code></li> <li><code>preview</code></li> </ul> <dl class="details"> <dt class="tag-since"><h5>Since</h5></dt> <dd class="tag-since">0.1.0</dd> </dl> <h5 class="h5-returns">Returns</h5> <dl class="param-type"> <dt> <span class="sr-only">Type</span> </dt> <dd> (<span class="param-type">string</span>) </dd> </dl> <h4 class="name" id=".timeRemaining">timeRemaining<span class="signature">()</span><span class="type-signature"> → {number|null}</span></h4> <p>The time remaining in the session. If <code>max_time</code> hasn't been set, the session is unlimited, so this returns <code>null</code>.</p> <dl class="details"> <dt class="tag-since"><h5>Since</h5></dt> <dd class="tag-since">2.6.0</dd> </dl> <h5 class="h5-returns">Returns</h5> <dl class="param-type"> <dt> <span class="sr-only">Type</span> </dt> <dd> (<span class="param-type">number</span> | <span class="param-type">null</span>) </dd> </dl> <h4 class="name" id=".totalItems">totalItems<span class="signature">()</span><span class="type-signature"> → {number}</span></h4> <p>The total number of items in the activity, including items within sections if relevant.</p> <dl class="details"> <dt class="tag-since"><h5>Since</h5></dt> <dd class="tag-since">0.1.0</dd> </dl> <h5 class="h5-returns">Returns</h5> <dl class="param-type"> <dt> <span class="sr-only">Type</span> </dt> <dd> (<span class="param-type">number</span>) </dd> </dl> <h4 class="name" id=".userId">userId<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> <p>The <code>user_id</code> as defined in the configuration.</p> <dl class="details"> <dt class="tag-since"><h5>Since</h5></dt> <dd class="tag-since">0.1.0</dd> </dl> <h5 class="h5-returns">Returns</h5> <dl class="param-type"> <dt> <span class="sr-only">Type</span> </dt> <dd> (<span class="param-type">string</span>) </dd> </dl> </article> </section> </div> <br class="clear"> <script>prettyPrint();</script> <script src="scripts/polyfill.js"></script> <script src="scripts/linenumber.js"></script> <script src="scripts/search.js" defer></script> <script src="scripts/collapse.js" defer></script> </body> </html>