musora-content-services 1.0.172 → 1.0.174
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/node.js.yml +0 -0
- package/CHANGELOG.md +4 -0
- package/README.md +0 -0
- package/babel.config.js +0 -0
- package/docs/config.js.html +4 -3
- package/docs/fonts/Montserrat/Montserrat-Bold.eot +0 -0
- package/docs/fonts/Montserrat/Montserrat-Bold.ttf +0 -0
- package/docs/fonts/Montserrat/Montserrat-Bold.woff +0 -0
- package/docs/fonts/Montserrat/Montserrat-Bold.woff2 +0 -0
- package/docs/fonts/Montserrat/Montserrat-Regular.eot +0 -0
- package/docs/fonts/Montserrat/Montserrat-Regular.ttf +0 -0
- package/docs/fonts/Montserrat/Montserrat-Regular.woff +0 -0
- package/docs/fonts/Montserrat/Montserrat-Regular.woff2 +0 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.eot +0 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.svg +0 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.ttf +0 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff +0 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff2 +0 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.eot +0 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.svg +0 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.ttf +0 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff +0 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff2 +0 -0
- package/docs/index.html +2 -2
- package/docs/module-Config.html +28 -4
- package/docs/module-Railcontent-Services.html +340 -79
- package/docs/module-Sanity-Services.html +403 -47
- package/docs/railcontent.js.html +58 -48
- package/docs/sanity.js.html +650 -560
- package/docs/scripts/collapse.js +0 -0
- package/docs/scripts/commonNav.js +0 -0
- package/docs/scripts/linenumber.js +0 -0
- package/docs/scripts/nav.js +0 -0
- package/docs/scripts/polyfill.js +0 -0
- package/docs/scripts/prettify/Apache-License-2.0.txt +0 -0
- package/docs/scripts/prettify/lang-css.js +0 -0
- package/docs/scripts/prettify/prettify.js +0 -0
- package/docs/scripts/search.js +0 -0
- package/docs/styles/jsdoc.css +0 -0
- package/docs/styles/prettify.css +0 -0
- package/jest.config.js +0 -0
- package/jsdoc.json +0 -0
- package/package.json +1 -1
- package/src/contentMetaData.js +0 -0
- package/src/filterBuilder.js +0 -0
- package/src/index.d.ts +4 -0
- package/src/index.js +4 -0
- package/src/services/config.js +0 -0
- package/src/services/contentLikes.js +0 -0
- package/src/services/contentProgress.js +50 -19
- package/src/services/dataContext.js +0 -0
- package/src/services/lastUpdated.js +0 -0
- package/src/services/sanity.js +26 -2
- package/src/services/userPermissions.js +0 -0
- package/test/contentLikes.test.js +0 -0
- package/test/contentProgress.test.js +38 -2
- package/test/initializeTests.js +0 -0
- package/test/lastUpdated.test.js +0 -0
- package/test/live/contentProgressLive.test.js +30 -1
- package/test/localStorageMock.js +0 -0
- package/test/log.js +0 -0
- package/test/sanityQueryService.test.js +30 -0
- package/test/userPermissions.test.js +0 -0
- package/tools/generate-index.js +0 -0
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
<nav >
|
|
30
30
|
|
|
31
31
|
|
|
32
|
-
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Config.html">Config</a><ul class='methods'><li data-type='method'><a href="module-Config.html#~initializeService">initializeService</a></li></ul></li><li><a href="module-Railcontent-Services.html">Railcontent-Services</a><ul class='methods'><li data-type='method'><a href="module-Railcontent-Services.html#.addItemToPlaylist">addItemToPlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.countAssignmentsAndLessons">countAssignmentsAndLessons</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.createPlaylist">createPlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.deletePlaylist">deletePlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.deletePlaylistItem">deletePlaylistItem</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.deletePlaylistLike">deletePlaylistLike</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.duplicatePlaylist">duplicatePlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchAllCompletedStates">fetchAllCompletedStates</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchChallengeIndexMetadata">fetchChallengeIndexMetadata</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchChallengeLessonData">fetchChallengeLessonData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchChallengeMetadata">fetchChallengeMetadata</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedContent">fetchCompletedContent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedState">fetchCompletedState</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentInProgress">fetchContentInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentPageUserData">fetchContentPageUserData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchPlaylist">fetchPlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchPlaylistItem">fetchPlaylistItem</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchPlaylistItems">fetchPlaylistItems</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchSongsInProgress">fetchSongsInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserAward">fetchUserAward</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserChallengeProgress">fetchUserChallengeProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserPlaylists">fetchUserPlaylists</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.likePlaylist">likePlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesCommunityNotification">postChallengesCommunityNotification</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.
|
|
32
|
+
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Config.html">Config</a><ul class='methods'><li data-type='method'><a href="module-Config.html#~initializeService">initializeService</a></li></ul></li><li><a href="module-Railcontent-Services.html">Railcontent-Services</a><ul class='methods'><li data-type='method'><a href="module-Railcontent-Services.html#.addItemToPlaylist">addItemToPlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.countAssignmentsAndLessons">countAssignmentsAndLessons</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.createPlaylist">createPlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.deletePlaylist">deletePlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.deletePlaylistItem">deletePlaylistItem</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.deletePlaylistLike">deletePlaylistLike</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.duplicatePlaylist">duplicatePlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchAllCompletedStates">fetchAllCompletedStates</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchChallengeIndexMetadata">fetchChallengeIndexMetadata</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchChallengeLessonData">fetchChallengeLessonData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchChallengeMetadata">fetchChallengeMetadata</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchChallengeUserActiveChallenges">fetchChallengeUserActiveChallenges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedContent">fetchCompletedContent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedState">fetchCompletedState</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentInProgress">fetchContentInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentPageUserData">fetchContentPageUserData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchPlaylist">fetchPlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchPlaylistItem">fetchPlaylistItem</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchPlaylistItems">fetchPlaylistItems</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchSongsInProgress">fetchSongsInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserAward">fetchUserAward</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserBadges">fetchUserBadges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserChallengeProgress">fetchUserChallengeProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserPlaylists">fetchUserPlaylists</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.likePlaylist">likePlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesCommunityNotification">postChallengesCommunityNotification</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesCompleteLesson">postChallengesCompleteLesson</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesEnroll">postChallengesEnroll</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesEnrollmentNotification">postChallengesEnrollmentNotification</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesLeave">postChallengesLeave</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesSetStartDate">postChallengesSetStartDate</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesUnlock">postChallengesUnlock</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.updatePlaylist">updatePlaylist</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.updatePlaylistItem">updatePlaylistItem</a></li></ul></li><li><a href="module-Sanity-Services.html">Sanity-Services</a><ul class='methods'><li data-type='method'><a href="module-Sanity-Services.html#.fetchAll">fetchAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllFilterOptions">fetchAllFilterOptions</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllPacks">fetchAllPacks</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllSongs">fetchAllSongs</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchArtistLessons">fetchArtistLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchArtists">fetchArtists</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAssignments">fetchAssignments</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByRailContentId">fetchByRailContentId</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByRailContentIds">fetchByRailContentIds</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByReference">fetchByReference</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchCatalogMetadata">fetchCatalogMetadata</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchChallengeOverview">fetchChallengeOverview</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchChildren">fetchChildren</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchCoachLessons">fetchCoachLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchCommentModContentData">fetchCommentModContentData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchCourseOverview">fetchCourseOverview</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchFoundation">fetchFoundation</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchGenreLessons">fetchGenreLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLessonContent">fetchLessonContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMetadata">fetchMetadata</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethod">fetchMethod</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodChildren">fetchMethodChildren</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodChildrenIds">fetchMethodChildrenIds</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodNextLesson">fetchMethodNextLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodPreviousNextLesson">fetchMethodPreviousNextLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethods">fetchMethods</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchNewReleases">fetchNewReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchNextPreviousLesson">fetchNextPreviousLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackAll">fetchPackAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackChildren">fetchPackChildren</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackData">fetchPackData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchParentByRailContentId">fetchParentByRailContentId</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchParentForDownload">fetchParentForDownload</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedLessons">fetchRelatedLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedMethodLessons">fetchRelatedMethodLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedSongs">fetchRelatedSongs</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSanity">fetchSanity</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchScheduledReleases">fetchScheduledReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchShowsData">fetchShowsData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongArtistCount">fetchSongArtistCount</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongById">fetchSongById</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongCount">fetchSongCount</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongFilterOptions">fetchSongFilterOptions</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchUpcomingEvents">fetchUpcomingEvents</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchWorkouts">fetchWorkouts</a></li></ul></li></ul>
|
|
33
33
|
|
|
34
34
|
</nav>
|
|
35
35
|
|
|
@@ -182,7 +182,7 @@
|
|
|
182
182
|
|
|
183
183
|
<dt class="tag-source">Source:</dt>
|
|
184
184
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
185
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
185
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line892">line 892</a>
|
|
186
186
|
</li></ul></dd>
|
|
187
187
|
|
|
188
188
|
|
|
@@ -699,7 +699,7 @@ Resolves to `null` if the request fails.
|
|
|
699
699
|
|
|
700
700
|
<dt class="tag-source">Source:</dt>
|
|
701
701
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
702
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
702
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line922">line 922</a>
|
|
703
703
|
</li></ul></dd>
|
|
704
704
|
|
|
705
705
|
|
|
@@ -880,7 +880,7 @@ the new playlist with the authenticated user. The `name` field is required, whil
|
|
|
880
880
|
|
|
881
881
|
<dt class="tag-source">Source:</dt>
|
|
882
882
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
883
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
883
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line627">line 627</a>
|
|
884
884
|
</li></ul></dd>
|
|
885
885
|
|
|
886
886
|
|
|
@@ -1058,7 +1058,7 @@ If the user is authorized, it deletes both the playlist and its associated items
|
|
|
1058
1058
|
|
|
1059
1059
|
<dt class="tag-source">Source:</dt>
|
|
1060
1060
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
1061
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
1061
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line562">line 562</a>
|
|
1062
1062
|
</li></ul></dd>
|
|
1063
1063
|
|
|
1064
1064
|
|
|
@@ -1234,7 +1234,7 @@ If the user is unauthorized or the playlist does not exist, the promise rejects
|
|
|
1234
1234
|
|
|
1235
1235
|
<dt class="tag-source">Source:</dt>
|
|
1236
1236
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
1237
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
1237
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line804">line 804</a>
|
|
1238
1238
|
</li></ul></dd>
|
|
1239
1239
|
|
|
1240
1240
|
|
|
@@ -1499,7 +1499,7 @@ and checks if a like by the authenticated user already exists for the specified
|
|
|
1499
1499
|
|
|
1500
1500
|
<dt class="tag-source">Source:</dt>
|
|
1501
1501
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
1502
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
1502
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line687">line 687</a>
|
|
1503
1503
|
</li></ul></dd>
|
|
1504
1504
|
|
|
1505
1505
|
|
|
@@ -1677,7 +1677,7 @@ to customize the duplicated playlist. If a new name is not provided, the server
|
|
|
1677
1677
|
|
|
1678
1678
|
<dt class="tag-source">Source:</dt>
|
|
1679
1679
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
1680
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
1680
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line534">line 534</a>
|
|
1681
1681
|
</li></ul></dd>
|
|
1682
1682
|
|
|
1683
1683
|
|
|
@@ -2060,7 +2060,7 @@ The duplicated playlist contains:
|
|
|
2060
2060
|
|
|
2061
2061
|
<dt class="tag-source">Source:</dt>
|
|
2062
2062
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
2063
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
2063
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line68">line 68</a>
|
|
2064
2064
|
</li></ul></dd>
|
|
2065
2065
|
|
|
2066
2066
|
|
|
@@ -2219,14 +2219,14 @@ The duplicated playlist contains:
|
|
|
2219
2219
|
<dl class="details">
|
|
2220
2220
|
|
|
2221
2221
|
<dt class="tag-description">Description:</dt>
|
|
2222
|
-
<dd class="tag-description"><ul class="dummy"><li>Get
|
|
2222
|
+
<dd class="tag-description"><ul class="dummy"><li>Get challenge duration, user progress, and status for the list of challenges
|
|
2223
2223
|
Intended to be used on the index page for challenges</li></ul></dd>
|
|
2224
2224
|
|
|
2225
2225
|
|
|
2226
2226
|
|
|
2227
2227
|
<dt class="tag-source">Source:</dt>
|
|
2228
2228
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
2229
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
2229
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line367">line 367</a>
|
|
2230
2230
|
</li></ul></dd>
|
|
2231
2231
|
|
|
2232
2232
|
|
|
@@ -2380,7 +2380,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
2380
2380
|
|
|
2381
2381
|
<dt class="tag-source">Source:</dt>
|
|
2382
2382
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
2383
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
2383
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line333">line 333</a>
|
|
2384
2384
|
</li></ul></dd>
|
|
2385
2385
|
|
|
2386
2386
|
|
|
@@ -2528,7 +2528,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
2528
2528
|
|
|
2529
2529
|
<dt class="tag-source">Source:</dt>
|
|
2530
2530
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
2531
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
2531
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line322">line 322</a>
|
|
2532
2532
|
</li></ul></dd>
|
|
2533
2533
|
|
|
2534
2534
|
|
|
@@ -2626,6 +2626,110 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
2626
2626
|
|
|
2627
2627
|
|
|
2628
2628
|
|
|
2629
|
+
|
|
2630
|
+
|
|
2631
|
+
|
|
2632
|
+
|
|
2633
|
+
|
|
2634
|
+
|
|
2635
|
+
|
|
2636
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
2637
|
+
|
|
2638
|
+
|
|
2639
|
+
|
|
2640
|
+
|
|
2641
|
+
<dl class="param-type">
|
|
2642
|
+
<dt>
|
|
2643
|
+
Type
|
|
2644
|
+
</dt>
|
|
2645
|
+
<dd>
|
|
2646
|
+
|
|
2647
|
+
<span class="param-type">Promise.<(any|null)></span>
|
|
2648
|
+
|
|
2649
|
+
|
|
2650
|
+
|
|
2651
|
+
</dd>
|
|
2652
|
+
</dl>
|
|
2653
|
+
|
|
2654
|
+
|
|
2655
|
+
|
|
2656
|
+
|
|
2657
|
+
|
|
2658
|
+
|
|
2659
|
+
|
|
2660
|
+
|
|
2661
|
+
|
|
2662
|
+
|
|
2663
|
+
<h4 class="name" id=".fetchChallengeUserActiveChallenges"><span class="type-signature type-signature-static">(static) </span>fetchChallengeUserActiveChallenges<span class="signature">()</span><span class="type-signature"> → {Promise.<(any|null)>}</span></h4>
|
|
2664
|
+
|
|
2665
|
+
|
|
2666
|
+
|
|
2667
|
+
|
|
2668
|
+
|
|
2669
|
+
|
|
2670
|
+
<dl class="details">
|
|
2671
|
+
|
|
2672
|
+
<dt class="tag-description">Description:</dt>
|
|
2673
|
+
<dd class="tag-description"><ul class="dummy"><li>Get active brand challenges for the authorized user</li></ul></dd>
|
|
2674
|
+
|
|
2675
|
+
|
|
2676
|
+
|
|
2677
|
+
<dt class="tag-source">Source:</dt>
|
|
2678
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
2679
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line378">line 378</a>
|
|
2680
|
+
</li></ul></dd>
|
|
2681
|
+
|
|
2682
|
+
|
|
2683
|
+
|
|
2684
|
+
|
|
2685
|
+
|
|
2686
|
+
|
|
2687
|
+
|
|
2688
|
+
|
|
2689
|
+
|
|
2690
|
+
|
|
2691
|
+
|
|
2692
|
+
|
|
2693
|
+
|
|
2694
|
+
|
|
2695
|
+
|
|
2696
|
+
|
|
2697
|
+
|
|
2698
|
+
|
|
2699
|
+
|
|
2700
|
+
|
|
2701
|
+
|
|
2702
|
+
|
|
2703
|
+
|
|
2704
|
+
|
|
2705
|
+
|
|
2706
|
+
|
|
2707
|
+
|
|
2708
|
+
|
|
2709
|
+
|
|
2710
|
+
|
|
2711
|
+
|
|
2712
|
+
</dl>
|
|
2713
|
+
|
|
2714
|
+
|
|
2715
|
+
|
|
2716
|
+
|
|
2717
|
+
|
|
2718
|
+
|
|
2719
|
+
|
|
2720
|
+
|
|
2721
|
+
|
|
2722
|
+
|
|
2723
|
+
|
|
2724
|
+
|
|
2725
|
+
|
|
2726
|
+
|
|
2727
|
+
|
|
2728
|
+
|
|
2729
|
+
|
|
2730
|
+
|
|
2731
|
+
|
|
2732
|
+
|
|
2629
2733
|
|
|
2630
2734
|
|
|
2631
2735
|
|
|
@@ -2676,7 +2780,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
2676
2780
|
|
|
2677
2781
|
<dt class="tag-source">Source:</dt>
|
|
2678
2782
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
2679
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
2783
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line178">line 178</a>
|
|
2680
2784
|
</li></ul></dd>
|
|
2681
2785
|
|
|
2682
2786
|
|
|
@@ -2973,7 +3077,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
2973
3077
|
|
|
2974
3078
|
<dt class="tag-source">Source:</dt>
|
|
2975
3079
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
2976
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
3080
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line34">line 34</a>
|
|
2977
3081
|
</li></ul></dd>
|
|
2978
3082
|
|
|
2979
3083
|
|
|
@@ -3138,7 +3242,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
3138
3242
|
|
|
3139
3243
|
<dt class="tag-source">Source:</dt>
|
|
3140
3244
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
3141
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
3245
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line136">line 136</a>
|
|
3142
3246
|
</li></ul></dd>
|
|
3143
3247
|
|
|
3144
3248
|
|
|
@@ -3435,7 +3539,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
3435
3539
|
|
|
3436
3540
|
<dt class="tag-source">Source:</dt>
|
|
3437
3541
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
3438
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
3542
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line218">line 218</a>
|
|
3439
3543
|
</li></ul></dd>
|
|
3440
3544
|
|
|
3441
3545
|
|
|
@@ -3603,7 +3707,7 @@ The server validates the user's access to the playlist and returns playlist deta
|
|
|
3603
3707
|
|
|
3604
3708
|
<dt class="tag-source">Source:</dt>
|
|
3605
3709
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
3606
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
3710
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line709">line 709</a>
|
|
3607
3711
|
</li></ul></dd>
|
|
3608
3712
|
|
|
3609
3713
|
|
|
@@ -3772,7 +3876,7 @@ The server validates the user's access to the playlist and returns playlist deta
|
|
|
3772
3876
|
|
|
3773
3877
|
<dt class="tag-source">Source:</dt>
|
|
3774
3878
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
3775
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
3879
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line836">line 836</a>
|
|
3776
3880
|
</li></ul></dd>
|
|
3777
3881
|
|
|
3778
3882
|
|
|
@@ -4034,7 +4138,7 @@ The server combines data from the playlist and additional metadata from Sanity t
|
|
|
4034
4138
|
|
|
4035
4139
|
<dt class="tag-source">Source:</dt>
|
|
4036
4140
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
4037
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
4141
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line729">line 729</a>
|
|
4038
4142
|
</li></ul></dd>
|
|
4039
4143
|
|
|
4040
4144
|
|
|
@@ -4202,7 +4306,7 @@ The server combines data from the playlist and additional metadata from Sanity t
|
|
|
4202
4306
|
|
|
4203
4307
|
<dt class="tag-source">Source:</dt>
|
|
4204
4308
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
4205
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
4309
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line100">line 100</a>
|
|
4206
4310
|
</li></ul></dd>
|
|
4207
4311
|
|
|
4208
4312
|
|
|
@@ -4367,7 +4471,7 @@ The server combines data from the playlist and additional metadata from Sanity t
|
|
|
4367
4471
|
|
|
4368
4472
|
<dt class="tag-source">Source:</dt>
|
|
4369
4473
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
4370
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
4474
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line355">line 355</a>
|
|
4371
4475
|
</li></ul></dd>
|
|
4372
4476
|
|
|
4373
4477
|
|
|
@@ -4503,6 +4607,163 @@ The server combines data from the playlist and additional metadata from Sanity t
|
|
|
4503
4607
|
|
|
4504
4608
|
|
|
4505
4609
|
|
|
4610
|
+
<h4 class="name" id=".fetchUserBadges"><span class="type-signature type-signature-static">(static) </span>fetchUserBadges<span class="signature">(brand)</span><span class="type-signature"> → {Promise.<(any|null)>}</span></h4>
|
|
4611
|
+
|
|
4612
|
+
|
|
4613
|
+
|
|
4614
|
+
|
|
4615
|
+
|
|
4616
|
+
|
|
4617
|
+
<dl class="details">
|
|
4618
|
+
|
|
4619
|
+
<dt class="tag-description">Description:</dt>
|
|
4620
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch all completed badges for the user ordered by completion date descending</li></ul></dd>
|
|
4621
|
+
|
|
4622
|
+
|
|
4623
|
+
|
|
4624
|
+
<dt class="tag-source">Source:</dt>
|
|
4625
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
4626
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line390">line 390</a>
|
|
4627
|
+
</li></ul></dd>
|
|
4628
|
+
|
|
4629
|
+
|
|
4630
|
+
|
|
4631
|
+
|
|
4632
|
+
|
|
4633
|
+
|
|
4634
|
+
|
|
4635
|
+
|
|
4636
|
+
|
|
4637
|
+
|
|
4638
|
+
|
|
4639
|
+
|
|
4640
|
+
|
|
4641
|
+
|
|
4642
|
+
|
|
4643
|
+
|
|
4644
|
+
|
|
4645
|
+
|
|
4646
|
+
|
|
4647
|
+
|
|
4648
|
+
|
|
4649
|
+
|
|
4650
|
+
|
|
4651
|
+
|
|
4652
|
+
|
|
4653
|
+
|
|
4654
|
+
|
|
4655
|
+
|
|
4656
|
+
|
|
4657
|
+
|
|
4658
|
+
|
|
4659
|
+
</dl>
|
|
4660
|
+
|
|
4661
|
+
|
|
4662
|
+
|
|
4663
|
+
|
|
4664
|
+
|
|
4665
|
+
|
|
4666
|
+
|
|
4667
|
+
|
|
4668
|
+
|
|
4669
|
+
|
|
4670
|
+
|
|
4671
|
+
|
|
4672
|
+
|
|
4673
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
4674
|
+
|
|
4675
|
+
|
|
4676
|
+
<table class="params">
|
|
4677
|
+
<thead>
|
|
4678
|
+
<tr>
|
|
4679
|
+
|
|
4680
|
+
<th>Name</th>
|
|
4681
|
+
|
|
4682
|
+
|
|
4683
|
+
<th>Type</th>
|
|
4684
|
+
|
|
4685
|
+
|
|
4686
|
+
|
|
4687
|
+
|
|
4688
|
+
|
|
4689
|
+
<th class="last">Description</th>
|
|
4690
|
+
</tr>
|
|
4691
|
+
</thead>
|
|
4692
|
+
|
|
4693
|
+
<tbody>
|
|
4694
|
+
|
|
4695
|
+
|
|
4696
|
+
<tr>
|
|
4697
|
+
|
|
4698
|
+
<td class="name"><code>brand</code></td>
|
|
4699
|
+
|
|
4700
|
+
|
|
4701
|
+
<td class="type">
|
|
4702
|
+
|
|
4703
|
+
|
|
4704
|
+
<span class="param-type">string</span>
|
|
4705
|
+
|
|
|
4706
|
+
|
|
4707
|
+
<span class="param-type">null</span>
|
|
4708
|
+
|
|
4709
|
+
|
|
4710
|
+
|
|
4711
|
+
|
|
4712
|
+
</td>
|
|
4713
|
+
|
|
4714
|
+
|
|
4715
|
+
|
|
4716
|
+
|
|
4717
|
+
|
|
4718
|
+
<td class="description last">-</td>
|
|
4719
|
+
</tr>
|
|
4720
|
+
|
|
4721
|
+
|
|
4722
|
+
</tbody>
|
|
4723
|
+
</table>
|
|
4724
|
+
|
|
4725
|
+
|
|
4726
|
+
|
|
4727
|
+
|
|
4728
|
+
|
|
4729
|
+
|
|
4730
|
+
|
|
4731
|
+
|
|
4732
|
+
|
|
4733
|
+
|
|
4734
|
+
|
|
4735
|
+
|
|
4736
|
+
|
|
4737
|
+
|
|
4738
|
+
|
|
4739
|
+
|
|
4740
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
4741
|
+
|
|
4742
|
+
|
|
4743
|
+
|
|
4744
|
+
|
|
4745
|
+
<dl class="param-type">
|
|
4746
|
+
<dt>
|
|
4747
|
+
Type
|
|
4748
|
+
</dt>
|
|
4749
|
+
<dd>
|
|
4750
|
+
|
|
4751
|
+
<span class="param-type">Promise.<(any|null)></span>
|
|
4752
|
+
|
|
4753
|
+
|
|
4754
|
+
|
|
4755
|
+
</dd>
|
|
4756
|
+
</dl>
|
|
4757
|
+
|
|
4758
|
+
|
|
4759
|
+
|
|
4760
|
+
|
|
4761
|
+
|
|
4762
|
+
|
|
4763
|
+
|
|
4764
|
+
|
|
4765
|
+
|
|
4766
|
+
|
|
4506
4767
|
<h4 class="name" id=".fetchUserChallengeProgress"><span class="type-signature type-signature-static">(static) </span>fetchUserChallengeProgress<span class="signature">(contentId)</span><span class="type-signature"> → {Promise.<(any|null)>}</span></h4>
|
|
4507
4768
|
|
|
4508
4769
|
|
|
@@ -4519,7 +4780,7 @@ The server combines data from the playlist and additional metadata from Sanity t
|
|
|
4519
4780
|
|
|
4520
4781
|
<dt class="tag-source">Source:</dt>
|
|
4521
4782
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
4522
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
4783
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line344">line 344</a>
|
|
4523
4784
|
</li></ul></dd>
|
|
4524
4785
|
|
|
4525
4786
|
|
|
@@ -4669,7 +4930,7 @@ Allows optional pagination, sorting, and search parameters to control the result
|
|
|
4669
4930
|
|
|
4670
4931
|
<dt class="tag-source">Source:</dt>
|
|
4671
4932
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
4672
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
4933
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line496">line 496</a>
|
|
4673
4934
|
</li></ul></dd>
|
|
4674
4935
|
|
|
4675
4936
|
|
|
@@ -5011,7 +5272,7 @@ if the authenticated user has already liked the playlist. If not, it creates a n
|
|
|
5011
5272
|
|
|
5012
5273
|
<dt class="tag-source">Source:</dt>
|
|
5013
5274
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
5014
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
5275
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line660">line 660</a>
|
|
5015
5276
|
</li></ul></dd>
|
|
5016
5277
|
|
|
5017
5278
|
|
|
@@ -5192,7 +5453,7 @@ The `like` object in the response includes:
|
|
|
5192
5453
|
|
|
5193
5454
|
<dt class="tag-source">Source:</dt>
|
|
5194
5455
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
5195
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
5456
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line462">line 462</a>
|
|
5196
5457
|
</li></ul></dd>
|
|
5197
5458
|
|
|
5198
5459
|
|
|
@@ -5333,7 +5594,7 @@ The `like` object in the response includes:
|
|
|
5333
5594
|
|
|
5334
5595
|
|
|
5335
5596
|
|
|
5336
|
-
<h4 class="name" id=".
|
|
5597
|
+
<h4 class="name" id=".postChallengesCompleteLesson"><span class="type-signature type-signature-static">(static) </span>postChallengesCompleteLesson<span class="signature">(contentId)</span><span class="type-signature"> → {Promise.<(any|null)>}</span></h4>
|
|
5337
5598
|
|
|
5338
5599
|
|
|
5339
5600
|
|
|
@@ -5343,14 +5604,13 @@ The `like` object in the response includes:
|
|
|
5343
5604
|
<dl class="details">
|
|
5344
5605
|
|
|
5345
5606
|
<dt class="tag-description">Description:</dt>
|
|
5346
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
5347
|
-
Clears any current progress data for this challenge</li></ul></dd>
|
|
5607
|
+
<dd class="tag-description"><ul class="dummy"><li>Complete the challenge lesson and update challenge progress</li></ul></dd>
|
|
5348
5608
|
|
|
5349
5609
|
|
|
5350
5610
|
|
|
5351
5611
|
<dt class="tag-source">Source:</dt>
|
|
5352
5612
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
5353
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
5613
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line473">line 473</a>
|
|
5354
5614
|
</li></ul></dd>
|
|
5355
5615
|
|
|
5356
5616
|
|
|
@@ -5467,6 +5727,10 @@ The `like` object in the response includes:
|
|
|
5467
5727
|
<h5 class="h5-returns">Returns:</h5>
|
|
5468
5728
|
|
|
5469
5729
|
|
|
5730
|
+
<div class="param-desc">
|
|
5731
|
+
- Modal data to display
|
|
5732
|
+
</div>
|
|
5733
|
+
|
|
5470
5734
|
|
|
5471
5735
|
|
|
5472
5736
|
<dl class="param-type">
|
|
@@ -5491,7 +5755,7 @@ The `like` object in the response includes:
|
|
|
5491
5755
|
|
|
5492
5756
|
|
|
5493
5757
|
|
|
5494
|
-
<h4 class="name" id=".
|
|
5758
|
+
<h4 class="name" id=".postChallengesEnroll"><span class="type-signature type-signature-static">(static) </span>postChallengesEnroll<span class="signature">(contentId)</span><span class="type-signature"> → {Promise.<(any|null)>}</span></h4>
|
|
5495
5759
|
|
|
5496
5760
|
|
|
5497
5761
|
|
|
@@ -5501,13 +5765,14 @@ The `like` object in the response includes:
|
|
|
5501
5765
|
<dl class="details">
|
|
5502
5766
|
|
|
5503
5767
|
<dt class="tag-description">Description:</dt>
|
|
5504
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
5768
|
+
<dd class="tag-description"><ul class="dummy"><li>Enroll the user in the given challenge on the challenge published_on date
|
|
5769
|
+
Clears any current progress data for this challenge</li></ul></dd>
|
|
5505
5770
|
|
|
5506
5771
|
|
|
5507
5772
|
|
|
5508
5773
|
<dt class="tag-source">Source:</dt>
|
|
5509
5774
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
5510
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
5775
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line428">line 428</a>
|
|
5511
5776
|
</li></ul></dd>
|
|
5512
5777
|
|
|
5513
5778
|
|
|
@@ -5648,7 +5913,7 @@ The `like` object in the response includes:
|
|
|
5648
5913
|
|
|
5649
5914
|
|
|
5650
5915
|
|
|
5651
|
-
<h4 class="name" id=".
|
|
5916
|
+
<h4 class="name" id=".postChallengesEnrollmentNotification"><span class="type-signature type-signature-static">(static) </span>postChallengesEnrollmentNotification<span class="signature">(contentId)</span><span class="type-signature"> → {Promise.<(any|null)>}</span></h4>
|
|
5652
5917
|
|
|
5653
5918
|
|
|
5654
5919
|
|
|
@@ -5658,14 +5923,13 @@ The `like` object in the response includes:
|
|
|
5658
5923
|
<dl class="details">
|
|
5659
5924
|
|
|
5660
5925
|
<dt class="tag-description">Description:</dt>
|
|
5661
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
5662
|
-
Clears any current progress data for this challenge</li></ul></dd>
|
|
5926
|
+
<dd class="tag-description"><ul class="dummy"><li>Enable enrollment notifications for the provided challenge</li></ul></dd>
|
|
5663
5927
|
|
|
5664
5928
|
|
|
5665
5929
|
|
|
5666
5930
|
<dt class="tag-source">Source:</dt>
|
|
5667
5931
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
5668
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
5932
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line451">line 451</a>
|
|
5669
5933
|
</li></ul></dd>
|
|
5670
5934
|
|
|
5671
5935
|
|
|
@@ -5806,7 +6070,7 @@ Clears any current progress data for this challenge</li></ul></dd>
|
|
|
5806
6070
|
|
|
5807
6071
|
|
|
5808
6072
|
|
|
5809
|
-
<h4 class="name" id=".
|
|
6073
|
+
<h4 class="name" id=".postChallengesLeave"><span class="type-signature type-signature-static">(static) </span>postChallengesLeave<span class="signature">(contentId)</span><span class="type-signature"> → {Promise.<(any|null)>}</span></h4>
|
|
5810
6074
|
|
|
5811
6075
|
|
|
5812
6076
|
|
|
@@ -5816,14 +6080,14 @@ Clears any current progress data for this challenge</li></ul></dd>
|
|
|
5816
6080
|
<dl class="details">
|
|
5817
6081
|
|
|
5818
6082
|
<dt class="tag-description">Description:</dt>
|
|
5819
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
5820
|
-
Clears any
|
|
6083
|
+
<dd class="tag-description"><ul class="dummy"><li>Remove the user from the provided challenge
|
|
6084
|
+
Clears any current progress data for this challenge</li></ul></dd>
|
|
5821
6085
|
|
|
5822
6086
|
|
|
5823
6087
|
|
|
5824
6088
|
<dt class="tag-source">Source:</dt>
|
|
5825
6089
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
5826
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
6090
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line440">line 440</a>
|
|
5827
6091
|
</li></ul></dd>
|
|
5828
6092
|
|
|
5829
6093
|
|
|
@@ -5919,30 +6183,6 @@ Clears any existing progress data for this challenge</li></ul></dd>
|
|
|
5919
6183
|
</tr>
|
|
5920
6184
|
|
|
5921
6185
|
|
|
5922
|
-
|
|
5923
|
-
<tr>
|
|
5924
|
-
|
|
5925
|
-
<td class="name"><code>startDate</code></td>
|
|
5926
|
-
|
|
5927
|
-
|
|
5928
|
-
<td class="type">
|
|
5929
|
-
|
|
5930
|
-
|
|
5931
|
-
<span class="param-type">string</span>
|
|
5932
|
-
|
|
5933
|
-
|
|
5934
|
-
|
|
5935
|
-
|
|
5936
|
-
</td>
|
|
5937
|
-
|
|
5938
|
-
|
|
5939
|
-
|
|
5940
|
-
|
|
5941
|
-
|
|
5942
|
-
<td class="description last">prefered format YYYYMMDD, but any Carbon parsable string will do.</td>
|
|
5943
|
-
</tr>
|
|
5944
|
-
|
|
5945
|
-
|
|
5946
6186
|
</tbody>
|
|
5947
6187
|
</table>
|
|
5948
6188
|
|
|
@@ -5988,7 +6228,7 @@ Clears any existing progress data for this challenge</li></ul></dd>
|
|
|
5988
6228
|
|
|
5989
6229
|
|
|
5990
6230
|
|
|
5991
|
-
<h4 class="name" id=".
|
|
6231
|
+
<h4 class="name" id=".postChallengesSetStartDate"><span class="type-signature type-signature-static">(static) </span>postChallengesSetStartDate<span class="signature">(contentId, startDate)</span><span class="type-signature"> → {Promise.<(any|null)>}</span></h4>
|
|
5992
6232
|
|
|
5993
6233
|
|
|
5994
6234
|
|
|
@@ -5998,14 +6238,14 @@ Clears any existing progress data for this challenge</li></ul></dd>
|
|
|
5998
6238
|
<dl class="details">
|
|
5999
6239
|
|
|
6000
6240
|
<dt class="tag-description">Description:</dt>
|
|
6001
|
-
<dd class="tag-description"><ul class="dummy"><li>Enroll
|
|
6002
|
-
Clears any
|
|
6241
|
+
<dd class="tag-description"><ul class="dummy"><li>Enroll a user in a challenge and set the start date of the challenge to the provided day.
|
|
6242
|
+
Clears any existing progress data for this challenge</li></ul></dd>
|
|
6003
6243
|
|
|
6004
6244
|
|
|
6005
6245
|
|
|
6006
6246
|
<dt class="tag-source">Source:</dt>
|
|
6007
6247
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
6008
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
6248
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line404">line 404</a>
|
|
6009
6249
|
</li></ul></dd>
|
|
6010
6250
|
|
|
6011
6251
|
|
|
@@ -6101,6 +6341,30 @@ Clears any current progress data for this challenge</li></ul></dd>
|
|
|
6101
6341
|
</tr>
|
|
6102
6342
|
|
|
6103
6343
|
|
|
6344
|
+
|
|
6345
|
+
<tr>
|
|
6346
|
+
|
|
6347
|
+
<td class="name"><code>startDate</code></td>
|
|
6348
|
+
|
|
6349
|
+
|
|
6350
|
+
<td class="type">
|
|
6351
|
+
|
|
6352
|
+
|
|
6353
|
+
<span class="param-type">string</span>
|
|
6354
|
+
|
|
6355
|
+
|
|
6356
|
+
|
|
6357
|
+
|
|
6358
|
+
</td>
|
|
6359
|
+
|
|
6360
|
+
|
|
6361
|
+
|
|
6362
|
+
|
|
6363
|
+
|
|
6364
|
+
<td class="description last">prefered format YYYYMMDD, but any Carbon parsable string will do.</td>
|
|
6365
|
+
</tr>
|
|
6366
|
+
|
|
6367
|
+
|
|
6104
6368
|
</tbody>
|
|
6105
6369
|
</table>
|
|
6106
6370
|
|
|
@@ -6146,7 +6410,7 @@ Clears any current progress data for this challenge</li></ul></dd>
|
|
|
6146
6410
|
|
|
6147
6411
|
|
|
6148
6412
|
|
|
6149
|
-
<h4 class="name" id=".
|
|
6413
|
+
<h4 class="name" id=".postChallengesUnlock"><span class="type-signature type-signature-static">(static) </span>postChallengesUnlock<span class="signature">(contentId)</span><span class="type-signature"> → {Promise.<(any|null)>}</span></h4>
|
|
6150
6414
|
|
|
6151
6415
|
|
|
6152
6416
|
|
|
@@ -6156,13 +6420,14 @@ Clears any current progress data for this challenge</li></ul></dd>
|
|
|
6156
6420
|
<dl class="details">
|
|
6157
6421
|
|
|
6158
6422
|
<dt class="tag-description">Description:</dt>
|
|
6159
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
6423
|
+
<dd class="tag-description"><ul class="dummy"><li>Enroll the user in the provided challenge and set to unlocked
|
|
6424
|
+
Clears any current progress data for this challenge</li></ul></dd>
|
|
6160
6425
|
|
|
6161
6426
|
|
|
6162
6427
|
|
|
6163
6428
|
<dt class="tag-source">Source:</dt>
|
|
6164
6429
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
6165
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
6430
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line416">line 416</a>
|
|
6166
6431
|
</li></ul></dd>
|
|
6167
6432
|
|
|
6168
6433
|
|
|
@@ -6279,10 +6544,6 @@ Clears any current progress data for this challenge</li></ul></dd>
|
|
|
6279
6544
|
<h5 class="h5-returns">Returns:</h5>
|
|
6280
6545
|
|
|
6281
6546
|
|
|
6282
|
-
<div class="param-desc">
|
|
6283
|
-
- Modal data to display
|
|
6284
|
-
</div>
|
|
6285
|
-
|
|
6286
6547
|
|
|
6287
6548
|
|
|
6288
6549
|
<dl class="param-type">
|
|
@@ -6326,7 +6587,7 @@ and verifies that the authenticated user is the playlist owner. If authorized, i
|
|
|
6326
6587
|
|
|
6327
6588
|
<dt class="tag-source">Source:</dt>
|
|
6328
6589
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
6329
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
6590
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line597">line 597</a>
|
|
6330
6591
|
</li></ul></dd>
|
|
6331
6592
|
|
|
6332
6593
|
|
|
@@ -6532,7 +6793,7 @@ If the user is unauthorized or the data validation fails, the promise rejects wi
|
|
|
6532
6793
|
|
|
6533
6794
|
<dt class="tag-source">Source:</dt>
|
|
6534
6795
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
6535
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
6796
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line769">line 769</a>
|
|
6536
6797
|
</li></ul></dd>
|
|
6537
6798
|
|
|
6538
6799
|
|
|
@@ -6940,7 +7201,7 @@ Resolves to `null` if the request fails.
|
|
|
6940
7201
|
<br class="clear">
|
|
6941
7202
|
|
|
6942
7203
|
<footer>
|
|
6943
|
-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on
|
|
7204
|
+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Thu Nov 14 2024 23:44:16 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
|
|
6944
7205
|
</footer>
|
|
6945
7206
|
|
|
6946
7207
|
<script>prettyPrint();</script>
|