musora-content-services 1.6.7 → 1.6.9
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/conventional-commits.yaml +0 -0
- package/.github/workflows/docs.js.yml +0 -0
- package/.github/workflows/sync-docs.yml +0 -0
- package/CHANGELOG.md +4 -0
- package/README.md +0 -0
- package/docs/algolia.js.html +0 -0
- package/docs/config.js.html +0 -0
- package/docs/index.html +0 -0
- package/docs/module-Config.html +0 -0
- package/docs/module-Railcontent-Services.html +0 -0
- package/docs/module-Sanity-Services.html +0 -0
- package/docs/module-Search-Engine-Services.html +0 -0
- package/docs/railcontent.js.html +0 -0
- package/docs/sanity.js.html +0 -0
- package/docs/v2/ContentOrganization.html +2 -2
- package/docs/v2/Forums.html +269 -0
- package/docs/v2/Gamification.html +2 -2
- package/docs/v2/TestUser.html +260 -0
- package/docs/v2/UserManagementSystem.html +2 -2
- package/docs/v2/api_types.js.html +2 -2
- package/docs/v2/config.js.html +2 -8
- package/docs/v2/content-org_content-org.js.html +2 -2
- package/docs/v2/content-org_guided-courses.ts.html +110 -0
- package/docs/v2/content-org_learning-paths.ts.html +123 -0
- package/docs/v2/content-org_playlists-types.js.html +14 -2
- package/docs/v2/content-org_playlists.js.html +39 -17
- package/docs/v2/content.js.html +111 -52
- package/docs/v2/fonts/Montserrat/Montserrat-Bold.eot +0 -0
- package/docs/v2/fonts/Montserrat/Montserrat-Bold.ttf +0 -0
- package/docs/v2/fonts/Montserrat/Montserrat-Bold.woff +0 -0
- package/docs/v2/fonts/Montserrat/Montserrat-Bold.woff2 +0 -0
- package/docs/v2/fonts/Montserrat/Montserrat-Regular.eot +0 -0
- package/docs/v2/fonts/Montserrat/Montserrat-Regular.ttf +0 -0
- package/docs/v2/fonts/Montserrat/Montserrat-Regular.woff +0 -0
- package/docs/v2/fonts/Montserrat/Montserrat-Regular.woff2 +0 -0
- package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.eot +0 -0
- package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.svg +0 -0
- package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.ttf +0 -0
- package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff +0 -0
- package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff2 +0 -0
- package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.eot +0 -0
- package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.svg +0 -0
- package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.ttf +0 -0
- package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff +0 -0
- package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff2 +0 -0
- package/docs/v2/forums_categories.ts.html +137 -0
- package/docs/v2/forums_discussions.js.html +95 -0
- package/docs/v2/forums_forum.js.html +95 -0
- package/docs/v2/forums_forums.ts.html +160 -0
- package/docs/v2/forums_posts.ts.html +258 -0
- package/docs/v2/forums_threads.ts.html +271 -0
- package/docs/v2/gamification_awards.js.html +35 -534
- package/docs/v2/gamification_awards.ts.html +181 -0
- package/docs/v2/gamification_gamification.js.html +2 -2
- package/docs/v2/gamification_types.js.html +7 -25
- package/docs/v2/global.html +849 -690
- package/docs/v2/index.html +2 -3
- package/docs/v2/liveTesting.ts.html +102 -0
- package/docs/v2/module-Accounts.html +2094 -0
- package/docs/v2/module-Awards.html +396 -14
- package/docs/v2/module-Categories.html +711 -0
- package/docs/v2/module-Config.html +4 -8
- package/docs/v2/module-Content-Services-V2.html +182 -49
- package/docs/v2/module-ForumCategories.html +687 -0
- package/docs/v2/module-ForumDiscussions.html +370 -0
- package/docs/v2/module-Forums.html +15393 -0
- package/docs/v2/module-GuidedCourses.html +1304 -0
- package/docs/v2/module-Interests.html +2 -2
- package/docs/v2/module-Onboarding.html +670 -0
- package/docs/v2/module-Payments.html +250 -0
- package/docs/v2/module-Permissions.html +2 -2
- package/docs/v2/module-Playlists.html +212 -44
- package/docs/v2/module-Railcontent-Services.html +689 -2175
- package/docs/v2/module-Sanity-Services.html +480 -925
- package/docs/v2/module-Sessions.html +3 -3
- package/docs/v2/module-Threads.html +1119 -0
- package/docs/v2/module-UserActivity.html +193 -23
- package/docs/v2/module-UserChat.html +410 -0
- package/docs/v2/module-UserManagement.html +1028 -11
- package/docs/v2/module-UserMemberships.html +829 -0
- package/docs/v2/module-UserNotifications.html +1399 -27
- package/docs/v2/module-UserProfile.html +106 -2
- package/docs/v2/railcontent.js.html +87 -236
- package/docs/v2/sanity.js.html +342 -415
- package/docs/v2/scripts/collapse.js +0 -0
- package/docs/v2/scripts/commonNav.js +0 -0
- package/docs/v2/scripts/linenumber.js +0 -0
- package/docs/v2/scripts/nav.js +0 -0
- package/docs/v2/scripts/polyfill.js +0 -0
- package/docs/v2/scripts/prettify/Apache-License-2.0.txt +0 -0
- package/docs/v2/scripts/prettify/lang-css.js +0 -0
- package/docs/v2/scripts/prettify/prettify.js +0 -0
- package/docs/v2/scripts/search.js +0 -0
- package/docs/v2/styles/jsdoc.css +0 -0
- package/docs/v2/styles/prettify.css +0 -0
- package/docs/v2/userActivity.js.html +532 -451
- package/docs/v2/user_account.ts.html +237 -0
- package/docs/v2/user_chat.js.html +98 -0
- package/docs/v2/user_interests.js.html +2 -2
- package/docs/v2/user_management.js.html +82 -2
- package/docs/v2/user_memberships.js.html +144 -0
- package/docs/v2/user_memberships.ts.html +292 -0
- package/docs/v2/user_notifications.js.html +203 -21
- package/docs/v2/user_onboarding.ts.html +183 -0
- package/docs/v2/user_payments.ts.html +97 -0
- package/docs/v2/user_permissions.js.html +2 -2
- package/docs/v2/user_profile.js.html +12 -2
- package/docs/v2/user_sessions.js.html +33 -2
- package/docs/v2/user_types.js.html +16 -2
- package/docs/v2/user_user-management-system.js.html +2 -2
- package/jsdoc.json +0 -0
- package/link_mcs.sh +0 -0
- package/package.json +1 -1
- package/src/contentMetaData.js +0 -0
- package/src/contentTypeConfig.js +3 -3
- package/src/filterBuilder.js +0 -0
- package/src/index.d.ts +0 -0
- package/src/index.js +0 -0
- package/src/services/algolia.js +0 -0
- package/src/services/config.js +0 -0
- package/src/services/contentLikes.js +0 -0
- package/src/services/contentProgress.js +0 -0
- package/src/services/dataContext.js +0 -0
- package/src/services/imageSRCBuilder.js +1 -1
- package/src/services/imageSRCVerify.js +1 -1
- package/src/services/lastUpdated.js +0 -0
- package/src/services/railcontent.js +0 -0
- package/src/services/recommendations.js +0 -0
- package/src/services/userPermissions.js +0 -0
- package/test/config.test.js +0 -0
- package/test/contentLikes.test.js +0 -0
- package/test/contentProgress.test.js +0 -0
- package/test/imageSRCBuilder.test.js +1 -1
- package/test/imageSRCVerify.test.js +4 -4
- package/test/initializeTests.js +0 -0
- package/test/lastUpdated.test.js +0 -0
- package/test/sanityQueryService.test.js +0 -0
- package/test/userPermissions.test.js +0 -0
- package/tools/generate-index.cjs +0 -0
- package/.yarnrc.yml +0 -1
- package/docs/v2/Content-Organization.html +0 -245
- package/docs/v2/UserManagement.html +0 -269
- package/docs/v2/global.html#User +0 -293
- package/docs/v2/module-Notifications.html +0 -1183
- package/docs/v2/module-Session-Management.html +0 -575
- package/docs/v2/module-User-Activity.html +0 -4410
- package/docs/v2/module-User-Management.html +0 -490
- package/docs/v2/module-User-Permissions.html +0 -406
- package/docs/v2/types.js.html +0 -122
- package/docs/v2/user_user-management.js.html +0 -78
|
@@ -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-Awards.html">Awards</a><ul class='methods'><li data-type='method'><a href="module-Awards.html#.fetchAwardsForUser">fetchAwardsForUser</a></li></ul></li><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-Content-Services-V2.html">Content-Services-V2</a><ul class='methods'><li data-type='method'><a href="module-Content-Services-V2.html#.getContentRows">getContentRows</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getNewAndUpcoming">getNewAndUpcoming</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getRecent">getRecent</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getRecommendedForYou">getRecommendedForYou</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getScheduleContentRows">getScheduleContentRows</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getTabResults">getTabResults</a></li></ul></li><li><a href="module-Interests.html">Interests</a><ul class='methods'><li data-type='method'><a href="module-Interests.html#.fetchInterests">fetchInterests</a></li><li data-type='method'><a href="module-Interests.html#.fetchUninterests">fetchUninterests</a></li><li data-type='method'><a href="module-Interests.html#.markContentAsInterested">markContentAsInterested</a></li><li data-type='method'><a href="module-Interests.html#.markContentAsNotInterested">markContentAsNotInterested</a></li><li data-type='method'><a href="module-Interests.html#.removeContentAsInterested">removeContentAsInterested</a></li><li data-type='method'><a href="module-Interests.html#.removeContentAsNotInterested">removeContentAsNotInterested</a></li></ul></li><li><a href="module-Permissions.html">Permissions</a><ul class='methods'><li data-type='method'><a href="module-Permissions.html#.fetchUserPermissions">fetchUserPermissions</a></li><li data-type='method'><a href="module-Permissions.html#.reset">reset</a></li></ul></li><li><a href="module-Playlists.html">Playlists</a><ul class='methods'><li data-type='method'><a href="module-Playlists.html#.addItemToPlaylist">addItemToPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.createPlaylist">createPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.deletePlaylist">deletePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.duplicatePlaylist">duplicatePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.fetchPlaylist">fetchPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.fetchPlaylistItems">fetchPlaylistItems</a></li><li data-type='method'><a href="module-Playlists.html#.fetchUserPlaylists">fetchUserPlaylists</a></li><li data-type='method'><a href="module-Playlists.html#.togglePlaylistPrivate">togglePlaylistPrivate</a></li><li data-type='method'><a href="module-Playlists.html#.undeletePlaylist">undeletePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.updatePlaylist">updatePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~likePlaylist">likePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~reportPlaylist">reportPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~togglePlaylistPrivate">togglePlaylistPrivate</a></li><li data-type='method'><a href="module-Playlists.html#~unlikePlaylist">unlikePlaylist</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#.assignModeratorToComment">assignModeratorToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.closeComment">closeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.createComment">createComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.deleteComment">deleteComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.editComment">editComment</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#.fetchCarouselCardData">fetchCarouselCardData</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#.fetchCommentRelies">fetchCommentRelies</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchComments">fetchComments</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedChallenges">fetchCompletedChallenges</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#.fetchNextContentDataForParent">fetchNextContentDataForParent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchOwnedChallenges">fetchOwnedChallenges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchRecentUserActivities">fetchRecentUserActivities</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#.fetchTopComment">fetchTopComment</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#.fetchUserPracticeNotes">fetchUserPracticeNotes</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.likeComment">likeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.openComment">openComment</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#.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#.postChallengesHideCompletedBanner">postChallengesHideCompletedBanner</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#.postChallengesSoloNotification">postChallengesSoloNotification</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#.replyToComment">replyToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.reportComment">reportComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.setStudentViewForUser">setStudentViewForUser</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.unassignModeratorToComment">unassignModeratorToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.unlikeComment">unlikeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#~fetchLastInteractedChild">fetchLastInteractedChild</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#.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#.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#.fetchCoachLessons">fetchCoachLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchComingSoon">fetchComingSoon</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#.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#.fetchLeaving">fetchLeaving</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#.fetchLessonsFeaturingThisContent">fetchLessonsFeaturingThisContent</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#.fetchMethodPreviousNextLesson">fetchMethodPreviousNextLesson</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#.fetchOtherSongVersions">fetchOtherSongVersions</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#.fetchPackData">fetchPackData</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#.fetchRelatedRecommendedContent">fetchRelatedRecommendedContent</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#.fetchReturning">fetchReturning</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#.fetchUpcomingEvents">fetchUpcomingEvents</a></li><li data-type='method'><a href="module-Sanity-Services.html#.jumpToContinueContent">jumpToContinueContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#~fetchRelatedByLicense">fetchRelatedByLicense</a></li><li data-type='method'><a href="module-Sanity-Services.html#~getNextAndPreviousQuarterDates">getNextAndPreviousQuarterDates</a></li><li data-type='method'><a href="module-Sanity-Services.html#~getQueryFromPage">getQueryFromPage</a></li><li data-type='method'><a href="module-Sanity-Services.html#~handleCustomFetchAll">handleCustomFetchAll</a></li></ul></li><li><a href="module-Sessions.html">Sessions</a><ul class='methods'><li data-type='method'><a href="module-Sessions.html#.login">login</a></li><li data-type='method'><a href="module-Sessions.html#.logout">logout</a></li></ul></li><li><a href="module-UserActivity.html">UserActivity</a><ul class='methods'><li data-type='method'><a href="module-UserActivity.html#.calculateLongestStreaks">calculateLongestStreaks</a></li><li data-type='method'><a href="module-UserActivity.html#.createPracticeNotes">createPracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.deletePracticeSession">deletePracticeSession</a></li><li data-type='method'><a href="module-UserActivity.html#.deleteUserActivity">deleteUserActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.getPracticeNotes">getPracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.getPracticeSessions">getPracticeSessions</a></li><li data-type='method'><a href="module-UserActivity.html#.getProgressRows">getProgressRows</a></li><li data-type='method'><a href="module-UserActivity.html#.getRecentActivity">getRecentActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.getUserMonthlyStats">getUserMonthlyStats</a></li><li data-type='method'><a href="module-UserActivity.html#.getUserWeeklyStats">getUserWeeklyStats</a></li><li data-type='method'><a href="module-UserActivity.html#.pinProgressRow">pinProgressRow</a></li><li data-type='method'><a href="module-UserActivity.html#.recordUserActivity">recordUserActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.recordUserPractice">recordUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.removeUserPractice">removeUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.restorePracticeSession">restorePracticeSession</a></li><li data-type='method'><a href="module-UserActivity.html#.restoreUserPractice">restoreUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.unpinProgressRow">unpinProgressRow</a></li><li data-type='method'><a href="module-UserActivity.html#.updatePracticeNotes">updatePracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.updateUserPractice">updateUserPractice</a></li></ul></li><li><a href="module-UserChat.html">UserChat</a><ul class='methods'><li data-type='method'><a href="module-UserChat.html#.fetchChatSettings">fetchChatSettings</a></li></ul></li><li><a href="module-UserManagement.html">UserManagement</a><ul class='methods'><li data-type='method'><a href="module-UserManagement.html#.blockUser">blockUser</a></li><li data-type='method'><a href="module-UserManagement.html#.deletePicture">deletePicture</a></li><li data-type='method'><a href="module-UserManagement.html#.unblockUser">unblockUser</a></li><li data-type='method'><a href="module-UserManagement.html#.uploadPicture">uploadPicture</a></li><li data-type='method'><a href="module-UserManagement.html#.uploadPictureFromS3">uploadPictureFromS3</a></li></ul></li><li><a href="module-UserNotifications.html">UserNotifications</a><ul class='methods'><li data-type='method'><a href="module-UserNotifications.html#.deleteNotification">deleteNotification</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchNotifications">fetchNotifications</a></li><li data-type='method'><a href="module-UserNotifications.html#.markAllNotificationsAsRead">markAllNotificationsAsRead</a></li><li data-type='method'><a href="module-UserNotifications.html#.markNotificationAsRead">markNotificationAsRead</a></li><li data-type='method'><a href="module-UserNotifications.html#.markNotificationAsUnread">markNotificationAsUnread</a></li></ul></li><li><a href="module-UserProfile.html">UserProfile</a><ul class='methods'><li data-type='method'><a href="module-UserProfile.html#.otherStats">otherStats</a></li></ul></li></ul><h3>Namespaces</h3><ul><li><a href="ContentOrganization.html">ContentOrganization</a></li><li><a href="Gamification.html">Gamification</a></li><li><a href="UserManagementSystem.html">UserManagementSystem</a></li></ul><h3><a href="global.html">Global</a></h3>
|
|
32
|
+
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Accounts.html">Accounts</a><ul class='methods'><li data-type='method'><a href="module-Accounts.html#~confirmEmailChange">confirmEmailChange</a></li><li data-type='method'><a href="module-Accounts.html#~deleteAccount">deleteAccount</a></li><li data-type='method'><a href="module-Accounts.html#~numberOfActiveUsers">numberOfActiveUsers</a></li><li data-type='method'><a href="module-Accounts.html#~requestEmailChange">requestEmailChange</a></li><li data-type='method'><a href="module-Accounts.html#~resetPassword">resetPassword</a></li><li data-type='method'><a href="module-Accounts.html#~sendAccountSetupEmail">sendAccountSetupEmail</a></li><li data-type='method'><a href="module-Accounts.html#~sendPasswordResetEmail">sendPasswordResetEmail</a></li><li data-type='method'><a href="module-Accounts.html#~setupAccount">setupAccount</a></li><li data-type='method'><a href="module-Accounts.html#~status">status</a></li></ul></li><li><a href="module-Awards.html">Awards</a><ul class='methods'><li data-type='method'><a href="module-Awards.html#~fetchAwardsForUser">fetchAwardsForUser</a></li><li data-type='method'><a href="module-Awards.html#~fetchCertificate">fetchCertificate</a></li><li data-type='method'><a href="module-Awards.html#~getAwardDataForGuidedContent">getAwardDataForGuidedContent</a></li></ul></li><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-Content-Services-V2.html">Content-Services-V2</a><ul class='methods'><li data-type='method'><a href="module-Content-Services-V2.html#.getContentRows">getContentRows</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getLegacyMethods">getLegacyMethods</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getNewAndUpcoming">getNewAndUpcoming</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getRecent">getRecent</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getRecommendedForYou">getRecommendedForYou</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getScheduleContentRows">getScheduleContentRows</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getTabResults">getTabResults</a></li></ul></li><li><a href="module-Forums.html">Forums</a><ul class='methods'><li data-type='method'><a href="module-Forums.html#~createForumCategory">createForumCategory</a></li><li data-type='method'><a href="module-Forums.html#~createPost">createPost</a></li><li data-type='method'><a href="module-Forums.html#~createThread">createThread</a></li><li data-type='method'><a href="module-Forums.html#~deletePost">deletePost</a></li><li data-type='method'><a href="module-Forums.html#~deleteThread">deleteThread</a></li><li data-type='method'><a href="module-Forums.html#~fetchCommunityGuidelines">fetchCommunityGuidelines</a></li><li data-type='method'><a href="module-Forums.html#~fetchFollowedThreads">fetchFollowedThreads</a></li><li data-type='method'><a href="module-Forums.html#~fetchForumCategories">fetchForumCategories</a></li><li data-type='method'><a href="module-Forums.html#~fetchLatestThreads">fetchLatestThreads</a></li><li data-type='method'><a href="module-Forums.html#~fetchPosts">fetchPosts</a></li><li data-type='method'><a href="module-Forums.html#~fetchThreads">fetchThreads</a></li><li data-type='method'><a href="module-Forums.html#~followThread">followThread</a></li><li data-type='method'><a href="module-Forums.html#~jumpToPost">jumpToPost</a></li><li data-type='method'><a href="module-Forums.html#~likePost">likePost</a></li><li data-type='method'><a href="module-Forums.html#~lockThread">lockThread</a></li><li data-type='method'><a href="module-Forums.html#~pinThread">pinThread</a></li><li data-type='method'><a href="module-Forums.html#~search">search</a></li><li data-type='method'><a href="module-Forums.html#~unfollowThread">unfollowThread</a></li><li data-type='method'><a href="module-Forums.html#~unlikePost">unlikePost</a></li><li data-type='method'><a href="module-Forums.html#~unlockThread">unlockThread</a></li><li data-type='method'><a href="module-Forums.html#~unpinThread">unpinThread</a></li><li data-type='method'><a href="module-Forums.html#~updateForumCategory">updateForumCategory</a></li><li data-type='method'><a href="module-Forums.html#~updatePost">updatePost</a></li><li data-type='method'><a href="module-Forums.html#~updateThread">updateThread</a></li></ul></li><li></li><li></li><li><a href="module-GuidedCourses.html">GuidedCourses</a><ul class='methods'><li data-type='method'><a href="module-GuidedCourses.html#~getActivePath">getActivePath</a></li><li data-type='method'><a href="module-GuidedCourses.html#~getDailySession">getDailySession</a></li><li data-type='method'><a href="module-GuidedCourses.html#~updateActivePath">updateActivePath</a></li><li data-type='method'><a href="module-GuidedCourses.html#~updateDailySession">updateDailySession</a></li></ul></li><li></li><li><a href="module-Interests.html">Interests</a><ul class='methods'><li data-type='method'><a href="module-Interests.html#.fetchInterests">fetchInterests</a></li><li data-type='method'><a href="module-Interests.html#.fetchUninterests">fetchUninterests</a></li><li data-type='method'><a href="module-Interests.html#.markContentAsInterested">markContentAsInterested</a></li><li data-type='method'><a href="module-Interests.html#.markContentAsNotInterested">markContentAsNotInterested</a></li><li data-type='method'><a href="module-Interests.html#.removeContentAsInterested">removeContentAsInterested</a></li><li data-type='method'><a href="module-Interests.html#.removeContentAsNotInterested">removeContentAsNotInterested</a></li></ul></li><li><a href="module-Onboarding.html">Onboarding</a><ul class='methods'><li data-type='method'><a href="module-Onboarding.html#~startOnboarding">startOnboarding</a></li><li data-type='method'><a href="module-Onboarding.html#~updateOnboarding">updateOnboarding</a></li><li data-type='method'><a href="module-Onboarding.html#~userOnboardingForBrand">userOnboardingForBrand</a></li></ul></li><li><a href="module-Payments.html">Payments</a><ul class='methods'><li data-type='method'><a href="module-Payments.html#~fetchCustomerPayments">fetchCustomerPayments</a></li></ul></li><li><a href="module-Permissions.html">Permissions</a><ul class='methods'><li data-type='method'><a href="module-Permissions.html#.fetchUserPermissions">fetchUserPermissions</a></li><li data-type='method'><a href="module-Permissions.html#.reset">reset</a></li></ul></li><li><a href="module-Playlists.html">Playlists</a><ul class='methods'><li data-type='method'><a href="module-Playlists.html#.addItemToPlaylist">addItemToPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.createPlaylist">createPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.deletePlaylist">deletePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.duplicatePlaylist">duplicatePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.fetchPlaylist">fetchPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.fetchPlaylistItems">fetchPlaylistItems</a></li><li data-type='method'><a href="module-Playlists.html#.fetchUserPlaylists">fetchUserPlaylists</a></li><li data-type='method'><a href="module-Playlists.html#.togglePlaylistPrivate">togglePlaylistPrivate</a></li><li data-type='method'><a href="module-Playlists.html#.undeletePlaylist">undeletePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.updatePlaylist">updatePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~deleteItemsFromPlaylist">deleteItemsFromPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~likePlaylist">likePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~reportPlaylist">reportPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~restoreItemFromPlaylist">restoreItemFromPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~unlikePlaylist">unlikePlaylist</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#.assignModeratorToComment">assignModeratorToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.closeComment">closeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.createComment">createComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.deleteComment">deleteComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.editComment">editComment</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#.fetchCarouselCardData">fetchCarouselCardData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchComment">fetchComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCommentRelies">fetchCommentRelies</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchComments">fetchComments</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#.fetchNextContentDataForParent">fetchNextContentDataForParent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchRecentUserActivities">fetchRecentUserActivities</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#.fetchTopComment">fetchTopComment</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#.fetchUserPracticeNotes">fetchUserPracticeNotes</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.likeComment">likeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.openComment">openComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentComplete">postContentComplete</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentReset">postContentReset</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentRestore">postContentRestore</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentStart">postContentStart</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.replyToComment">replyToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.reportComment">reportComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.restoreComment">restoreComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.setStudentViewForUser">setStudentViewForUser</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.unassignModeratorToComment">unassignModeratorToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.unlikeComment">unlikeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#~fetchLastInteractedChild">fetchLastInteractedChild</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#.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#.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#.fetchCoachLessons">fetchCoachLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchComingSoon">fetchComingSoon</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#.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#.fetchLeaving">fetchLeaving</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#.fetchLessonsFeaturingThisContent">fetchLessonsFeaturingThisContent</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#.fetchMethodPreviousNextLesson">fetchMethodPreviousNextLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodV2IntroVideo">fetchMethodV2IntroVideo</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodV2Structure">fetchMethodV2Structure</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#.fetchOtherSongVersions">fetchOtherSongVersions</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#.fetchPackData">fetchPackData</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#.fetchRelatedRecommendedContent">fetchRelatedRecommendedContent</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#.fetchReturning">fetchReturning</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#.fetchSiblingContent">fetchSiblingContent</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#.fetchUpcomingEvents">fetchUpcomingEvents</a></li><li data-type='method'><a href="module-Sanity-Services.html#.jumpToContinueContent">jumpToContinueContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#~fetchRelatedByLicense">fetchRelatedByLicense</a></li><li data-type='method'><a href="module-Sanity-Services.html#~getQueryFromPage">getQueryFromPage</a></li></ul></li><li><a href="module-Sessions.html">Sessions</a><ul class='methods'><li data-type='method'><a href="module-Sessions.html#.login">login</a></li><li data-type='method'><a href="module-Sessions.html#.logout">logout</a></li></ul></li><li><a href="module-UserActivity.html">UserActivity</a><ul class='methods'><li data-type='method'><a href="module-UserActivity.html#.calculateLongestStreaks">calculateLongestStreaks</a></li><li data-type='method'><a href="module-UserActivity.html#.createPracticeNotes">createPracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.deletePracticeSession">deletePracticeSession</a></li><li data-type='method'><a href="module-UserActivity.html#.deleteUserActivity">deleteUserActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.getPracticeNotes">getPracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.getPracticeSessions">getPracticeSessions</a></li><li data-type='method'><a href="module-UserActivity.html#.getProgressRows">getProgressRows</a></li><li data-type='method'><a href="module-UserActivity.html#.getRecentActivity">getRecentActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.getUserMonthlyStats">getUserMonthlyStats</a></li><li data-type='method'><a href="module-UserActivity.html#.getUserWeeklyStats">getUserWeeklyStats</a></li><li data-type='method'><a href="module-UserActivity.html#.pinProgressRow">pinProgressRow</a></li><li data-type='method'><a href="module-UserActivity.html#.recordUserActivity">recordUserActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.recordUserPractice">recordUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.removeUserPractice">removeUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.restorePracticeSession">restorePracticeSession</a></li><li data-type='method'><a href="module-UserActivity.html#.restoreUserActivity">restoreUserActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.restoreUserPractice">restoreUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.unpinProgressRow">unpinProgressRow</a></li><li data-type='method'><a href="module-UserActivity.html#.updatePracticeNotes">updatePracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.updateUserPractice">updateUserPractice</a></li></ul></li><li><a href="module-UserChat.html">UserChat</a><ul class='methods'><li data-type='method'><a href="module-UserChat.html#.fetchChatSettings">fetchChatSettings</a></li></ul></li><li><a href="module-UserManagement.html">UserManagement</a><ul class='methods'><li data-type='method'><a href="module-UserManagement.html#.blockUser">blockUser</a></li><li data-type='method'><a href="module-UserManagement.html#.blockedUsers">blockedUsers</a></li><li data-type='method'><a href="module-UserManagement.html#.deletePicture">deletePicture</a></li><li data-type='method'><a href="module-UserManagement.html#.getUserData">getUserData</a></li><li data-type='method'><a href="module-UserManagement.html#.getUserSignature">getUserSignature</a></li><li data-type='method'><a href="module-UserManagement.html#.isUsernameAvailable">isUsernameAvailable</a></li><li data-type='method'><a href="module-UserManagement.html#.setUserSignature">setUserSignature</a></li><li data-type='method'><a href="module-UserManagement.html#.toggleSignaturePrivate">toggleSignaturePrivate</a></li><li data-type='method'><a href="module-UserManagement.html#.unblockUser">unblockUser</a></li><li data-type='method'><a href="module-UserManagement.html#.updateDisplayName">updateDisplayName</a></li><li data-type='method'><a href="module-UserManagement.html#.uploadPicture">uploadPicture</a></li><li data-type='method'><a href="module-UserManagement.html#.uploadPictureFromS3">uploadPictureFromS3</a></li></ul></li><li><a href="module-UserMemberships.html">UserMemberships</a><ul class='methods'><li data-type='method'><a href="module-UserMemberships.html#~fetchMemberships">fetchMemberships</a></li><li data-type='method'><a href="module-UserMemberships.html#~fetchRechargeTokens">fetchRechargeTokens</a></li><li data-type='method'><a href="module-UserMemberships.html#~restorePurchases">restorePurchases</a></li><li data-type='method'><a href="module-UserMemberships.html#~upgradeSubscription">upgradeSubscription</a></li></ul></li><li><a href="module-UserNotifications.html">UserNotifications</a><ul class='methods'><li data-type='method'><a href="module-UserNotifications.html#.deleteNotification">deleteNotification</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchLiveEventPollingState">fetchLiveEventPollingState</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchNotificationSettings">fetchNotificationSettings</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchNotifications">fetchNotifications</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchUnreadCount">fetchUnreadCount</a></li><li data-type='method'><a href="module-UserNotifications.html#.markAllNotificationsAsRead">markAllNotificationsAsRead</a></li><li data-type='method'><a href="module-UserNotifications.html#.markNotificationAsRead">markNotificationAsRead</a></li><li data-type='method'><a href="module-UserNotifications.html#.markNotificationAsUnread">markNotificationAsUnread</a></li><li data-type='method'><a href="module-UserNotifications.html#.pauseLiveEventPolling">pauseLiveEventPolling</a></li><li data-type='method'><a href="module-UserNotifications.html#.restoreNotification">restoreNotification</a></li><li data-type='method'><a href="module-UserNotifications.html#.startLiveEventPolling">startLiveEventPolling</a></li><li data-type='method'><a href="module-UserNotifications.html#.updateNotificationSetting">updateNotificationSetting</a></li></ul></li><li><a href="module-UserProfile.html">UserProfile</a><ul class='methods'><li data-type='method'><a href="module-UserProfile.html#.deleteProfilePicture">deleteProfilePicture</a></li><li data-type='method'><a href="module-UserProfile.html#.otherStats">otherStats</a></li></ul></li></ul><h3>Namespaces</h3><ul><li><a href="ContentOrganization.html">ContentOrganization</a></li><li><a href="Forums.html">Forums</a></li><li><a href="Gamification.html">Gamification</a></li><li><a href="UserManagementSystem.html">UserManagementSystem</a></li></ul><h3>Interfaces</h3><ul><li><a href="TestUser.html">TestUser</a></li></ul><h3>Global</h3><ul><li><a href="global.html#createTestUser">createTestUser</a></li></ul>
|
|
33
33
|
|
|
34
34
|
</nav>
|
|
35
35
|
|
|
@@ -94,7 +94,7 @@
|
|
|
94
94
|
|
|
95
95
|
<dt class="tag-source">Source:</dt>
|
|
96
96
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
97
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
97
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line12">line 12</a>
|
|
98
98
|
</li></ul></dd>
|
|
99
99
|
|
|
100
100
|
|
|
@@ -179,7 +179,7 @@
|
|
|
179
179
|
|
|
180
180
|
<dt class="tag-source">Source:</dt>
|
|
181
181
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
182
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
182
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line516">line 516</a>
|
|
183
183
|
</li></ul></dd>
|
|
184
184
|
|
|
185
185
|
|
|
@@ -330,7 +330,7 @@
|
|
|
330
330
|
|
|
331
331
|
<dt class="tag-source">Source:</dt>
|
|
332
332
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
333
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
333
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line552">line 552</a>
|
|
334
334
|
</li></ul></dd>
|
|
335
335
|
|
|
336
336
|
|
|
@@ -481,7 +481,7 @@
|
|
|
481
481
|
|
|
482
482
|
<dt class="tag-source">Source:</dt>
|
|
483
483
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
484
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
484
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line503">line 503</a>
|
|
485
485
|
</li></ul></dd>
|
|
486
486
|
|
|
487
487
|
|
|
@@ -656,7 +656,7 @@
|
|
|
656
656
|
|
|
657
657
|
<dt class="tag-source">Source:</dt>
|
|
658
658
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
659
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
659
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line473">line 473</a>
|
|
660
660
|
</li></ul></dd>
|
|
661
661
|
|
|
662
662
|
|
|
@@ -807,7 +807,7 @@
|
|
|
807
807
|
|
|
808
808
|
<dt class="tag-source">Source:</dt>
|
|
809
809
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
810
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
810
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line577">line 577</a>
|
|
811
811
|
</li></ul></dd>
|
|
812
812
|
|
|
813
813
|
|
|
@@ -985,7 +985,7 @@
|
|
|
985
985
|
|
|
986
986
|
<dt class="tag-source">Source:</dt>
|
|
987
987
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
988
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
988
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line67">line 67</a>
|
|
989
989
|
</li></ul></dd>
|
|
990
990
|
|
|
991
991
|
|
|
@@ -1150,7 +1150,7 @@
|
|
|
1150
1150
|
|
|
1151
1151
|
<dt class="tag-source">Source:</dt>
|
|
1152
1152
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
1153
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
1153
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line363">line 363</a>
|
|
1154
1154
|
</li></ul></dd>
|
|
1155
1155
|
|
|
1156
1156
|
|
|
@@ -1238,7 +1238,7 @@
|
|
|
1238
1238
|
|
|
1239
1239
|
|
|
1240
1240
|
|
|
1241
|
-
<h4 class="name" id=".
|
|
1241
|
+
<h4 class="name" id=".fetchComment"><span class="type-signature type-signature-static">(static) </span>fetchComment<span class="signature">(commentId)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
1242
1242
|
|
|
1243
1243
|
|
|
1244
1244
|
|
|
@@ -1248,14 +1248,13 @@
|
|
|
1248
1248
|
<dl class="details">
|
|
1249
1249
|
|
|
1250
1250
|
<dt class="tag-description">Description:</dt>
|
|
1251
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
1252
|
-
Intended to be used on the index page for challenges</li></ul></dd>
|
|
1251
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetches a single comment by its ID.</li></ul></dd>
|
|
1253
1252
|
|
|
1254
1253
|
|
|
1255
1254
|
|
|
1256
1255
|
<dt class="tag-source">Source:</dt>
|
|
1257
1256
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
1258
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
1257
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line609">line 609</a>
|
|
1259
1258
|
</li></ul></dd>
|
|
1260
1259
|
|
|
1261
1260
|
|
|
@@ -1300,6 +1299,13 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
1300
1299
|
|
|
1301
1300
|
|
|
1302
1301
|
|
|
1302
|
+
<h5 class="h5-examples">Example</h5>
|
|
1303
|
+
|
|
1304
|
+
<pre class="prettyprint"><code>fetchComment(123)
|
|
1305
|
+
.then(comment => console.log(comment))
|
|
1306
|
+
.catch(error => console.error(error));</code></pre>
|
|
1307
|
+
|
|
1308
|
+
|
|
1303
1309
|
|
|
1304
1310
|
|
|
1305
1311
|
<h5 class="h5-parameters">Parameters:</h5>
|
|
@@ -1327,13 +1333,16 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
1327
1333
|
|
|
1328
1334
|
<tr>
|
|
1329
1335
|
|
|
1330
|
-
<td class="name"><code>
|
|
1336
|
+
<td class="name"><code>commentId</code></td>
|
|
1331
1337
|
|
|
1332
1338
|
|
|
1333
1339
|
<td class="type">
|
|
1334
1340
|
|
|
1335
1341
|
|
|
1336
|
-
<span class="param-type">
|
|
1342
|
+
<span class="param-type">number</span>
|
|
1343
|
+
|
|
|
1344
|
+
|
|
1345
|
+
<span class="param-type">string</span>
|
|
1337
1346
|
|
|
1338
1347
|
|
|
1339
1348
|
|
|
@@ -1344,7 +1353,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
1344
1353
|
|
|
1345
1354
|
|
|
1346
1355
|
|
|
1347
|
-
<td class="description last">
|
|
1356
|
+
<td class="description last">The ID of the comment to fetch.</td>
|
|
1348
1357
|
</tr>
|
|
1349
1358
|
|
|
1350
1359
|
|
|
@@ -1369,6 +1378,10 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
1369
1378
|
<h5 class="h5-returns">Returns:</h5>
|
|
1370
1379
|
|
|
1371
1380
|
|
|
1381
|
+
<div class="param-desc">
|
|
1382
|
+
- A promise that resolves to the comment object if found, otherwise null.
|
|
1383
|
+
</div>
|
|
1384
|
+
|
|
1372
1385
|
|
|
1373
1386
|
|
|
1374
1387
|
<dl class="param-type">
|
|
@@ -1377,7 +1390,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
1377
1390
|
</dt>
|
|
1378
1391
|
<dd>
|
|
1379
1392
|
|
|
1380
|
-
<span class="param-type">Promise.<(
|
|
1393
|
+
<span class="param-type">Promise.<(Object|null)></span>
|
|
1381
1394
|
|
|
1382
1395
|
|
|
1383
1396
|
|
|
@@ -1393,7 +1406,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
1393
1406
|
|
|
1394
1407
|
|
|
1395
1408
|
|
|
1396
|
-
<h4 class="name" id=".
|
|
1409
|
+
<h4 class="name" id=".fetchCommentRelies"><span class="type-signature type-signature-static">(static) </span>fetchCommentRelies<span class="signature">(commentId, page, limit)</span><span class="type-signature"> → {Promise.<(*|null)>}</span></h4>
|
|
1397
1410
|
|
|
1398
1411
|
|
|
1399
1412
|
|
|
@@ -1402,14 +1415,11 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
1402
1415
|
|
|
1403
1416
|
<dl class="details">
|
|
1404
1417
|
|
|
1405
|
-
<dt class="tag-description">Description:</dt>
|
|
1406
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetch lesson, user, and challenge data for a given lesson</li></ul></dd>
|
|
1407
|
-
|
|
1408
1418
|
|
|
1409
1419
|
|
|
1410
1420
|
<dt class="tag-source">Source:</dt>
|
|
1411
1421
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
1412
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
1422
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line464">line 464</a>
|
|
1413
1423
|
</li></ul></dd>
|
|
1414
1424
|
|
|
1415
1425
|
|
|
@@ -1481,18 +1491,72 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
1481
1491
|
|
|
1482
1492
|
<tr>
|
|
1483
1493
|
|
|
1484
|
-
<td class="name"><code>
|
|
1494
|
+
<td class="name"><code>commentId</code></td>
|
|
1495
|
+
|
|
1496
|
+
|
|
1497
|
+
<td class="type">
|
|
1498
|
+
|
|
1499
|
+
|
|
1500
|
+
<span class="param-type">int</span>
|
|
1501
|
+
|
|
1502
|
+
|
|
1503
|
+
|
|
1504
|
+
|
|
1505
|
+
</td>
|
|
1506
|
+
|
|
1507
|
+
|
|
1508
|
+
|
|
1509
|
+
|
|
1510
|
+
|
|
1511
|
+
<td class="description last"></td>
|
|
1512
|
+
</tr>
|
|
1513
|
+
|
|
1514
|
+
|
|
1515
|
+
|
|
1516
|
+
<tr>
|
|
1517
|
+
|
|
1518
|
+
<td class="name"><code>page</code></td>
|
|
1519
|
+
|
|
1520
|
+
|
|
1521
|
+
<td class="type">
|
|
1522
|
+
|
|
1523
|
+
|
|
1524
|
+
<span class="param-type">int</span>
|
|
1525
|
+
|
|
1526
|
+
|
|
1527
|
+
|
|
1528
|
+
|
|
1529
|
+
</td>
|
|
1530
|
+
|
|
1531
|
+
|
|
1532
|
+
|
|
1533
|
+
|
|
1534
|
+
|
|
1535
|
+
<td class="description last"></td>
|
|
1536
|
+
</tr>
|
|
1537
|
+
|
|
1538
|
+
|
|
1539
|
+
|
|
1540
|
+
<tr>
|
|
1541
|
+
|
|
1542
|
+
<td class="name"><code>limit</code></td>
|
|
1485
1543
|
|
|
1486
1544
|
|
|
1487
1545
|
<td class="type">
|
|
1488
1546
|
|
|
1547
|
+
|
|
1548
|
+
<span class="param-type">int</span>
|
|
1549
|
+
|
|
1550
|
+
|
|
1551
|
+
|
|
1552
|
+
|
|
1489
1553
|
</td>
|
|
1490
1554
|
|
|
1491
1555
|
|
|
1492
1556
|
|
|
1493
1557
|
|
|
1494
1558
|
|
|
1495
|
-
<td class="description last"
|
|
1559
|
+
<td class="description last"></td>
|
|
1496
1560
|
</tr>
|
|
1497
1561
|
|
|
1498
1562
|
|
|
@@ -1525,7 +1589,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
1525
1589
|
</dt>
|
|
1526
1590
|
<dd>
|
|
1527
1591
|
|
|
1528
|
-
<span class="param-type">Promise.<(
|
|
1592
|
+
<span class="param-type">Promise.<(*|null)></span>
|
|
1529
1593
|
|
|
1530
1594
|
|
|
1531
1595
|
|
|
@@ -1541,7 +1605,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
1541
1605
|
|
|
1542
1606
|
|
|
1543
1607
|
|
|
1544
|
-
<h4 class="name" id=".
|
|
1608
|
+
<h4 class="name" id=".fetchComments"><span class="type-signature type-signature-static">(static) </span>fetchComments<span class="signature">(railcontentId, page, limit)</span><span class="type-signature"> → {Promise.<(*|null)>}</span></h4>
|
|
1545
1609
|
|
|
1546
1610
|
|
|
1547
1611
|
|
|
@@ -1550,14 +1614,11 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
1550
1614
|
|
|
1551
1615
|
<dl class="details">
|
|
1552
1616
|
|
|
1553
|
-
<dt class="tag-description">Description:</dt>
|
|
1554
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetch enrolled user data for a given challenge. Intended to be used in the enrolled modal</li></ul></dd>
|
|
1555
|
-
|
|
1556
1617
|
|
|
1557
1618
|
|
|
1558
1619
|
<dt class="tag-source">Source:</dt>
|
|
1559
1620
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
1560
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
1621
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line452">line 452</a>
|
|
1561
1622
|
</li></ul></dd>
|
|
1562
1623
|
|
|
1563
1624
|
|
|
@@ -1629,127 +1690,77 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
1629
1690
|
|
|
1630
1691
|
<tr>
|
|
1631
1692
|
|
|
1632
|
-
<td class="name"><code>
|
|
1693
|
+
<td class="name"><code>railcontentId</code></td>
|
|
1633
1694
|
|
|
1634
1695
|
|
|
1635
1696
|
<td class="type">
|
|
1636
1697
|
|
|
1698
|
+
|
|
1699
|
+
<span class="param-type">int</span>
|
|
1700
|
+
|
|
1701
|
+
|
|
1702
|
+
|
|
1703
|
+
|
|
1637
1704
|
</td>
|
|
1638
1705
|
|
|
1639
1706
|
|
|
1640
1707
|
|
|
1641
1708
|
|
|
1642
1709
|
|
|
1643
|
-
<td class="description last"
|
|
1710
|
+
<td class="description last"></td>
|
|
1644
1711
|
</tr>
|
|
1645
1712
|
|
|
1646
1713
|
|
|
1647
|
-
</tbody>
|
|
1648
|
-
</table>
|
|
1649
|
-
|
|
1650
|
-
|
|
1651
|
-
|
|
1652
|
-
|
|
1653
|
-
|
|
1654
|
-
|
|
1655
|
-
|
|
1656
|
-
|
|
1657
|
-
|
|
1658
|
-
|
|
1659
|
-
|
|
1660
|
-
|
|
1661
|
-
|
|
1662
|
-
|
|
1663
|
-
|
|
1664
|
-
|
|
1665
|
-
<h5 class="h5-returns">Returns:</h5>
|
|
1666
|
-
|
|
1667
|
-
|
|
1668
|
-
|
|
1669
|
-
|
|
1670
|
-
<dl class="param-type">
|
|
1671
|
-
<dt>
|
|
1672
|
-
Type
|
|
1673
|
-
</dt>
|
|
1674
|
-
<dd>
|
|
1675
|
-
|
|
1676
|
-
<span class="param-type">Promise.<(any|null)></span>
|
|
1677
|
-
|
|
1678
|
-
|
|
1679
|
-
|
|
1680
|
-
</dd>
|
|
1681
|
-
</dl>
|
|
1682
|
-
|
|
1683
|
-
|
|
1684
|
-
|
|
1685
1714
|
|
|
1686
|
-
|
|
1687
|
-
|
|
1715
|
+
<tr>
|
|
1716
|
+
|
|
1717
|
+
<td class="name"><code>page</code></td>
|
|
1688
1718
|
|
|
1689
1719
|
|
|
1690
|
-
|
|
1691
|
-
|
|
1692
|
-
|
|
1693
|
-
|
|
1694
|
-
|
|
1695
|
-
|
|
1696
|
-
|
|
1697
|
-
|
|
1698
|
-
|
|
1699
|
-
<dl class="details">
|
|
1700
|
-
|
|
1701
|
-
<dt class="tag-description">Description:</dt>
|
|
1702
|
-
<dd class="tag-description"><ul class="dummy"><li>Get active brand challenges for the authorized user</li></ul></dd>
|
|
1703
|
-
|
|
1720
|
+
<td class="type">
|
|
1721
|
+
|
|
1722
|
+
|
|
1723
|
+
<span class="param-type">int</span>
|
|
1704
1724
|
|
|
1705
|
-
|
|
1706
|
-
<dt class="tag-source">Source:</dt>
|
|
1707
|
-
<dd class="tag-source"><ul class="dummy"><li>
|
|
1708
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line449">line 449</a>
|
|
1709
|
-
</li></ul></dd>
|
|
1710
|
-
|
|
1711
1725
|
|
|
1712
|
-
|
|
1713
1726
|
|
|
1714
|
-
|
|
1727
|
+
|
|
1728
|
+
</td>
|
|
1715
1729
|
|
|
1716
|
-
|
|
1730
|
+
|
|
1717
1731
|
|
|
1718
|
-
|
|
1732
|
+
|
|
1719
1733
|
|
|
1720
|
-
|
|
1734
|
+
<td class="description last"></td>
|
|
1735
|
+
</tr>
|
|
1721
1736
|
|
|
1722
1737
|
|
|
1723
1738
|
|
|
1724
|
-
|
|
1739
|
+
<tr>
|
|
1740
|
+
|
|
1741
|
+
<td class="name"><code>limit</code></td>
|
|
1742
|
+
|
|
1725
1743
|
|
|
1726
|
-
|
|
1744
|
+
<td class="type">
|
|
1745
|
+
|
|
1746
|
+
|
|
1747
|
+
<span class="param-type">int</span>
|
|
1727
1748
|
|
|
1728
|
-
|
|
1729
1749
|
|
|
1730
|
-
|
|
1731
1750
|
|
|
1732
|
-
|
|
1751
|
+
|
|
1752
|
+
</td>
|
|
1733
1753
|
|
|
1734
|
-
|
|
1754
|
+
|
|
1735
1755
|
|
|
1736
|
-
|
|
1756
|
+
|
|
1737
1757
|
|
|
1738
|
-
|
|
1758
|
+
<td class="description last"></td>
|
|
1759
|
+
</tr>
|
|
1739
1760
|
|
|
1740
1761
|
|
|
1741
|
-
</
|
|
1742
|
-
|
|
1743
|
-
|
|
1744
|
-
|
|
1745
|
-
|
|
1746
|
-
|
|
1747
|
-
|
|
1748
|
-
|
|
1749
|
-
|
|
1750
|
-
|
|
1751
|
-
|
|
1752
|
-
|
|
1762
|
+
</tbody>
|
|
1763
|
+
</table>
|
|
1753
1764
|
|
|
1754
1765
|
|
|
1755
1766
|
|
|
@@ -1777,7 +1788,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
1777
1788
|
</dt>
|
|
1778
1789
|
<dd>
|
|
1779
1790
|
|
|
1780
|
-
<span class="param-type">Promise.<(
|
|
1791
|
+
<span class="param-type">Promise.<(*|null)></span>
|
|
1781
1792
|
|
|
1782
1793
|
|
|
1783
1794
|
|
|
@@ -1793,7 +1804,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
1793
1804
|
|
|
1794
1805
|
|
|
1795
1806
|
|
|
1796
|
-
<h4 class="name" id=".
|
|
1807
|
+
<h4 class="name" id=".fetchCompletedContent"><span class="type-signature type-signature-static">(static) </span>fetchCompletedContent<span class="signature">(type, brand)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
1797
1808
|
|
|
1798
1809
|
|
|
1799
1810
|
|
|
@@ -1802,11 +1813,14 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
1802
1813
|
|
|
1803
1814
|
<dl class="details">
|
|
1804
1815
|
|
|
1816
|
+
<dt class="tag-description">Description:</dt>
|
|
1817
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetches a list of content that has been completed for the current user.</li></ul></dd>
|
|
1818
|
+
|
|
1805
1819
|
|
|
1806
1820
|
|
|
1807
1821
|
<dt class="tag-source">Source:</dt>
|
|
1808
1822
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
1809
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
1823
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line180">line 180</a>
|
|
1810
1824
|
</li></ul></dd>
|
|
1811
1825
|
|
|
1812
1826
|
|
|
@@ -1851,6 +1865,13 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
1851
1865
|
|
|
1852
1866
|
|
|
1853
1867
|
|
|
1868
|
+
<h5 class="h5-examples">Example</h5>
|
|
1869
|
+
|
|
1870
|
+
<pre class="prettyprint"><code>fetchCompletedContent('song', 'drumeo')
|
|
1871
|
+
.then(songs => console.log(songs))
|
|
1872
|
+
.catch(error => console.error(error));</code></pre>
|
|
1873
|
+
|
|
1874
|
+
|
|
1854
1875
|
|
|
1855
1876
|
|
|
1856
1877
|
<h5 class="h5-parameters">Parameters:</h5>
|
|
@@ -1866,8 +1887,12 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
1866
1887
|
<th>Type</th>
|
|
1867
1888
|
|
|
1868
1889
|
|
|
1890
|
+
<th>Attributes</th>
|
|
1891
|
+
|
|
1869
1892
|
|
|
1870
1893
|
|
|
1894
|
+
<th>Default</th>
|
|
1895
|
+
|
|
1871
1896
|
|
|
1872
1897
|
<th class="last">Description</th>
|
|
1873
1898
|
</tr>
|
|
@@ -1878,13 +1903,13 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
1878
1903
|
|
|
1879
1904
|
<tr>
|
|
1880
1905
|
|
|
1881
|
-
<td class="name"><code>
|
|
1906
|
+
<td class="name"><code>type</code></td>
|
|
1882
1907
|
|
|
1883
1908
|
|
|
1884
1909
|
<td class="type">
|
|
1885
1910
|
|
|
1886
1911
|
|
|
1887
|
-
<span class="param-type">
|
|
1912
|
+
<span class="param-type">string</span>
|
|
1888
1913
|
|
|
1889
1914
|
|
|
1890
1915
|
|
|
@@ -1892,23 +1917,35 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
1892
1917
|
</td>
|
|
1893
1918
|
|
|
1894
1919
|
|
|
1920
|
+
<td class="attributes">
|
|
1921
|
+
|
|
1922
|
+
|
|
1923
|
+
|
|
1895
1924
|
|
|
1925
|
+
|
|
1926
|
+
</td>
|
|
1896
1927
|
|
|
1897
1928
|
|
|
1898
|
-
|
|
1929
|
+
|
|
1930
|
+
<td class="default">
|
|
1931
|
+
|
|
1932
|
+
</td>
|
|
1933
|
+
|
|
1934
|
+
|
|
1935
|
+
<td class="description last">The content type associated with the content.</td>
|
|
1899
1936
|
</tr>
|
|
1900
1937
|
|
|
1901
1938
|
|
|
1902
1939
|
|
|
1903
1940
|
<tr>
|
|
1904
1941
|
|
|
1905
|
-
<td class="name"><code>
|
|
1942
|
+
<td class="name"><code>brand</code></td>
|
|
1906
1943
|
|
|
1907
1944
|
|
|
1908
1945
|
<td class="type">
|
|
1909
1946
|
|
|
1910
1947
|
|
|
1911
|
-
<span class="param-type">
|
|
1948
|
+
<span class="param-type">string</span>
|
|
1912
1949
|
|
|
1913
1950
|
|
|
1914
1951
|
|
|
@@ -1916,23 +1953,35 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
1916
1953
|
</td>
|
|
1917
1954
|
|
|
1918
1955
|
|
|
1956
|
+
<td class="attributes">
|
|
1957
|
+
|
|
1919
1958
|
|
|
1920
|
-
|
|
1921
|
-
|
|
1922
|
-
<td class="description last"></td>
|
|
1923
|
-
</tr>
|
|
1959
|
+
|
|
1924
1960
|
|
|
1925
|
-
|
|
1961
|
+
|
|
1962
|
+
</td>
|
|
1963
|
+
|
|
1926
1964
|
|
|
1927
|
-
<tr>
|
|
1928
1965
|
|
|
1929
|
-
<td class="
|
|
1966
|
+
<td class="default">
|
|
1967
|
+
|
|
1968
|
+
</td>
|
|
1969
|
+
|
|
1970
|
+
|
|
1971
|
+
<td class="description last">The brand associated with the content.</td>
|
|
1972
|
+
</tr>
|
|
1973
|
+
|
|
1974
|
+
|
|
1975
|
+
|
|
1976
|
+
<tr>
|
|
1977
|
+
|
|
1978
|
+
<td class="name"><code>params.limit</code></td>
|
|
1930
1979
|
|
|
1931
1980
|
|
|
1932
1981
|
<td class="type">
|
|
1933
1982
|
|
|
1934
1983
|
|
|
1935
|
-
<span class="param-type">
|
|
1984
|
+
<span class="param-type">number</span>
|
|
1936
1985
|
|
|
1937
1986
|
|
|
1938
1987
|
|
|
@@ -1940,10 +1989,66 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
1940
1989
|
</td>
|
|
1941
1990
|
|
|
1942
1991
|
|
|
1992
|
+
<td class="attributes">
|
|
1993
|
+
|
|
1994
|
+
<optional><br>
|
|
1995
|
+
|
|
1996
|
+
|
|
1997
|
+
|
|
1998
|
+
|
|
1999
|
+
|
|
2000
|
+
</td>
|
|
2001
|
+
|
|
1943
2002
|
|
|
1944
2003
|
|
|
2004
|
+
<td class="default">
|
|
2005
|
+
|
|
2006
|
+
<code>20</code>
|
|
2007
|
+
|
|
2008
|
+
</td>
|
|
2009
|
+
|
|
1945
2010
|
|
|
1946
|
-
<td class="description last"
|
|
2011
|
+
<td class="description last">The limit of results per page.</td>
|
|
2012
|
+
</tr>
|
|
2013
|
+
|
|
2014
|
+
|
|
2015
|
+
|
|
2016
|
+
<tr>
|
|
2017
|
+
|
|
2018
|
+
<td class="name"><code>params.page</code></td>
|
|
2019
|
+
|
|
2020
|
+
|
|
2021
|
+
<td class="type">
|
|
2022
|
+
|
|
2023
|
+
|
|
2024
|
+
<span class="param-type">number</span>
|
|
2025
|
+
|
|
2026
|
+
|
|
2027
|
+
|
|
2028
|
+
|
|
2029
|
+
</td>
|
|
2030
|
+
|
|
2031
|
+
|
|
2032
|
+
<td class="attributes">
|
|
2033
|
+
|
|
2034
|
+
<optional><br>
|
|
2035
|
+
|
|
2036
|
+
|
|
2037
|
+
|
|
2038
|
+
|
|
2039
|
+
|
|
2040
|
+
</td>
|
|
2041
|
+
|
|
2042
|
+
|
|
2043
|
+
|
|
2044
|
+
<td class="default">
|
|
2045
|
+
|
|
2046
|
+
<code>1</code>
|
|
2047
|
+
|
|
2048
|
+
</td>
|
|
2049
|
+
|
|
2050
|
+
|
|
2051
|
+
<td class="description last">The page number for pagination.</td>
|
|
1947
2052
|
</tr>
|
|
1948
2053
|
|
|
1949
2054
|
|
|
@@ -1968,6 +2073,10 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
1968
2073
|
<h5 class="h5-returns">Returns:</h5>
|
|
1969
2074
|
|
|
1970
2075
|
|
|
2076
|
+
<div class="param-desc">
|
|
2077
|
+
- Returns an object containing in-progress content if found, otherwise null.
|
|
2078
|
+
</div>
|
|
2079
|
+
|
|
1971
2080
|
|
|
1972
2081
|
|
|
1973
2082
|
<dl class="param-type">
|
|
@@ -1976,7 +2085,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
1976
2085
|
</dt>
|
|
1977
2086
|
<dd>
|
|
1978
2087
|
|
|
1979
|
-
<span class="param-type">Promise.<(
|
|
2088
|
+
<span class="param-type">Promise.<(Object|null)></span>
|
|
1980
2089
|
|
|
1981
2090
|
|
|
1982
2091
|
|
|
@@ -1992,7 +2101,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
1992
2101
|
|
|
1993
2102
|
|
|
1994
2103
|
|
|
1995
|
-
<h4 class="name" id=".
|
|
2104
|
+
<h4 class="name" id=".fetchCompletedState"><span class="type-signature type-signature-static">(static) </span>fetchCompletedState<span class="signature">(content_id)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
1996
2105
|
|
|
1997
2106
|
|
|
1998
2107
|
|
|
@@ -2001,11 +2110,14 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
2001
2110
|
|
|
2002
2111
|
<dl class="details">
|
|
2003
2112
|
|
|
2113
|
+
<dt class="tag-description">Description:</dt>
|
|
2114
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetches the completion status of a specific lesson for the current user.</li></ul></dd>
|
|
2115
|
+
|
|
2004
2116
|
|
|
2005
2117
|
|
|
2006
2118
|
<dt class="tag-source">Source:</dt>
|
|
2007
2119
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
2008
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
2120
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line33">line 33</a>
|
|
2009
2121
|
</li></ul></dd>
|
|
2010
2122
|
|
|
2011
2123
|
|
|
@@ -2050,6 +2162,13 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
2050
2162
|
|
|
2051
2163
|
|
|
2052
2164
|
|
|
2165
|
+
<h5 class="h5-examples">Example</h5>
|
|
2166
|
+
|
|
2167
|
+
<pre class="prettyprint"><code>fetchCurrentSongComplete('user123', 'lesson456', 'csrf-token')
|
|
2168
|
+
.then(status => console.log(status))
|
|
2169
|
+
.catch(error => console.error(error));</code></pre>
|
|
2170
|
+
|
|
2171
|
+
|
|
2053
2172
|
|
|
2054
2173
|
|
|
2055
2174
|
<h5 class="h5-parameters">Parameters:</h5>
|
|
@@ -2077,61 +2196,13 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
2077
2196
|
|
|
2078
2197
|
<tr>
|
|
2079
2198
|
|
|
2080
|
-
<td class="name"><code>
|
|
2081
|
-
|
|
2082
|
-
|
|
2083
|
-
<td class="type">
|
|
2084
|
-
|
|
2085
|
-
|
|
2086
|
-
<span class="param-type">int</span>
|
|
2087
|
-
|
|
2088
|
-
|
|
2089
|
-
|
|
2090
|
-
|
|
2091
|
-
</td>
|
|
2092
|
-
|
|
2093
|
-
|
|
2094
|
-
|
|
2095
|
-
|
|
2096
|
-
|
|
2097
|
-
<td class="description last"></td>
|
|
2098
|
-
</tr>
|
|
2099
|
-
|
|
2100
|
-
|
|
2101
|
-
|
|
2102
|
-
<tr>
|
|
2103
|
-
|
|
2104
|
-
<td class="name"><code>page</code></td>
|
|
2105
|
-
|
|
2106
|
-
|
|
2107
|
-
<td class="type">
|
|
2108
|
-
|
|
2109
|
-
|
|
2110
|
-
<span class="param-type">int</span>
|
|
2111
|
-
|
|
2112
|
-
|
|
2113
|
-
|
|
2114
|
-
|
|
2115
|
-
</td>
|
|
2116
|
-
|
|
2117
|
-
|
|
2118
|
-
|
|
2119
|
-
|
|
2120
|
-
|
|
2121
|
-
<td class="description last"></td>
|
|
2122
|
-
</tr>
|
|
2123
|
-
|
|
2124
|
-
|
|
2125
|
-
|
|
2126
|
-
<tr>
|
|
2127
|
-
|
|
2128
|
-
<td class="name"><code>limit</code></td>
|
|
2199
|
+
<td class="name"><code>content_id</code></td>
|
|
2129
2200
|
|
|
2130
2201
|
|
|
2131
2202
|
<td class="type">
|
|
2132
2203
|
|
|
2133
2204
|
|
|
2134
|
-
<span class="param-type">
|
|
2205
|
+
<span class="param-type">string</span>
|
|
2135
2206
|
|
|
2136
2207
|
|
|
2137
2208
|
|
|
@@ -2142,7 +2213,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
2142
2213
|
|
|
2143
2214
|
|
|
2144
2215
|
|
|
2145
|
-
<td class="description last"
|
|
2216
|
+
<td class="description last">The ID of the lesson content to check.</td>
|
|
2146
2217
|
</tr>
|
|
2147
2218
|
|
|
2148
2219
|
|
|
@@ -2167,6 +2238,10 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
2167
2238
|
<h5 class="h5-returns">Returns:</h5>
|
|
2168
2239
|
|
|
2169
2240
|
|
|
2241
|
+
<div class="param-desc">
|
|
2242
|
+
- Returns the completion status object if found, otherwise null.
|
|
2243
|
+
</div>
|
|
2244
|
+
|
|
2170
2245
|
|
|
2171
2246
|
|
|
2172
2247
|
<dl class="param-type">
|
|
@@ -2175,7 +2250,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
2175
2250
|
</dt>
|
|
2176
2251
|
<dd>
|
|
2177
2252
|
|
|
2178
|
-
<span class="param-type">Promise.<(
|
|
2253
|
+
<span class="param-type">Promise.<(Object|null)></span>
|
|
2179
2254
|
|
|
2180
2255
|
|
|
2181
2256
|
|
|
@@ -2191,7 +2266,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
2191
2266
|
|
|
2192
2267
|
|
|
2193
2268
|
|
|
2194
|
-
<h4 class="name" id=".
|
|
2269
|
+
<h4 class="name" id=".fetchContentInProgress"><span class="type-signature type-signature-static">(static) </span>fetchContentInProgress<span class="signature">(type, brand)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
2195
2270
|
|
|
2196
2271
|
|
|
2197
2272
|
|
|
@@ -2201,13 +2276,13 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
2201
2276
|
<dl class="details">
|
|
2202
2277
|
|
|
2203
2278
|
<dt class="tag-description">Description:</dt>
|
|
2204
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
2279
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetches a list of content that is currently in progress for the current user.</li></ul></dd>
|
|
2205
2280
|
|
|
2206
2281
|
|
|
2207
2282
|
|
|
2208
2283
|
<dt class="tag-source">Source:</dt>
|
|
2209
2284
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
2210
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
2285
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line137">line 137</a>
|
|
2211
2286
|
</li></ul></dd>
|
|
2212
2287
|
|
|
2213
2288
|
|
|
@@ -2252,6 +2327,13 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
2252
2327
|
|
|
2253
2328
|
|
|
2254
2329
|
|
|
2330
|
+
<h5 class="h5-examples">Example</h5>
|
|
2331
|
+
|
|
2332
|
+
<pre class="prettyprint"><code>fetchContentInProgress('song', 'drumeo')
|
|
2333
|
+
.then(songs => console.log(songs))
|
|
2334
|
+
.catch(error => console.error(error));</code></pre>
|
|
2335
|
+
|
|
2336
|
+
|
|
2255
2337
|
|
|
2256
2338
|
|
|
2257
2339
|
<h5 class="h5-parameters">Parameters:</h5>
|
|
@@ -2267,8 +2349,12 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
2267
2349
|
<th>Type</th>
|
|
2268
2350
|
|
|
2269
2351
|
|
|
2352
|
+
<th>Attributes</th>
|
|
2353
|
+
|
|
2270
2354
|
|
|
2271
2355
|
|
|
2356
|
+
<th>Default</th>
|
|
2357
|
+
|
|
2272
2358
|
|
|
2273
2359
|
<th class="last">Description</th>
|
|
2274
2360
|
</tr>
|
|
@@ -2279,16 +2365,13 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
2279
2365
|
|
|
2280
2366
|
<tr>
|
|
2281
2367
|
|
|
2282
|
-
<td class="name"><code>
|
|
2368
|
+
<td class="name"><code>type</code></td>
|
|
2283
2369
|
|
|
2284
2370
|
|
|
2285
2371
|
<td class="type">
|
|
2286
2372
|
|
|
2287
2373
|
|
|
2288
2374
|
<span class="param-type">string</span>
|
|
2289
|
-
|
|
|
2290
|
-
|
|
2291
|
-
<span class="param-type">null</span>
|
|
2292
2375
|
|
|
2293
2376
|
|
|
2294
2377
|
|
|
@@ -2296,23 +2379,35 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
2296
2379
|
</td>
|
|
2297
2380
|
|
|
2298
2381
|
|
|
2382
|
+
<td class="attributes">
|
|
2383
|
+
|
|
2384
|
+
|
|
2385
|
+
|
|
2386
|
+
|
|
2387
|
+
|
|
2388
|
+
</td>
|
|
2389
|
+
|
|
2299
2390
|
|
|
2300
2391
|
|
|
2392
|
+
<td class="default">
|
|
2393
|
+
|
|
2394
|
+
</td>
|
|
2395
|
+
|
|
2301
2396
|
|
|
2302
|
-
<td class="description last">
|
|
2397
|
+
<td class="description last">The content type associated with the content.</td>
|
|
2303
2398
|
</tr>
|
|
2304
2399
|
|
|
2305
2400
|
|
|
2306
2401
|
|
|
2307
2402
|
<tr>
|
|
2308
2403
|
|
|
2309
|
-
<td class="name"><code>
|
|
2404
|
+
<td class="name"><code>brand</code></td>
|
|
2310
2405
|
|
|
2311
2406
|
|
|
2312
2407
|
<td class="type">
|
|
2313
2408
|
|
|
2314
2409
|
|
|
2315
|
-
<span class="param-type">
|
|
2410
|
+
<span class="param-type">string</span>
|
|
2316
2411
|
|
|
2317
2412
|
|
|
2318
2413
|
|
|
@@ -2320,23 +2415,35 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
2320
2415
|
</td>
|
|
2321
2416
|
|
|
2322
2417
|
|
|
2418
|
+
<td class="attributes">
|
|
2419
|
+
|
|
2420
|
+
|
|
2421
|
+
|
|
2422
|
+
|
|
2423
|
+
|
|
2424
|
+
</td>
|
|
2425
|
+
|
|
2323
2426
|
|
|
2324
2427
|
|
|
2428
|
+
<td class="default">
|
|
2429
|
+
|
|
2430
|
+
</td>
|
|
2431
|
+
|
|
2325
2432
|
|
|
2326
|
-
<td class="description last">
|
|
2433
|
+
<td class="description last">The brand associated with the content.</td>
|
|
2327
2434
|
</tr>
|
|
2328
2435
|
|
|
2329
2436
|
|
|
2330
2437
|
|
|
2331
2438
|
<tr>
|
|
2332
2439
|
|
|
2333
|
-
<td class="name"><code>limit</code></td>
|
|
2440
|
+
<td class="name"><code>params.limit</code></td>
|
|
2334
2441
|
|
|
2335
2442
|
|
|
2336
2443
|
<td class="type">
|
|
2337
2444
|
|
|
2338
2445
|
|
|
2339
|
-
<span class="param-type">
|
|
2446
|
+
<span class="param-type">number</span>
|
|
2340
2447
|
|
|
2341
2448
|
|
|
2342
2449
|
|
|
@@ -2344,252 +2451,15 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
2344
2451
|
</td>
|
|
2345
2452
|
|
|
2346
2453
|
|
|
2454
|
+
<td class="attributes">
|
|
2455
|
+
|
|
2456
|
+
<optional><br>
|
|
2457
|
+
|
|
2347
2458
|
|
|
2348
|
-
|
|
2349
|
-
|
|
2350
|
-
<td class="description last">number of elements to pull</td>
|
|
2351
|
-
</tr>
|
|
2352
|
-
|
|
2353
|
-
|
|
2354
|
-
</tbody>
|
|
2355
|
-
</table>
|
|
2356
|
-
|
|
2357
|
-
|
|
2358
|
-
|
|
2359
|
-
|
|
2360
|
-
|
|
2361
|
-
|
|
2362
|
-
|
|
2363
|
-
|
|
2364
|
-
|
|
2365
|
-
|
|
2366
|
-
|
|
2367
|
-
|
|
2368
|
-
|
|
2369
|
-
|
|
2370
|
-
|
|
2371
|
-
|
|
2372
|
-
<h5 class="h5-returns">Returns:</h5>
|
|
2373
|
-
|
|
2374
|
-
|
|
2375
|
-
|
|
2376
|
-
|
|
2377
|
-
<dl class="param-type">
|
|
2378
|
-
<dt>
|
|
2379
|
-
Type
|
|
2380
|
-
</dt>
|
|
2381
|
-
<dd>
|
|
2382
|
-
|
|
2383
|
-
<span class="param-type">Promise.<(any|null)></span>
|
|
2384
|
-
|
|
2385
|
-
|
|
2386
|
-
|
|
2387
|
-
</dd>
|
|
2388
|
-
</dl>
|
|
2389
|
-
|
|
2390
|
-
|
|
2391
|
-
|
|
2392
|
-
|
|
2459
|
+
|
|
2393
2460
|
|
|
2394
|
-
|
|
2395
|
-
|
|
2396
|
-
|
|
2397
|
-
|
|
2398
|
-
|
|
2399
|
-
<h4 class="name" id=".fetchCompletedContent"><span class="type-signature type-signature-static">(static) </span>fetchCompletedContent<span class="signature">(type, brand)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
2400
|
-
|
|
2401
|
-
|
|
2402
|
-
|
|
2403
|
-
|
|
2404
|
-
|
|
2405
|
-
|
|
2406
|
-
<dl class="details">
|
|
2407
|
-
|
|
2408
|
-
<dt class="tag-description">Description:</dt>
|
|
2409
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetches a list of content that has been completed for the current user.</li></ul></dd>
|
|
2410
|
-
|
|
2411
|
-
|
|
2412
|
-
|
|
2413
|
-
<dt class="tag-source">Source:</dt>
|
|
2414
|
-
<dd class="tag-source"><ul class="dummy"><li>
|
|
2415
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line183">line 183</a>
|
|
2416
|
-
</li></ul></dd>
|
|
2417
|
-
|
|
2418
|
-
|
|
2419
|
-
|
|
2420
|
-
|
|
2421
|
-
|
|
2422
|
-
|
|
2423
|
-
|
|
2424
|
-
|
|
2425
|
-
|
|
2426
|
-
|
|
2427
|
-
|
|
2428
|
-
|
|
2429
|
-
|
|
2430
|
-
|
|
2431
|
-
|
|
2432
|
-
|
|
2433
|
-
|
|
2434
|
-
|
|
2435
|
-
|
|
2436
|
-
|
|
2437
|
-
|
|
2438
|
-
|
|
2439
|
-
|
|
2440
|
-
|
|
2441
|
-
|
|
2442
|
-
|
|
2443
|
-
|
|
2444
|
-
|
|
2445
|
-
|
|
2446
|
-
|
|
2447
|
-
|
|
2448
|
-
</dl>
|
|
2449
|
-
|
|
2450
|
-
|
|
2451
|
-
|
|
2452
|
-
|
|
2453
|
-
|
|
2454
|
-
|
|
2455
|
-
|
|
2456
|
-
|
|
2457
|
-
|
|
2458
|
-
|
|
2459
|
-
|
|
2460
|
-
<h5 class="h5-examples">Example</h5>
|
|
2461
|
-
|
|
2462
|
-
<pre class="prettyprint"><code>fetchCompletedContent('song', 'drumeo')
|
|
2463
|
-
.then(songs => console.log(songs))
|
|
2464
|
-
.catch(error => console.error(error));</code></pre>
|
|
2465
|
-
|
|
2466
|
-
|
|
2467
|
-
|
|
2468
|
-
|
|
2469
|
-
<h5 class="h5-parameters">Parameters:</h5>
|
|
2470
|
-
|
|
2471
|
-
|
|
2472
|
-
<table class="params">
|
|
2473
|
-
<thead>
|
|
2474
|
-
<tr>
|
|
2475
|
-
|
|
2476
|
-
<th>Name</th>
|
|
2477
|
-
|
|
2478
|
-
|
|
2479
|
-
<th>Type</th>
|
|
2480
|
-
|
|
2481
|
-
|
|
2482
|
-
<th>Attributes</th>
|
|
2483
|
-
|
|
2484
|
-
|
|
2485
|
-
|
|
2486
|
-
<th>Default</th>
|
|
2487
|
-
|
|
2488
|
-
|
|
2489
|
-
<th class="last">Description</th>
|
|
2490
|
-
</tr>
|
|
2491
|
-
</thead>
|
|
2492
|
-
|
|
2493
|
-
<tbody>
|
|
2494
|
-
|
|
2495
|
-
|
|
2496
|
-
<tr>
|
|
2497
|
-
|
|
2498
|
-
<td class="name"><code>type</code></td>
|
|
2499
|
-
|
|
2500
|
-
|
|
2501
|
-
<td class="type">
|
|
2502
|
-
|
|
2503
|
-
|
|
2504
|
-
<span class="param-type">string</span>
|
|
2505
|
-
|
|
2506
|
-
|
|
2507
|
-
|
|
2508
|
-
|
|
2509
|
-
</td>
|
|
2510
|
-
|
|
2511
|
-
|
|
2512
|
-
<td class="attributes">
|
|
2513
|
-
|
|
2514
|
-
|
|
2515
|
-
|
|
2516
|
-
|
|
2517
|
-
|
|
2518
|
-
</td>
|
|
2519
|
-
|
|
2520
|
-
|
|
2521
|
-
|
|
2522
|
-
<td class="default">
|
|
2523
|
-
|
|
2524
|
-
</td>
|
|
2525
|
-
|
|
2526
|
-
|
|
2527
|
-
<td class="description last">The content type associated with the content.</td>
|
|
2528
|
-
</tr>
|
|
2529
|
-
|
|
2530
|
-
|
|
2531
|
-
|
|
2532
|
-
<tr>
|
|
2533
|
-
|
|
2534
|
-
<td class="name"><code>brand</code></td>
|
|
2535
|
-
|
|
2536
|
-
|
|
2537
|
-
<td class="type">
|
|
2538
|
-
|
|
2539
|
-
|
|
2540
|
-
<span class="param-type">string</span>
|
|
2541
|
-
|
|
2542
|
-
|
|
2543
|
-
|
|
2544
|
-
|
|
2545
|
-
</td>
|
|
2546
|
-
|
|
2547
|
-
|
|
2548
|
-
<td class="attributes">
|
|
2549
|
-
|
|
2550
|
-
|
|
2551
|
-
|
|
2552
|
-
|
|
2553
|
-
|
|
2554
|
-
</td>
|
|
2555
|
-
|
|
2556
|
-
|
|
2557
|
-
|
|
2558
|
-
<td class="default">
|
|
2559
|
-
|
|
2560
|
-
</td>
|
|
2561
|
-
|
|
2562
|
-
|
|
2563
|
-
<td class="description last">The brand associated with the content.</td>
|
|
2564
|
-
</tr>
|
|
2565
|
-
|
|
2566
|
-
|
|
2567
|
-
|
|
2568
|
-
<tr>
|
|
2569
|
-
|
|
2570
|
-
<td class="name"><code>params.limit</code></td>
|
|
2571
|
-
|
|
2572
|
-
|
|
2573
|
-
<td class="type">
|
|
2574
|
-
|
|
2575
|
-
|
|
2576
|
-
<span class="param-type">number</span>
|
|
2577
|
-
|
|
2578
|
-
|
|
2579
|
-
|
|
2580
|
-
|
|
2581
|
-
</td>
|
|
2582
|
-
|
|
2583
|
-
|
|
2584
|
-
<td class="attributes">
|
|
2585
|
-
|
|
2586
|
-
<optional><br>
|
|
2587
|
-
|
|
2588
|
-
|
|
2589
|
-
|
|
2590
|
-
|
|
2591
|
-
|
|
2592
|
-
</td>
|
|
2461
|
+
|
|
2462
|
+
</td>
|
|
2593
2463
|
|
|
2594
2464
|
|
|
2595
2465
|
|
|
@@ -2601,1528 +2471,19 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
2601
2471
|
|
|
2602
2472
|
|
|
2603
2473
|
<td class="description last">The limit of results per page.</td>
|
|
2604
|
-
</tr>
|
|
2605
|
-
|
|
2606
|
-
|
|
2607
|
-
|
|
2608
|
-
<tr>
|
|
2609
|
-
|
|
2610
|
-
<td class="name"><code>params.page</code></td>
|
|
2611
|
-
|
|
2612
|
-
|
|
2613
|
-
<td class="type">
|
|
2614
|
-
|
|
2615
|
-
|
|
2616
|
-
<span class="param-type">number</span>
|
|
2617
|
-
|
|
2618
|
-
|
|
2619
|
-
|
|
2620
|
-
|
|
2621
|
-
</td>
|
|
2622
|
-
|
|
2623
|
-
|
|
2624
|
-
<td class="attributes">
|
|
2625
|
-
|
|
2626
|
-
<optional><br>
|
|
2627
|
-
|
|
2628
|
-
|
|
2629
|
-
|
|
2630
|
-
|
|
2631
|
-
|
|
2632
|
-
</td>
|
|
2633
|
-
|
|
2634
|
-
|
|
2635
|
-
|
|
2636
|
-
<td class="default">
|
|
2637
|
-
|
|
2638
|
-
<code>1</code>
|
|
2639
|
-
|
|
2640
|
-
</td>
|
|
2641
|
-
|
|
2642
|
-
|
|
2643
|
-
<td class="description last">The page number for pagination.</td>
|
|
2644
|
-
</tr>
|
|
2645
|
-
|
|
2646
|
-
|
|
2647
|
-
</tbody>
|
|
2648
|
-
</table>
|
|
2649
|
-
|
|
2650
|
-
|
|
2651
|
-
|
|
2652
|
-
|
|
2653
|
-
|
|
2654
|
-
|
|
2655
|
-
|
|
2656
|
-
|
|
2657
|
-
|
|
2658
|
-
|
|
2659
|
-
|
|
2660
|
-
|
|
2661
|
-
|
|
2662
|
-
|
|
2663
|
-
|
|
2664
|
-
|
|
2665
|
-
<h5 class="h5-returns">Returns:</h5>
|
|
2666
|
-
|
|
2667
|
-
|
|
2668
|
-
<div class="param-desc">
|
|
2669
|
-
- Returns an object containing in-progress content if found, otherwise null.
|
|
2670
|
-
</div>
|
|
2671
|
-
|
|
2672
|
-
|
|
2673
|
-
|
|
2674
|
-
<dl class="param-type">
|
|
2675
|
-
<dt>
|
|
2676
|
-
Type
|
|
2677
|
-
</dt>
|
|
2678
|
-
<dd>
|
|
2679
|
-
|
|
2680
|
-
<span class="param-type">Promise.<(Object|null)></span>
|
|
2681
|
-
|
|
2682
|
-
|
|
2683
|
-
|
|
2684
|
-
</dd>
|
|
2685
|
-
</dl>
|
|
2686
|
-
|
|
2687
|
-
|
|
2688
|
-
|
|
2689
|
-
|
|
2690
|
-
|
|
2691
|
-
|
|
2692
|
-
|
|
2693
|
-
|
|
2694
|
-
|
|
2695
|
-
|
|
2696
|
-
<h4 class="name" id=".fetchCompletedState"><span class="type-signature type-signature-static">(static) </span>fetchCompletedState<span class="signature">(content_id)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
2697
|
-
|
|
2698
|
-
|
|
2699
|
-
|
|
2700
|
-
|
|
2701
|
-
|
|
2702
|
-
|
|
2703
|
-
<dl class="details">
|
|
2704
|
-
|
|
2705
|
-
<dt class="tag-description">Description:</dt>
|
|
2706
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetches the completion status of a specific lesson for the current user.</li></ul></dd>
|
|
2707
|
-
|
|
2708
|
-
|
|
2709
|
-
|
|
2710
|
-
<dt class="tag-source">Source:</dt>
|
|
2711
|
-
<dd class="tag-source"><ul class="dummy"><li>
|
|
2712
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line36">line 36</a>
|
|
2713
|
-
</li></ul></dd>
|
|
2714
|
-
|
|
2715
|
-
|
|
2716
|
-
|
|
2717
|
-
|
|
2718
|
-
|
|
2719
|
-
|
|
2720
|
-
|
|
2721
|
-
|
|
2722
|
-
|
|
2723
|
-
|
|
2724
|
-
|
|
2725
|
-
|
|
2726
|
-
|
|
2727
|
-
|
|
2728
|
-
|
|
2729
|
-
|
|
2730
|
-
|
|
2731
|
-
|
|
2732
|
-
|
|
2733
|
-
|
|
2734
|
-
|
|
2735
|
-
|
|
2736
|
-
|
|
2737
|
-
|
|
2738
|
-
|
|
2739
|
-
|
|
2740
|
-
|
|
2741
|
-
|
|
2742
|
-
|
|
2743
|
-
|
|
2744
|
-
|
|
2745
|
-
</dl>
|
|
2746
|
-
|
|
2747
|
-
|
|
2748
|
-
|
|
2749
|
-
|
|
2750
|
-
|
|
2751
|
-
|
|
2752
|
-
|
|
2753
|
-
|
|
2754
|
-
|
|
2755
|
-
|
|
2756
|
-
|
|
2757
|
-
<h5 class="h5-examples">Example</h5>
|
|
2758
|
-
|
|
2759
|
-
<pre class="prettyprint"><code>fetchCurrentSongComplete('user123', 'lesson456', 'csrf-token')
|
|
2760
|
-
.then(status => console.log(status))
|
|
2761
|
-
.catch(error => console.error(error));</code></pre>
|
|
2762
|
-
|
|
2763
|
-
|
|
2764
|
-
|
|
2765
|
-
|
|
2766
|
-
<h5 class="h5-parameters">Parameters:</h5>
|
|
2767
|
-
|
|
2768
|
-
|
|
2769
|
-
<table class="params">
|
|
2770
|
-
<thead>
|
|
2771
|
-
<tr>
|
|
2772
|
-
|
|
2773
|
-
<th>Name</th>
|
|
2774
|
-
|
|
2775
|
-
|
|
2776
|
-
<th>Type</th>
|
|
2777
|
-
|
|
2778
|
-
|
|
2779
|
-
|
|
2780
|
-
|
|
2781
|
-
|
|
2782
|
-
<th class="last">Description</th>
|
|
2783
|
-
</tr>
|
|
2784
|
-
</thead>
|
|
2785
|
-
|
|
2786
|
-
<tbody>
|
|
2787
|
-
|
|
2788
|
-
|
|
2789
|
-
<tr>
|
|
2790
|
-
|
|
2791
|
-
<td class="name"><code>content_id</code></td>
|
|
2792
|
-
|
|
2793
|
-
|
|
2794
|
-
<td class="type">
|
|
2795
|
-
|
|
2796
|
-
|
|
2797
|
-
<span class="param-type">string</span>
|
|
2798
|
-
|
|
2799
|
-
|
|
2800
|
-
|
|
2801
|
-
|
|
2802
|
-
</td>
|
|
2803
|
-
|
|
2804
|
-
|
|
2805
|
-
|
|
2806
|
-
|
|
2807
|
-
|
|
2808
|
-
<td class="description last">The ID of the lesson content to check.</td>
|
|
2809
|
-
</tr>
|
|
2810
|
-
|
|
2811
|
-
|
|
2812
|
-
</tbody>
|
|
2813
|
-
</table>
|
|
2814
|
-
|
|
2815
|
-
|
|
2816
|
-
|
|
2817
|
-
|
|
2818
|
-
|
|
2819
|
-
|
|
2820
|
-
|
|
2821
|
-
|
|
2822
|
-
|
|
2823
|
-
|
|
2824
|
-
|
|
2825
|
-
|
|
2826
|
-
|
|
2827
|
-
|
|
2828
|
-
|
|
2829
|
-
|
|
2830
|
-
<h5 class="h5-returns">Returns:</h5>
|
|
2831
|
-
|
|
2832
|
-
|
|
2833
|
-
<div class="param-desc">
|
|
2834
|
-
- Returns the completion status object if found, otherwise null.
|
|
2835
|
-
</div>
|
|
2836
|
-
|
|
2837
|
-
|
|
2838
|
-
|
|
2839
|
-
<dl class="param-type">
|
|
2840
|
-
<dt>
|
|
2841
|
-
Type
|
|
2842
|
-
</dt>
|
|
2843
|
-
<dd>
|
|
2844
|
-
|
|
2845
|
-
<span class="param-type">Promise.<(Object|null)></span>
|
|
2846
|
-
|
|
2847
|
-
|
|
2848
|
-
|
|
2849
|
-
</dd>
|
|
2850
|
-
</dl>
|
|
2851
|
-
|
|
2852
|
-
|
|
2853
|
-
|
|
2854
|
-
|
|
2855
|
-
|
|
2856
|
-
|
|
2857
|
-
|
|
2858
|
-
|
|
2859
|
-
|
|
2860
|
-
|
|
2861
|
-
<h4 class="name" id=".fetchContentInProgress"><span class="type-signature type-signature-static">(static) </span>fetchContentInProgress<span class="signature">(type, brand)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
2862
|
-
|
|
2863
|
-
|
|
2864
|
-
|
|
2865
|
-
|
|
2866
|
-
|
|
2867
|
-
|
|
2868
|
-
<dl class="details">
|
|
2869
|
-
|
|
2870
|
-
<dt class="tag-description">Description:</dt>
|
|
2871
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetches a list of content that is currently in progress for the current user.</li></ul></dd>
|
|
2872
|
-
|
|
2873
|
-
|
|
2874
|
-
|
|
2875
|
-
<dt class="tag-source">Source:</dt>
|
|
2876
|
-
<dd class="tag-source"><ul class="dummy"><li>
|
|
2877
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line140">line 140</a>
|
|
2878
|
-
</li></ul></dd>
|
|
2879
|
-
|
|
2880
|
-
|
|
2881
|
-
|
|
2882
|
-
|
|
2883
|
-
|
|
2884
|
-
|
|
2885
|
-
|
|
2886
|
-
|
|
2887
|
-
|
|
2888
|
-
|
|
2889
|
-
|
|
2890
|
-
|
|
2891
|
-
|
|
2892
|
-
|
|
2893
|
-
|
|
2894
|
-
|
|
2895
|
-
|
|
2896
|
-
|
|
2897
|
-
|
|
2898
|
-
|
|
2899
|
-
|
|
2900
|
-
|
|
2901
|
-
|
|
2902
|
-
|
|
2903
|
-
|
|
2904
|
-
|
|
2905
|
-
|
|
2906
|
-
|
|
2907
|
-
|
|
2908
|
-
|
|
2909
|
-
|
|
2910
|
-
</dl>
|
|
2911
|
-
|
|
2912
|
-
|
|
2913
|
-
|
|
2914
|
-
|
|
2915
|
-
|
|
2916
|
-
|
|
2917
|
-
|
|
2918
|
-
|
|
2919
|
-
|
|
2920
|
-
|
|
2921
|
-
|
|
2922
|
-
<h5 class="h5-examples">Example</h5>
|
|
2923
|
-
|
|
2924
|
-
<pre class="prettyprint"><code>fetchContentInProgress('song', 'drumeo')
|
|
2925
|
-
.then(songs => console.log(songs))
|
|
2926
|
-
.catch(error => console.error(error));</code></pre>
|
|
2927
|
-
|
|
2928
|
-
|
|
2929
|
-
|
|
2930
|
-
|
|
2931
|
-
<h5 class="h5-parameters">Parameters:</h5>
|
|
2932
|
-
|
|
2933
|
-
|
|
2934
|
-
<table class="params">
|
|
2935
|
-
<thead>
|
|
2936
|
-
<tr>
|
|
2937
|
-
|
|
2938
|
-
<th>Name</th>
|
|
2939
|
-
|
|
2940
|
-
|
|
2941
|
-
<th>Type</th>
|
|
2942
|
-
|
|
2943
|
-
|
|
2944
|
-
<th>Attributes</th>
|
|
2945
|
-
|
|
2946
|
-
|
|
2947
|
-
|
|
2948
|
-
<th>Default</th>
|
|
2949
|
-
|
|
2950
|
-
|
|
2951
|
-
<th class="last">Description</th>
|
|
2952
|
-
</tr>
|
|
2953
|
-
</thead>
|
|
2954
|
-
|
|
2955
|
-
<tbody>
|
|
2956
|
-
|
|
2957
|
-
|
|
2958
|
-
<tr>
|
|
2959
|
-
|
|
2960
|
-
<td class="name"><code>type</code></td>
|
|
2961
|
-
|
|
2962
|
-
|
|
2963
|
-
<td class="type">
|
|
2964
|
-
|
|
2965
|
-
|
|
2966
|
-
<span class="param-type">string</span>
|
|
2967
|
-
|
|
2968
|
-
|
|
2969
|
-
|
|
2970
|
-
|
|
2971
|
-
</td>
|
|
2972
|
-
|
|
2973
|
-
|
|
2974
|
-
<td class="attributes">
|
|
2975
|
-
|
|
2976
|
-
|
|
2977
|
-
|
|
2978
|
-
|
|
2979
|
-
|
|
2980
|
-
</td>
|
|
2981
|
-
|
|
2982
|
-
|
|
2983
|
-
|
|
2984
|
-
<td class="default">
|
|
2985
|
-
|
|
2986
|
-
</td>
|
|
2987
|
-
|
|
2988
|
-
|
|
2989
|
-
<td class="description last">The content type associated with the content.</td>
|
|
2990
|
-
</tr>
|
|
2991
|
-
|
|
2992
|
-
|
|
2993
|
-
|
|
2994
|
-
<tr>
|
|
2995
|
-
|
|
2996
|
-
<td class="name"><code>brand</code></td>
|
|
2997
|
-
|
|
2998
|
-
|
|
2999
|
-
<td class="type">
|
|
3000
|
-
|
|
3001
|
-
|
|
3002
|
-
<span class="param-type">string</span>
|
|
3003
|
-
|
|
3004
|
-
|
|
3005
|
-
|
|
3006
|
-
|
|
3007
|
-
</td>
|
|
3008
|
-
|
|
3009
|
-
|
|
3010
|
-
<td class="attributes">
|
|
3011
|
-
|
|
3012
|
-
|
|
3013
|
-
|
|
3014
|
-
|
|
3015
|
-
|
|
3016
|
-
</td>
|
|
3017
|
-
|
|
3018
|
-
|
|
3019
|
-
|
|
3020
|
-
<td class="default">
|
|
3021
|
-
|
|
3022
|
-
</td>
|
|
3023
|
-
|
|
3024
|
-
|
|
3025
|
-
<td class="description last">The brand associated with the content.</td>
|
|
3026
|
-
</tr>
|
|
3027
|
-
|
|
3028
|
-
|
|
3029
|
-
|
|
3030
|
-
<tr>
|
|
3031
|
-
|
|
3032
|
-
<td class="name"><code>params.limit</code></td>
|
|
3033
|
-
|
|
3034
|
-
|
|
3035
|
-
<td class="type">
|
|
3036
|
-
|
|
3037
|
-
|
|
3038
|
-
<span class="param-type">number</span>
|
|
3039
|
-
|
|
3040
|
-
|
|
3041
|
-
|
|
3042
|
-
|
|
3043
|
-
</td>
|
|
3044
|
-
|
|
3045
|
-
|
|
3046
|
-
<td class="attributes">
|
|
3047
|
-
|
|
3048
|
-
<optional><br>
|
|
3049
|
-
|
|
3050
|
-
|
|
3051
|
-
|
|
3052
|
-
|
|
3053
|
-
|
|
3054
|
-
</td>
|
|
3055
|
-
|
|
3056
|
-
|
|
3057
|
-
|
|
3058
|
-
<td class="default">
|
|
3059
|
-
|
|
3060
|
-
<code>20</code>
|
|
3061
|
-
|
|
3062
|
-
</td>
|
|
3063
|
-
|
|
3064
|
-
|
|
3065
|
-
<td class="description last">The limit of results per page.</td>
|
|
3066
|
-
</tr>
|
|
3067
|
-
|
|
3068
|
-
|
|
3069
|
-
|
|
3070
|
-
<tr>
|
|
3071
|
-
|
|
3072
|
-
<td class="name"><code>params.page</code></td>
|
|
3073
|
-
|
|
3074
|
-
|
|
3075
|
-
<td class="type">
|
|
3076
|
-
|
|
3077
|
-
|
|
3078
|
-
<span class="param-type">number</span>
|
|
3079
|
-
|
|
3080
|
-
|
|
3081
|
-
|
|
3082
|
-
|
|
3083
|
-
</td>
|
|
3084
|
-
|
|
3085
|
-
|
|
3086
|
-
<td class="attributes">
|
|
3087
|
-
|
|
3088
|
-
<optional><br>
|
|
3089
|
-
|
|
3090
|
-
|
|
3091
|
-
|
|
3092
|
-
|
|
3093
|
-
|
|
3094
|
-
</td>
|
|
3095
|
-
|
|
3096
|
-
|
|
3097
|
-
|
|
3098
|
-
<td class="default">
|
|
3099
|
-
|
|
3100
|
-
<code>1</code>
|
|
3101
|
-
|
|
3102
|
-
</td>
|
|
3103
|
-
|
|
3104
|
-
|
|
3105
|
-
<td class="description last">The page number for pagination.</td>
|
|
3106
|
-
</tr>
|
|
3107
|
-
|
|
3108
|
-
|
|
3109
|
-
</tbody>
|
|
3110
|
-
</table>
|
|
3111
|
-
|
|
3112
|
-
|
|
3113
|
-
|
|
3114
|
-
|
|
3115
|
-
|
|
3116
|
-
|
|
3117
|
-
|
|
3118
|
-
|
|
3119
|
-
|
|
3120
|
-
|
|
3121
|
-
|
|
3122
|
-
|
|
3123
|
-
|
|
3124
|
-
|
|
3125
|
-
|
|
3126
|
-
|
|
3127
|
-
<h5 class="h5-returns">Returns:</h5>
|
|
3128
|
-
|
|
3129
|
-
|
|
3130
|
-
<div class="param-desc">
|
|
3131
|
-
- Returns an object containing in-progress content if found, otherwise null.
|
|
3132
|
-
</div>
|
|
3133
|
-
|
|
3134
|
-
|
|
3135
|
-
|
|
3136
|
-
<dl class="param-type">
|
|
3137
|
-
<dt>
|
|
3138
|
-
Type
|
|
3139
|
-
</dt>
|
|
3140
|
-
<dd>
|
|
3141
|
-
|
|
3142
|
-
<span class="param-type">Promise.<(Object|null)></span>
|
|
3143
|
-
|
|
3144
|
-
|
|
3145
|
-
|
|
3146
|
-
</dd>
|
|
3147
|
-
</dl>
|
|
3148
|
-
|
|
3149
|
-
|
|
3150
|
-
|
|
3151
|
-
|
|
3152
|
-
|
|
3153
|
-
|
|
3154
|
-
|
|
3155
|
-
|
|
3156
|
-
|
|
3157
|
-
|
|
3158
|
-
<h4 class="name" id=".fetchContentPageUserData"><span class="type-signature type-signature-static">(static) </span>fetchContentPageUserData<span class="signature">(contentId)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
3159
|
-
|
|
3160
|
-
|
|
3161
|
-
|
|
3162
|
-
|
|
3163
|
-
|
|
3164
|
-
|
|
3165
|
-
<dl class="details">
|
|
3166
|
-
|
|
3167
|
-
<dt class="tag-description">Description:</dt>
|
|
3168
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetches user context data for a specific piece of content.</li></ul></dd>
|
|
3169
|
-
|
|
3170
|
-
|
|
3171
|
-
|
|
3172
|
-
<dt class="tag-source">Source:</dt>
|
|
3173
|
-
<dd class="tag-source"><ul class="dummy"><li>
|
|
3174
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line223">line 223</a>
|
|
3175
|
-
</li></ul></dd>
|
|
3176
|
-
|
|
3177
|
-
|
|
3178
|
-
|
|
3179
|
-
|
|
3180
|
-
|
|
3181
|
-
|
|
3182
|
-
|
|
3183
|
-
|
|
3184
|
-
|
|
3185
|
-
|
|
3186
|
-
|
|
3187
|
-
|
|
3188
|
-
|
|
3189
|
-
|
|
3190
|
-
|
|
3191
|
-
|
|
3192
|
-
|
|
3193
|
-
|
|
3194
|
-
|
|
3195
|
-
|
|
3196
|
-
|
|
3197
|
-
|
|
3198
|
-
|
|
3199
|
-
|
|
3200
|
-
|
|
3201
|
-
|
|
3202
|
-
|
|
3203
|
-
|
|
3204
|
-
|
|
3205
|
-
|
|
3206
|
-
|
|
3207
|
-
</dl>
|
|
3208
|
-
|
|
3209
|
-
|
|
3210
|
-
|
|
3211
|
-
|
|
3212
|
-
|
|
3213
|
-
|
|
3214
|
-
|
|
3215
|
-
|
|
3216
|
-
|
|
3217
|
-
|
|
3218
|
-
|
|
3219
|
-
<h5 class="h5-examples">Example</h5>
|
|
3220
|
-
|
|
3221
|
-
<pre class="prettyprint"><code>fetchContentPageUserData(406548)
|
|
3222
|
-
.then(data => console.log(data))
|
|
3223
|
-
.catch(error => console.error(error));</code></pre>
|
|
3224
|
-
|
|
3225
|
-
|
|
3226
|
-
|
|
3227
|
-
|
|
3228
|
-
<h5 class="h5-parameters">Parameters:</h5>
|
|
3229
|
-
|
|
3230
|
-
|
|
3231
|
-
<table class="params">
|
|
3232
|
-
<thead>
|
|
3233
|
-
<tr>
|
|
3234
|
-
|
|
3235
|
-
<th>Name</th>
|
|
3236
|
-
|
|
3237
|
-
|
|
3238
|
-
<th>Type</th>
|
|
3239
|
-
|
|
3240
|
-
|
|
3241
|
-
|
|
3242
|
-
|
|
3243
|
-
|
|
3244
|
-
<th class="last">Description</th>
|
|
3245
|
-
</tr>
|
|
3246
|
-
</thead>
|
|
3247
|
-
|
|
3248
|
-
<tbody>
|
|
3249
|
-
|
|
3250
|
-
|
|
3251
|
-
<tr>
|
|
3252
|
-
|
|
3253
|
-
<td class="name"><code>contentId</code></td>
|
|
3254
|
-
|
|
3255
|
-
|
|
3256
|
-
<td class="type">
|
|
3257
|
-
|
|
3258
|
-
|
|
3259
|
-
<span class="param-type">int</span>
|
|
3260
|
-
|
|
3261
|
-
|
|
3262
|
-
|
|
3263
|
-
|
|
3264
|
-
</td>
|
|
3265
|
-
|
|
3266
|
-
|
|
3267
|
-
|
|
3268
|
-
|
|
3269
|
-
|
|
3270
|
-
<td class="description last">The content id.</td>
|
|
3271
|
-
</tr>
|
|
3272
|
-
|
|
3273
|
-
|
|
3274
|
-
</tbody>
|
|
3275
|
-
</table>
|
|
3276
|
-
|
|
3277
|
-
|
|
3278
|
-
|
|
3279
|
-
|
|
3280
|
-
|
|
3281
|
-
|
|
3282
|
-
|
|
3283
|
-
|
|
3284
|
-
|
|
3285
|
-
|
|
3286
|
-
|
|
3287
|
-
|
|
3288
|
-
|
|
3289
|
-
|
|
3290
|
-
|
|
3291
|
-
|
|
3292
|
-
<h5 class="h5-returns">Returns:</h5>
|
|
3293
|
-
|
|
3294
|
-
|
|
3295
|
-
<div class="param-desc">
|
|
3296
|
-
- Returns an object containing user context data if found, otherwise null.
|
|
3297
|
-
</div>
|
|
3298
|
-
|
|
3299
|
-
|
|
3300
|
-
|
|
3301
|
-
<dl class="param-type">
|
|
3302
|
-
<dt>
|
|
3303
|
-
Type
|
|
3304
|
-
</dt>
|
|
3305
|
-
<dd>
|
|
3306
|
-
|
|
3307
|
-
<span class="param-type">Promise.<(Object|null)></span>
|
|
3308
|
-
|
|
3309
|
-
|
|
3310
|
-
|
|
3311
|
-
</dd>
|
|
3312
|
-
</dl>
|
|
3313
|
-
|
|
3314
|
-
|
|
3315
|
-
|
|
3316
|
-
|
|
3317
|
-
|
|
3318
|
-
|
|
3319
|
-
|
|
3320
|
-
|
|
3321
|
-
|
|
3322
|
-
|
|
3323
|
-
<h4 class="name" id=".fetchNextContentDataForParent"><span class="type-signature type-signature-static">(static) </span>fetchNextContentDataForParent<span class="signature">(contentId)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
3324
|
-
|
|
3325
|
-
|
|
3326
|
-
|
|
3327
|
-
|
|
3328
|
-
|
|
3329
|
-
|
|
3330
|
-
<dl class="details">
|
|
3331
|
-
|
|
3332
|
-
<dt class="tag-description">Description:</dt>
|
|
3333
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetches the ID and Type of the piece of content that would be the next one for the user</li></ul></dd>
|
|
3334
|
-
|
|
3335
|
-
|
|
3336
|
-
|
|
3337
|
-
<dt class="tag-source">Source:</dt>
|
|
3338
|
-
<dd class="tag-source"><ul class="dummy"><li>
|
|
3339
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line252">line 252</a>
|
|
3340
|
-
</li></ul></dd>
|
|
3341
|
-
|
|
3342
|
-
|
|
3343
|
-
|
|
3344
|
-
|
|
3345
|
-
|
|
3346
|
-
|
|
3347
|
-
|
|
3348
|
-
|
|
3349
|
-
|
|
3350
|
-
|
|
3351
|
-
|
|
3352
|
-
|
|
3353
|
-
|
|
3354
|
-
|
|
3355
|
-
|
|
3356
|
-
|
|
3357
|
-
|
|
3358
|
-
|
|
3359
|
-
|
|
3360
|
-
|
|
3361
|
-
|
|
3362
|
-
|
|
3363
|
-
|
|
3364
|
-
|
|
3365
|
-
|
|
3366
|
-
|
|
3367
|
-
|
|
3368
|
-
|
|
3369
|
-
|
|
3370
|
-
|
|
3371
|
-
|
|
3372
|
-
</dl>
|
|
3373
|
-
|
|
3374
|
-
|
|
3375
|
-
|
|
3376
|
-
|
|
3377
|
-
|
|
3378
|
-
|
|
3379
|
-
|
|
3380
|
-
|
|
3381
|
-
|
|
3382
|
-
|
|
3383
|
-
|
|
3384
|
-
|
|
3385
|
-
|
|
3386
|
-
<h5 class="h5-parameters">Parameters:</h5>
|
|
3387
|
-
|
|
3388
|
-
|
|
3389
|
-
<table class="params">
|
|
3390
|
-
<thead>
|
|
3391
|
-
<tr>
|
|
3392
|
-
|
|
3393
|
-
<th>Name</th>
|
|
3394
|
-
|
|
3395
|
-
|
|
3396
|
-
<th>Type</th>
|
|
3397
|
-
|
|
3398
|
-
|
|
3399
|
-
|
|
3400
|
-
|
|
3401
|
-
|
|
3402
|
-
<th class="last">Description</th>
|
|
3403
|
-
</tr>
|
|
3404
|
-
</thead>
|
|
3405
|
-
|
|
3406
|
-
<tbody>
|
|
3407
|
-
|
|
3408
|
-
|
|
3409
|
-
<tr>
|
|
3410
|
-
|
|
3411
|
-
<td class="name"><code>contentId</code></td>
|
|
3412
|
-
|
|
3413
|
-
|
|
3414
|
-
<td class="type">
|
|
3415
|
-
|
|
3416
|
-
|
|
3417
|
-
<span class="param-type">int</span>
|
|
3418
|
-
|
|
3419
|
-
|
|
3420
|
-
|
|
3421
|
-
|
|
3422
|
-
</td>
|
|
3423
|
-
|
|
3424
|
-
|
|
3425
|
-
|
|
3426
|
-
|
|
3427
|
-
|
|
3428
|
-
<td class="description last">The id of the parent (method, level, or course) piece of content.</td>
|
|
3429
|
-
</tr>
|
|
3430
|
-
|
|
3431
|
-
|
|
3432
|
-
</tbody>
|
|
3433
|
-
</table>
|
|
3434
|
-
|
|
3435
|
-
|
|
3436
|
-
|
|
3437
|
-
|
|
3438
|
-
|
|
3439
|
-
|
|
3440
|
-
|
|
3441
|
-
|
|
3442
|
-
|
|
3443
|
-
|
|
3444
|
-
|
|
3445
|
-
|
|
3446
|
-
|
|
3447
|
-
|
|
3448
|
-
|
|
3449
|
-
|
|
3450
|
-
<h5 class="h5-returns">Returns:</h5>
|
|
3451
|
-
|
|
3452
|
-
|
|
3453
|
-
<div class="param-desc">
|
|
3454
|
-
- Returns and Object with the id and type of the next piece of content if found, otherwise null.
|
|
3455
|
-
</div>
|
|
3456
|
-
|
|
3457
|
-
|
|
3458
|
-
|
|
3459
|
-
<dl class="param-type">
|
|
3460
|
-
<dt>
|
|
3461
|
-
Type
|
|
3462
|
-
</dt>
|
|
3463
|
-
<dd>
|
|
3464
|
-
|
|
3465
|
-
<span class="param-type">Promise.<(Object|null)></span>
|
|
3466
|
-
|
|
3467
|
-
|
|
3468
|
-
|
|
3469
|
-
</dd>
|
|
3470
|
-
</dl>
|
|
3471
|
-
|
|
3472
|
-
|
|
3473
|
-
|
|
3474
|
-
|
|
3475
|
-
|
|
3476
|
-
|
|
3477
|
-
|
|
3478
|
-
|
|
3479
|
-
|
|
3480
|
-
|
|
3481
|
-
<h4 class="name" id=".fetchOwnedChallenges"><span class="type-signature type-signature-static">(static) </span>fetchOwnedChallenges<span class="signature">(brand, page, limit)</span><span class="type-signature"> → {Promise.<(any|null)>}</span></h4>
|
|
3482
|
-
|
|
3483
|
-
|
|
3484
|
-
|
|
3485
|
-
|
|
3486
|
-
|
|
3487
|
-
|
|
3488
|
-
<dl class="details">
|
|
3489
|
-
|
|
3490
|
-
<dt class="tag-description">Description:</dt>
|
|
3491
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetch all owned brand challenges for user</li></ul></dd>
|
|
3492
|
-
|
|
3493
|
-
|
|
3494
|
-
|
|
3495
|
-
<dt class="tag-source">Source:</dt>
|
|
3496
|
-
<dd class="tag-source"><ul class="dummy"><li>
|
|
3497
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line374">line 374</a>
|
|
3498
|
-
</li></ul></dd>
|
|
3499
|
-
|
|
3500
|
-
|
|
3501
|
-
|
|
3502
|
-
|
|
3503
|
-
|
|
3504
|
-
|
|
3505
|
-
|
|
3506
|
-
|
|
3507
|
-
|
|
3508
|
-
|
|
3509
|
-
|
|
3510
|
-
|
|
3511
|
-
|
|
3512
|
-
|
|
3513
|
-
|
|
3514
|
-
|
|
3515
|
-
|
|
3516
|
-
|
|
3517
|
-
|
|
3518
|
-
|
|
3519
|
-
|
|
3520
|
-
|
|
3521
|
-
|
|
3522
|
-
|
|
3523
|
-
|
|
3524
|
-
|
|
3525
|
-
|
|
3526
|
-
|
|
3527
|
-
|
|
3528
|
-
|
|
3529
|
-
|
|
3530
|
-
</dl>
|
|
3531
|
-
|
|
3532
|
-
|
|
3533
|
-
|
|
3534
|
-
|
|
3535
|
-
|
|
3536
|
-
|
|
3537
|
-
|
|
3538
|
-
|
|
3539
|
-
|
|
3540
|
-
|
|
3541
|
-
|
|
3542
|
-
|
|
3543
|
-
|
|
3544
|
-
<h5 class="h5-parameters">Parameters:</h5>
|
|
3545
|
-
|
|
3546
|
-
|
|
3547
|
-
<table class="params">
|
|
3548
|
-
<thead>
|
|
3549
|
-
<tr>
|
|
3550
|
-
|
|
3551
|
-
<th>Name</th>
|
|
3552
|
-
|
|
3553
|
-
|
|
3554
|
-
<th>Type</th>
|
|
3555
|
-
|
|
3556
|
-
|
|
3557
|
-
|
|
3558
|
-
|
|
3559
|
-
|
|
3560
|
-
<th class="last">Description</th>
|
|
3561
|
-
</tr>
|
|
3562
|
-
</thead>
|
|
3563
|
-
|
|
3564
|
-
<tbody>
|
|
3565
|
-
|
|
3566
|
-
|
|
3567
|
-
<tr>
|
|
3568
|
-
|
|
3569
|
-
<td class="name"><code>brand</code></td>
|
|
3570
|
-
|
|
3571
|
-
|
|
3572
|
-
<td class="type">
|
|
3573
|
-
|
|
3574
|
-
|
|
3575
|
-
<span class="param-type">string</span>
|
|
3576
|
-
|
|
|
3577
|
-
|
|
3578
|
-
<span class="param-type">null</span>
|
|
3579
|
-
|
|
3580
|
-
|
|
3581
|
-
|
|
3582
|
-
|
|
3583
|
-
</td>
|
|
3584
|
-
|
|
3585
|
-
|
|
3586
|
-
|
|
3587
|
-
|
|
3588
|
-
|
|
3589
|
-
<td class="description last">brand</td>
|
|
3590
|
-
</tr>
|
|
3591
|
-
|
|
3592
|
-
|
|
3593
|
-
|
|
3594
|
-
<tr>
|
|
3595
|
-
|
|
3596
|
-
<td class="name"><code>page</code></td>
|
|
3597
|
-
|
|
3598
|
-
|
|
3599
|
-
<td class="type">
|
|
3600
|
-
|
|
3601
|
-
|
|
3602
|
-
<span class="param-type">int</span>
|
|
3603
|
-
|
|
3604
|
-
|
|
3605
|
-
|
|
3606
|
-
|
|
3607
|
-
</td>
|
|
3608
|
-
|
|
3609
|
-
|
|
3610
|
-
|
|
3611
|
-
|
|
3612
|
-
|
|
3613
|
-
<td class="description last">page of data to pull</td>
|
|
3614
|
-
</tr>
|
|
3615
|
-
|
|
3616
|
-
|
|
3617
|
-
|
|
3618
|
-
<tr>
|
|
3619
|
-
|
|
3620
|
-
<td class="name"><code>limit</code></td>
|
|
3621
|
-
|
|
3622
|
-
|
|
3623
|
-
<td class="type">
|
|
3624
|
-
|
|
3625
|
-
|
|
3626
|
-
<span class="param-type">int</span>
|
|
3627
|
-
|
|
3628
|
-
|
|
3629
|
-
|
|
3630
|
-
|
|
3631
|
-
</td>
|
|
3632
|
-
|
|
3633
|
-
|
|
3634
|
-
|
|
3635
|
-
|
|
3636
|
-
|
|
3637
|
-
<td class="description last">number of elements to pull</td>
|
|
3638
|
-
</tr>
|
|
3639
|
-
|
|
3640
|
-
|
|
3641
|
-
</tbody>
|
|
3642
|
-
</table>
|
|
3643
|
-
|
|
3644
|
-
|
|
3645
|
-
|
|
3646
|
-
|
|
3647
|
-
|
|
3648
|
-
|
|
3649
|
-
|
|
3650
|
-
|
|
3651
|
-
|
|
3652
|
-
|
|
3653
|
-
|
|
3654
|
-
|
|
3655
|
-
|
|
3656
|
-
|
|
3657
|
-
|
|
3658
|
-
|
|
3659
|
-
<h5 class="h5-returns">Returns:</h5>
|
|
3660
|
-
|
|
3661
|
-
|
|
3662
|
-
|
|
3663
|
-
|
|
3664
|
-
<dl class="param-type">
|
|
3665
|
-
<dt>
|
|
3666
|
-
Type
|
|
3667
|
-
</dt>
|
|
3668
|
-
<dd>
|
|
3669
|
-
|
|
3670
|
-
<span class="param-type">Promise.<(any|null)></span>
|
|
3671
|
-
|
|
3672
|
-
|
|
3673
|
-
|
|
3674
|
-
</dd>
|
|
3675
|
-
</dl>
|
|
3676
|
-
|
|
3677
|
-
|
|
3678
|
-
|
|
3679
|
-
|
|
3680
|
-
|
|
3681
|
-
|
|
3682
|
-
|
|
3683
|
-
|
|
3684
|
-
|
|
3685
|
-
|
|
3686
|
-
<h4 class="name" id=".fetchRecentUserActivities"><span class="type-signature type-signature-static">(static) </span>fetchRecentUserActivities<span class="signature">(params<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<PaginatedActivities>}</span></h4>
|
|
3687
|
-
|
|
3688
|
-
|
|
3689
|
-
|
|
3690
|
-
|
|
3691
|
-
|
|
3692
|
-
|
|
3693
|
-
<dl class="details">
|
|
3694
|
-
|
|
3695
|
-
<dt class="tag-description">Description:</dt>
|
|
3696
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetches a paginated list of recent user activities.</li></ul></dd>
|
|
3697
|
-
|
|
3698
|
-
|
|
3699
|
-
|
|
3700
|
-
<dt class="tag-source">Source:</dt>
|
|
3701
|
-
<dd class="tag-source"><ul class="dummy"><li>
|
|
3702
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line879">line 879</a>
|
|
3703
|
-
</li></ul></dd>
|
|
3704
|
-
|
|
3705
|
-
|
|
3706
|
-
|
|
3707
|
-
|
|
3708
|
-
|
|
3709
|
-
|
|
3710
|
-
|
|
3711
|
-
|
|
3712
|
-
|
|
3713
|
-
|
|
3714
|
-
|
|
3715
|
-
|
|
3716
|
-
|
|
3717
|
-
|
|
3718
|
-
|
|
3719
|
-
|
|
3720
|
-
|
|
3721
|
-
|
|
3722
|
-
|
|
3723
|
-
|
|
3724
|
-
|
|
3725
|
-
|
|
3726
|
-
|
|
3727
|
-
|
|
3728
|
-
|
|
3729
|
-
|
|
3730
|
-
|
|
3731
|
-
|
|
3732
|
-
|
|
3733
|
-
|
|
3734
|
-
|
|
3735
|
-
</dl>
|
|
3736
|
-
|
|
3737
|
-
|
|
3738
|
-
|
|
3739
|
-
|
|
3740
|
-
|
|
3741
|
-
|
|
3742
|
-
|
|
3743
|
-
|
|
3744
|
-
|
|
3745
|
-
|
|
3746
|
-
|
|
3747
|
-
<h5 class="h5-examples">Example</h5>
|
|
3748
|
-
|
|
3749
|
-
<pre class="prettyprint"><code>fetchRecentUserActivities({ page: 2, limit: 5 })
|
|
3750
|
-
.then(activities => console.log(activities))
|
|
3751
|
-
.catch(error => console.error(error));</code></pre>
|
|
3752
|
-
|
|
3753
|
-
|
|
3754
|
-
|
|
3755
|
-
|
|
3756
|
-
<h5 class="h5-parameters">Parameters:</h5>
|
|
3757
|
-
|
|
3758
|
-
|
|
3759
|
-
<table class="params">
|
|
3760
|
-
<thead>
|
|
3761
|
-
<tr>
|
|
3762
|
-
|
|
3763
|
-
<th>Name</th>
|
|
3764
|
-
|
|
3765
|
-
|
|
3766
|
-
<th>Type</th>
|
|
3767
|
-
|
|
3768
|
-
|
|
3769
|
-
<th>Attributes</th>
|
|
3770
|
-
|
|
3771
|
-
|
|
3772
|
-
|
|
3773
|
-
<th>Default</th>
|
|
3774
|
-
|
|
3775
|
-
|
|
3776
|
-
<th class="last">Description</th>
|
|
3777
|
-
</tr>
|
|
3778
|
-
</thead>
|
|
3779
|
-
|
|
3780
|
-
<tbody>
|
|
3781
|
-
|
|
3782
|
-
|
|
3783
|
-
<tr>
|
|
3784
|
-
|
|
3785
|
-
<td class="name"><code>params</code></td>
|
|
3786
|
-
|
|
3787
|
-
|
|
3788
|
-
<td class="type">
|
|
3789
|
-
|
|
3790
|
-
|
|
3791
|
-
<span class="param-type">Object</span>
|
|
3792
|
-
|
|
3793
|
-
|
|
3794
|
-
|
|
3795
|
-
|
|
3796
|
-
</td>
|
|
3797
|
-
|
|
3798
|
-
|
|
3799
|
-
<td class="attributes">
|
|
3800
|
-
|
|
3801
|
-
<optional><br>
|
|
3802
|
-
|
|
3803
|
-
|
|
3804
|
-
|
|
3805
|
-
|
|
3806
|
-
|
|
3807
|
-
</td>
|
|
3808
|
-
|
|
3809
|
-
|
|
3810
|
-
|
|
3811
|
-
<td class="default">
|
|
3812
|
-
|
|
3813
|
-
<code>{}</code>
|
|
3814
|
-
|
|
3815
|
-
</td>
|
|
3816
|
-
|
|
3817
|
-
|
|
3818
|
-
<td class="description last">Optional parameters.
|
|
3819
|
-
<h6>Properties</h6>
|
|
3820
|
-
|
|
3821
|
-
|
|
3822
|
-
<table class="params">
|
|
3823
|
-
<thead>
|
|
3824
|
-
<tr>
|
|
3825
|
-
|
|
3826
|
-
<th>Name</th>
|
|
3827
|
-
|
|
3828
|
-
|
|
3829
|
-
<th>Type</th>
|
|
3830
|
-
|
|
3831
|
-
|
|
3832
|
-
<th>Attributes</th>
|
|
3833
|
-
|
|
3834
|
-
|
|
3835
|
-
|
|
3836
|
-
<th>Default</th>
|
|
3837
|
-
|
|
3838
|
-
|
|
3839
|
-
<th class="last">Description</th>
|
|
3840
|
-
</tr>
|
|
3841
|
-
</thead>
|
|
3842
|
-
|
|
3843
|
-
<tbody>
|
|
3844
|
-
|
|
3845
|
-
|
|
3846
|
-
<tr>
|
|
3847
|
-
|
|
3848
|
-
<td class="name"><code>page</code></td>
|
|
3849
|
-
|
|
3850
|
-
|
|
3851
|
-
<td class="type">
|
|
3852
|
-
|
|
3853
|
-
|
|
3854
|
-
<span class="param-type">number</span>
|
|
3855
|
-
|
|
3856
|
-
|
|
3857
|
-
|
|
3858
|
-
|
|
3859
|
-
</td>
|
|
3860
|
-
|
|
3861
|
-
|
|
3862
|
-
<td class="attributes">
|
|
3863
|
-
|
|
3864
|
-
<optional><br>
|
|
3865
|
-
|
|
3866
|
-
|
|
3867
|
-
|
|
3868
|
-
|
|
3869
|
-
|
|
3870
|
-
</td>
|
|
3871
|
-
|
|
3872
|
-
|
|
3873
|
-
|
|
3874
|
-
<td class="default">
|
|
3875
|
-
|
|
3876
|
-
<code>1</code>
|
|
3877
|
-
|
|
3878
|
-
</td>
|
|
3879
|
-
|
|
3880
|
-
|
|
3881
|
-
<td class="description last">The page number for pagination.</td>
|
|
3882
|
-
</tr>
|
|
3883
|
-
|
|
3884
|
-
|
|
3885
|
-
|
|
3886
|
-
<tr>
|
|
3887
|
-
|
|
3888
|
-
<td class="name"><code>limit</code></td>
|
|
3889
|
-
|
|
3890
|
-
|
|
3891
|
-
<td class="type">
|
|
3892
|
-
|
|
3893
|
-
|
|
3894
|
-
<span class="param-type">number</span>
|
|
3895
|
-
|
|
3896
|
-
|
|
3897
|
-
|
|
3898
|
-
|
|
3899
|
-
</td>
|
|
3900
|
-
|
|
3901
|
-
|
|
3902
|
-
<td class="attributes">
|
|
3903
|
-
|
|
3904
|
-
<optional><br>
|
|
3905
|
-
|
|
3906
|
-
|
|
3907
|
-
|
|
3908
|
-
|
|
3909
|
-
|
|
3910
|
-
</td>
|
|
3911
|
-
|
|
3912
|
-
|
|
3913
|
-
|
|
3914
|
-
<td class="default">
|
|
3915
|
-
|
|
3916
|
-
<code>10</code>
|
|
3917
|
-
|
|
3918
|
-
</td>
|
|
3919
|
-
|
|
3920
|
-
|
|
3921
|
-
<td class="description last">The number of results per page.</td>
|
|
3922
|
-
</tr>
|
|
3923
|
-
|
|
3924
|
-
|
|
3925
|
-
|
|
3926
|
-
<tr>
|
|
3927
|
-
|
|
3928
|
-
<td class="name"><code>tabName</code></td>
|
|
3929
|
-
|
|
3930
|
-
|
|
3931
|
-
<td class="type">
|
|
3932
|
-
|
|
3933
|
-
|
|
3934
|
-
<span class="param-type">string</span>
|
|
3935
|
-
|
|
|
3936
|
-
|
|
3937
|
-
<span class="param-type">null</span>
|
|
3938
|
-
|
|
3939
|
-
|
|
3940
|
-
|
|
3941
|
-
|
|
3942
|
-
</td>
|
|
3943
|
-
|
|
3944
|
-
|
|
3945
|
-
<td class="attributes">
|
|
3946
|
-
|
|
3947
|
-
<optional><br>
|
|
3948
|
-
|
|
3949
|
-
|
|
3950
|
-
|
|
3951
|
-
|
|
3952
|
-
|
|
3953
|
-
</td>
|
|
3954
|
-
|
|
3955
|
-
|
|
3956
|
-
|
|
3957
|
-
<td class="default">
|
|
3958
|
-
|
|
3959
|
-
<code>null</code>
|
|
3960
|
-
|
|
3961
|
-
</td>
|
|
3962
|
-
|
|
3963
|
-
|
|
3964
|
-
<td class="description last">Optional filter for activity type/tab.</td>
|
|
3965
|
-
</tr>
|
|
3966
|
-
|
|
3967
|
-
|
|
3968
|
-
</tbody>
|
|
3969
|
-
</table>
|
|
3970
|
-
|
|
3971
|
-
</td>
|
|
3972
|
-
</tr>
|
|
3973
|
-
|
|
3974
|
-
|
|
3975
|
-
</tbody>
|
|
3976
|
-
</table>
|
|
3977
|
-
|
|
3978
|
-
|
|
3979
|
-
|
|
3980
|
-
|
|
3981
|
-
|
|
3982
|
-
|
|
3983
|
-
|
|
3984
|
-
|
|
3985
|
-
|
|
3986
|
-
|
|
3987
|
-
|
|
3988
|
-
|
|
3989
|
-
|
|
3990
|
-
|
|
3991
|
-
|
|
3992
|
-
|
|
3993
|
-
<h5 class="h5-returns">Returns:</h5>
|
|
3994
|
-
|
|
3995
|
-
|
|
3996
|
-
<div class="param-desc">
|
|
3997
|
-
- A promise that resolves to a paginated object of user activities.
|
|
3998
|
-
</div>
|
|
3999
|
-
|
|
4000
|
-
|
|
4001
|
-
|
|
4002
|
-
<dl class="param-type">
|
|
4003
|
-
<dt>
|
|
4004
|
-
Type
|
|
4005
|
-
</dt>
|
|
4006
|
-
<dd>
|
|
4007
|
-
|
|
4008
|
-
<span class="param-type">Promise.<PaginatedActivities></span>
|
|
4009
|
-
|
|
4010
|
-
|
|
4011
|
-
|
|
4012
|
-
</dd>
|
|
4013
|
-
</dl>
|
|
4014
|
-
|
|
4015
|
-
|
|
4016
|
-
|
|
4017
|
-
|
|
4018
|
-
|
|
4019
|
-
|
|
4020
|
-
|
|
4021
|
-
|
|
4022
|
-
|
|
4023
|
-
|
|
4024
|
-
<h4 class="name" id=".fetchSongsInProgress"><span class="type-signature type-signature-static">(static) </span>fetchSongsInProgress<span class="signature">(brand)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
4025
|
-
|
|
4026
|
-
|
|
4027
|
-
|
|
4028
|
-
|
|
4029
|
-
|
|
4030
|
-
|
|
4031
|
-
<dl class="details">
|
|
4032
|
-
|
|
4033
|
-
<dt class="tag-description">Description:</dt>
|
|
4034
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetches a list of songs that are currently in progress for the current user.</li></ul></dd>
|
|
4035
|
-
|
|
4036
|
-
|
|
4037
|
-
|
|
4038
|
-
<dt class="tag-source">Source:</dt>
|
|
4039
|
-
<dd class="tag-source"><ul class="dummy"><li>
|
|
4040
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line103">line 103</a>
|
|
4041
|
-
</li></ul></dd>
|
|
4042
|
-
|
|
4043
|
-
|
|
4044
|
-
|
|
4045
|
-
|
|
4046
|
-
|
|
4047
|
-
|
|
4048
|
-
|
|
4049
|
-
|
|
4050
|
-
|
|
4051
|
-
|
|
4052
|
-
|
|
4053
|
-
|
|
4054
|
-
|
|
4055
|
-
|
|
4056
|
-
|
|
4057
|
-
|
|
4058
|
-
|
|
4059
|
-
|
|
4060
|
-
|
|
4061
|
-
|
|
4062
|
-
|
|
4063
|
-
|
|
4064
|
-
|
|
4065
|
-
|
|
4066
|
-
|
|
4067
|
-
|
|
4068
|
-
|
|
4069
|
-
|
|
4070
|
-
|
|
4071
|
-
|
|
4072
|
-
|
|
4073
|
-
</dl>
|
|
4074
|
-
|
|
4075
|
-
|
|
4076
|
-
|
|
4077
|
-
|
|
4078
|
-
|
|
4079
|
-
|
|
4080
|
-
|
|
4081
|
-
|
|
4082
|
-
|
|
4083
|
-
|
|
4084
|
-
|
|
4085
|
-
<h5 class="h5-examples">Example</h5>
|
|
4086
|
-
|
|
4087
|
-
<pre class="prettyprint"><code>fetchSongsInProgress('drumeo')
|
|
4088
|
-
.then(songs => console.log(songs))
|
|
4089
|
-
.catch(error => console.error(error));</code></pre>
|
|
4090
|
-
|
|
4091
|
-
|
|
4092
|
-
|
|
4093
|
-
|
|
4094
|
-
<h5 class="h5-parameters">Parameters:</h5>
|
|
4095
|
-
|
|
4096
|
-
|
|
4097
|
-
<table class="params">
|
|
4098
|
-
<thead>
|
|
4099
|
-
<tr>
|
|
4100
|
-
|
|
4101
|
-
<th>Name</th>
|
|
4102
|
-
|
|
4103
|
-
|
|
4104
|
-
<th>Type</th>
|
|
4105
|
-
|
|
4106
|
-
|
|
4107
|
-
|
|
4108
|
-
|
|
4109
|
-
|
|
4110
|
-
<th class="last">Description</th>
|
|
4111
|
-
</tr>
|
|
4112
|
-
</thead>
|
|
2474
|
+
</tr>
|
|
4113
2475
|
|
|
4114
|
-
<tbody>
|
|
4115
2476
|
|
|
4116
2477
|
|
|
4117
2478
|
<tr>
|
|
4118
2479
|
|
|
4119
|
-
<td class="name"><code>
|
|
2480
|
+
<td class="name"><code>params.page</code></td>
|
|
4120
2481
|
|
|
4121
2482
|
|
|
4122
2483
|
<td class="type">
|
|
4123
2484
|
|
|
4124
2485
|
|
|
4125
|
-
<span class="param-type">
|
|
2486
|
+
<span class="param-type">number</span>
|
|
4126
2487
|
|
|
4127
2488
|
|
|
4128
2489
|
|
|
@@ -4130,10 +2491,26 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4130
2491
|
</td>
|
|
4131
2492
|
|
|
4132
2493
|
|
|
2494
|
+
<td class="attributes">
|
|
2495
|
+
|
|
2496
|
+
<optional><br>
|
|
2497
|
+
|
|
2498
|
+
|
|
2499
|
+
|
|
4133
2500
|
|
|
2501
|
+
|
|
2502
|
+
</td>
|
|
4134
2503
|
|
|
4135
2504
|
|
|
4136
|
-
|
|
2505
|
+
|
|
2506
|
+
<td class="default">
|
|
2507
|
+
|
|
2508
|
+
<code>1</code>
|
|
2509
|
+
|
|
2510
|
+
</td>
|
|
2511
|
+
|
|
2512
|
+
|
|
2513
|
+
<td class="description last">The page number for pagination.</td>
|
|
4137
2514
|
</tr>
|
|
4138
2515
|
|
|
4139
2516
|
|
|
@@ -4159,7 +2536,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4159
2536
|
|
|
4160
2537
|
|
|
4161
2538
|
<div class="param-desc">
|
|
4162
|
-
- Returns an object containing in-progress
|
|
2539
|
+
- Returns an object containing in-progress content if found, otherwise null.
|
|
4163
2540
|
</div>
|
|
4164
2541
|
|
|
4165
2542
|
|
|
@@ -4186,7 +2563,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4186
2563
|
|
|
4187
2564
|
|
|
4188
2565
|
|
|
4189
|
-
<h4 class="name" id=".
|
|
2566
|
+
<h4 class="name" id=".fetchContentPageUserData"><span class="type-signature type-signature-static">(static) </span>fetchContentPageUserData<span class="signature">(contentId)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
4190
2567
|
|
|
4191
2568
|
|
|
4192
2569
|
|
|
@@ -4196,13 +2573,13 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4196
2573
|
<dl class="details">
|
|
4197
2574
|
|
|
4198
2575
|
<dt class="tag-description">Description:</dt>
|
|
4199
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
2576
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetches user context data for a specific piece of content.</li></ul></dd>
|
|
4200
2577
|
|
|
4201
2578
|
|
|
4202
2579
|
|
|
4203
2580
|
<dt class="tag-source">Source:</dt>
|
|
4204
2581
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
4205
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
2582
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line220">line 220</a>
|
|
4206
2583
|
</li></ul></dd>
|
|
4207
2584
|
|
|
4208
2585
|
|
|
@@ -4247,6 +2624,13 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4247
2624
|
|
|
4248
2625
|
|
|
4249
2626
|
|
|
2627
|
+
<h5 class="h5-examples">Example</h5>
|
|
2628
|
+
|
|
2629
|
+
<pre class="prettyprint"><code>fetchContentPageUserData(406548)
|
|
2630
|
+
.then(data => console.log(data))
|
|
2631
|
+
.catch(error => console.error(error));</code></pre>
|
|
2632
|
+
|
|
2633
|
+
|
|
4250
2634
|
|
|
4251
2635
|
|
|
4252
2636
|
<h5 class="h5-parameters">Parameters:</h5>
|
|
@@ -4274,7 +2658,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4274
2658
|
|
|
4275
2659
|
<tr>
|
|
4276
2660
|
|
|
4277
|
-
<td class="name"><code>
|
|
2661
|
+
<td class="name"><code>contentId</code></td>
|
|
4278
2662
|
|
|
4279
2663
|
|
|
4280
2664
|
<td class="type">
|
|
@@ -4291,7 +2675,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4291
2675
|
|
|
4292
2676
|
|
|
4293
2677
|
|
|
4294
|
-
<td class="description last">The
|
|
2678
|
+
<td class="description last">The content id.</td>
|
|
4295
2679
|
</tr>
|
|
4296
2680
|
|
|
4297
2681
|
|
|
@@ -4317,7 +2701,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4317
2701
|
|
|
4318
2702
|
|
|
4319
2703
|
<div class="param-desc">
|
|
4320
|
-
-
|
|
2704
|
+
- Returns an object containing user context data if found, otherwise null.
|
|
4321
2705
|
</div>
|
|
4322
2706
|
|
|
4323
2707
|
|
|
@@ -4344,7 +2728,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4344
2728
|
|
|
4345
2729
|
|
|
4346
2730
|
|
|
4347
|
-
<h4 class="name" id=".
|
|
2731
|
+
<h4 class="name" id=".fetchNextContentDataForParent"><span class="type-signature type-signature-static">(static) </span>fetchNextContentDataForParent<span class="signature">(contentId)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
4348
2732
|
|
|
4349
2733
|
|
|
4350
2734
|
|
|
@@ -4354,13 +2738,13 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4354
2738
|
<dl class="details">
|
|
4355
2739
|
|
|
4356
2740
|
<dt class="tag-description">Description:</dt>
|
|
4357
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
2741
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetches the ID and Type of the piece of content that would be the next one for the user</li></ul></dd>
|
|
4358
2742
|
|
|
4359
2743
|
|
|
4360
2744
|
|
|
4361
2745
|
<dt class="tag-source">Source:</dt>
|
|
4362
2746
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
4363
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
2747
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line249">line 249</a>
|
|
4364
2748
|
</li></ul></dd>
|
|
4365
2749
|
|
|
4366
2750
|
|
|
@@ -4437,13 +2821,19 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4437
2821
|
|
|
4438
2822
|
<td class="type">
|
|
4439
2823
|
|
|
2824
|
+
|
|
2825
|
+
<span class="param-type">int</span>
|
|
2826
|
+
|
|
2827
|
+
|
|
2828
|
+
|
|
2829
|
+
|
|
4440
2830
|
</td>
|
|
4441
2831
|
|
|
4442
2832
|
|
|
4443
2833
|
|
|
4444
2834
|
|
|
4445
2835
|
|
|
4446
|
-
<td class="description last">
|
|
2836
|
+
<td class="description last">The id of the parent (method, level, or course) piece of content.</td>
|
|
4447
2837
|
</tr>
|
|
4448
2838
|
|
|
4449
2839
|
|
|
@@ -4469,7 +2859,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4469
2859
|
|
|
4470
2860
|
|
|
4471
2861
|
<div class="param-desc">
|
|
4472
|
-
-
|
|
2862
|
+
- Returns and Object with the id and type of the next piece of content if found, otherwise null.
|
|
4473
2863
|
</div>
|
|
4474
2864
|
|
|
4475
2865
|
|
|
@@ -4480,7 +2870,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4480
2870
|
</dt>
|
|
4481
2871
|
<dd>
|
|
4482
2872
|
|
|
4483
|
-
<span class="param-type">Promise.<(
|
|
2873
|
+
<span class="param-type">Promise.<(Object|null)></span>
|
|
4484
2874
|
|
|
4485
2875
|
|
|
4486
2876
|
|
|
@@ -4496,7 +2886,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4496
2886
|
|
|
4497
2887
|
|
|
4498
2888
|
|
|
4499
|
-
<h4 class="name" id=".
|
|
2889
|
+
<h4 class="name" id=".fetchRecentUserActivities"><span class="type-signature type-signature-static">(static) </span>fetchRecentUserActivities<span class="signature">(params<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<PaginatedActivities>}</span></h4>
|
|
4500
2890
|
|
|
4501
2891
|
|
|
4502
2892
|
|
|
@@ -4506,13 +2896,13 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4506
2896
|
<dl class="details">
|
|
4507
2897
|
|
|
4508
2898
|
<dt class="tag-description">Description:</dt>
|
|
4509
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
2899
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetches a paginated list of recent user activities.</li></ul></dd>
|
|
4510
2900
|
|
|
4511
2901
|
|
|
4512
2902
|
|
|
4513
2903
|
<dt class="tag-source">Source:</dt>
|
|
4514
2904
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
4515
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
2905
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line735">line 735</a>
|
|
4516
2906
|
</li></ul></dd>
|
|
4517
2907
|
|
|
4518
2908
|
|
|
@@ -4557,6 +2947,13 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4557
2947
|
|
|
4558
2948
|
|
|
4559
2949
|
|
|
2950
|
+
<h5 class="h5-examples">Example</h5>
|
|
2951
|
+
|
|
2952
|
+
<pre class="prettyprint"><code>fetchRecentUserActivities({ page: 2, limit: 5 })
|
|
2953
|
+
.then(activities => console.log(activities))
|
|
2954
|
+
.catch(error => console.error(error));</code></pre>
|
|
2955
|
+
|
|
2956
|
+
|
|
4560
2957
|
|
|
4561
2958
|
|
|
4562
2959
|
<h5 class="h5-parameters">Parameters:</h5>
|
|
@@ -4572,8 +2969,12 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4572
2969
|
<th>Type</th>
|
|
4573
2970
|
|
|
4574
2971
|
|
|
2972
|
+
<th>Attributes</th>
|
|
2973
|
+
|
|
4575
2974
|
|
|
4576
2975
|
|
|
2976
|
+
<th>Default</th>
|
|
2977
|
+
|
|
4577
2978
|
|
|
4578
2979
|
<th class="last">Description</th>
|
|
4579
2980
|
</tr>
|
|
@@ -4584,7 +2985,150 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4584
2985
|
|
|
4585
2986
|
<tr>
|
|
4586
2987
|
|
|
4587
|
-
<td class="name"><code>
|
|
2988
|
+
<td class="name"><code>params</code></td>
|
|
2989
|
+
|
|
2990
|
+
|
|
2991
|
+
<td class="type">
|
|
2992
|
+
|
|
2993
|
+
|
|
2994
|
+
<span class="param-type">Object</span>
|
|
2995
|
+
|
|
2996
|
+
|
|
2997
|
+
|
|
2998
|
+
|
|
2999
|
+
</td>
|
|
3000
|
+
|
|
3001
|
+
|
|
3002
|
+
<td class="attributes">
|
|
3003
|
+
|
|
3004
|
+
<optional><br>
|
|
3005
|
+
|
|
3006
|
+
|
|
3007
|
+
|
|
3008
|
+
|
|
3009
|
+
|
|
3010
|
+
</td>
|
|
3011
|
+
|
|
3012
|
+
|
|
3013
|
+
|
|
3014
|
+
<td class="default">
|
|
3015
|
+
|
|
3016
|
+
<code>{}</code>
|
|
3017
|
+
|
|
3018
|
+
</td>
|
|
3019
|
+
|
|
3020
|
+
|
|
3021
|
+
<td class="description last">Optional parameters.
|
|
3022
|
+
<h6>Properties</h6>
|
|
3023
|
+
|
|
3024
|
+
|
|
3025
|
+
<table class="params">
|
|
3026
|
+
<thead>
|
|
3027
|
+
<tr>
|
|
3028
|
+
|
|
3029
|
+
<th>Name</th>
|
|
3030
|
+
|
|
3031
|
+
|
|
3032
|
+
<th>Type</th>
|
|
3033
|
+
|
|
3034
|
+
|
|
3035
|
+
<th>Attributes</th>
|
|
3036
|
+
|
|
3037
|
+
|
|
3038
|
+
|
|
3039
|
+
<th>Default</th>
|
|
3040
|
+
|
|
3041
|
+
|
|
3042
|
+
<th class="last">Description</th>
|
|
3043
|
+
</tr>
|
|
3044
|
+
</thead>
|
|
3045
|
+
|
|
3046
|
+
<tbody>
|
|
3047
|
+
|
|
3048
|
+
|
|
3049
|
+
<tr>
|
|
3050
|
+
|
|
3051
|
+
<td class="name"><code>page</code></td>
|
|
3052
|
+
|
|
3053
|
+
|
|
3054
|
+
<td class="type">
|
|
3055
|
+
|
|
3056
|
+
|
|
3057
|
+
<span class="param-type">number</span>
|
|
3058
|
+
|
|
3059
|
+
|
|
3060
|
+
|
|
3061
|
+
|
|
3062
|
+
</td>
|
|
3063
|
+
|
|
3064
|
+
|
|
3065
|
+
<td class="attributes">
|
|
3066
|
+
|
|
3067
|
+
<optional><br>
|
|
3068
|
+
|
|
3069
|
+
|
|
3070
|
+
|
|
3071
|
+
|
|
3072
|
+
|
|
3073
|
+
</td>
|
|
3074
|
+
|
|
3075
|
+
|
|
3076
|
+
|
|
3077
|
+
<td class="default">
|
|
3078
|
+
|
|
3079
|
+
<code>1</code>
|
|
3080
|
+
|
|
3081
|
+
</td>
|
|
3082
|
+
|
|
3083
|
+
|
|
3084
|
+
<td class="description last">The page number for pagination.</td>
|
|
3085
|
+
</tr>
|
|
3086
|
+
|
|
3087
|
+
|
|
3088
|
+
|
|
3089
|
+
<tr>
|
|
3090
|
+
|
|
3091
|
+
<td class="name"><code>limit</code></td>
|
|
3092
|
+
|
|
3093
|
+
|
|
3094
|
+
<td class="type">
|
|
3095
|
+
|
|
3096
|
+
|
|
3097
|
+
<span class="param-type">number</span>
|
|
3098
|
+
|
|
3099
|
+
|
|
3100
|
+
|
|
3101
|
+
|
|
3102
|
+
</td>
|
|
3103
|
+
|
|
3104
|
+
|
|
3105
|
+
<td class="attributes">
|
|
3106
|
+
|
|
3107
|
+
<optional><br>
|
|
3108
|
+
|
|
3109
|
+
|
|
3110
|
+
|
|
3111
|
+
|
|
3112
|
+
|
|
3113
|
+
</td>
|
|
3114
|
+
|
|
3115
|
+
|
|
3116
|
+
|
|
3117
|
+
<td class="default">
|
|
3118
|
+
|
|
3119
|
+
<code>10</code>
|
|
3120
|
+
|
|
3121
|
+
</td>
|
|
3122
|
+
|
|
3123
|
+
|
|
3124
|
+
<td class="description last">The number of results per page.</td>
|
|
3125
|
+
</tr>
|
|
3126
|
+
|
|
3127
|
+
|
|
3128
|
+
|
|
3129
|
+
<tr>
|
|
3130
|
+
|
|
3131
|
+
<td class="name"><code>tabName</code></td>
|
|
4588
3132
|
|
|
4589
3133
|
|
|
4590
3134
|
<td class="type">
|
|
@@ -4601,10 +3145,33 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4601
3145
|
</td>
|
|
4602
3146
|
|
|
4603
3147
|
|
|
3148
|
+
<td class="attributes">
|
|
3149
|
+
|
|
3150
|
+
<optional><br>
|
|
3151
|
+
|
|
3152
|
+
|
|
3153
|
+
|
|
3154
|
+
|
|
3155
|
+
|
|
3156
|
+
</td>
|
|
3157
|
+
|
|
4604
3158
|
|
|
4605
3159
|
|
|
3160
|
+
<td class="default">
|
|
3161
|
+
|
|
3162
|
+
<code>null</code>
|
|
3163
|
+
|
|
3164
|
+
</td>
|
|
3165
|
+
|
|
4606
3166
|
|
|
4607
|
-
<td class="description last"
|
|
3167
|
+
<td class="description last">Optional filter for activity type/tab.</td>
|
|
3168
|
+
</tr>
|
|
3169
|
+
|
|
3170
|
+
|
|
3171
|
+
</tbody>
|
|
3172
|
+
</table>
|
|
3173
|
+
|
|
3174
|
+
</td>
|
|
4608
3175
|
</tr>
|
|
4609
3176
|
|
|
4610
3177
|
|
|
@@ -4629,6 +3196,10 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4629
3196
|
<h5 class="h5-returns">Returns:</h5>
|
|
4630
3197
|
|
|
4631
3198
|
|
|
3199
|
+
<div class="param-desc">
|
|
3200
|
+
- A promise that resolves to a paginated object of user activities.
|
|
3201
|
+
</div>
|
|
3202
|
+
|
|
4632
3203
|
|
|
4633
3204
|
|
|
4634
3205
|
<dl class="param-type">
|
|
@@ -4637,7 +3208,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4637
3208
|
</dt>
|
|
4638
3209
|
<dd>
|
|
4639
3210
|
|
|
4640
|
-
<span class="param-type">Promise.<
|
|
3211
|
+
<span class="param-type">Promise.<PaginatedActivities></span>
|
|
4641
3212
|
|
|
4642
3213
|
|
|
4643
3214
|
|
|
@@ -4653,7 +3224,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4653
3224
|
|
|
4654
3225
|
|
|
4655
3226
|
|
|
4656
|
-
<h4 class="name" id=".
|
|
3227
|
+
<h4 class="name" id=".fetchSongsInProgress"><span class="type-signature type-signature-static">(static) </span>fetchSongsInProgress<span class="signature">(brand)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
4657
3228
|
|
|
4658
3229
|
|
|
4659
3230
|
|
|
@@ -4663,13 +3234,13 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4663
3234
|
<dl class="details">
|
|
4664
3235
|
|
|
4665
3236
|
<dt class="tag-description">Description:</dt>
|
|
4666
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
3237
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetches a list of songs that are currently in progress for the current user.</li></ul></dd>
|
|
4667
3238
|
|
|
4668
3239
|
|
|
4669
3240
|
|
|
4670
3241
|
<dt class="tag-source">Source:</dt>
|
|
4671
3242
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
4672
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
3243
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line100">line 100</a>
|
|
4673
3244
|
</li></ul></dd>
|
|
4674
3245
|
|
|
4675
3246
|
|
|
@@ -4714,6 +3285,13 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4714
3285
|
|
|
4715
3286
|
|
|
4716
3287
|
|
|
3288
|
+
<h5 class="h5-examples">Example</h5>
|
|
3289
|
+
|
|
3290
|
+
<pre class="prettyprint"><code>fetchSongsInProgress('drumeo')
|
|
3291
|
+
.then(songs => console.log(songs))
|
|
3292
|
+
.catch(error => console.error(error));</code></pre>
|
|
3293
|
+
|
|
3294
|
+
|
|
4717
3295
|
|
|
4718
3296
|
|
|
4719
3297
|
<h5 class="h5-parameters">Parameters:</h5>
|
|
@@ -4741,18 +3319,24 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4741
3319
|
|
|
4742
3320
|
<tr>
|
|
4743
3321
|
|
|
4744
|
-
<td class="name"><code>
|
|
3322
|
+
<td class="name"><code>brand</code></td>
|
|
4745
3323
|
|
|
4746
3324
|
|
|
4747
3325
|
<td class="type">
|
|
4748
3326
|
|
|
3327
|
+
|
|
3328
|
+
<span class="param-type">string</span>
|
|
3329
|
+
|
|
3330
|
+
|
|
3331
|
+
|
|
3332
|
+
|
|
4749
3333
|
</td>
|
|
4750
3334
|
|
|
4751
3335
|
|
|
4752
3336
|
|
|
4753
3337
|
|
|
4754
3338
|
|
|
4755
|
-
<td class="description last">
|
|
3339
|
+
<td class="description last">The brand associated with the songs.</td>
|
|
4756
3340
|
</tr>
|
|
4757
3341
|
|
|
4758
3342
|
|
|
@@ -4777,6 +3361,10 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4777
3361
|
<h5 class="h5-returns">Returns:</h5>
|
|
4778
3362
|
|
|
4779
3363
|
|
|
3364
|
+
<div class="param-desc">
|
|
3365
|
+
- Returns an object containing in-progress songs if found, otherwise null.
|
|
3366
|
+
</div>
|
|
3367
|
+
|
|
4780
3368
|
|
|
4781
3369
|
|
|
4782
3370
|
<dl class="param-type">
|
|
@@ -4785,7 +3373,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4785
3373
|
</dt>
|
|
4786
3374
|
<dd>
|
|
4787
3375
|
|
|
4788
|
-
<span class="param-type">Promise.<(
|
|
3376
|
+
<span class="param-type">Promise.<(Object|null)></span>
|
|
4789
3377
|
|
|
4790
3378
|
|
|
4791
3379
|
|
|
@@ -4801,7 +3389,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4801
3389
|
|
|
4802
3390
|
|
|
4803
3391
|
|
|
4804
|
-
<h4 class="name" id=".
|
|
3392
|
+
<h4 class="name" id=".fetchTopComment"><span class="type-signature type-signature-static">(static) </span>fetchTopComment<span class="signature">(railcontentId)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
4805
3393
|
|
|
4806
3394
|
|
|
4807
3395
|
|
|
@@ -4811,13 +3399,13 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4811
3399
|
<dl class="details">
|
|
4812
3400
|
|
|
4813
3401
|
<dt class="tag-description">Description:</dt>
|
|
4814
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
3402
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch the top comment for a given content</li></ul></dd>
|
|
4815
3403
|
|
|
4816
3404
|
|
|
4817
3405
|
|
|
4818
3406
|
<dt class="tag-source">Source:</dt>
|
|
4819
3407
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
4820
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
3408
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line440">line 440</a>
|
|
4821
3409
|
</li></ul></dd>
|
|
4822
3410
|
|
|
4823
3411
|
|
|
@@ -4862,13 +3450,6 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4862
3450
|
|
|
4863
3451
|
|
|
4864
3452
|
|
|
4865
|
-
<h5 class="h5-examples">Example</h5>
|
|
4866
|
-
|
|
4867
|
-
<pre class="prettyprint"><code>fetchUserPracticeNotes('2025-04-10')
|
|
4868
|
-
.then(notes => console.log(notes))
|
|
4869
|
-
.catch(error => console.error(error));</code></pre>
|
|
4870
|
-
|
|
4871
|
-
|
|
4872
3453
|
|
|
4873
3454
|
|
|
4874
3455
|
<h5 class="h5-parameters">Parameters:</h5>
|
|
@@ -4896,13 +3477,13 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4896
3477
|
|
|
4897
3478
|
<tr>
|
|
4898
3479
|
|
|
4899
|
-
<td class="name"><code>
|
|
3480
|
+
<td class="name"><code>railcontentId</code></td>
|
|
4900
3481
|
|
|
4901
3482
|
|
|
4902
3483
|
<td class="type">
|
|
4903
3484
|
|
|
4904
3485
|
|
|
4905
|
-
<span class="param-type">
|
|
3486
|
+
<span class="param-type">int</span>
|
|
4906
3487
|
|
|
4907
3488
|
|
|
4908
3489
|
|
|
@@ -4913,7 +3494,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4913
3494
|
|
|
4914
3495
|
|
|
4915
3496
|
|
|
4916
|
-
<td class="description last">The
|
|
3497
|
+
<td class="description last">The railcontent id to fetch.</td>
|
|
4917
3498
|
</tr>
|
|
4918
3499
|
|
|
4919
3500
|
|
|
@@ -4939,7 +3520,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4939
3520
|
|
|
4940
3521
|
|
|
4941
3522
|
<div class="param-desc">
|
|
4942
|
-
- A promise that resolves to an object
|
|
3523
|
+
- A promise that resolves to an comment object
|
|
4943
3524
|
</div>
|
|
4944
3525
|
|
|
4945
3526
|
|
|
@@ -4966,7 +3547,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4966
3547
|
|
|
4967
3548
|
|
|
4968
3549
|
|
|
4969
|
-
<h4 class="name" id=".
|
|
3550
|
+
<h4 class="name" id=".fetchUserAward"><span class="type-signature type-signature-static">(static) </span>fetchUserAward<span class="signature">(contentId)</span><span class="type-signature"> → {Promise.<(any|null)>}</span></h4>
|
|
4970
3551
|
|
|
4971
3552
|
|
|
4972
3553
|
|
|
@@ -4975,11 +3556,14 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4975
3556
|
|
|
4976
3557
|
<dl class="details">
|
|
4977
3558
|
|
|
3559
|
+
<dt class="tag-description">Description:</dt>
|
|
3560
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch the user's best award for this challenge</li></ul></dd>
|
|
3561
|
+
|
|
4978
3562
|
|
|
4979
3563
|
|
|
4980
3564
|
<dt class="tag-source">Source:</dt>
|
|
4981
3565
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
4982
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
3566
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line353">line 353</a>
|
|
4983
3567
|
</li></ul></dd>
|
|
4984
3568
|
|
|
4985
3569
|
|
|
@@ -5051,24 +3635,18 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5051
3635
|
|
|
5052
3636
|
<tr>
|
|
5053
3637
|
|
|
5054
|
-
<td class="name"><code>
|
|
3638
|
+
<td class="name"><code>contentId</code></td>
|
|
5055
3639
|
|
|
5056
3640
|
|
|
5057
3641
|
<td class="type">
|
|
5058
3642
|
|
|
5059
|
-
|
|
5060
|
-
<span class="param-type">int</span>
|
|
5061
|
-
|
|
5062
|
-
|
|
5063
|
-
|
|
5064
|
-
|
|
5065
3643
|
</td>
|
|
5066
3644
|
|
|
5067
3645
|
|
|
5068
3646
|
|
|
5069
3647
|
|
|
5070
3648
|
|
|
5071
|
-
<td class="description last"
|
|
3649
|
+
<td class="description last">railcontent id of the challenge</td>
|
|
5072
3650
|
</tr>
|
|
5073
3651
|
|
|
5074
3652
|
|
|
@@ -5093,6 +3671,10 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5093
3671
|
<h5 class="h5-returns">Returns:</h5>
|
|
5094
3672
|
|
|
5095
3673
|
|
|
3674
|
+
<div class="param-desc">
|
|
3675
|
+
- streamed PDF
|
|
3676
|
+
</div>
|
|
3677
|
+
|
|
5096
3678
|
|
|
5097
3679
|
|
|
5098
3680
|
<dl class="param-type">
|
|
@@ -5101,7 +3683,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5101
3683
|
</dt>
|
|
5102
3684
|
<dd>
|
|
5103
3685
|
|
|
5104
|
-
<span class="param-type">Promise.<(
|
|
3686
|
+
<span class="param-type">Promise.<(any|null)></span>
|
|
5105
3687
|
|
|
5106
3688
|
|
|
5107
3689
|
|
|
@@ -5117,7 +3699,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5117
3699
|
|
|
5118
3700
|
|
|
5119
3701
|
|
|
5120
|
-
<h4 class="name" id=".
|
|
3702
|
+
<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>
|
|
5121
3703
|
|
|
5122
3704
|
|
|
5123
3705
|
|
|
@@ -5126,11 +3708,14 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5126
3708
|
|
|
5127
3709
|
<dl class="details">
|
|
5128
3710
|
|
|
3711
|
+
<dt class="tag-description">Description:</dt>
|
|
3712
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch all completed badges for the user ordered by completion date descending</li></ul></dd>
|
|
3713
|
+
|
|
5129
3714
|
|
|
5130
3715
|
|
|
5131
3716
|
<dt class="tag-source">Source:</dt>
|
|
5132
3717
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
5133
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
3718
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line375">line 375</a>
|
|
5134
3719
|
</li></ul></dd>
|
|
5135
3720
|
|
|
5136
3721
|
|
|
@@ -5202,13 +3787,16 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5202
3787
|
|
|
5203
3788
|
<tr>
|
|
5204
3789
|
|
|
5205
|
-
<td class="name"><code>
|
|
3790
|
+
<td class="name"><code>brand</code></td>
|
|
5206
3791
|
|
|
5207
3792
|
|
|
5208
3793
|
<td class="type">
|
|
5209
3794
|
|
|
5210
3795
|
|
|
5211
|
-
<span class="param-type">
|
|
3796
|
+
<span class="param-type">string</span>
|
|
3797
|
+
|
|
|
3798
|
+
|
|
3799
|
+
<span class="param-type">null</span>
|
|
5212
3800
|
|
|
5213
3801
|
|
|
5214
3802
|
|
|
@@ -5219,7 +3807,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5219
3807
|
|
|
5220
3808
|
|
|
5221
3809
|
|
|
5222
|
-
<td class="description last"
|
|
3810
|
+
<td class="description last">-</td>
|
|
5223
3811
|
</tr>
|
|
5224
3812
|
|
|
5225
3813
|
|
|
@@ -5252,7 +3840,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5252
3840
|
</dt>
|
|
5253
3841
|
<dd>
|
|
5254
3842
|
|
|
5255
|
-
<span class="param-type">Promise.<(
|
|
3843
|
+
<span class="param-type">Promise.<(any|null)></span>
|
|
5256
3844
|
|
|
5257
3845
|
|
|
5258
3846
|
|
|
@@ -5268,7 +3856,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5268
3856
|
|
|
5269
3857
|
|
|
5270
3858
|
|
|
5271
|
-
<h4 class="name" id=".
|
|
3859
|
+
<h4 class="name" id=".fetchUserPracticeNotes"><span class="type-signature type-signature-static">(static) </span>fetchUserPracticeNotes<span class="signature">(date)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
5272
3860
|
|
|
5273
3861
|
|
|
5274
3862
|
|
|
@@ -5278,13 +3866,13 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5278
3866
|
<dl class="details">
|
|
5279
3867
|
|
|
5280
3868
|
<dt class="tag-description">Description:</dt>
|
|
5281
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
3869
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetches user practice notes for a specific date.</li></ul></dd>
|
|
5282
3870
|
|
|
5283
3871
|
|
|
5284
3872
|
|
|
5285
3873
|
<dt class="tag-source">Source:</dt>
|
|
5286
3874
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
5287
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
3875
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line676">line 676</a>
|
|
5288
3876
|
</li></ul></dd>
|
|
5289
3877
|
|
|
5290
3878
|
|
|
@@ -5329,6 +3917,13 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5329
3917
|
|
|
5330
3918
|
|
|
5331
3919
|
|
|
3920
|
+
<h5 class="h5-examples">Example</h5>
|
|
3921
|
+
|
|
3922
|
+
<pre class="prettyprint"><code>fetchUserPracticeNotes('2025-04-10')
|
|
3923
|
+
.then(notes => console.log(notes))
|
|
3924
|
+
.catch(error => console.error(error));</code></pre>
|
|
3925
|
+
|
|
3926
|
+
|
|
5332
3927
|
|
|
5333
3928
|
|
|
5334
3929
|
<h5 class="h5-parameters">Parameters:</h5>
|
|
@@ -5356,15 +3951,12 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5356
3951
|
|
|
5357
3952
|
<tr>
|
|
5358
3953
|
|
|
5359
|
-
<td class="name"><code>
|
|
3954
|
+
<td class="name"><code>date</code></td>
|
|
5360
3955
|
|
|
5361
3956
|
|
|
5362
3957
|
<td class="type">
|
|
5363
3958
|
|
|
5364
3959
|
|
|
5365
|
-
<span class="param-type">int</span>
|
|
5366
|
-
|
|
|
5367
|
-
|
|
5368
3960
|
<span class="param-type">string</span>
|
|
5369
3961
|
|
|
5370
3962
|
|
|
@@ -5376,7 +3968,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5376
3968
|
|
|
5377
3969
|
|
|
5378
3970
|
|
|
5379
|
-
<td class="description last">
|
|
3971
|
+
<td class="description last">The date for which to fetch practice notes (format: YYYY-MM-DD).</td>
|
|
5380
3972
|
</tr>
|
|
5381
3973
|
|
|
5382
3974
|
|
|
@@ -5401,6 +3993,10 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5401
3993
|
<h5 class="h5-returns">Returns:</h5>
|
|
5402
3994
|
|
|
5403
3995
|
|
|
3996
|
+
<div class="param-desc">
|
|
3997
|
+
- A promise that resolves to an object containing the practice notes if found, otherwise null.
|
|
3998
|
+
</div>
|
|
3999
|
+
|
|
5404
4000
|
|
|
5405
4001
|
|
|
5406
4002
|
<dl class="param-type">
|
|
@@ -5409,7 +4005,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5409
4005
|
</dt>
|
|
5410
4006
|
<dd>
|
|
5411
4007
|
|
|
5412
|
-
<span class="param-type">Promise.<(
|
|
4008
|
+
<span class="param-type">Promise.<(Object|null)></span>
|
|
5413
4009
|
|
|
5414
4010
|
|
|
5415
4011
|
|
|
@@ -5425,7 +4021,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5425
4021
|
|
|
5426
4022
|
|
|
5427
4023
|
|
|
5428
|
-
<h4 class="name" id=".
|
|
4024
|
+
<h4 class="name" id=".likeComment"><span class="type-signature type-signature-static">(static) </span>likeComment<span class="signature">(commentId)</span><span class="type-signature"> → {Promise.<(*|null)>}</span></h4>
|
|
5429
4025
|
|
|
5430
4026
|
|
|
5431
4027
|
|
|
@@ -5434,15 +4030,11 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5434
4030
|
|
|
5435
4031
|
<dl class="details">
|
|
5436
4032
|
|
|
5437
|
-
<dt class="tag-description">Description:</dt>
|
|
5438
|
-
<dd class="tag-description"><ul class="dummy"><li>Enroll the user in the given challenge on the challenge published_on date
|
|
5439
|
-
Clears any current progress data for this challenge</li></ul></dd>
|
|
5440
|
-
|
|
5441
4033
|
|
|
5442
4034
|
|
|
5443
4035
|
<dt class="tag-source">Source:</dt>
|
|
5444
4036
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
5445
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
4037
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line534">line 534</a>
|
|
5446
4038
|
</li></ul></dd>
|
|
5447
4039
|
|
|
5448
4040
|
|
|
@@ -5514,16 +4106,13 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5514
4106
|
|
|
5515
4107
|
<tr>
|
|
5516
4108
|
|
|
5517
|
-
<td class="name"><code>
|
|
4109
|
+
<td class="name"><code>commentId</code></td>
|
|
5518
4110
|
|
|
5519
4111
|
|
|
5520
4112
|
<td class="type">
|
|
5521
4113
|
|
|
5522
4114
|
|
|
5523
4115
|
<span class="param-type">int</span>
|
|
5524
|
-
|
|
|
5525
|
-
|
|
5526
|
-
<span class="param-type">string</span>
|
|
5527
4116
|
|
|
5528
4117
|
|
|
5529
4118
|
|
|
@@ -5534,7 +4123,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5534
4123
|
|
|
5535
4124
|
|
|
5536
4125
|
|
|
5537
|
-
<td class="description last"
|
|
4126
|
+
<td class="description last"></td>
|
|
5538
4127
|
</tr>
|
|
5539
4128
|
|
|
5540
4129
|
|
|
@@ -5567,7 +4156,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5567
4156
|
</dt>
|
|
5568
4157
|
<dd>
|
|
5569
4158
|
|
|
5570
|
-
<span class="param-type">Promise.<(
|
|
4159
|
+
<span class="param-type">Promise.<(*|null)></span>
|
|
5571
4160
|
|
|
5572
4161
|
|
|
5573
4162
|
|
|
@@ -5583,7 +4172,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5583
4172
|
|
|
5584
4173
|
|
|
5585
4174
|
|
|
5586
|
-
<h4 class="name" id=".
|
|
4175
|
+
<h4 class="name" id=".openComment"><span class="type-signature type-signature-static">(static) </span>openComment<span class="signature">(commentId)</span><span class="type-signature"> → {Promise.<(*|null)>}</span></h4>
|
|
5587
4176
|
|
|
5588
4177
|
|
|
5589
4178
|
|
|
@@ -5592,14 +4181,11 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5592
4181
|
|
|
5593
4182
|
<dl class="details">
|
|
5594
4183
|
|
|
5595
|
-
<dt class="tag-description">Description:</dt>
|
|
5596
|
-
<dd class="tag-description"><ul class="dummy"><li>Enable enrollment notifications for the provided challenge</li></ul></dd>
|
|
5597
|
-
|
|
5598
4184
|
|
|
5599
4185
|
|
|
5600
4186
|
<dt class="tag-source">Source:</dt>
|
|
5601
4187
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
5602
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
4188
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line564">line 564</a>
|
|
5603
4189
|
</li></ul></dd>
|
|
5604
4190
|
|
|
5605
4191
|
|
|
@@ -5671,16 +4257,13 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5671
4257
|
|
|
5672
4258
|
<tr>
|
|
5673
4259
|
|
|
5674
|
-
<td class="name"><code>
|
|
4260
|
+
<td class="name"><code>commentId</code></td>
|
|
5675
4261
|
|
|
5676
4262
|
|
|
5677
4263
|
<td class="type">
|
|
5678
4264
|
|
|
5679
4265
|
|
|
5680
4266
|
<span class="param-type">int</span>
|
|
5681
|
-
|
|
|
5682
|
-
|
|
5683
|
-
<span class="param-type">string</span>
|
|
5684
4267
|
|
|
5685
4268
|
|
|
5686
4269
|
|
|
@@ -5691,7 +4274,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5691
4274
|
|
|
5692
4275
|
|
|
5693
4276
|
|
|
5694
|
-
<td class="description last"
|
|
4277
|
+
<td class="description last"></td>
|
|
5695
4278
|
</tr>
|
|
5696
4279
|
|
|
5697
4280
|
|
|
@@ -5724,7 +4307,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5724
4307
|
</dt>
|
|
5725
4308
|
<dd>
|
|
5726
4309
|
|
|
5727
|
-
<span class="param-type">Promise.<(
|
|
4310
|
+
<span class="param-type">Promise.<(*|null)></span>
|
|
5728
4311
|
|
|
5729
4312
|
|
|
5730
4313
|
|
|
@@ -5740,7 +4323,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5740
4323
|
|
|
5741
4324
|
|
|
5742
4325
|
|
|
5743
|
-
<h4 class="name" id=".
|
|
4326
|
+
<h4 class="name" id=".postContentComplete"><span class="type-signature type-signature-static">(static) </span>postContentComplete<span class="signature">(contentId)</span><span class="type-signature"> → {Promise.<(any|string|null)>}</span></h4>
|
|
5744
4327
|
|
|
5745
4328
|
|
|
5746
4329
|
|
|
@@ -5750,13 +4333,13 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5750
4333
|
<dl class="details">
|
|
5751
4334
|
|
|
5752
4335
|
<dt class="tag-description">Description:</dt>
|
|
5753
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
4336
|
+
<dd class="tag-description"><ul class="dummy"><li>complete a content's progress for a given user</li></ul></dd>
|
|
5754
4337
|
|
|
5755
4338
|
|
|
5756
4339
|
|
|
5757
4340
|
<dt class="tag-source">Source:</dt>
|
|
5758
4341
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
5759
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
4342
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line386">line 386</a>
|
|
5760
4343
|
</li></ul></dd>
|
|
5761
4344
|
|
|
5762
4345
|
|
|
@@ -5833,22 +4416,13 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5833
4416
|
|
|
5834
4417
|
<td class="type">
|
|
5835
4418
|
|
|
5836
|
-
|
|
5837
|
-
<span class="param-type">int</span>
|
|
5838
|
-
|
|
|
5839
|
-
|
|
5840
|
-
<span class="param-type">string</span>
|
|
5841
|
-
|
|
5842
|
-
|
|
5843
|
-
|
|
5844
|
-
|
|
5845
4419
|
</td>
|
|
5846
4420
|
|
|
5847
4421
|
|
|
5848
4422
|
|
|
5849
4423
|
|
|
5850
4424
|
|
|
5851
|
-
<td class="description last"
|
|
4425
|
+
<td class="description last"></td>
|
|
5852
4426
|
</tr>
|
|
5853
4427
|
|
|
5854
4428
|
|
|
@@ -5881,7 +4455,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5881
4455
|
</dt>
|
|
5882
4456
|
<dd>
|
|
5883
4457
|
|
|
5884
|
-
<span class="param-type">Promise.<(any|null)></span>
|
|
4458
|
+
<span class="param-type">Promise.<(any|string|null)></span>
|
|
5885
4459
|
|
|
5886
4460
|
|
|
5887
4461
|
|
|
@@ -5897,7 +4471,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5897
4471
|
|
|
5898
4472
|
|
|
5899
4473
|
|
|
5900
|
-
<h4 class="name" id=".
|
|
4474
|
+
<h4 class="name" id=".postContentReset"><span class="type-signature type-signature-static">(static) </span>postContentReset<span class="signature">(contentId)</span><span class="type-signature"> → {Promise.<(any|string|null)>}</span></h4>
|
|
5901
4475
|
|
|
5902
4476
|
|
|
5903
4477
|
|
|
@@ -5907,14 +4481,13 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5907
4481
|
<dl class="details">
|
|
5908
4482
|
|
|
5909
4483
|
<dt class="tag-description">Description:</dt>
|
|
5910
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
5911
|
-
Clears any current progress data for this challenge</li></ul></dd>
|
|
4484
|
+
<dd class="tag-description"><ul class="dummy"><li>resets the user's progress on a content</li></ul></dd>
|
|
5912
4485
|
|
|
5913
4486
|
|
|
5914
4487
|
|
|
5915
4488
|
<dt class="tag-source">Source:</dt>
|
|
5916
4489
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
5917
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
4490
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line406">line 406</a>
|
|
5918
4491
|
</li></ul></dd>
|
|
5919
4492
|
|
|
5920
4493
|
|
|
@@ -5991,22 +4564,13 @@ Clears any current progress data for this challenge</li></ul></dd>
|
|
|
5991
4564
|
|
|
5992
4565
|
<td class="type">
|
|
5993
4566
|
|
|
5994
|
-
|
|
5995
|
-
<span class="param-type">int</span>
|
|
5996
|
-
|
|
|
5997
|
-
|
|
5998
|
-
<span class="param-type">string</span>
|
|
5999
|
-
|
|
6000
|
-
|
|
6001
|
-
|
|
6002
|
-
|
|
6003
4567
|
</td>
|
|
6004
4568
|
|
|
6005
4569
|
|
|
6006
4570
|
|
|
6007
4571
|
|
|
6008
4572
|
|
|
6009
|
-
<td class="description last"
|
|
4573
|
+
<td class="description last"></td>
|
|
6010
4574
|
</tr>
|
|
6011
4575
|
|
|
6012
4576
|
|
|
@@ -6039,7 +4603,7 @@ Clears any current progress data for this challenge</li></ul></dd>
|
|
|
6039
4603
|
</dt>
|
|
6040
4604
|
<dd>
|
|
6041
4605
|
|
|
6042
|
-
<span class="param-type">Promise.<(any|null)></span>
|
|
4606
|
+
<span class="param-type">Promise.<(any|string|null)></span>
|
|
6043
4607
|
|
|
6044
4608
|
|
|
6045
4609
|
|
|
@@ -6055,7 +4619,7 @@ Clears any current progress data for this challenge</li></ul></dd>
|
|
|
6055
4619
|
|
|
6056
4620
|
|
|
6057
4621
|
|
|
6058
|
-
<h4 class="name" id=".
|
|
4622
|
+
<h4 class="name" id=".postContentRestore"><span class="type-signature type-signature-static">(static) </span>postContentRestore<span class="signature">(contentId)</span><span class="type-signature"> → {Promise.<(any|string|null)>}</span></h4>
|
|
6059
4623
|
|
|
6060
4624
|
|
|
6061
4625
|
|
|
@@ -6065,14 +4629,13 @@ Clears any current progress data for this challenge</li></ul></dd>
|
|
|
6065
4629
|
<dl class="details">
|
|
6066
4630
|
|
|
6067
4631
|
<dt class="tag-description">Description:</dt>
|
|
6068
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
6069
|
-
Clears any existing progress data for this challenge</li></ul></dd>
|
|
4632
|
+
<dd class="tag-description"><ul class="dummy"><li>restores the user's progress on a content</li></ul></dd>
|
|
6070
4633
|
|
|
6071
4634
|
|
|
6072
4635
|
|
|
6073
4636
|
<dt class="tag-source">Source:</dt>
|
|
6074
4637
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
6075
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
4638
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line416">line 416</a>
|
|
6076
4639
|
</li></ul></dd>
|
|
6077
4640
|
|
|
6078
4641
|
|
|
@@ -6149,46 +4712,13 @@ Clears any existing progress data for this challenge</li></ul></dd>
|
|
|
6149
4712
|
|
|
6150
4713
|
<td class="type">
|
|
6151
4714
|
|
|
6152
|
-
|
|
6153
|
-
<span class="param-type">int</span>
|
|
6154
|
-
|
|
|
6155
|
-
|
|
6156
|
-
<span class="param-type">string</span>
|
|
6157
|
-
|
|
6158
|
-
|
|
6159
|
-
|
|
6160
|
-
|
|
6161
|
-
</td>
|
|
6162
|
-
|
|
6163
|
-
|
|
6164
|
-
|
|
6165
|
-
|
|
6166
|
-
|
|
6167
|
-
<td class="description last">railcontent id of the challenge</td>
|
|
6168
|
-
</tr>
|
|
6169
|
-
|
|
6170
|
-
|
|
6171
|
-
|
|
6172
|
-
<tr>
|
|
6173
|
-
|
|
6174
|
-
<td class="name"><code>startDate</code></td>
|
|
6175
|
-
|
|
6176
|
-
|
|
6177
|
-
<td class="type">
|
|
6178
|
-
|
|
6179
|
-
|
|
6180
|
-
<span class="param-type">string</span>
|
|
6181
|
-
|
|
6182
|
-
|
|
6183
|
-
|
|
6184
|
-
|
|
6185
4715
|
</td>
|
|
6186
4716
|
|
|
6187
4717
|
|
|
6188
4718
|
|
|
6189
4719
|
|
|
6190
4720
|
|
|
6191
|
-
<td class="description last"
|
|
4721
|
+
<td class="description last"></td>
|
|
6192
4722
|
</tr>
|
|
6193
4723
|
|
|
6194
4724
|
|
|
@@ -6221,7 +4751,7 @@ Clears any existing progress data for this challenge</li></ul></dd>
|
|
|
6221
4751
|
</dt>
|
|
6222
4752
|
<dd>
|
|
6223
4753
|
|
|
6224
|
-
<span class="param-type">Promise.<(any|null)></span>
|
|
4754
|
+
<span class="param-type">Promise.<(any|string|null)></span>
|
|
6225
4755
|
|
|
6226
4756
|
|
|
6227
4757
|
|
|
@@ -6237,7 +4767,7 @@ Clears any existing progress data for this challenge</li></ul></dd>
|
|
|
6237
4767
|
|
|
6238
4768
|
|
|
6239
4769
|
|
|
6240
|
-
<h4 class="name" id=".
|
|
4770
|
+
<h4 class="name" id=".postContentStart"><span class="type-signature type-signature-static">(static) </span>postContentStart<span class="signature">(contentId)</span><span class="type-signature"> → {Promise.<(any|string|null)>}</span></h4>
|
|
6241
4771
|
|
|
6242
4772
|
|
|
6243
4773
|
|
|
@@ -6247,13 +4777,13 @@ Clears any existing progress data for this challenge</li></ul></dd>
|
|
|
6247
4777
|
<dl class="details">
|
|
6248
4778
|
|
|
6249
4779
|
<dt class="tag-description">Description:</dt>
|
|
6250
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
4780
|
+
<dd class="tag-description"><ul class="dummy"><li>start the user's progress on a content</li></ul></dd>
|
|
6251
4781
|
|
|
6252
4782
|
|
|
6253
4783
|
|
|
6254
4784
|
<dt class="tag-source">Source:</dt>
|
|
6255
4785
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
6256
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
4786
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line396">line 396</a>
|
|
6257
4787
|
</li></ul></dd>
|
|
6258
4788
|
|
|
6259
4789
|
|
|
@@ -6330,22 +4860,13 @@ Clears any existing progress data for this challenge</li></ul></dd>
|
|
|
6330
4860
|
|
|
6331
4861
|
<td class="type">
|
|
6332
4862
|
|
|
6333
|
-
|
|
6334
|
-
<span class="param-type">int</span>
|
|
6335
|
-
|
|
|
6336
|
-
|
|
6337
|
-
<span class="param-type">string</span>
|
|
6338
|
-
|
|
6339
|
-
|
|
6340
|
-
|
|
6341
|
-
|
|
6342
4863
|
</td>
|
|
6343
4864
|
|
|
6344
4865
|
|
|
6345
4866
|
|
|
6346
4867
|
|
|
6347
4868
|
|
|
6348
|
-
<td class="description last"
|
|
4869
|
+
<td class="description last"></td>
|
|
6349
4870
|
</tr>
|
|
6350
4871
|
|
|
6351
4872
|
|
|
@@ -6378,7 +4899,7 @@ Clears any existing progress data for this challenge</li></ul></dd>
|
|
|
6378
4899
|
</dt>
|
|
6379
4900
|
<dd>
|
|
6380
4901
|
|
|
6381
|
-
<span class="param-type">Promise.<(any|null)></span>
|
|
4902
|
+
<span class="param-type">Promise.<(any|string|null)></span>
|
|
6382
4903
|
|
|
6383
4904
|
|
|
6384
4905
|
|
|
@@ -6394,7 +4915,7 @@ Clears any existing progress data for this challenge</li></ul></dd>
|
|
|
6394
4915
|
|
|
6395
4916
|
|
|
6396
4917
|
|
|
6397
|
-
<h4 class="name" id=".
|
|
4918
|
+
<h4 class="name" id=".replyToComment"><span class="type-signature type-signature-static">(static) </span>replyToComment<span class="signature">(commentId, comment)</span><span class="type-signature"> → {Promise.<(*|null)>}</span></h4>
|
|
6398
4919
|
|
|
6399
4920
|
|
|
6400
4921
|
|
|
@@ -6403,15 +4924,11 @@ Clears any existing progress data for this challenge</li></ul></dd>
|
|
|
6403
4924
|
|
|
6404
4925
|
<dl class="details">
|
|
6405
4926
|
|
|
6406
|
-
<dt class="tag-description">Description:</dt>
|
|
6407
|
-
<dd class="tag-description"><ul class="dummy"><li>Enroll the user in the provided challenge and set to unlocked
|
|
6408
|
-
Clears any current progress data for this challenge</li></ul></dd>
|
|
6409
|
-
|
|
6410
4927
|
|
|
6411
4928
|
|
|
6412
4929
|
<dt class="tag-source">Source:</dt>
|
|
6413
4930
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
6414
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
4931
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line492">line 492</a>
|
|
6415
4932
|
</li></ul></dd>
|
|
6416
4933
|
|
|
6417
4934
|
|
|
@@ -6483,15 +5000,36 @@ Clears any current progress data for this challenge</li></ul></dd>
|
|
|
6483
5000
|
|
|
6484
5001
|
<tr>
|
|
6485
5002
|
|
|
6486
|
-
<td class="name"><code>
|
|
5003
|
+
<td class="name"><code>commentId</code></td>
|
|
6487
5004
|
|
|
6488
5005
|
|
|
6489
5006
|
<td class="type">
|
|
6490
5007
|
|
|
6491
5008
|
|
|
6492
5009
|
<span class="param-type">int</span>
|
|
6493
|
-
|
|
|
6494
5010
|
|
|
5011
|
+
|
|
5012
|
+
|
|
5013
|
+
|
|
5014
|
+
</td>
|
|
5015
|
+
|
|
5016
|
+
|
|
5017
|
+
|
|
5018
|
+
|
|
5019
|
+
|
|
5020
|
+
<td class="description last"></td>
|
|
5021
|
+
</tr>
|
|
5022
|
+
|
|
5023
|
+
|
|
5024
|
+
|
|
5025
|
+
<tr>
|
|
5026
|
+
|
|
5027
|
+
<td class="name"><code>comment</code></td>
|
|
5028
|
+
|
|
5029
|
+
|
|
5030
|
+
<td class="type">
|
|
5031
|
+
|
|
5032
|
+
|
|
6495
5033
|
<span class="param-type">string</span>
|
|
6496
5034
|
|
|
6497
5035
|
|
|
@@ -6503,7 +5041,7 @@ Clears any current progress data for this challenge</li></ul></dd>
|
|
|
6503
5041
|
|
|
6504
5042
|
|
|
6505
5043
|
|
|
6506
|
-
<td class="description last"
|
|
5044
|
+
<td class="description last"></td>
|
|
6507
5045
|
</tr>
|
|
6508
5046
|
|
|
6509
5047
|
|
|
@@ -6536,7 +5074,7 @@ Clears any current progress data for this challenge</li></ul></dd>
|
|
|
6536
5074
|
</dt>
|
|
6537
5075
|
<dd>
|
|
6538
5076
|
|
|
6539
|
-
<span class="param-type">Promise.<(
|
|
5077
|
+
<span class="param-type">Promise.<(*|null)></span>
|
|
6540
5078
|
|
|
6541
5079
|
|
|
6542
5080
|
|
|
@@ -6552,7 +5090,7 @@ Clears any current progress data for this challenge</li></ul></dd>
|
|
|
6552
5090
|
|
|
6553
5091
|
|
|
6554
5092
|
|
|
6555
|
-
<h4 class="name" id=".
|
|
5093
|
+
<h4 class="name" id=".reportComment"><span class="type-signature type-signature-static">(static) </span>reportComment<span class="signature">(commentId, issue)</span><span class="type-signature"> → {Promise.<(*|null)>}</span></h4>
|
|
6556
5094
|
|
|
6557
5095
|
|
|
6558
5096
|
|
|
@@ -6565,7 +5103,7 @@ Clears any current progress data for this challenge</li></ul></dd>
|
|
|
6565
5103
|
|
|
6566
5104
|
<dt class="tag-source">Source:</dt>
|
|
6567
5105
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
6568
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
5106
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line590">line 590</a>
|
|
6569
5107
|
</li></ul></dd>
|
|
6570
5108
|
|
|
6571
5109
|
|
|
@@ -6661,7 +5199,7 @@ Clears any current progress data for this challenge</li></ul></dd>
|
|
|
6661
5199
|
|
|
6662
5200
|
<tr>
|
|
6663
5201
|
|
|
6664
|
-
<td class="name"><code>
|
|
5202
|
+
<td class="name"><code>issue</code></td>
|
|
6665
5203
|
|
|
6666
5204
|
|
|
6667
5205
|
<td class="type">
|
|
@@ -6727,7 +5265,7 @@ Clears any current progress data for this challenge</li></ul></dd>
|
|
|
6727
5265
|
|
|
6728
5266
|
|
|
6729
5267
|
|
|
6730
|
-
<h4 class="name" id=".
|
|
5268
|
+
<h4 class="name" id=".restoreComment"><span class="type-signature type-signature-static">(static) </span>restoreComment<span class="signature">(commentId)</span><span class="type-signature"> → {Promise.<(*|null)>}</span></h4>
|
|
6731
5269
|
|
|
6732
5270
|
|
|
6733
5271
|
|
|
@@ -6740,7 +5278,7 @@ Clears any current progress data for this challenge</li></ul></dd>
|
|
|
6740
5278
|
|
|
6741
5279
|
<dt class="tag-source">Source:</dt>
|
|
6742
5280
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
6743
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
5281
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line482">line 482</a>
|
|
6744
5282
|
</li></ul></dd>
|
|
6745
5283
|
|
|
6746
5284
|
|
|
@@ -6829,30 +5367,6 @@ Clears any current progress data for this challenge</li></ul></dd>
|
|
|
6829
5367
|
|
|
6830
5368
|
|
|
6831
5369
|
|
|
6832
|
-
<td class="description last"></td>
|
|
6833
|
-
</tr>
|
|
6834
|
-
|
|
6835
|
-
|
|
6836
|
-
|
|
6837
|
-
<tr>
|
|
6838
|
-
|
|
6839
|
-
<td class="name"><code>issue</code></td>
|
|
6840
|
-
|
|
6841
|
-
|
|
6842
|
-
<td class="type">
|
|
6843
|
-
|
|
6844
|
-
|
|
6845
|
-
<span class="param-type">string</span>
|
|
6846
|
-
|
|
6847
|
-
|
|
6848
|
-
|
|
6849
|
-
|
|
6850
|
-
</td>
|
|
6851
|
-
|
|
6852
|
-
|
|
6853
|
-
|
|
6854
|
-
|
|
6855
|
-
|
|
6856
5370
|
<td class="description last"></td>
|
|
6857
5371
|
</tr>
|
|
6858
5372
|
|
|
@@ -6918,7 +5432,7 @@ Clears any current progress data for this challenge</li></ul></dd>
|
|
|
6918
5432
|
|
|
6919
5433
|
<dt class="tag-source">Source:</dt>
|
|
6920
5434
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
6921
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
5435
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line428">line 428</a>
|
|
6922
5436
|
</li></ul></dd>
|
|
6923
5437
|
|
|
6924
5438
|
|
|
@@ -7096,7 +5610,7 @@ Clears any current progress data for this challenge</li></ul></dd>
|
|
|
7096
5610
|
|
|
7097
5611
|
<dt class="tag-source">Source:</dt>
|
|
7098
5612
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
7099
|
-
<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#line525">line 525</a>
|
|
7100
5614
|
</li></ul></dd>
|
|
7101
5615
|
|
|
7102
5616
|
|
|
@@ -7247,7 +5761,7 @@ Clears any current progress data for this challenge</li></ul></dd>
|
|
|
7247
5761
|
|
|
7248
5762
|
<dt class="tag-source">Source:</dt>
|
|
7249
5763
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
7250
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
5764
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line543">line 543</a>
|
|
7251
5765
|
</li></ul></dd>
|
|
7252
5766
|
|
|
7253
5767
|
|
|
@@ -7401,7 +5915,7 @@ Clears any current progress data for this challenge</li></ul></dd>
|
|
|
7401
5915
|
|
|
7402
5916
|
<dt class="tag-source">Source:</dt>
|
|
7403
5917
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
7404
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
5918
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line681">line 681</a>
|
|
7405
5919
|
</li></ul></dd>
|
|
7406
5920
|
|
|
7407
5921
|
|
|
@@ -7569,7 +6083,7 @@ Clears any current progress data for this challenge</li></ul></dd>
|
|
|
7569
6083
|
|
|
7570
6084
|
<dt class="tag-source">Source:</dt>
|
|
7571
6085
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
7572
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
6086
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line707">line 707</a>
|
|
7573
6087
|
</li></ul></dd>
|
|
7574
6088
|
|
|
7575
6089
|
|
|
@@ -7765,7 +6279,7 @@ Clears any current progress data for this challenge</li></ul></dd>
|
|
|
7765
6279
|
|
|
7766
6280
|
<dt class="tag-source">Source:</dt>
|
|
7767
6281
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
7768
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
6282
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line715">line 715</a>
|
|
7769
6283
|
</li></ul></dd>
|
|
7770
6284
|
|
|
7771
6285
|
|
|
@@ -7941,7 +6455,7 @@ Clears any current progress data for this challenge</li></ul></dd>
|
|
|
7941
6455
|
<br class="clear">
|
|
7942
6456
|
|
|
7943
6457
|
<footer>
|
|
7944
|
-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on
|
|
6458
|
+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Tue Nov 04 2025 18:21:55 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
|
|
7945
6459
|
</footer>
|
|
7946
6460
|
|
|
7947
6461
|
<script>prettyPrint();</script>
|