musora-content-services 2.5.1 → 2.6.1
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/.coderabbit.yaml +0 -0
- package/.editorconfig +0 -0
- package/.github/pull_request_template.md +0 -0
- package/.github/workflows/node.js.yml +0 -0
- package/.prettierignore +0 -0
- package/.prettierrc +0 -0
- package/CHANGELOG.md +14 -0
- package/README.md +0 -0
- package/babel.config.cjs +0 -0
- package/docs/Content-Organization.html +0 -0
- package/docs/ContentOrganization.html +2 -2
- package/docs/Gamification.html +2 -2
- package/docs/UserManagement.html +0 -0
- package/docs/UserManagementSystem.html +2 -2
- package/docs/api_types.js.html +2 -2
- package/docs/config.js.html +2 -2
- package/docs/content-org_content-org.js.html +2 -2
- package/docs/content-org_playlists-types.js.html +2 -2
- package/docs/content-org_playlists.js.html +2 -2
- package/docs/content.js.html +2 -4
- package/docs/fonts/Montserrat/Montserrat-Bold.eot +0 -0
- package/docs/fonts/Montserrat/Montserrat-Bold.ttf +0 -0
- package/docs/fonts/Montserrat/Montserrat-Bold.woff +0 -0
- package/docs/fonts/Montserrat/Montserrat-Bold.woff2 +0 -0
- package/docs/fonts/Montserrat/Montserrat-Regular.eot +0 -0
- package/docs/fonts/Montserrat/Montserrat-Regular.ttf +0 -0
- package/docs/fonts/Montserrat/Montserrat-Regular.woff +0 -0
- package/docs/fonts/Montserrat/Montserrat-Regular.woff2 +0 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.eot +0 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.svg +0 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.ttf +0 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff +0 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff2 +0 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.eot +0 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.svg +0 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.ttf +0 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff +0 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff2 +0 -0
- package/docs/gamification_awards.js.html +2 -2
- package/docs/gamification_gamification.js.html +2 -2
- package/docs/gamification_types.js.html +2 -2
- package/docs/global.html +448 -2
- package/docs/global.html#User +0 -0
- package/docs/index.html +2 -2
- package/docs/module-Awards.html +2 -2
- package/docs/module-Config.html +2 -2
- package/docs/module-Content-Services-V2.html +8 -8
- package/docs/module-Interests.html +2 -2
- package/docs/module-Permissions.html +2 -2
- package/docs/module-Playlists.html +2 -2
- package/docs/module-Railcontent-Services.html +754 -44
- package/docs/module-Sanity-Services.html +2 -2
- package/docs/module-Session-Management.html +0 -0
- package/docs/module-Sessions.html +2 -2
- package/docs/module-User-Activity.html +521 -12
- package/docs/module-User-Management.html +0 -0
- package/docs/module-User-Permissions.html +0 -0
- package/docs/module-UserManagement.html +2 -2
- package/docs/module-UserProfile.html +266 -0
- package/docs/railcontent.js.html +41 -2
- package/docs/sanity.js.html +2 -2
- package/docs/scripts/collapse.js +0 -0
- package/docs/scripts/commonNav.js +0 -0
- package/docs/scripts/linenumber.js +0 -0
- package/docs/scripts/nav.js +0 -0
- package/docs/scripts/polyfill.js +0 -0
- package/docs/scripts/prettify/Apache-License-2.0.txt +0 -0
- package/docs/scripts/prettify/lang-css.js +0 -0
- package/docs/scripts/prettify/prettify.js +0 -0
- package/docs/scripts/search.js +0 -0
- package/docs/styles/jsdoc.css +0 -0
- package/docs/styles/prettify.css +0 -0
- package/docs/types.js.html +0 -0
- package/docs/userActivity.js.html +350 -263
- package/docs/user_interests.js.html +2 -2
- package/docs/user_management.js.html +2 -2
- package/docs/user_permissions.js.html +2 -2
- package/docs/user_profile.js.html +105 -0
- package/docs/user_sessions.js.html +2 -2
- package/docs/user_types.js.html +22 -2
- package/docs/user_user-management-system.js.html +2 -2
- package/docs/user_user-management.js.html +0 -0
- package/jest.config.js +0 -0
- package/jsdoc.json +0 -0
- package/package.json +1 -1
- package/src/contentMetaData.js +14 -0
- package/src/filterBuilder.js +0 -0
- package/src/index.d.ts +15 -0
- package/src/index.js +15 -0
- package/src/infrastructure/http/HttpClient.ts +0 -0
- package/src/infrastructure/http/executors/FetchRequestExecutor.ts +0 -0
- package/src/infrastructure/http/index.ts +0 -0
- package/src/infrastructure/http/interfaces/HeaderProvider.ts +0 -0
- package/src/infrastructure/http/interfaces/HttpError.ts +0 -0
- package/src/infrastructure/http/interfaces/NetworkError.ts +0 -0
- package/src/infrastructure/http/interfaces/RequestExecutor.ts +0 -0
- package/src/infrastructure/http/interfaces/RequestOptions.ts +0 -0
- package/src/infrastructure/http/providers/DefaultHeaderProvider.ts +0 -0
- package/src/lib/httpHelper.js +0 -0
- package/src/lib/lastUpdated.js +0 -0
- package/src/services/api/types.js +0 -0
- package/src/services/config.js +0 -0
- package/src/services/content-org/content-org.js +0 -0
- package/src/services/content-org/playlists-types.js +0 -0
- package/src/services/content-org/playlists.js +0 -0
- package/src/services/content.js +0 -2
- package/src/services/contentAggregator.js +0 -0
- package/src/services/contentLikes.js +0 -0
- package/src/services/dataContext.js +0 -0
- package/src/services/dateUtils.js +0 -0
- package/src/services/forum.js +0 -0
- package/src/services/gamification/awards.js +0 -0
- package/src/services/gamification/gamification.js +0 -0
- package/src/services/gamification/types.js +0 -0
- package/src/services/imageSRCBuilder.js +0 -0
- package/src/services/imageSRCVerify.js +0 -0
- package/src/services/railcontent.js +39 -0
- package/src/services/recommendations.js +0 -0
- package/src/services/types.js +0 -0
- package/src/services/user/interests.js +0 -0
- package/src/services/user/management.js +0 -0
- package/src/services/user/permissions.js +0 -0
- package/src/services/user/profile.js +33 -0
- package/src/services/user/sessions.js +0 -0
- package/src/services/user/types.js +20 -0
- package/src/services/user/user-management-system.js +0 -0
- package/src/services/userActivity.js +348 -261
- package/test/HttpClient.test.js +0 -0
- package/test/content.test.js +8 -6
- package/test/contentLikes.test.js +0 -0
- package/test/contentProgress.test.js +0 -0
- package/test/dataContext.test.js +0 -0
- package/test/forum.test.js +0 -0
- package/test/imageSRCBuilder.test.js +0 -0
- package/test/imageSRCVerify.test.js +0 -0
- package/test/initializeTests.js +0 -0
- package/test/lib/lastUpdated.test.js +0 -0
- package/test/live/contentProgressLive.test.js +0 -0
- package/test/live/railcontentLive.test.js +0 -0
- package/test/localStorageMock.js +0 -0
- package/test/log.js +0 -0
- package/test/mockData/mockData_fetchByRailContentIds_one_content.json +0 -0
- package/test/mockData/mockData_user_practices.json +0 -0
- package/test/sanityQueryService.test.js +6 -0
- package/test/streakMessage.test.js +0 -0
- package/test/user/permissions.test.js +0 -0
- package/test/userActivity.test.js +0 -0
- package/tools/generate-index.cjs +0 -0
- package/.yarnrc.yml +0 -1
- package/docs/module-Content-Services.html +0 -763
|
@@ -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#.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#.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#.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-User-Activity.html">User-Activity</a><ul class='methods'><li data-type='method'><a href="module-User-Activity.html#.calculateLongestStreaks">calculateLongestStreaks</a></li><li data-type='method'><a href="module-User-Activity.html#.createPracticeNotes">createPracticeNotes</a></li><li data-type='method'><a href="module-User-Activity.html#.deletePracticeSession">deletePracticeSession</a></li><li data-type='method'><a href="module-User-Activity.html#.getPracticeNotes">getPracticeNotes</a></li><li data-type='method'><a href="module-User-Activity.html#.getPracticeSessions">getPracticeSessions</a></li><li data-type='method'><a href="module-User-Activity.html#.getRecentActivity">getRecentActivity</a></li><li data-type='method'><a href="module-User-Activity.html#.getUserMonthlyStats">getUserMonthlyStats</a></li><li data-type='method'><a href="module-User-Activity.html#.getUserWeeklyStats">getUserWeeklyStats</a></li><li data-type='method'><a href="module-User-Activity.html#.recordUserPractice">recordUserPractice</a></li><li data-type='method'><a href="module-User-Activity.html#.removeUserPractice">removeUserPractice</a></li><li data-type='method'><a href="module-User-Activity.html#.restorePracticeSession">restorePracticeSession</a></li><li data-type='method'><a href="module-User-Activity.html#.restoreUserPractice">restoreUserPractice</a></li><li data-type='method'><a href="module-User-Activity.html#.updatePracticeNotes">updatePracticeNotes</a></li><li data-type='method'><a href="module-User-Activity.html#.updateUserPractice">updateUserPractice</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#.unblockUser">unblockUser</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-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#.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#.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-User-Activity.html">User-Activity</a><ul class='methods'><li data-type='method'><a href="module-User-Activity.html#.calculateLongestStreaks">calculateLongestStreaks</a></li><li data-type='method'><a href="module-User-Activity.html#.createPracticeNotes">createPracticeNotes</a></li><li data-type='method'><a href="module-User-Activity.html#.deletePracticeSession">deletePracticeSession</a></li><li data-type='method'><a href="module-User-Activity.html#.deleteUserActivity">deleteUserActivity</a></li><li data-type='method'><a href="module-User-Activity.html#.getPracticeNotes">getPracticeNotes</a></li><li data-type='method'><a href="module-User-Activity.html#.getPracticeSessions">getPracticeSessions</a></li><li data-type='method'><a href="module-User-Activity.html#.getRecentActivity">getRecentActivity</a></li><li data-type='method'><a href="module-User-Activity.html#.getUserMonthlyStats">getUserMonthlyStats</a></li><li data-type='method'><a href="module-User-Activity.html#.getUserWeeklyStats">getUserWeeklyStats</a></li><li data-type='method'><a href="module-User-Activity.html#.recordUserActivity">recordUserActivity</a></li><li data-type='method'><a href="module-User-Activity.html#.recordUserPractice">recordUserPractice</a></li><li data-type='method'><a href="module-User-Activity.html#.removeUserPractice">removeUserPractice</a></li><li data-type='method'><a href="module-User-Activity.html#.restorePracticeSession">restorePracticeSession</a></li><li data-type='method'><a href="module-User-Activity.html#.restoreUserPractice">restoreUserPractice</a></li><li data-type='method'><a href="module-User-Activity.html#.updatePracticeNotes">updatePracticeNotes</a></li><li data-type='method'><a href="module-User-Activity.html#.updateUserPractice">updateUserPractice</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#.unblockUser">unblockUser</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>
|
|
33
33
|
|
|
34
34
|
</nav>
|
|
35
35
|
|
|
@@ -3683,7 +3683,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
3683
3683
|
|
|
3684
3684
|
|
|
3685
3685
|
|
|
3686
|
-
<h4 class="name" id=".
|
|
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
3687
|
|
|
3688
3688
|
|
|
3689
3689
|
|
|
@@ -3693,13 +3693,13 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
3693
3693
|
<dl class="details">
|
|
3694
3694
|
|
|
3695
3695
|
<dt class="tag-description">Description:</dt>
|
|
3696
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetches a list of
|
|
3696
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetches a paginated list of recent user activities.</li></ul></dd>
|
|
3697
3697
|
|
|
3698
3698
|
|
|
3699
3699
|
|
|
3700
3700
|
<dt class="tag-source">Source:</dt>
|
|
3701
3701
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
3702
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
3702
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line879">line 879</a>
|
|
3703
3703
|
</li></ul></dd>
|
|
3704
3704
|
|
|
3705
3705
|
|
|
@@ -3746,8 +3746,8 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
3746
3746
|
|
|
3747
3747
|
<h5 class="h5-examples">Example</h5>
|
|
3748
3748
|
|
|
3749
|
-
<pre class="prettyprint"><code>
|
|
3750
|
-
.then(
|
|
3749
|
+
<pre class="prettyprint"><code>fetchRecentUserActivities({ page: 2, limit: 5 })
|
|
3750
|
+
.then(activities => console.log(activities))
|
|
3751
3751
|
.catch(error => console.error(error));</code></pre>
|
|
3752
3752
|
|
|
3753
3753
|
|
|
@@ -3766,8 +3766,12 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
3766
3766
|
<th>Type</th>
|
|
3767
3767
|
|
|
3768
3768
|
|
|
3769
|
+
<th>Attributes</th>
|
|
3770
|
+
|
|
3769
3771
|
|
|
3770
3772
|
|
|
3773
|
+
<th>Default</th>
|
|
3774
|
+
|
|
3771
3775
|
|
|
3772
3776
|
<th class="last">Description</th>
|
|
3773
3777
|
</tr>
|
|
@@ -3778,13 +3782,159 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
3778
3782
|
|
|
3779
3783
|
<tr>
|
|
3780
3784
|
|
|
3781
|
-
<td class="name"><code>
|
|
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>
|
|
3782
3929
|
|
|
3783
3930
|
|
|
3784
3931
|
<td class="type">
|
|
3785
3932
|
|
|
3786
3933
|
|
|
3787
3934
|
<span class="param-type">string</span>
|
|
3935
|
+
|
|
|
3936
|
+
|
|
3937
|
+
<span class="param-type">null</span>
|
|
3788
3938
|
|
|
3789
3939
|
|
|
3790
3940
|
|
|
@@ -3792,10 +3942,33 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
3792
3942
|
</td>
|
|
3793
3943
|
|
|
3794
3944
|
|
|
3945
|
+
<td class="attributes">
|
|
3946
|
+
|
|
3947
|
+
<optional><br>
|
|
3948
|
+
|
|
3949
|
+
|
|
3950
|
+
|
|
3795
3951
|
|
|
3952
|
+
|
|
3953
|
+
</td>
|
|
3796
3954
|
|
|
3797
3955
|
|
|
3798
|
-
|
|
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>
|
|
3799
3972
|
</tr>
|
|
3800
3973
|
|
|
3801
3974
|
|
|
@@ -3821,7 +3994,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
3821
3994
|
|
|
3822
3995
|
|
|
3823
3996
|
<div class="param-desc">
|
|
3824
|
-
-
|
|
3997
|
+
- A promise that resolves to a paginated object of user activities.
|
|
3825
3998
|
</div>
|
|
3826
3999
|
|
|
3827
4000
|
|
|
@@ -3832,7 +4005,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
3832
4005
|
</dt>
|
|
3833
4006
|
<dd>
|
|
3834
4007
|
|
|
3835
|
-
<span class="param-type">Promise.<
|
|
4008
|
+
<span class="param-type">Promise.<PaginatedActivities></span>
|
|
3836
4009
|
|
|
3837
4010
|
|
|
3838
4011
|
|
|
@@ -3848,7 +4021,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
3848
4021
|
|
|
3849
4022
|
|
|
3850
4023
|
|
|
3851
|
-
<h4 class="name" id=".
|
|
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>
|
|
3852
4025
|
|
|
3853
4026
|
|
|
3854
4027
|
|
|
@@ -3858,13 +4031,13 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
3858
4031
|
<dl class="details">
|
|
3859
4032
|
|
|
3860
4033
|
<dt class="tag-description">Description:</dt>
|
|
3861
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
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>
|
|
3862
4035
|
|
|
3863
4036
|
|
|
3864
4037
|
|
|
3865
4038
|
<dt class="tag-source">Source:</dt>
|
|
3866
4039
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
3867
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
4040
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line103">line 103</a>
|
|
3868
4041
|
</li></ul></dd>
|
|
3869
4042
|
|
|
3870
4043
|
|
|
@@ -3909,6 +4082,13 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
3909
4082
|
|
|
3910
4083
|
|
|
3911
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
|
+
|
|
3912
4092
|
|
|
3913
4093
|
|
|
3914
4094
|
<h5 class="h5-parameters">Parameters:</h5>
|
|
@@ -3936,13 +4116,13 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
3936
4116
|
|
|
3937
4117
|
<tr>
|
|
3938
4118
|
|
|
3939
|
-
<td class="name"><code>
|
|
4119
|
+
<td class="name"><code>brand</code></td>
|
|
3940
4120
|
|
|
3941
4121
|
|
|
3942
4122
|
<td class="type">
|
|
3943
4123
|
|
|
3944
4124
|
|
|
3945
|
-
<span class="param-type">
|
|
4125
|
+
<span class="param-type">string</span>
|
|
3946
4126
|
|
|
3947
4127
|
|
|
3948
4128
|
|
|
@@ -3953,7 +4133,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
3953
4133
|
|
|
3954
4134
|
|
|
3955
4135
|
|
|
3956
|
-
<td class="description last">The
|
|
4136
|
+
<td class="description last">The brand associated with the songs.</td>
|
|
3957
4137
|
</tr>
|
|
3958
4138
|
|
|
3959
4139
|
|
|
@@ -3979,7 +4159,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
3979
4159
|
|
|
3980
4160
|
|
|
3981
4161
|
<div class="param-desc">
|
|
3982
|
-
-
|
|
4162
|
+
- Returns an object containing in-progress songs if found, otherwise null.
|
|
3983
4163
|
</div>
|
|
3984
4164
|
|
|
3985
4165
|
|
|
@@ -4006,7 +4186,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4006
4186
|
|
|
4007
4187
|
|
|
4008
4188
|
|
|
4009
|
-
<h4 class="name" id=".
|
|
4189
|
+
<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>
|
|
4010
4190
|
|
|
4011
4191
|
|
|
4012
4192
|
|
|
@@ -4016,13 +4196,13 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4016
4196
|
<dl class="details">
|
|
4017
4197
|
|
|
4018
4198
|
<dt class="tag-description">Description:</dt>
|
|
4019
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetch the
|
|
4199
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch the top comment for a given content</li></ul></dd>
|
|
4020
4200
|
|
|
4021
4201
|
|
|
4022
4202
|
|
|
4023
4203
|
<dt class="tag-source">Source:</dt>
|
|
4024
4204
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
4025
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
4205
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line600">line 600</a>
|
|
4026
4206
|
</li></ul></dd>
|
|
4027
4207
|
|
|
4028
4208
|
|
|
@@ -4094,18 +4274,24 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4094
4274
|
|
|
4095
4275
|
<tr>
|
|
4096
4276
|
|
|
4097
|
-
<td class="name"><code>
|
|
4277
|
+
<td class="name"><code>railcontentId</code></td>
|
|
4098
4278
|
|
|
4099
4279
|
|
|
4100
4280
|
<td class="type">
|
|
4101
4281
|
|
|
4282
|
+
|
|
4283
|
+
<span class="param-type">int</span>
|
|
4284
|
+
|
|
4285
|
+
|
|
4286
|
+
|
|
4287
|
+
|
|
4102
4288
|
</td>
|
|
4103
4289
|
|
|
4104
4290
|
|
|
4105
4291
|
|
|
4106
4292
|
|
|
4107
4293
|
|
|
4108
|
-
<td class="description last">railcontent id
|
|
4294
|
+
<td class="description last">The railcontent id to fetch.</td>
|
|
4109
4295
|
</tr>
|
|
4110
4296
|
|
|
4111
4297
|
|
|
@@ -4131,7 +4317,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4131
4317
|
|
|
4132
4318
|
|
|
4133
4319
|
<div class="param-desc">
|
|
4134
|
-
-
|
|
4320
|
+
- A promise that resolves to an comment object
|
|
4135
4321
|
</div>
|
|
4136
4322
|
|
|
4137
4323
|
|
|
@@ -4142,7 +4328,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4142
4328
|
</dt>
|
|
4143
4329
|
<dd>
|
|
4144
4330
|
|
|
4145
|
-
<span class="param-type">Promise.<(
|
|
4331
|
+
<span class="param-type">Promise.<(Object|null)></span>
|
|
4146
4332
|
|
|
4147
4333
|
|
|
4148
4334
|
|
|
@@ -4158,7 +4344,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4158
4344
|
|
|
4159
4345
|
|
|
4160
4346
|
|
|
4161
|
-
<h4 class="name" id=".
|
|
4347
|
+
<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>
|
|
4162
4348
|
|
|
4163
4349
|
|
|
4164
4350
|
|
|
@@ -4168,13 +4354,13 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4168
4354
|
<dl class="details">
|
|
4169
4355
|
|
|
4170
4356
|
<dt class="tag-description">Description:</dt>
|
|
4171
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetch
|
|
4357
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch the user's best award for this challenge</li></ul></dd>
|
|
4172
4358
|
|
|
4173
4359
|
|
|
4174
4360
|
|
|
4175
4361
|
<dt class="tag-source">Source:</dt>
|
|
4176
4362
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
4177
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
4363
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line412">line 412</a>
|
|
4178
4364
|
</li></ul></dd>
|
|
4179
4365
|
|
|
4180
4366
|
|
|
@@ -4246,27 +4432,18 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4246
4432
|
|
|
4247
4433
|
<tr>
|
|
4248
4434
|
|
|
4249
|
-
<td class="name"><code>
|
|
4435
|
+
<td class="name"><code>contentId</code></td>
|
|
4250
4436
|
|
|
4251
4437
|
|
|
4252
4438
|
<td class="type">
|
|
4253
4439
|
|
|
4254
|
-
|
|
4255
|
-
<span class="param-type">string</span>
|
|
4256
|
-
|
|
|
4257
|
-
|
|
4258
|
-
<span class="param-type">null</span>
|
|
4259
|
-
|
|
4260
|
-
|
|
4261
|
-
|
|
4262
|
-
|
|
4263
4440
|
</td>
|
|
4264
4441
|
|
|
4265
4442
|
|
|
4266
4443
|
|
|
4267
4444
|
|
|
4268
4445
|
|
|
4269
|
-
<td class="description last"
|
|
4446
|
+
<td class="description last">railcontent id of the challenge</td>
|
|
4270
4447
|
</tr>
|
|
4271
4448
|
|
|
4272
4449
|
|
|
@@ -4291,6 +4468,10 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4291
4468
|
<h5 class="h5-returns">Returns:</h5>
|
|
4292
4469
|
|
|
4293
4470
|
|
|
4471
|
+
<div class="param-desc">
|
|
4472
|
+
- streamed PDF
|
|
4473
|
+
</div>
|
|
4474
|
+
|
|
4294
4475
|
|
|
4295
4476
|
|
|
4296
4477
|
<dl class="param-type">
|
|
@@ -4315,7 +4496,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4315
4496
|
|
|
4316
4497
|
|
|
4317
4498
|
|
|
4318
|
-
<h4 class="name" id=".
|
|
4499
|
+
<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>
|
|
4319
4500
|
|
|
4320
4501
|
|
|
4321
4502
|
|
|
@@ -4325,13 +4506,13 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4325
4506
|
<dl class="details">
|
|
4326
4507
|
|
|
4327
4508
|
<dt class="tag-description">Description:</dt>
|
|
4328
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetch
|
|
4509
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch all completed badges for the user ordered by completion date descending</li></ul></dd>
|
|
4329
4510
|
|
|
4330
4511
|
|
|
4331
4512
|
|
|
4332
4513
|
<dt class="tag-source">Source:</dt>
|
|
4333
4514
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
4334
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
4515
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line472">line 472</a>
|
|
4335
4516
|
</li></ul></dd>
|
|
4336
4517
|
|
|
4337
4518
|
|
|
@@ -4403,18 +4584,175 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4403
4584
|
|
|
4404
4585
|
<tr>
|
|
4405
4586
|
|
|
4406
|
-
<td class="name"><code>
|
|
4587
|
+
<td class="name"><code>brand</code></td>
|
|
4407
4588
|
|
|
4408
4589
|
|
|
4409
4590
|
<td class="type">
|
|
4410
4591
|
|
|
4592
|
+
|
|
4593
|
+
<span class="param-type">string</span>
|
|
4594
|
+
|
|
|
4595
|
+
|
|
4596
|
+
<span class="param-type">null</span>
|
|
4597
|
+
|
|
4598
|
+
|
|
4599
|
+
|
|
4600
|
+
|
|
4411
4601
|
</td>
|
|
4412
4602
|
|
|
4413
4603
|
|
|
4414
4604
|
|
|
4415
4605
|
|
|
4416
4606
|
|
|
4417
|
-
<td class="description last"
|
|
4607
|
+
<td class="description last">-</td>
|
|
4608
|
+
</tr>
|
|
4609
|
+
|
|
4610
|
+
|
|
4611
|
+
</tbody>
|
|
4612
|
+
</table>
|
|
4613
|
+
|
|
4614
|
+
|
|
4615
|
+
|
|
4616
|
+
|
|
4617
|
+
|
|
4618
|
+
|
|
4619
|
+
|
|
4620
|
+
|
|
4621
|
+
|
|
4622
|
+
|
|
4623
|
+
|
|
4624
|
+
|
|
4625
|
+
|
|
4626
|
+
|
|
4627
|
+
|
|
4628
|
+
|
|
4629
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
4630
|
+
|
|
4631
|
+
|
|
4632
|
+
|
|
4633
|
+
|
|
4634
|
+
<dl class="param-type">
|
|
4635
|
+
<dt>
|
|
4636
|
+
Type
|
|
4637
|
+
</dt>
|
|
4638
|
+
<dd>
|
|
4639
|
+
|
|
4640
|
+
<span class="param-type">Promise.<(any|null)></span>
|
|
4641
|
+
|
|
4642
|
+
|
|
4643
|
+
|
|
4644
|
+
</dd>
|
|
4645
|
+
</dl>
|
|
4646
|
+
|
|
4647
|
+
|
|
4648
|
+
|
|
4649
|
+
|
|
4650
|
+
|
|
4651
|
+
|
|
4652
|
+
|
|
4653
|
+
|
|
4654
|
+
|
|
4655
|
+
|
|
4656
|
+
<h4 class="name" id=".fetchUserChallengeProgress"><span class="type-signature type-signature-static">(static) </span>fetchUserChallengeProgress<span class="signature">(contentId)</span><span class="type-signature"> → {Promise.<(any|null)>}</span></h4>
|
|
4657
|
+
|
|
4658
|
+
|
|
4659
|
+
|
|
4660
|
+
|
|
4661
|
+
|
|
4662
|
+
|
|
4663
|
+
<dl class="details">
|
|
4664
|
+
|
|
4665
|
+
<dt class="tag-description">Description:</dt>
|
|
4666
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch challenge, lesson, and user metadata for a given challenge</li></ul></dd>
|
|
4667
|
+
|
|
4668
|
+
|
|
4669
|
+
|
|
4670
|
+
<dt class="tag-source">Source:</dt>
|
|
4671
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
4672
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line401">line 401</a>
|
|
4673
|
+
</li></ul></dd>
|
|
4674
|
+
|
|
4675
|
+
|
|
4676
|
+
|
|
4677
|
+
|
|
4678
|
+
|
|
4679
|
+
|
|
4680
|
+
|
|
4681
|
+
|
|
4682
|
+
|
|
4683
|
+
|
|
4684
|
+
|
|
4685
|
+
|
|
4686
|
+
|
|
4687
|
+
|
|
4688
|
+
|
|
4689
|
+
|
|
4690
|
+
|
|
4691
|
+
|
|
4692
|
+
|
|
4693
|
+
|
|
4694
|
+
|
|
4695
|
+
|
|
4696
|
+
|
|
4697
|
+
|
|
4698
|
+
|
|
4699
|
+
|
|
4700
|
+
|
|
4701
|
+
|
|
4702
|
+
|
|
4703
|
+
|
|
4704
|
+
|
|
4705
|
+
</dl>
|
|
4706
|
+
|
|
4707
|
+
|
|
4708
|
+
|
|
4709
|
+
|
|
4710
|
+
|
|
4711
|
+
|
|
4712
|
+
|
|
4713
|
+
|
|
4714
|
+
|
|
4715
|
+
|
|
4716
|
+
|
|
4717
|
+
|
|
4718
|
+
|
|
4719
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
4720
|
+
|
|
4721
|
+
|
|
4722
|
+
<table class="params">
|
|
4723
|
+
<thead>
|
|
4724
|
+
<tr>
|
|
4725
|
+
|
|
4726
|
+
<th>Name</th>
|
|
4727
|
+
|
|
4728
|
+
|
|
4729
|
+
<th>Type</th>
|
|
4730
|
+
|
|
4731
|
+
|
|
4732
|
+
|
|
4733
|
+
|
|
4734
|
+
|
|
4735
|
+
<th class="last">Description</th>
|
|
4736
|
+
</tr>
|
|
4737
|
+
</thead>
|
|
4738
|
+
|
|
4739
|
+
<tbody>
|
|
4740
|
+
|
|
4741
|
+
|
|
4742
|
+
<tr>
|
|
4743
|
+
|
|
4744
|
+
<td class="name"><code>contentId</code></td>
|
|
4745
|
+
|
|
4746
|
+
|
|
4747
|
+
<td class="type">
|
|
4748
|
+
|
|
4749
|
+
</td>
|
|
4750
|
+
|
|
4751
|
+
|
|
4752
|
+
|
|
4753
|
+
|
|
4754
|
+
|
|
4755
|
+
<td class="description last">railcontent id of the challenge</td>
|
|
4418
4756
|
</tr>
|
|
4419
4757
|
|
|
4420
4758
|
|
|
@@ -7215,6 +7553,378 @@ Clears any current progress data for this challenge</li></ul></dd>
|
|
|
7215
7553
|
|
|
7216
7554
|
|
|
7217
7555
|
|
|
7556
|
+
<h3 class="subsection-title">Type Definitions</h3>
|
|
7557
|
+
|
|
7558
|
+
|
|
7559
|
+
|
|
7560
|
+
<h4 class="name" id="~Activity">Activity</h4>
|
|
7561
|
+
|
|
7562
|
+
|
|
7563
|
+
|
|
7564
|
+
|
|
7565
|
+
|
|
7566
|
+
<dl class="details">
|
|
7567
|
+
|
|
7568
|
+
|
|
7569
|
+
|
|
7570
|
+
<dt class="tag-source">Source:</dt>
|
|
7571
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
7572
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line851">line 851</a>
|
|
7573
|
+
</li></ul></dd>
|
|
7574
|
+
|
|
7575
|
+
|
|
7576
|
+
|
|
7577
|
+
|
|
7578
|
+
|
|
7579
|
+
|
|
7580
|
+
|
|
7581
|
+
|
|
7582
|
+
|
|
7583
|
+
|
|
7584
|
+
|
|
7585
|
+
|
|
7586
|
+
|
|
7587
|
+
|
|
7588
|
+
|
|
7589
|
+
|
|
7590
|
+
|
|
7591
|
+
|
|
7592
|
+
|
|
7593
|
+
|
|
7594
|
+
|
|
7595
|
+
|
|
7596
|
+
|
|
7597
|
+
|
|
7598
|
+
|
|
7599
|
+
|
|
7600
|
+
|
|
7601
|
+
|
|
7602
|
+
|
|
7603
|
+
|
|
7604
|
+
|
|
7605
|
+
</dl>
|
|
7606
|
+
|
|
7607
|
+
|
|
7608
|
+
|
|
7609
|
+
<h5 class="subsection-title">Properties:</h5>
|
|
7610
|
+
|
|
7611
|
+
|
|
7612
|
+
|
|
7613
|
+
<table class="props">
|
|
7614
|
+
<thead>
|
|
7615
|
+
<tr>
|
|
7616
|
+
|
|
7617
|
+
<th>Name</th>
|
|
7618
|
+
|
|
7619
|
+
|
|
7620
|
+
<th>Type</th>
|
|
7621
|
+
|
|
7622
|
+
|
|
7623
|
+
|
|
7624
|
+
|
|
7625
|
+
|
|
7626
|
+
<th class="last">Description</th>
|
|
7627
|
+
</tr>
|
|
7628
|
+
</thead>
|
|
7629
|
+
|
|
7630
|
+
<tbody>
|
|
7631
|
+
|
|
7632
|
+
|
|
7633
|
+
<tr>
|
|
7634
|
+
|
|
7635
|
+
<td class="name"><code>id</code></td>
|
|
7636
|
+
|
|
7637
|
+
|
|
7638
|
+
<td class="type">
|
|
7639
|
+
|
|
7640
|
+
|
|
7641
|
+
<span class="param-type">string</span>
|
|
7642
|
+
|
|
7643
|
+
|
|
7644
|
+
|
|
7645
|
+
|
|
7646
|
+
</td>
|
|
7647
|
+
|
|
7648
|
+
|
|
7649
|
+
|
|
7650
|
+
|
|
7651
|
+
|
|
7652
|
+
<td class="description last">Unique identifier for the activity.</td>
|
|
7653
|
+
</tr>
|
|
7654
|
+
|
|
7655
|
+
|
|
7656
|
+
|
|
7657
|
+
<tr>
|
|
7658
|
+
|
|
7659
|
+
<td class="name"><code>type</code></td>
|
|
7660
|
+
|
|
7661
|
+
|
|
7662
|
+
<td class="type">
|
|
7663
|
+
|
|
7664
|
+
|
|
7665
|
+
<span class="param-type">string</span>
|
|
7666
|
+
|
|
7667
|
+
|
|
7668
|
+
|
|
7669
|
+
|
|
7670
|
+
</td>
|
|
7671
|
+
|
|
7672
|
+
|
|
7673
|
+
|
|
7674
|
+
|
|
7675
|
+
|
|
7676
|
+
<td class="description last">Type of activity (e.g., "lesson_completed").</td>
|
|
7677
|
+
</tr>
|
|
7678
|
+
|
|
7679
|
+
|
|
7680
|
+
|
|
7681
|
+
<tr>
|
|
7682
|
+
|
|
7683
|
+
<td class="name"><code>timestamp</code></td>
|
|
7684
|
+
|
|
7685
|
+
|
|
7686
|
+
<td class="type">
|
|
7687
|
+
|
|
7688
|
+
|
|
7689
|
+
<span class="param-type">string</span>
|
|
7690
|
+
|
|
7691
|
+
|
|
7692
|
+
|
|
7693
|
+
|
|
7694
|
+
</td>
|
|
7695
|
+
|
|
7696
|
+
|
|
7697
|
+
|
|
7698
|
+
|
|
7699
|
+
|
|
7700
|
+
<td class="description last">ISO 8601 string of when the activity occurred.</td>
|
|
7701
|
+
</tr>
|
|
7702
|
+
|
|
7703
|
+
|
|
7704
|
+
|
|
7705
|
+
<tr>
|
|
7706
|
+
|
|
7707
|
+
<td class="name"><code>meta</code></td>
|
|
7708
|
+
|
|
7709
|
+
|
|
7710
|
+
<td class="type">
|
|
7711
|
+
|
|
7712
|
+
|
|
7713
|
+
<span class="param-type">Object</span>
|
|
7714
|
+
|
|
7715
|
+
|
|
7716
|
+
|
|
7717
|
+
|
|
7718
|
+
</td>
|
|
7719
|
+
|
|
7720
|
+
|
|
7721
|
+
|
|
7722
|
+
|
|
7723
|
+
|
|
7724
|
+
<td class="description last">Additional metadata related to the activity.</td>
|
|
7725
|
+
</tr>
|
|
7726
|
+
|
|
7727
|
+
|
|
7728
|
+
</tbody>
|
|
7729
|
+
</table>
|
|
7730
|
+
|
|
7731
|
+
|
|
7732
|
+
|
|
7733
|
+
|
|
7734
|
+
|
|
7735
|
+
|
|
7736
|
+
|
|
7737
|
+
|
|
7738
|
+
<h5 class="h5-types">Type:</h5>
|
|
7739
|
+
<ul>
|
|
7740
|
+
<li>
|
|
7741
|
+
|
|
7742
|
+
<span class="param-type">Object</span>
|
|
7743
|
+
|
|
7744
|
+
|
|
7745
|
+
|
|
7746
|
+
</li>
|
|
7747
|
+
</ul>
|
|
7748
|
+
|
|
7749
|
+
|
|
7750
|
+
|
|
7751
|
+
|
|
7752
|
+
|
|
7753
|
+
|
|
7754
|
+
|
|
7755
|
+
|
|
7756
|
+
<h4 class="name" id="~PaginatedActivities">PaginatedActivities</h4>
|
|
7757
|
+
|
|
7758
|
+
|
|
7759
|
+
|
|
7760
|
+
|
|
7761
|
+
|
|
7762
|
+
<dl class="details">
|
|
7763
|
+
|
|
7764
|
+
|
|
7765
|
+
|
|
7766
|
+
<dt class="tag-source">Source:</dt>
|
|
7767
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
7768
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line859">line 859</a>
|
|
7769
|
+
</li></ul></dd>
|
|
7770
|
+
|
|
7771
|
+
|
|
7772
|
+
|
|
7773
|
+
|
|
7774
|
+
|
|
7775
|
+
|
|
7776
|
+
|
|
7777
|
+
|
|
7778
|
+
|
|
7779
|
+
|
|
7780
|
+
|
|
7781
|
+
|
|
7782
|
+
|
|
7783
|
+
|
|
7784
|
+
|
|
7785
|
+
|
|
7786
|
+
|
|
7787
|
+
|
|
7788
|
+
|
|
7789
|
+
|
|
7790
|
+
|
|
7791
|
+
|
|
7792
|
+
|
|
7793
|
+
|
|
7794
|
+
|
|
7795
|
+
|
|
7796
|
+
|
|
7797
|
+
|
|
7798
|
+
|
|
7799
|
+
|
|
7800
|
+
|
|
7801
|
+
</dl>
|
|
7802
|
+
|
|
7803
|
+
|
|
7804
|
+
|
|
7805
|
+
<h5 class="subsection-title">Properties:</h5>
|
|
7806
|
+
|
|
7807
|
+
|
|
7808
|
+
|
|
7809
|
+
<table class="props">
|
|
7810
|
+
<thead>
|
|
7811
|
+
<tr>
|
|
7812
|
+
|
|
7813
|
+
<th>Name</th>
|
|
7814
|
+
|
|
7815
|
+
|
|
7816
|
+
<th>Type</th>
|
|
7817
|
+
|
|
7818
|
+
|
|
7819
|
+
|
|
7820
|
+
|
|
7821
|
+
|
|
7822
|
+
<th class="last">Description</th>
|
|
7823
|
+
</tr>
|
|
7824
|
+
</thead>
|
|
7825
|
+
|
|
7826
|
+
<tbody>
|
|
7827
|
+
|
|
7828
|
+
|
|
7829
|
+
<tr>
|
|
7830
|
+
|
|
7831
|
+
<td class="name"><code>currentPage</code></td>
|
|
7832
|
+
|
|
7833
|
+
|
|
7834
|
+
<td class="type">
|
|
7835
|
+
|
|
7836
|
+
|
|
7837
|
+
<span class="param-type">number</span>
|
|
7838
|
+
|
|
7839
|
+
|
|
7840
|
+
|
|
7841
|
+
|
|
7842
|
+
</td>
|
|
7843
|
+
|
|
7844
|
+
|
|
7845
|
+
|
|
7846
|
+
|
|
7847
|
+
|
|
7848
|
+
<td class="description last"></td>
|
|
7849
|
+
</tr>
|
|
7850
|
+
|
|
7851
|
+
|
|
7852
|
+
|
|
7853
|
+
<tr>
|
|
7854
|
+
|
|
7855
|
+
<td class="name"><code>totalPages</code></td>
|
|
7856
|
+
|
|
7857
|
+
|
|
7858
|
+
<td class="type">
|
|
7859
|
+
|
|
7860
|
+
|
|
7861
|
+
<span class="param-type">number</span>
|
|
7862
|
+
|
|
7863
|
+
|
|
7864
|
+
|
|
7865
|
+
|
|
7866
|
+
</td>
|
|
7867
|
+
|
|
7868
|
+
|
|
7869
|
+
|
|
7870
|
+
|
|
7871
|
+
|
|
7872
|
+
<td class="description last"></td>
|
|
7873
|
+
</tr>
|
|
7874
|
+
|
|
7875
|
+
|
|
7876
|
+
|
|
7877
|
+
<tr>
|
|
7878
|
+
|
|
7879
|
+
<td class="name"><code>data</code></td>
|
|
7880
|
+
|
|
7881
|
+
|
|
7882
|
+
<td class="type">
|
|
7883
|
+
|
|
7884
|
+
|
|
7885
|
+
<span class="param-type">Array.<Activity></span>
|
|
7886
|
+
|
|
7887
|
+
|
|
7888
|
+
|
|
7889
|
+
|
|
7890
|
+
</td>
|
|
7891
|
+
|
|
7892
|
+
|
|
7893
|
+
|
|
7894
|
+
|
|
7895
|
+
|
|
7896
|
+
<td class="description last"></td>
|
|
7897
|
+
</tr>
|
|
7898
|
+
|
|
7899
|
+
|
|
7900
|
+
</tbody>
|
|
7901
|
+
</table>
|
|
7902
|
+
|
|
7903
|
+
|
|
7904
|
+
|
|
7905
|
+
|
|
7906
|
+
|
|
7907
|
+
|
|
7908
|
+
|
|
7909
|
+
|
|
7910
|
+
<h5 class="h5-types">Type:</h5>
|
|
7911
|
+
<ul>
|
|
7912
|
+
<li>
|
|
7913
|
+
|
|
7914
|
+
<span class="param-type">Object</span>
|
|
7915
|
+
|
|
7916
|
+
|
|
7917
|
+
|
|
7918
|
+
</li>
|
|
7919
|
+
</ul>
|
|
7920
|
+
|
|
7921
|
+
|
|
7922
|
+
|
|
7923
|
+
|
|
7924
|
+
|
|
7925
|
+
|
|
7926
|
+
|
|
7927
|
+
|
|
7218
7928
|
|
|
7219
7929
|
|
|
7220
7930
|
</article>
|
|
@@ -7231,7 +7941,7 @@ Clears any current progress data for this challenge</li></ul></dd>
|
|
|
7231
7941
|
<br class="clear">
|
|
7232
7942
|
|
|
7233
7943
|
<footer>
|
|
7234
|
-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Wed May
|
|
7944
|
+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Wed May 21 2025 14:49:14 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
|
|
7235
7945
|
</footer>
|
|
7236
7946
|
|
|
7237
7947
|
<script>prettyPrint();</script>
|