musora-content-services 2.28.3 → 2.28.5
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/CHANGELOG.md +9 -0
- package/docs/ContentOrganization.html +2 -2
- package/docs/Gamification.html +2 -2
- 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 +4 -4
- 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 +2 -2
- 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 +4 -4
- 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 +590 -2987
- package/docs/module-Sanity-Services.html +30 -664
- package/docs/module-Sessions.html +2 -2
- package/docs/module-UserActivity.html +21 -21
- package/docs/module-UserChat.html +2 -2
- package/docs/module-UserManagement.html +2 -2
- package/docs/module-UserNotifications.html +2 -2
- package/docs/module-UserProfile.html +2 -2
- package/docs/railcontent.js.html +2 -196
- package/docs/sanity.js.html +17 -209
- package/docs/userActivity.js.html +4 -3
- package/docs/user_chat.js.html +2 -2
- package/docs/user_interests.js.html +2 -2
- package/docs/user_management.js.html +2 -2
- package/docs/user_notifications.js.html +2 -2
- package/docs/user_permissions.js.html +2 -2
- package/docs/user_profile.js.html +2 -2
- package/docs/user_sessions.js.html +2 -2
- package/docs/user_types.js.html +2 -2
- package/docs/user_user-management-system.js.html +2 -2
- package/package.json +1 -1
- package/src/contentMetaData.js +0 -24
- package/src/contentTypeConfig.js +2 -41
- package/src/index.d.ts +0 -30
- package/src/index.js +1 -31
- package/src/services/content.js +2 -2
- package/src/services/railcontent.js +0 -194
- package/src/services/sanity.js +13 -173
- package/src/services/userActivity.js +0 -1
- package/test/live/railcontentLive.test.js +0 -7
- package/test/sanityQueryService.test.js +3 -55
- package/docs/Content-Organization.html +0 -245
- package/docs/UserManagement.html +0 -269
- package/docs/global.html#User +0 -293
- package/docs/module-Notifications.html +0 -1183
- package/docs/module-Session-Management.html +0 -575
- package/docs/module-User-Activity.html +0 -4410
- package/docs/module-User-Management.html +0 -490
- package/docs/module-User-Permissions.html +0 -406
- package/docs/types.js.html +0 -122
- package/docs/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#~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#.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#.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#.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#.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#.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#.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#~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#.getUserData">getUserData</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#.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#.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="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#.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#.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#.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#.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#~getNextAndPreviousQuarterDates">getNextAndPreviousQuarterDates</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#.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#.getUserData">getUserData</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#.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#.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="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
|
|
|
@@ -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#line487">line 487</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#line523">line 523</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#line474">line 474</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#line444">line 444</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#line548">line 548</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#line68">line 68</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#line364">line 364</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#line580">line 580</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#line435">line 435</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#line423">line 423</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#line454">line 454</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
|
|
|
@@ -1803,13 +1814,13 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
1803
1814
|
<dl class="details">
|
|
1804
1815
|
|
|
1805
1816
|
<dt class="tag-description">Description:</dt>
|
|
1806
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetches a
|
|
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>
|
|
1807
1818
|
|
|
1808
1819
|
|
|
1809
1820
|
|
|
1810
1821
|
<dt class="tag-source">Source:</dt>
|
|
1811
1822
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
1812
|
-
<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#line181">line 181</a>
|
|
1813
1824
|
</li></ul></dd>
|
|
1814
1825
|
|
|
1815
1826
|
|
|
@@ -1856,8 +1867,8 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
1856
1867
|
|
|
1857
1868
|
<h5 class="h5-examples">Example</h5>
|
|
1858
1869
|
|
|
1859
|
-
<pre class="prettyprint"><code>
|
|
1860
|
-
.then(
|
|
1870
|
+
<pre class="prettyprint"><code>fetchCompletedContent('song', 'drumeo')
|
|
1871
|
+
.then(songs => console.log(songs))
|
|
1861
1872
|
.catch(error => console.error(error));</code></pre>
|
|
1862
1873
|
|
|
1863
1874
|
|
|
@@ -1876,8 +1887,12 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
1876
1887
|
<th>Type</th>
|
|
1877
1888
|
|
|
1878
1889
|
|
|
1890
|
+
<th>Attributes</th>
|
|
1891
|
+
|
|
1879
1892
|
|
|
1880
1893
|
|
|
1894
|
+
<th>Default</th>
|
|
1895
|
+
|
|
1881
1896
|
|
|
1882
1897
|
<th class="last">Description</th>
|
|
1883
1898
|
</tr>
|
|
@@ -1888,15 +1903,12 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
1888
1903
|
|
|
1889
1904
|
<tr>
|
|
1890
1905
|
|
|
1891
|
-
<td class="name"><code>
|
|
1906
|
+
<td class="name"><code>type</code></td>
|
|
1892
1907
|
|
|
1893
1908
|
|
|
1894
1909
|
<td class="type">
|
|
1895
1910
|
|
|
1896
1911
|
|
|
1897
|
-
<span class="param-type">number</span>
|
|
1898
|
-
|
|
|
1899
|
-
|
|
1900
1912
|
<span class="param-type">string</span>
|
|
1901
1913
|
|
|
1902
1914
|
|
|
@@ -1905,2550 +1917,111 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
1905
1917
|
</td>
|
|
1906
1918
|
|
|
1907
1919
|
|
|
1920
|
+
<td class="attributes">
|
|
1921
|
+
|
|
1922
|
+
|
|
1923
|
+
|
|
1908
1924
|
|
|
1925
|
+
|
|
1926
|
+
</td>
|
|
1909
1927
|
|
|
1910
1928
|
|
|
1911
|
-
|
|
1929
|
+
|
|
1930
|
+
<td class="default">
|
|
1931
|
+
|
|
1932
|
+
</td>
|
|
1933
|
+
|
|
1934
|
+
|
|
1935
|
+
<td class="description last">The content type associated with the content.</td>
|
|
1912
1936
|
</tr>
|
|
1913
1937
|
|
|
1914
1938
|
|
|
1915
|
-
</tbody>
|
|
1916
|
-
</table>
|
|
1917
|
-
|
|
1918
|
-
|
|
1919
1939
|
|
|
1940
|
+
<tr>
|
|
1941
|
+
|
|
1942
|
+
<td class="name"><code>brand</code></td>
|
|
1943
|
+
|
|
1920
1944
|
|
|
1945
|
+
<td class="type">
|
|
1946
|
+
|
|
1947
|
+
|
|
1948
|
+
<span class="param-type">string</span>
|
|
1921
1949
|
|
|
1922
1950
|
|
|
1923
1951
|
|
|
1952
|
+
|
|
1953
|
+
</td>
|
|
1924
1954
|
|
|
1955
|
+
|
|
1956
|
+
<td class="attributes">
|
|
1957
|
+
|
|
1925
1958
|
|
|
1959
|
+
|
|
1926
1960
|
|
|
1961
|
+
|
|
1962
|
+
</td>
|
|
1963
|
+
|
|
1927
1964
|
|
|
1965
|
+
|
|
1966
|
+
<td class="default">
|
|
1967
|
+
|
|
1968
|
+
</td>
|
|
1969
|
+
|
|
1928
1970
|
|
|
1929
|
-
|
|
1930
|
-
|
|
1931
|
-
|
|
1932
|
-
|
|
1933
|
-
<h5 class="h5-returns">Returns:</h5>
|
|
1934
|
-
|
|
1935
|
-
|
|
1936
|
-
<div class="param-desc">
|
|
1937
|
-
- A promise that resolves to the comment object if found, otherwise null.
|
|
1938
|
-
</div>
|
|
1939
|
-
|
|
1940
|
-
|
|
1941
|
-
|
|
1942
|
-
<dl class="param-type">
|
|
1943
|
-
<dt>
|
|
1944
|
-
Type
|
|
1945
|
-
</dt>
|
|
1946
|
-
<dd>
|
|
1947
|
-
|
|
1948
|
-
<span class="param-type">Promise.<(Object|null)></span>
|
|
1949
|
-
|
|
1950
|
-
|
|
1951
|
-
|
|
1952
|
-
</dd>
|
|
1953
|
-
</dl>
|
|
1954
|
-
|
|
1955
|
-
|
|
1956
|
-
|
|
1957
|
-
|
|
1958
|
-
|
|
1959
|
-
|
|
1960
|
-
|
|
1961
|
-
|
|
1962
|
-
|
|
1963
|
-
|
|
1964
|
-
<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>
|
|
1965
|
-
|
|
1966
|
-
|
|
1967
|
-
|
|
1968
|
-
|
|
1969
|
-
|
|
1970
|
-
|
|
1971
|
-
<dl class="details">
|
|
1972
|
-
|
|
1973
|
-
|
|
1974
|
-
|
|
1975
|
-
<dt class="tag-source">Source:</dt>
|
|
1976
|
-
<dd class="tag-source"><ul class="dummy"><li>
|
|
1977
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line629">line 629</a>
|
|
1978
|
-
</li></ul></dd>
|
|
1979
|
-
|
|
1980
|
-
|
|
1981
|
-
|
|
1982
|
-
|
|
1983
|
-
|
|
1984
|
-
|
|
1985
|
-
|
|
1986
|
-
|
|
1987
|
-
|
|
1988
|
-
|
|
1989
|
-
|
|
1990
|
-
|
|
1991
|
-
|
|
1992
|
-
|
|
1993
|
-
|
|
1994
|
-
|
|
1995
|
-
|
|
1996
|
-
|
|
1997
|
-
|
|
1998
|
-
|
|
1999
|
-
|
|
2000
|
-
|
|
2001
|
-
|
|
2002
|
-
|
|
2003
|
-
|
|
2004
|
-
|
|
2005
|
-
|
|
2006
|
-
|
|
2007
|
-
|
|
2008
|
-
|
|
2009
|
-
|
|
2010
|
-
</dl>
|
|
2011
|
-
|
|
2012
|
-
|
|
2013
|
-
|
|
2014
|
-
|
|
2015
|
-
|
|
2016
|
-
|
|
2017
|
-
|
|
2018
|
-
|
|
2019
|
-
|
|
2020
|
-
|
|
2021
|
-
|
|
2022
|
-
|
|
2023
|
-
|
|
2024
|
-
<h5 class="h5-parameters">Parameters:</h5>
|
|
2025
|
-
|
|
2026
|
-
|
|
2027
|
-
<table class="params">
|
|
2028
|
-
<thead>
|
|
2029
|
-
<tr>
|
|
2030
|
-
|
|
2031
|
-
<th>Name</th>
|
|
2032
|
-
|
|
2033
|
-
|
|
2034
|
-
<th>Type</th>
|
|
2035
|
-
|
|
2036
|
-
|
|
2037
|
-
|
|
2038
|
-
|
|
2039
|
-
|
|
2040
|
-
<th class="last">Description</th>
|
|
2041
|
-
</tr>
|
|
2042
|
-
</thead>
|
|
2043
|
-
|
|
2044
|
-
<tbody>
|
|
2045
|
-
|
|
2046
|
-
|
|
2047
|
-
<tr>
|
|
2048
|
-
|
|
2049
|
-
<td class="name"><code>commentId</code></td>
|
|
2050
|
-
|
|
2051
|
-
|
|
2052
|
-
<td class="type">
|
|
2053
|
-
|
|
2054
|
-
|
|
2055
|
-
<span class="param-type">int</span>
|
|
2056
|
-
|
|
2057
|
-
|
|
2058
|
-
|
|
2059
|
-
|
|
2060
|
-
</td>
|
|
2061
|
-
|
|
2062
|
-
|
|
2063
|
-
|
|
2064
|
-
|
|
2065
|
-
|
|
2066
|
-
<td class="description last"></td>
|
|
2067
|
-
</tr>
|
|
2068
|
-
|
|
2069
|
-
|
|
2070
|
-
|
|
2071
|
-
<tr>
|
|
2072
|
-
|
|
2073
|
-
<td class="name"><code>page</code></td>
|
|
2074
|
-
|
|
2075
|
-
|
|
2076
|
-
<td class="type">
|
|
2077
|
-
|
|
2078
|
-
|
|
2079
|
-
<span class="param-type">int</span>
|
|
2080
|
-
|
|
2081
|
-
|
|
2082
|
-
|
|
2083
|
-
|
|
2084
|
-
</td>
|
|
2085
|
-
|
|
2086
|
-
|
|
2087
|
-
|
|
2088
|
-
|
|
2089
|
-
|
|
2090
|
-
<td class="description last"></td>
|
|
2091
|
-
</tr>
|
|
2092
|
-
|
|
2093
|
-
|
|
2094
|
-
|
|
2095
|
-
<tr>
|
|
2096
|
-
|
|
2097
|
-
<td class="name"><code>limit</code></td>
|
|
2098
|
-
|
|
2099
|
-
|
|
2100
|
-
<td class="type">
|
|
2101
|
-
|
|
2102
|
-
|
|
2103
|
-
<span class="param-type">int</span>
|
|
2104
|
-
|
|
2105
|
-
|
|
2106
|
-
|
|
2107
|
-
|
|
2108
|
-
</td>
|
|
2109
|
-
|
|
2110
|
-
|
|
2111
|
-
|
|
2112
|
-
|
|
2113
|
-
|
|
2114
|
-
<td class="description last"></td>
|
|
2115
|
-
</tr>
|
|
2116
|
-
|
|
2117
|
-
|
|
2118
|
-
</tbody>
|
|
2119
|
-
</table>
|
|
2120
|
-
|
|
2121
|
-
|
|
2122
|
-
|
|
2123
|
-
|
|
2124
|
-
|
|
2125
|
-
|
|
2126
|
-
|
|
2127
|
-
|
|
2128
|
-
|
|
2129
|
-
|
|
2130
|
-
|
|
2131
|
-
|
|
2132
|
-
|
|
2133
|
-
|
|
2134
|
-
|
|
2135
|
-
|
|
2136
|
-
<h5 class="h5-returns">Returns:</h5>
|
|
2137
|
-
|
|
2138
|
-
|
|
2139
|
-
|
|
2140
|
-
|
|
2141
|
-
<dl class="param-type">
|
|
2142
|
-
<dt>
|
|
2143
|
-
Type
|
|
2144
|
-
</dt>
|
|
2145
|
-
<dd>
|
|
2146
|
-
|
|
2147
|
-
<span class="param-type">Promise.<(*|null)></span>
|
|
2148
|
-
|
|
2149
|
-
|
|
2150
|
-
|
|
2151
|
-
</dd>
|
|
2152
|
-
</dl>
|
|
2153
|
-
|
|
2154
|
-
|
|
2155
|
-
|
|
2156
|
-
|
|
2157
|
-
|
|
2158
|
-
|
|
2159
|
-
|
|
2160
|
-
|
|
2161
|
-
|
|
2162
|
-
|
|
2163
|
-
<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>
|
|
2164
|
-
|
|
2165
|
-
|
|
2166
|
-
|
|
2167
|
-
|
|
2168
|
-
|
|
2169
|
-
|
|
2170
|
-
<dl class="details">
|
|
2171
|
-
|
|
2172
|
-
|
|
2173
|
-
|
|
2174
|
-
<dt class="tag-source">Source:</dt>
|
|
2175
|
-
<dd class="tag-source"><ul class="dummy"><li>
|
|
2176
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line617">line 617</a>
|
|
2177
|
-
</li></ul></dd>
|
|
2178
|
-
|
|
2179
|
-
|
|
2180
|
-
|
|
2181
|
-
|
|
2182
|
-
|
|
2183
|
-
|
|
2184
|
-
|
|
2185
|
-
|
|
2186
|
-
|
|
2187
|
-
|
|
2188
|
-
|
|
2189
|
-
|
|
2190
|
-
|
|
2191
|
-
|
|
2192
|
-
|
|
2193
|
-
|
|
2194
|
-
|
|
2195
|
-
|
|
2196
|
-
|
|
2197
|
-
|
|
2198
|
-
|
|
2199
|
-
|
|
2200
|
-
|
|
2201
|
-
|
|
2202
|
-
|
|
2203
|
-
|
|
2204
|
-
|
|
2205
|
-
|
|
2206
|
-
|
|
2207
|
-
|
|
2208
|
-
|
|
2209
|
-
</dl>
|
|
2210
|
-
|
|
2211
|
-
|
|
2212
|
-
|
|
2213
|
-
|
|
2214
|
-
|
|
2215
|
-
|
|
2216
|
-
|
|
2217
|
-
|
|
2218
|
-
|
|
2219
|
-
|
|
2220
|
-
|
|
2221
|
-
|
|
2222
|
-
|
|
2223
|
-
<h5 class="h5-parameters">Parameters:</h5>
|
|
2224
|
-
|
|
2225
|
-
|
|
2226
|
-
<table class="params">
|
|
2227
|
-
<thead>
|
|
2228
|
-
<tr>
|
|
2229
|
-
|
|
2230
|
-
<th>Name</th>
|
|
2231
|
-
|
|
2232
|
-
|
|
2233
|
-
<th>Type</th>
|
|
2234
|
-
|
|
2235
|
-
|
|
2236
|
-
|
|
2237
|
-
|
|
2238
|
-
|
|
2239
|
-
<th class="last">Description</th>
|
|
2240
|
-
</tr>
|
|
2241
|
-
</thead>
|
|
2242
|
-
|
|
2243
|
-
<tbody>
|
|
2244
|
-
|
|
2245
|
-
|
|
2246
|
-
<tr>
|
|
2247
|
-
|
|
2248
|
-
<td class="name"><code>railcontentId</code></td>
|
|
2249
|
-
|
|
2250
|
-
|
|
2251
|
-
<td class="type">
|
|
2252
|
-
|
|
2253
|
-
|
|
2254
|
-
<span class="param-type">int</span>
|
|
2255
|
-
|
|
2256
|
-
|
|
2257
|
-
|
|
2258
|
-
|
|
2259
|
-
</td>
|
|
2260
|
-
|
|
2261
|
-
|
|
2262
|
-
|
|
2263
|
-
|
|
2264
|
-
|
|
2265
|
-
<td class="description last"></td>
|
|
2266
|
-
</tr>
|
|
2267
|
-
|
|
2268
|
-
|
|
2269
|
-
|
|
2270
|
-
<tr>
|
|
2271
|
-
|
|
2272
|
-
<td class="name"><code>page</code></td>
|
|
2273
|
-
|
|
2274
|
-
|
|
2275
|
-
<td class="type">
|
|
2276
|
-
|
|
2277
|
-
|
|
2278
|
-
<span class="param-type">int</span>
|
|
2279
|
-
|
|
2280
|
-
|
|
2281
|
-
|
|
2282
|
-
|
|
2283
|
-
</td>
|
|
2284
|
-
|
|
2285
|
-
|
|
2286
|
-
|
|
2287
|
-
|
|
2288
|
-
|
|
2289
|
-
<td class="description last"></td>
|
|
2290
|
-
</tr>
|
|
2291
|
-
|
|
2292
|
-
|
|
2293
|
-
|
|
2294
|
-
<tr>
|
|
2295
|
-
|
|
2296
|
-
<td class="name"><code>limit</code></td>
|
|
2297
|
-
|
|
2298
|
-
|
|
2299
|
-
<td class="type">
|
|
2300
|
-
|
|
2301
|
-
|
|
2302
|
-
<span class="param-type">int</span>
|
|
2303
|
-
|
|
2304
|
-
|
|
2305
|
-
|
|
2306
|
-
|
|
2307
|
-
</td>
|
|
2308
|
-
|
|
2309
|
-
|
|
2310
|
-
|
|
2311
|
-
|
|
2312
|
-
|
|
2313
|
-
<td class="description last"></td>
|
|
2314
|
-
</tr>
|
|
2315
|
-
|
|
2316
|
-
|
|
2317
|
-
</tbody>
|
|
2318
|
-
</table>
|
|
2319
|
-
|
|
2320
|
-
|
|
2321
|
-
|
|
2322
|
-
|
|
2323
|
-
|
|
2324
|
-
|
|
2325
|
-
|
|
2326
|
-
|
|
2327
|
-
|
|
2328
|
-
|
|
2329
|
-
|
|
2330
|
-
|
|
2331
|
-
|
|
2332
|
-
|
|
2333
|
-
|
|
2334
|
-
|
|
2335
|
-
<h5 class="h5-returns">Returns:</h5>
|
|
2336
|
-
|
|
2337
|
-
|
|
2338
|
-
|
|
2339
|
-
|
|
2340
|
-
<dl class="param-type">
|
|
2341
|
-
<dt>
|
|
2342
|
-
Type
|
|
2343
|
-
</dt>
|
|
2344
|
-
<dd>
|
|
2345
|
-
|
|
2346
|
-
<span class="param-type">Promise.<(*|null)></span>
|
|
2347
|
-
|
|
2348
|
-
|
|
2349
|
-
|
|
2350
|
-
</dd>
|
|
2351
|
-
</dl>
|
|
2352
|
-
|
|
2353
|
-
|
|
2354
|
-
|
|
2355
|
-
|
|
2356
|
-
|
|
2357
|
-
|
|
2358
|
-
|
|
2359
|
-
|
|
2360
|
-
|
|
2361
|
-
|
|
2362
|
-
<h4 class="name" id=".fetchCompletedChallenges"><span class="type-signature type-signature-static">(static) </span>fetchCompletedChallenges<span class="signature">(brand, page, limit)</span><span class="type-signature"> → {Promise.<(any|null)>}</span></h4>
|
|
2363
|
-
|
|
2364
|
-
|
|
2365
|
-
|
|
2366
|
-
|
|
2367
|
-
|
|
2368
|
-
|
|
2369
|
-
<dl class="details">
|
|
2370
|
-
|
|
2371
|
-
<dt class="tag-description">Description:</dt>
|
|
2372
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetch all completed brand challenges for user</li></ul></dd>
|
|
2373
|
-
|
|
2374
|
-
|
|
2375
|
-
|
|
2376
|
-
<dt class="tag-source">Source:</dt>
|
|
2377
|
-
<dd class="tag-source"><ul class="dummy"><li>
|
|
2378
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line393">line 393</a>
|
|
2379
|
-
</li></ul></dd>
|
|
2380
|
-
|
|
2381
|
-
|
|
2382
|
-
|
|
2383
|
-
|
|
2384
|
-
|
|
2385
|
-
|
|
2386
|
-
|
|
2387
|
-
|
|
2388
|
-
|
|
2389
|
-
|
|
2390
|
-
|
|
2391
|
-
|
|
2392
|
-
|
|
2393
|
-
|
|
2394
|
-
|
|
2395
|
-
|
|
2396
|
-
|
|
2397
|
-
|
|
2398
|
-
|
|
2399
|
-
|
|
2400
|
-
|
|
2401
|
-
|
|
2402
|
-
|
|
2403
|
-
|
|
2404
|
-
|
|
2405
|
-
|
|
2406
|
-
|
|
2407
|
-
|
|
2408
|
-
|
|
2409
|
-
|
|
2410
|
-
|
|
2411
|
-
</dl>
|
|
2412
|
-
|
|
2413
|
-
|
|
2414
|
-
|
|
2415
|
-
|
|
2416
|
-
|
|
2417
|
-
|
|
2418
|
-
|
|
2419
|
-
|
|
2420
|
-
|
|
2421
|
-
|
|
2422
|
-
|
|
2423
|
-
|
|
2424
|
-
|
|
2425
|
-
<h5 class="h5-parameters">Parameters:</h5>
|
|
2426
|
-
|
|
2427
|
-
|
|
2428
|
-
<table class="params">
|
|
2429
|
-
<thead>
|
|
2430
|
-
<tr>
|
|
2431
|
-
|
|
2432
|
-
<th>Name</th>
|
|
2433
|
-
|
|
2434
|
-
|
|
2435
|
-
<th>Type</th>
|
|
2436
|
-
|
|
2437
|
-
|
|
2438
|
-
|
|
2439
|
-
|
|
2440
|
-
|
|
2441
|
-
<th class="last">Description</th>
|
|
2442
|
-
</tr>
|
|
2443
|
-
</thead>
|
|
2444
|
-
|
|
2445
|
-
<tbody>
|
|
2446
|
-
|
|
2447
|
-
|
|
2448
|
-
<tr>
|
|
2449
|
-
|
|
2450
|
-
<td class="name"><code>brand</code></td>
|
|
2451
|
-
|
|
2452
|
-
|
|
2453
|
-
<td class="type">
|
|
2454
|
-
|
|
2455
|
-
|
|
2456
|
-
<span class="param-type">string</span>
|
|
2457
|
-
|
|
|
2458
|
-
|
|
2459
|
-
<span class="param-type">null</span>
|
|
2460
|
-
|
|
2461
|
-
|
|
2462
|
-
|
|
2463
|
-
|
|
2464
|
-
</td>
|
|
2465
|
-
|
|
2466
|
-
|
|
2467
|
-
|
|
2468
|
-
|
|
2469
|
-
|
|
2470
|
-
<td class="description last">brand</td>
|
|
2471
|
-
</tr>
|
|
2472
|
-
|
|
2473
|
-
|
|
2474
|
-
|
|
2475
|
-
<tr>
|
|
2476
|
-
|
|
2477
|
-
<td class="name"><code>page</code></td>
|
|
2478
|
-
|
|
2479
|
-
|
|
2480
|
-
<td class="type">
|
|
2481
|
-
|
|
2482
|
-
|
|
2483
|
-
<span class="param-type">int</span>
|
|
2484
|
-
|
|
2485
|
-
|
|
2486
|
-
|
|
2487
|
-
|
|
2488
|
-
</td>
|
|
2489
|
-
|
|
2490
|
-
|
|
2491
|
-
|
|
2492
|
-
|
|
2493
|
-
|
|
2494
|
-
<td class="description last">page of data to pull</td>
|
|
2495
|
-
</tr>
|
|
2496
|
-
|
|
2497
|
-
|
|
2498
|
-
|
|
2499
|
-
<tr>
|
|
2500
|
-
|
|
2501
|
-
<td class="name"><code>limit</code></td>
|
|
2502
|
-
|
|
2503
|
-
|
|
2504
|
-
<td class="type">
|
|
2505
|
-
|
|
2506
|
-
|
|
2507
|
-
<span class="param-type">int</span>
|
|
2508
|
-
|
|
2509
|
-
|
|
2510
|
-
|
|
2511
|
-
|
|
2512
|
-
</td>
|
|
2513
|
-
|
|
2514
|
-
|
|
2515
|
-
|
|
2516
|
-
|
|
2517
|
-
|
|
2518
|
-
<td class="description last">number of elements to pull</td>
|
|
2519
|
-
</tr>
|
|
2520
|
-
|
|
2521
|
-
|
|
2522
|
-
</tbody>
|
|
2523
|
-
</table>
|
|
2524
|
-
|
|
2525
|
-
|
|
2526
|
-
|
|
2527
|
-
|
|
2528
|
-
|
|
2529
|
-
|
|
2530
|
-
|
|
2531
|
-
|
|
2532
|
-
|
|
2533
|
-
|
|
2534
|
-
|
|
2535
|
-
|
|
2536
|
-
|
|
2537
|
-
|
|
2538
|
-
|
|
2539
|
-
|
|
2540
|
-
<h5 class="h5-returns">Returns:</h5>
|
|
2541
|
-
|
|
2542
|
-
|
|
2543
|
-
|
|
2544
|
-
|
|
2545
|
-
<dl class="param-type">
|
|
2546
|
-
<dt>
|
|
2547
|
-
Type
|
|
2548
|
-
</dt>
|
|
2549
|
-
<dd>
|
|
2550
|
-
|
|
2551
|
-
<span class="param-type">Promise.<(any|null)></span>
|
|
2552
|
-
|
|
2553
|
-
|
|
2554
|
-
|
|
2555
|
-
</dd>
|
|
2556
|
-
</dl>
|
|
2557
|
-
|
|
2558
|
-
|
|
2559
|
-
|
|
2560
|
-
|
|
2561
|
-
|
|
2562
|
-
|
|
2563
|
-
|
|
2564
|
-
|
|
2565
|
-
|
|
2566
|
-
|
|
2567
|
-
<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>
|
|
2568
|
-
|
|
2569
|
-
|
|
2570
|
-
|
|
2571
|
-
|
|
2572
|
-
|
|
2573
|
-
|
|
2574
|
-
<dl class="details">
|
|
2575
|
-
|
|
2576
|
-
<dt class="tag-description">Description:</dt>
|
|
2577
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetches a list of content that has been completed for the current user.</li></ul></dd>
|
|
2578
|
-
|
|
2579
|
-
|
|
2580
|
-
|
|
2581
|
-
<dt class="tag-source">Source:</dt>
|
|
2582
|
-
<dd class="tag-source"><ul class="dummy"><li>
|
|
2583
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line183">line 183</a>
|
|
2584
|
-
</li></ul></dd>
|
|
2585
|
-
|
|
2586
|
-
|
|
2587
|
-
|
|
2588
|
-
|
|
2589
|
-
|
|
2590
|
-
|
|
2591
|
-
|
|
2592
|
-
|
|
2593
|
-
|
|
2594
|
-
|
|
2595
|
-
|
|
2596
|
-
|
|
2597
|
-
|
|
2598
|
-
|
|
2599
|
-
|
|
2600
|
-
|
|
2601
|
-
|
|
2602
|
-
|
|
2603
|
-
|
|
2604
|
-
|
|
2605
|
-
|
|
2606
|
-
|
|
2607
|
-
|
|
2608
|
-
|
|
2609
|
-
|
|
2610
|
-
|
|
2611
|
-
|
|
2612
|
-
|
|
2613
|
-
|
|
2614
|
-
|
|
2615
|
-
|
|
2616
|
-
</dl>
|
|
2617
|
-
|
|
2618
|
-
|
|
2619
|
-
|
|
2620
|
-
|
|
2621
|
-
|
|
2622
|
-
|
|
2623
|
-
|
|
2624
|
-
|
|
2625
|
-
|
|
2626
|
-
|
|
2627
|
-
|
|
2628
|
-
<h5 class="h5-examples">Example</h5>
|
|
2629
|
-
|
|
2630
|
-
<pre class="prettyprint"><code>fetchCompletedContent('song', 'drumeo')
|
|
2631
|
-
.then(songs => console.log(songs))
|
|
2632
|
-
.catch(error => console.error(error));</code></pre>
|
|
2633
|
-
|
|
2634
|
-
|
|
2635
|
-
|
|
2636
|
-
|
|
2637
|
-
<h5 class="h5-parameters">Parameters:</h5>
|
|
2638
|
-
|
|
2639
|
-
|
|
2640
|
-
<table class="params">
|
|
2641
|
-
<thead>
|
|
2642
|
-
<tr>
|
|
2643
|
-
|
|
2644
|
-
<th>Name</th>
|
|
2645
|
-
|
|
2646
|
-
|
|
2647
|
-
<th>Type</th>
|
|
2648
|
-
|
|
2649
|
-
|
|
2650
|
-
<th>Attributes</th>
|
|
2651
|
-
|
|
2652
|
-
|
|
2653
|
-
|
|
2654
|
-
<th>Default</th>
|
|
2655
|
-
|
|
2656
|
-
|
|
2657
|
-
<th class="last">Description</th>
|
|
2658
|
-
</tr>
|
|
2659
|
-
</thead>
|
|
2660
|
-
|
|
2661
|
-
<tbody>
|
|
2662
|
-
|
|
2663
|
-
|
|
2664
|
-
<tr>
|
|
2665
|
-
|
|
2666
|
-
<td class="name"><code>type</code></td>
|
|
2667
|
-
|
|
2668
|
-
|
|
2669
|
-
<td class="type">
|
|
2670
|
-
|
|
2671
|
-
|
|
2672
|
-
<span class="param-type">string</span>
|
|
2673
|
-
|
|
2674
|
-
|
|
2675
|
-
|
|
2676
|
-
|
|
2677
|
-
</td>
|
|
2678
|
-
|
|
2679
|
-
|
|
2680
|
-
<td class="attributes">
|
|
2681
|
-
|
|
2682
|
-
|
|
2683
|
-
|
|
2684
|
-
|
|
2685
|
-
|
|
2686
|
-
</td>
|
|
2687
|
-
|
|
2688
|
-
|
|
2689
|
-
|
|
2690
|
-
<td class="default">
|
|
2691
|
-
|
|
2692
|
-
</td>
|
|
2693
|
-
|
|
2694
|
-
|
|
2695
|
-
<td class="description last">The content type associated with the content.</td>
|
|
2696
|
-
</tr>
|
|
2697
|
-
|
|
2698
|
-
|
|
2699
|
-
|
|
2700
|
-
<tr>
|
|
2701
|
-
|
|
2702
|
-
<td class="name"><code>brand</code></td>
|
|
2703
|
-
|
|
2704
|
-
|
|
2705
|
-
<td class="type">
|
|
2706
|
-
|
|
2707
|
-
|
|
2708
|
-
<span class="param-type">string</span>
|
|
2709
|
-
|
|
2710
|
-
|
|
2711
|
-
|
|
2712
|
-
|
|
2713
|
-
</td>
|
|
2714
|
-
|
|
2715
|
-
|
|
2716
|
-
<td class="attributes">
|
|
2717
|
-
|
|
2718
|
-
|
|
2719
|
-
|
|
2720
|
-
|
|
2721
|
-
|
|
2722
|
-
</td>
|
|
2723
|
-
|
|
2724
|
-
|
|
2725
|
-
|
|
2726
|
-
<td class="default">
|
|
2727
|
-
|
|
2728
|
-
</td>
|
|
2729
|
-
|
|
2730
|
-
|
|
2731
|
-
<td class="description last">The brand associated with the content.</td>
|
|
2732
|
-
</tr>
|
|
2733
|
-
|
|
2734
|
-
|
|
2735
|
-
|
|
2736
|
-
<tr>
|
|
2737
|
-
|
|
2738
|
-
<td class="name"><code>params.limit</code></td>
|
|
2739
|
-
|
|
2740
|
-
|
|
2741
|
-
<td class="type">
|
|
2742
|
-
|
|
2743
|
-
|
|
2744
|
-
<span class="param-type">number</span>
|
|
2745
|
-
|
|
2746
|
-
|
|
2747
|
-
|
|
2748
|
-
|
|
2749
|
-
</td>
|
|
2750
|
-
|
|
2751
|
-
|
|
2752
|
-
<td class="attributes">
|
|
2753
|
-
|
|
2754
|
-
<optional><br>
|
|
2755
|
-
|
|
2756
|
-
|
|
2757
|
-
|
|
2758
|
-
|
|
2759
|
-
|
|
2760
|
-
</td>
|
|
2761
|
-
|
|
2762
|
-
|
|
2763
|
-
|
|
2764
|
-
<td class="default">
|
|
2765
|
-
|
|
2766
|
-
<code>20</code>
|
|
2767
|
-
|
|
2768
|
-
</td>
|
|
2769
|
-
|
|
2770
|
-
|
|
2771
|
-
<td class="description last">The limit of results per page.</td>
|
|
2772
|
-
</tr>
|
|
2773
|
-
|
|
2774
|
-
|
|
2775
|
-
|
|
2776
|
-
<tr>
|
|
2777
|
-
|
|
2778
|
-
<td class="name"><code>params.page</code></td>
|
|
2779
|
-
|
|
2780
|
-
|
|
2781
|
-
<td class="type">
|
|
2782
|
-
|
|
2783
|
-
|
|
2784
|
-
<span class="param-type">number</span>
|
|
2785
|
-
|
|
2786
|
-
|
|
2787
|
-
|
|
2788
|
-
|
|
2789
|
-
</td>
|
|
2790
|
-
|
|
2791
|
-
|
|
2792
|
-
<td class="attributes">
|
|
2793
|
-
|
|
2794
|
-
<optional><br>
|
|
2795
|
-
|
|
2796
|
-
|
|
2797
|
-
|
|
2798
|
-
|
|
2799
|
-
|
|
2800
|
-
</td>
|
|
2801
|
-
|
|
2802
|
-
|
|
2803
|
-
|
|
2804
|
-
<td class="default">
|
|
2805
|
-
|
|
2806
|
-
<code>1</code>
|
|
2807
|
-
|
|
2808
|
-
</td>
|
|
2809
|
-
|
|
2810
|
-
|
|
2811
|
-
<td class="description last">The page number for pagination.</td>
|
|
2812
|
-
</tr>
|
|
2813
|
-
|
|
2814
|
-
|
|
2815
|
-
</tbody>
|
|
2816
|
-
</table>
|
|
2817
|
-
|
|
2818
|
-
|
|
2819
|
-
|
|
2820
|
-
|
|
2821
|
-
|
|
2822
|
-
|
|
2823
|
-
|
|
2824
|
-
|
|
2825
|
-
|
|
2826
|
-
|
|
2827
|
-
|
|
2828
|
-
|
|
2829
|
-
|
|
2830
|
-
|
|
2831
|
-
|
|
2832
|
-
|
|
2833
|
-
<h5 class="h5-returns">Returns:</h5>
|
|
2834
|
-
|
|
2835
|
-
|
|
2836
|
-
<div class="param-desc">
|
|
2837
|
-
- Returns an object containing in-progress content if found, otherwise null.
|
|
2838
|
-
</div>
|
|
2839
|
-
|
|
2840
|
-
|
|
2841
|
-
|
|
2842
|
-
<dl class="param-type">
|
|
2843
|
-
<dt>
|
|
2844
|
-
Type
|
|
2845
|
-
</dt>
|
|
2846
|
-
<dd>
|
|
2847
|
-
|
|
2848
|
-
<span class="param-type">Promise.<(Object|null)></span>
|
|
2849
|
-
|
|
2850
|
-
|
|
2851
|
-
|
|
2852
|
-
</dd>
|
|
2853
|
-
</dl>
|
|
2854
|
-
|
|
2855
|
-
|
|
2856
|
-
|
|
2857
|
-
|
|
2858
|
-
|
|
2859
|
-
|
|
2860
|
-
|
|
2861
|
-
|
|
2862
|
-
|
|
2863
|
-
|
|
2864
|
-
<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>
|
|
2865
|
-
|
|
2866
|
-
|
|
2867
|
-
|
|
2868
|
-
|
|
2869
|
-
|
|
2870
|
-
|
|
2871
|
-
<dl class="details">
|
|
2872
|
-
|
|
2873
|
-
<dt class="tag-description">Description:</dt>
|
|
2874
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetches the completion status of a specific lesson for the current user.</li></ul></dd>
|
|
2875
|
-
|
|
2876
|
-
|
|
2877
|
-
|
|
2878
|
-
<dt class="tag-source">Source:</dt>
|
|
2879
|
-
<dd class="tag-source"><ul class="dummy"><li>
|
|
2880
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line36">line 36</a>
|
|
2881
|
-
</li></ul></dd>
|
|
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
|
-
|
|
2911
|
-
|
|
2912
|
-
|
|
2913
|
-
</dl>
|
|
2914
|
-
|
|
2915
|
-
|
|
2916
|
-
|
|
2917
|
-
|
|
2918
|
-
|
|
2919
|
-
|
|
2920
|
-
|
|
2921
|
-
|
|
2922
|
-
|
|
2923
|
-
|
|
2924
|
-
|
|
2925
|
-
<h5 class="h5-examples">Example</h5>
|
|
2926
|
-
|
|
2927
|
-
<pre class="prettyprint"><code>fetchCurrentSongComplete('user123', 'lesson456', 'csrf-token')
|
|
2928
|
-
.then(status => console.log(status))
|
|
2929
|
-
.catch(error => console.error(error));</code></pre>
|
|
2930
|
-
|
|
2931
|
-
|
|
2932
|
-
|
|
2933
|
-
|
|
2934
|
-
<h5 class="h5-parameters">Parameters:</h5>
|
|
2935
|
-
|
|
2936
|
-
|
|
2937
|
-
<table class="params">
|
|
2938
|
-
<thead>
|
|
2939
|
-
<tr>
|
|
2940
|
-
|
|
2941
|
-
<th>Name</th>
|
|
2942
|
-
|
|
2943
|
-
|
|
2944
|
-
<th>Type</th>
|
|
2945
|
-
|
|
2946
|
-
|
|
2947
|
-
|
|
2948
|
-
|
|
2949
|
-
|
|
2950
|
-
<th class="last">Description</th>
|
|
2951
|
-
</tr>
|
|
2952
|
-
</thead>
|
|
2953
|
-
|
|
2954
|
-
<tbody>
|
|
2955
|
-
|
|
2956
|
-
|
|
2957
|
-
<tr>
|
|
2958
|
-
|
|
2959
|
-
<td class="name"><code>content_id</code></td>
|
|
2960
|
-
|
|
2961
|
-
|
|
2962
|
-
<td class="type">
|
|
2963
|
-
|
|
2964
|
-
|
|
2965
|
-
<span class="param-type">string</span>
|
|
2966
|
-
|
|
2967
|
-
|
|
2968
|
-
|
|
2969
|
-
|
|
2970
|
-
</td>
|
|
2971
|
-
|
|
2972
|
-
|
|
2973
|
-
|
|
2974
|
-
|
|
2975
|
-
|
|
2976
|
-
<td class="description last">The ID of the lesson content to check.</td>
|
|
2977
|
-
</tr>
|
|
2978
|
-
|
|
2979
|
-
|
|
2980
|
-
</tbody>
|
|
2981
|
-
</table>
|
|
2982
|
-
|
|
2983
|
-
|
|
2984
|
-
|
|
2985
|
-
|
|
2986
|
-
|
|
2987
|
-
|
|
2988
|
-
|
|
2989
|
-
|
|
2990
|
-
|
|
2991
|
-
|
|
2992
|
-
|
|
2993
|
-
|
|
2994
|
-
|
|
2995
|
-
|
|
2996
|
-
|
|
2997
|
-
|
|
2998
|
-
<h5 class="h5-returns">Returns:</h5>
|
|
2999
|
-
|
|
3000
|
-
|
|
3001
|
-
<div class="param-desc">
|
|
3002
|
-
- Returns the completion status object if found, otherwise null.
|
|
3003
|
-
</div>
|
|
3004
|
-
|
|
3005
|
-
|
|
3006
|
-
|
|
3007
|
-
<dl class="param-type">
|
|
3008
|
-
<dt>
|
|
3009
|
-
Type
|
|
3010
|
-
</dt>
|
|
3011
|
-
<dd>
|
|
3012
|
-
|
|
3013
|
-
<span class="param-type">Promise.<(Object|null)></span>
|
|
3014
|
-
|
|
3015
|
-
|
|
3016
|
-
|
|
3017
|
-
</dd>
|
|
3018
|
-
</dl>
|
|
3019
|
-
|
|
3020
|
-
|
|
3021
|
-
|
|
3022
|
-
|
|
3023
|
-
|
|
3024
|
-
|
|
3025
|
-
|
|
3026
|
-
|
|
3027
|
-
|
|
3028
|
-
|
|
3029
|
-
<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>
|
|
3030
|
-
|
|
3031
|
-
|
|
3032
|
-
|
|
3033
|
-
|
|
3034
|
-
|
|
3035
|
-
|
|
3036
|
-
<dl class="details">
|
|
3037
|
-
|
|
3038
|
-
<dt class="tag-description">Description:</dt>
|
|
3039
|
-
<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>
|
|
3040
|
-
|
|
3041
|
-
|
|
3042
|
-
|
|
3043
|
-
<dt class="tag-source">Source:</dt>
|
|
3044
|
-
<dd class="tag-source"><ul class="dummy"><li>
|
|
3045
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line140">line 140</a>
|
|
3046
|
-
</li></ul></dd>
|
|
3047
|
-
|
|
3048
|
-
|
|
3049
|
-
|
|
3050
|
-
|
|
3051
|
-
|
|
3052
|
-
|
|
3053
|
-
|
|
3054
|
-
|
|
3055
|
-
|
|
3056
|
-
|
|
3057
|
-
|
|
3058
|
-
|
|
3059
|
-
|
|
3060
|
-
|
|
3061
|
-
|
|
3062
|
-
|
|
3063
|
-
|
|
3064
|
-
|
|
3065
|
-
|
|
3066
|
-
|
|
3067
|
-
|
|
3068
|
-
|
|
3069
|
-
|
|
3070
|
-
|
|
3071
|
-
|
|
3072
|
-
|
|
3073
|
-
|
|
3074
|
-
|
|
3075
|
-
|
|
3076
|
-
|
|
3077
|
-
|
|
3078
|
-
</dl>
|
|
3079
|
-
|
|
3080
|
-
|
|
3081
|
-
|
|
3082
|
-
|
|
3083
|
-
|
|
3084
|
-
|
|
3085
|
-
|
|
3086
|
-
|
|
3087
|
-
|
|
3088
|
-
|
|
3089
|
-
|
|
3090
|
-
<h5 class="h5-examples">Example</h5>
|
|
3091
|
-
|
|
3092
|
-
<pre class="prettyprint"><code>fetchContentInProgress('song', 'drumeo')
|
|
3093
|
-
.then(songs => console.log(songs))
|
|
3094
|
-
.catch(error => console.error(error));</code></pre>
|
|
3095
|
-
|
|
3096
|
-
|
|
3097
|
-
|
|
3098
|
-
|
|
3099
|
-
<h5 class="h5-parameters">Parameters:</h5>
|
|
3100
|
-
|
|
3101
|
-
|
|
3102
|
-
<table class="params">
|
|
3103
|
-
<thead>
|
|
3104
|
-
<tr>
|
|
3105
|
-
|
|
3106
|
-
<th>Name</th>
|
|
3107
|
-
|
|
3108
|
-
|
|
3109
|
-
<th>Type</th>
|
|
3110
|
-
|
|
3111
|
-
|
|
3112
|
-
<th>Attributes</th>
|
|
3113
|
-
|
|
3114
|
-
|
|
3115
|
-
|
|
3116
|
-
<th>Default</th>
|
|
3117
|
-
|
|
3118
|
-
|
|
3119
|
-
<th class="last">Description</th>
|
|
3120
|
-
</tr>
|
|
3121
|
-
</thead>
|
|
3122
|
-
|
|
3123
|
-
<tbody>
|
|
3124
|
-
|
|
3125
|
-
|
|
3126
|
-
<tr>
|
|
3127
|
-
|
|
3128
|
-
<td class="name"><code>type</code></td>
|
|
3129
|
-
|
|
3130
|
-
|
|
3131
|
-
<td class="type">
|
|
3132
|
-
|
|
3133
|
-
|
|
3134
|
-
<span class="param-type">string</span>
|
|
3135
|
-
|
|
3136
|
-
|
|
3137
|
-
|
|
3138
|
-
|
|
3139
|
-
</td>
|
|
3140
|
-
|
|
3141
|
-
|
|
3142
|
-
<td class="attributes">
|
|
3143
|
-
|
|
3144
|
-
|
|
3145
|
-
|
|
3146
|
-
|
|
3147
|
-
|
|
3148
|
-
</td>
|
|
3149
|
-
|
|
3150
|
-
|
|
3151
|
-
|
|
3152
|
-
<td class="default">
|
|
3153
|
-
|
|
3154
|
-
</td>
|
|
3155
|
-
|
|
3156
|
-
|
|
3157
|
-
<td class="description last">The content type associated with the content.</td>
|
|
3158
|
-
</tr>
|
|
3159
|
-
|
|
3160
|
-
|
|
3161
|
-
|
|
3162
|
-
<tr>
|
|
3163
|
-
|
|
3164
|
-
<td class="name"><code>brand</code></td>
|
|
3165
|
-
|
|
3166
|
-
|
|
3167
|
-
<td class="type">
|
|
3168
|
-
|
|
3169
|
-
|
|
3170
|
-
<span class="param-type">string</span>
|
|
3171
|
-
|
|
3172
|
-
|
|
3173
|
-
|
|
3174
|
-
|
|
3175
|
-
</td>
|
|
3176
|
-
|
|
3177
|
-
|
|
3178
|
-
<td class="attributes">
|
|
3179
|
-
|
|
3180
|
-
|
|
3181
|
-
|
|
3182
|
-
|
|
3183
|
-
|
|
3184
|
-
</td>
|
|
3185
|
-
|
|
3186
|
-
|
|
3187
|
-
|
|
3188
|
-
<td class="default">
|
|
3189
|
-
|
|
3190
|
-
</td>
|
|
3191
|
-
|
|
3192
|
-
|
|
3193
|
-
<td class="description last">The brand associated with the content.</td>
|
|
3194
|
-
</tr>
|
|
3195
|
-
|
|
3196
|
-
|
|
3197
|
-
|
|
3198
|
-
<tr>
|
|
3199
|
-
|
|
3200
|
-
<td class="name"><code>params.limit</code></td>
|
|
3201
|
-
|
|
3202
|
-
|
|
3203
|
-
<td class="type">
|
|
3204
|
-
|
|
3205
|
-
|
|
3206
|
-
<span class="param-type">number</span>
|
|
3207
|
-
|
|
3208
|
-
|
|
3209
|
-
|
|
3210
|
-
|
|
3211
|
-
</td>
|
|
3212
|
-
|
|
3213
|
-
|
|
3214
|
-
<td class="attributes">
|
|
3215
|
-
|
|
3216
|
-
<optional><br>
|
|
3217
|
-
|
|
3218
|
-
|
|
3219
|
-
|
|
3220
|
-
|
|
3221
|
-
|
|
3222
|
-
</td>
|
|
3223
|
-
|
|
3224
|
-
|
|
3225
|
-
|
|
3226
|
-
<td class="default">
|
|
3227
|
-
|
|
3228
|
-
<code>20</code>
|
|
3229
|
-
|
|
3230
|
-
</td>
|
|
3231
|
-
|
|
3232
|
-
|
|
3233
|
-
<td class="description last">The limit of results per page.</td>
|
|
3234
|
-
</tr>
|
|
3235
|
-
|
|
3236
|
-
|
|
3237
|
-
|
|
3238
|
-
<tr>
|
|
3239
|
-
|
|
3240
|
-
<td class="name"><code>params.page</code></td>
|
|
3241
|
-
|
|
3242
|
-
|
|
3243
|
-
<td class="type">
|
|
3244
|
-
|
|
3245
|
-
|
|
3246
|
-
<span class="param-type">number</span>
|
|
3247
|
-
|
|
3248
|
-
|
|
3249
|
-
|
|
3250
|
-
|
|
3251
|
-
</td>
|
|
3252
|
-
|
|
3253
|
-
|
|
3254
|
-
<td class="attributes">
|
|
3255
|
-
|
|
3256
|
-
<optional><br>
|
|
3257
|
-
|
|
3258
|
-
|
|
3259
|
-
|
|
3260
|
-
|
|
3261
|
-
|
|
3262
|
-
</td>
|
|
3263
|
-
|
|
3264
|
-
|
|
3265
|
-
|
|
3266
|
-
<td class="default">
|
|
3267
|
-
|
|
3268
|
-
<code>1</code>
|
|
3269
|
-
|
|
3270
|
-
</td>
|
|
3271
|
-
|
|
3272
|
-
|
|
3273
|
-
<td class="description last">The page number for pagination.</td>
|
|
3274
|
-
</tr>
|
|
3275
|
-
|
|
3276
|
-
|
|
3277
|
-
</tbody>
|
|
3278
|
-
</table>
|
|
3279
|
-
|
|
3280
|
-
|
|
3281
|
-
|
|
3282
|
-
|
|
3283
|
-
|
|
3284
|
-
|
|
3285
|
-
|
|
3286
|
-
|
|
3287
|
-
|
|
3288
|
-
|
|
3289
|
-
|
|
3290
|
-
|
|
3291
|
-
|
|
3292
|
-
|
|
3293
|
-
|
|
3294
|
-
|
|
3295
|
-
<h5 class="h5-returns">Returns:</h5>
|
|
3296
|
-
|
|
3297
|
-
|
|
3298
|
-
<div class="param-desc">
|
|
3299
|
-
- Returns an object containing in-progress content if found, otherwise null.
|
|
3300
|
-
</div>
|
|
3301
|
-
|
|
3302
|
-
|
|
3303
|
-
|
|
3304
|
-
<dl class="param-type">
|
|
3305
|
-
<dt>
|
|
3306
|
-
Type
|
|
3307
|
-
</dt>
|
|
3308
|
-
<dd>
|
|
3309
|
-
|
|
3310
|
-
<span class="param-type">Promise.<(Object|null)></span>
|
|
3311
|
-
|
|
3312
|
-
|
|
3313
|
-
|
|
3314
|
-
</dd>
|
|
3315
|
-
</dl>
|
|
3316
|
-
|
|
3317
|
-
|
|
3318
|
-
|
|
3319
|
-
|
|
3320
|
-
|
|
3321
|
-
|
|
3322
|
-
|
|
3323
|
-
|
|
3324
|
-
|
|
3325
|
-
|
|
3326
|
-
<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>
|
|
3327
|
-
|
|
3328
|
-
|
|
3329
|
-
|
|
3330
|
-
|
|
3331
|
-
|
|
3332
|
-
|
|
3333
|
-
<dl class="details">
|
|
3334
|
-
|
|
3335
|
-
<dt class="tag-description">Description:</dt>
|
|
3336
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetches user context data for a specific piece of content.</li></ul></dd>
|
|
3337
|
-
|
|
3338
|
-
|
|
3339
|
-
|
|
3340
|
-
<dt class="tag-source">Source:</dt>
|
|
3341
|
-
<dd class="tag-source"><ul class="dummy"><li>
|
|
3342
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line223">line 223</a>
|
|
3343
|
-
</li></ul></dd>
|
|
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
|
-
|
|
3373
|
-
|
|
3374
|
-
|
|
3375
|
-
</dl>
|
|
3376
|
-
|
|
3377
|
-
|
|
3378
|
-
|
|
3379
|
-
|
|
3380
|
-
|
|
3381
|
-
|
|
3382
|
-
|
|
3383
|
-
|
|
3384
|
-
|
|
3385
|
-
|
|
3386
|
-
|
|
3387
|
-
<h5 class="h5-examples">Example</h5>
|
|
3388
|
-
|
|
3389
|
-
<pre class="prettyprint"><code>fetchContentPageUserData(406548)
|
|
3390
|
-
.then(data => console.log(data))
|
|
3391
|
-
.catch(error => console.error(error));</code></pre>
|
|
3392
|
-
|
|
3393
|
-
|
|
3394
|
-
|
|
3395
|
-
|
|
3396
|
-
<h5 class="h5-parameters">Parameters:</h5>
|
|
3397
|
-
|
|
3398
|
-
|
|
3399
|
-
<table class="params">
|
|
3400
|
-
<thead>
|
|
3401
|
-
<tr>
|
|
3402
|
-
|
|
3403
|
-
<th>Name</th>
|
|
3404
|
-
|
|
3405
|
-
|
|
3406
|
-
<th>Type</th>
|
|
3407
|
-
|
|
3408
|
-
|
|
3409
|
-
|
|
3410
|
-
|
|
3411
|
-
|
|
3412
|
-
<th class="last">Description</th>
|
|
3413
|
-
</tr>
|
|
3414
|
-
</thead>
|
|
3415
|
-
|
|
3416
|
-
<tbody>
|
|
3417
|
-
|
|
3418
|
-
|
|
3419
|
-
<tr>
|
|
3420
|
-
|
|
3421
|
-
<td class="name"><code>contentId</code></td>
|
|
3422
|
-
|
|
3423
|
-
|
|
3424
|
-
<td class="type">
|
|
3425
|
-
|
|
3426
|
-
|
|
3427
|
-
<span class="param-type">int</span>
|
|
3428
|
-
|
|
3429
|
-
|
|
3430
|
-
|
|
3431
|
-
|
|
3432
|
-
</td>
|
|
3433
|
-
|
|
3434
|
-
|
|
3435
|
-
|
|
3436
|
-
|
|
3437
|
-
|
|
3438
|
-
<td class="description last">The content id.</td>
|
|
3439
|
-
</tr>
|
|
3440
|
-
|
|
3441
|
-
|
|
3442
|
-
</tbody>
|
|
3443
|
-
</table>
|
|
3444
|
-
|
|
3445
|
-
|
|
3446
|
-
|
|
3447
|
-
|
|
3448
|
-
|
|
3449
|
-
|
|
3450
|
-
|
|
3451
|
-
|
|
3452
|
-
|
|
3453
|
-
|
|
3454
|
-
|
|
3455
|
-
|
|
3456
|
-
|
|
3457
|
-
|
|
3458
|
-
|
|
3459
|
-
|
|
3460
|
-
<h5 class="h5-returns">Returns:</h5>
|
|
3461
|
-
|
|
3462
|
-
|
|
3463
|
-
<div class="param-desc">
|
|
3464
|
-
- Returns an object containing user context data if found, otherwise null.
|
|
3465
|
-
</div>
|
|
3466
|
-
|
|
3467
|
-
|
|
3468
|
-
|
|
3469
|
-
<dl class="param-type">
|
|
3470
|
-
<dt>
|
|
3471
|
-
Type
|
|
3472
|
-
</dt>
|
|
3473
|
-
<dd>
|
|
3474
|
-
|
|
3475
|
-
<span class="param-type">Promise.<(Object|null)></span>
|
|
3476
|
-
|
|
3477
|
-
|
|
3478
|
-
|
|
3479
|
-
</dd>
|
|
3480
|
-
</dl>
|
|
3481
|
-
|
|
3482
|
-
|
|
3483
|
-
|
|
3484
|
-
|
|
3485
|
-
|
|
3486
|
-
|
|
3487
|
-
|
|
3488
|
-
|
|
3489
|
-
|
|
3490
|
-
|
|
3491
|
-
<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>
|
|
3492
|
-
|
|
3493
|
-
|
|
3494
|
-
|
|
3495
|
-
|
|
3496
|
-
|
|
3497
|
-
|
|
3498
|
-
<dl class="details">
|
|
3499
|
-
|
|
3500
|
-
<dt class="tag-description">Description:</dt>
|
|
3501
|
-
<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>
|
|
3502
|
-
|
|
3503
|
-
|
|
3504
|
-
|
|
3505
|
-
<dt class="tag-source">Source:</dt>
|
|
3506
|
-
<dd class="tag-source"><ul class="dummy"><li>
|
|
3507
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line252">line 252</a>
|
|
3508
|
-
</li></ul></dd>
|
|
3509
|
-
|
|
3510
|
-
|
|
3511
|
-
|
|
3512
|
-
|
|
3513
|
-
|
|
3514
|
-
|
|
3515
|
-
|
|
3516
|
-
|
|
3517
|
-
|
|
3518
|
-
|
|
3519
|
-
|
|
3520
|
-
|
|
3521
|
-
|
|
3522
|
-
|
|
3523
|
-
|
|
3524
|
-
|
|
3525
|
-
|
|
3526
|
-
|
|
3527
|
-
|
|
3528
|
-
|
|
3529
|
-
|
|
3530
|
-
|
|
3531
|
-
|
|
3532
|
-
|
|
3533
|
-
|
|
3534
|
-
|
|
3535
|
-
|
|
3536
|
-
|
|
3537
|
-
|
|
3538
|
-
|
|
3539
|
-
|
|
3540
|
-
</dl>
|
|
3541
|
-
|
|
3542
|
-
|
|
3543
|
-
|
|
3544
|
-
|
|
3545
|
-
|
|
3546
|
-
|
|
3547
|
-
|
|
3548
|
-
|
|
3549
|
-
|
|
3550
|
-
|
|
3551
|
-
|
|
3552
|
-
|
|
3553
|
-
|
|
3554
|
-
<h5 class="h5-parameters">Parameters:</h5>
|
|
3555
|
-
|
|
3556
|
-
|
|
3557
|
-
<table class="params">
|
|
3558
|
-
<thead>
|
|
3559
|
-
<tr>
|
|
3560
|
-
|
|
3561
|
-
<th>Name</th>
|
|
3562
|
-
|
|
3563
|
-
|
|
3564
|
-
<th>Type</th>
|
|
3565
|
-
|
|
3566
|
-
|
|
3567
|
-
|
|
3568
|
-
|
|
3569
|
-
|
|
3570
|
-
<th class="last">Description</th>
|
|
3571
|
-
</tr>
|
|
3572
|
-
</thead>
|
|
3573
|
-
|
|
3574
|
-
<tbody>
|
|
3575
|
-
|
|
3576
|
-
|
|
3577
|
-
<tr>
|
|
3578
|
-
|
|
3579
|
-
<td class="name"><code>contentId</code></td>
|
|
3580
|
-
|
|
3581
|
-
|
|
3582
|
-
<td class="type">
|
|
3583
|
-
|
|
3584
|
-
|
|
3585
|
-
<span class="param-type">int</span>
|
|
3586
|
-
|
|
3587
|
-
|
|
3588
|
-
|
|
3589
|
-
|
|
3590
|
-
</td>
|
|
3591
|
-
|
|
3592
|
-
|
|
3593
|
-
|
|
3594
|
-
|
|
3595
|
-
|
|
3596
|
-
<td class="description last">The id of the parent (method, level, or course) piece of content.</td>
|
|
3597
|
-
</tr>
|
|
3598
|
-
|
|
3599
|
-
|
|
3600
|
-
</tbody>
|
|
3601
|
-
</table>
|
|
3602
|
-
|
|
3603
|
-
|
|
3604
|
-
|
|
3605
|
-
|
|
3606
|
-
|
|
3607
|
-
|
|
3608
|
-
|
|
3609
|
-
|
|
3610
|
-
|
|
3611
|
-
|
|
3612
|
-
|
|
3613
|
-
|
|
3614
|
-
|
|
3615
|
-
|
|
3616
|
-
|
|
3617
|
-
|
|
3618
|
-
<h5 class="h5-returns">Returns:</h5>
|
|
3619
|
-
|
|
3620
|
-
|
|
3621
|
-
<div class="param-desc">
|
|
3622
|
-
- Returns and Object with the id and type of the next piece of content if found, otherwise null.
|
|
3623
|
-
</div>
|
|
3624
|
-
|
|
3625
|
-
|
|
3626
|
-
|
|
3627
|
-
<dl class="param-type">
|
|
3628
|
-
<dt>
|
|
3629
|
-
Type
|
|
3630
|
-
</dt>
|
|
3631
|
-
<dd>
|
|
3632
|
-
|
|
3633
|
-
<span class="param-type">Promise.<(Object|null)></span>
|
|
3634
|
-
|
|
3635
|
-
|
|
3636
|
-
|
|
3637
|
-
</dd>
|
|
3638
|
-
</dl>
|
|
3639
|
-
|
|
3640
|
-
|
|
3641
|
-
|
|
3642
|
-
|
|
3643
|
-
|
|
3644
|
-
|
|
3645
|
-
|
|
3646
|
-
|
|
3647
|
-
|
|
3648
|
-
|
|
3649
|
-
<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>
|
|
3650
|
-
|
|
3651
|
-
|
|
3652
|
-
|
|
3653
|
-
|
|
3654
|
-
|
|
3655
|
-
|
|
3656
|
-
<dl class="details">
|
|
3657
|
-
|
|
3658
|
-
<dt class="tag-description">Description:</dt>
|
|
3659
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetch all owned brand challenges for user</li></ul></dd>
|
|
3660
|
-
|
|
3661
|
-
|
|
3662
|
-
|
|
3663
|
-
<dt class="tag-source">Source:</dt>
|
|
3664
|
-
<dd class="tag-source"><ul class="dummy"><li>
|
|
3665
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line379">line 379</a>
|
|
3666
|
-
</li></ul></dd>
|
|
3667
|
-
|
|
3668
|
-
|
|
3669
|
-
|
|
3670
|
-
|
|
3671
|
-
|
|
3672
|
-
|
|
3673
|
-
|
|
3674
|
-
|
|
3675
|
-
|
|
3676
|
-
|
|
3677
|
-
|
|
3678
|
-
|
|
3679
|
-
|
|
3680
|
-
|
|
3681
|
-
|
|
3682
|
-
|
|
3683
|
-
|
|
3684
|
-
|
|
3685
|
-
|
|
3686
|
-
|
|
3687
|
-
|
|
3688
|
-
|
|
3689
|
-
|
|
3690
|
-
|
|
3691
|
-
|
|
3692
|
-
|
|
3693
|
-
|
|
3694
|
-
|
|
3695
|
-
|
|
3696
|
-
|
|
3697
|
-
|
|
3698
|
-
</dl>
|
|
3699
|
-
|
|
3700
|
-
|
|
3701
|
-
|
|
3702
|
-
|
|
3703
|
-
|
|
3704
|
-
|
|
3705
|
-
|
|
3706
|
-
|
|
3707
|
-
|
|
3708
|
-
|
|
3709
|
-
|
|
3710
|
-
|
|
3711
|
-
|
|
3712
|
-
<h5 class="h5-parameters">Parameters:</h5>
|
|
3713
|
-
|
|
3714
|
-
|
|
3715
|
-
<table class="params">
|
|
3716
|
-
<thead>
|
|
3717
|
-
<tr>
|
|
3718
|
-
|
|
3719
|
-
<th>Name</th>
|
|
3720
|
-
|
|
3721
|
-
|
|
3722
|
-
<th>Type</th>
|
|
3723
|
-
|
|
3724
|
-
|
|
3725
|
-
|
|
3726
|
-
|
|
3727
|
-
|
|
3728
|
-
<th class="last">Description</th>
|
|
3729
|
-
</tr>
|
|
3730
|
-
</thead>
|
|
3731
|
-
|
|
3732
|
-
<tbody>
|
|
3733
|
-
|
|
3734
|
-
|
|
3735
|
-
<tr>
|
|
3736
|
-
|
|
3737
|
-
<td class="name"><code>brand</code></td>
|
|
3738
|
-
|
|
3739
|
-
|
|
3740
|
-
<td class="type">
|
|
3741
|
-
|
|
3742
|
-
|
|
3743
|
-
<span class="param-type">string</span>
|
|
3744
|
-
|
|
|
3745
|
-
|
|
3746
|
-
<span class="param-type">null</span>
|
|
3747
|
-
|
|
3748
|
-
|
|
3749
|
-
|
|
3750
|
-
|
|
3751
|
-
</td>
|
|
3752
|
-
|
|
3753
|
-
|
|
3754
|
-
|
|
3755
|
-
|
|
3756
|
-
|
|
3757
|
-
<td class="description last">brand</td>
|
|
3758
|
-
</tr>
|
|
3759
|
-
|
|
3760
|
-
|
|
3761
|
-
|
|
3762
|
-
<tr>
|
|
3763
|
-
|
|
3764
|
-
<td class="name"><code>page</code></td>
|
|
3765
|
-
|
|
3766
|
-
|
|
3767
|
-
<td class="type">
|
|
3768
|
-
|
|
3769
|
-
|
|
3770
|
-
<span class="param-type">int</span>
|
|
3771
|
-
|
|
3772
|
-
|
|
3773
|
-
|
|
3774
|
-
|
|
3775
|
-
</td>
|
|
3776
|
-
|
|
3777
|
-
|
|
3778
|
-
|
|
3779
|
-
|
|
3780
|
-
|
|
3781
|
-
<td class="description last">page of data to pull</td>
|
|
3782
|
-
</tr>
|
|
3783
|
-
|
|
3784
|
-
|
|
3785
|
-
|
|
3786
|
-
<tr>
|
|
3787
|
-
|
|
3788
|
-
<td class="name"><code>limit</code></td>
|
|
3789
|
-
|
|
3790
|
-
|
|
3791
|
-
<td class="type">
|
|
3792
|
-
|
|
3793
|
-
|
|
3794
|
-
<span class="param-type">int</span>
|
|
3795
|
-
|
|
3796
|
-
|
|
3797
|
-
|
|
3798
|
-
|
|
3799
|
-
</td>
|
|
3800
|
-
|
|
3801
|
-
|
|
3802
|
-
|
|
3803
|
-
|
|
3804
|
-
|
|
3805
|
-
<td class="description last">number of elements to pull</td>
|
|
3806
|
-
</tr>
|
|
3807
|
-
|
|
3808
|
-
|
|
3809
|
-
</tbody>
|
|
3810
|
-
</table>
|
|
3811
|
-
|
|
3812
|
-
|
|
3813
|
-
|
|
3814
|
-
|
|
3815
|
-
|
|
3816
|
-
|
|
3817
|
-
|
|
3818
|
-
|
|
3819
|
-
|
|
3820
|
-
|
|
3821
|
-
|
|
3822
|
-
|
|
3823
|
-
|
|
3824
|
-
|
|
3825
|
-
|
|
3826
|
-
|
|
3827
|
-
<h5 class="h5-returns">Returns:</h5>
|
|
3828
|
-
|
|
3829
|
-
|
|
3830
|
-
|
|
3831
|
-
|
|
3832
|
-
<dl class="param-type">
|
|
3833
|
-
<dt>
|
|
3834
|
-
Type
|
|
3835
|
-
</dt>
|
|
3836
|
-
<dd>
|
|
3837
|
-
|
|
3838
|
-
<span class="param-type">Promise.<(any|null)></span>
|
|
3839
|
-
|
|
3840
|
-
|
|
3841
|
-
|
|
3842
|
-
</dd>
|
|
3843
|
-
</dl>
|
|
3844
|
-
|
|
3845
|
-
|
|
3846
|
-
|
|
3847
|
-
|
|
3848
|
-
|
|
3849
|
-
|
|
3850
|
-
|
|
3851
|
-
|
|
3852
|
-
|
|
3853
|
-
|
|
3854
|
-
<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>
|
|
3855
|
-
|
|
3856
|
-
|
|
3857
|
-
|
|
3858
|
-
|
|
3859
|
-
|
|
3860
|
-
|
|
3861
|
-
<dl class="details">
|
|
3862
|
-
|
|
3863
|
-
<dt class="tag-description">Description:</dt>
|
|
3864
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetches a paginated list of recent user activities.</li></ul></dd>
|
|
3865
|
-
|
|
3866
|
-
|
|
3867
|
-
|
|
3868
|
-
<dt class="tag-source">Source:</dt>
|
|
3869
|
-
<dd class="tag-source"><ul class="dummy"><li>
|
|
3870
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line905">line 905</a>
|
|
3871
|
-
</li></ul></dd>
|
|
3872
|
-
|
|
3873
|
-
|
|
3874
|
-
|
|
3875
|
-
|
|
3876
|
-
|
|
3877
|
-
|
|
3878
|
-
|
|
3879
|
-
|
|
3880
|
-
|
|
3881
|
-
|
|
3882
|
-
|
|
3883
|
-
|
|
3884
|
-
|
|
3885
|
-
|
|
3886
|
-
|
|
3887
|
-
|
|
3888
|
-
|
|
3889
|
-
|
|
3890
|
-
|
|
3891
|
-
|
|
3892
|
-
|
|
3893
|
-
|
|
3894
|
-
|
|
3895
|
-
|
|
3896
|
-
|
|
3897
|
-
|
|
3898
|
-
|
|
3899
|
-
|
|
3900
|
-
|
|
3901
|
-
|
|
3902
|
-
|
|
3903
|
-
</dl>
|
|
3904
|
-
|
|
3905
|
-
|
|
3906
|
-
|
|
3907
|
-
|
|
3908
|
-
|
|
3909
|
-
|
|
3910
|
-
|
|
3911
|
-
|
|
3912
|
-
|
|
3913
|
-
|
|
3914
|
-
|
|
3915
|
-
<h5 class="h5-examples">Example</h5>
|
|
3916
|
-
|
|
3917
|
-
<pre class="prettyprint"><code>fetchRecentUserActivities({ page: 2, limit: 5 })
|
|
3918
|
-
.then(activities => console.log(activities))
|
|
3919
|
-
.catch(error => console.error(error));</code></pre>
|
|
3920
|
-
|
|
3921
|
-
|
|
3922
|
-
|
|
3923
|
-
|
|
3924
|
-
<h5 class="h5-parameters">Parameters:</h5>
|
|
3925
|
-
|
|
3926
|
-
|
|
3927
|
-
<table class="params">
|
|
3928
|
-
<thead>
|
|
3929
|
-
<tr>
|
|
3930
|
-
|
|
3931
|
-
<th>Name</th>
|
|
3932
|
-
|
|
3933
|
-
|
|
3934
|
-
<th>Type</th>
|
|
3935
|
-
|
|
3936
|
-
|
|
3937
|
-
<th>Attributes</th>
|
|
3938
|
-
|
|
3939
|
-
|
|
3940
|
-
|
|
3941
|
-
<th>Default</th>
|
|
3942
|
-
|
|
3943
|
-
|
|
3944
|
-
<th class="last">Description</th>
|
|
3945
|
-
</tr>
|
|
3946
|
-
</thead>
|
|
3947
|
-
|
|
3948
|
-
<tbody>
|
|
3949
|
-
|
|
3950
|
-
|
|
3951
|
-
<tr>
|
|
3952
|
-
|
|
3953
|
-
<td class="name"><code>params</code></td>
|
|
3954
|
-
|
|
3955
|
-
|
|
3956
|
-
<td class="type">
|
|
3957
|
-
|
|
3958
|
-
|
|
3959
|
-
<span class="param-type">Object</span>
|
|
3960
|
-
|
|
3961
|
-
|
|
3962
|
-
|
|
3963
|
-
|
|
3964
|
-
</td>
|
|
3965
|
-
|
|
3966
|
-
|
|
3967
|
-
<td class="attributes">
|
|
3968
|
-
|
|
3969
|
-
<optional><br>
|
|
3970
|
-
|
|
3971
|
-
|
|
3972
|
-
|
|
3973
|
-
|
|
3974
|
-
|
|
3975
|
-
</td>
|
|
3976
|
-
|
|
3977
|
-
|
|
3978
|
-
|
|
3979
|
-
<td class="default">
|
|
3980
|
-
|
|
3981
|
-
<code>{}</code>
|
|
3982
|
-
|
|
3983
|
-
</td>
|
|
3984
|
-
|
|
3985
|
-
|
|
3986
|
-
<td class="description last">Optional parameters.
|
|
3987
|
-
<h6>Properties</h6>
|
|
3988
|
-
|
|
3989
|
-
|
|
3990
|
-
<table class="params">
|
|
3991
|
-
<thead>
|
|
3992
|
-
<tr>
|
|
3993
|
-
|
|
3994
|
-
<th>Name</th>
|
|
3995
|
-
|
|
3996
|
-
|
|
3997
|
-
<th>Type</th>
|
|
3998
|
-
|
|
3999
|
-
|
|
4000
|
-
<th>Attributes</th>
|
|
4001
|
-
|
|
4002
|
-
|
|
4003
|
-
|
|
4004
|
-
<th>Default</th>
|
|
4005
|
-
|
|
4006
|
-
|
|
4007
|
-
<th class="last">Description</th>
|
|
4008
|
-
</tr>
|
|
4009
|
-
</thead>
|
|
4010
|
-
|
|
4011
|
-
<tbody>
|
|
4012
|
-
|
|
4013
|
-
|
|
4014
|
-
<tr>
|
|
4015
|
-
|
|
4016
|
-
<td class="name"><code>page</code></td>
|
|
4017
|
-
|
|
4018
|
-
|
|
4019
|
-
<td class="type">
|
|
4020
|
-
|
|
4021
|
-
|
|
4022
|
-
<span class="param-type">number</span>
|
|
4023
|
-
|
|
4024
|
-
|
|
4025
|
-
|
|
4026
|
-
|
|
4027
|
-
</td>
|
|
4028
|
-
|
|
4029
|
-
|
|
4030
|
-
<td class="attributes">
|
|
4031
|
-
|
|
4032
|
-
<optional><br>
|
|
4033
|
-
|
|
4034
|
-
|
|
4035
|
-
|
|
4036
|
-
|
|
4037
|
-
|
|
4038
|
-
</td>
|
|
4039
|
-
|
|
4040
|
-
|
|
4041
|
-
|
|
4042
|
-
<td class="default">
|
|
4043
|
-
|
|
4044
|
-
<code>1</code>
|
|
4045
|
-
|
|
4046
|
-
</td>
|
|
4047
|
-
|
|
4048
|
-
|
|
4049
|
-
<td class="description last">The page number for pagination.</td>
|
|
4050
|
-
</tr>
|
|
4051
|
-
|
|
4052
|
-
|
|
4053
|
-
|
|
4054
|
-
<tr>
|
|
4055
|
-
|
|
4056
|
-
<td class="name"><code>limit</code></td>
|
|
4057
|
-
|
|
4058
|
-
|
|
4059
|
-
<td class="type">
|
|
4060
|
-
|
|
4061
|
-
|
|
4062
|
-
<span class="param-type">number</span>
|
|
4063
|
-
|
|
4064
|
-
|
|
4065
|
-
|
|
4066
|
-
|
|
4067
|
-
</td>
|
|
4068
|
-
|
|
4069
|
-
|
|
4070
|
-
<td class="attributes">
|
|
4071
|
-
|
|
4072
|
-
<optional><br>
|
|
4073
|
-
|
|
4074
|
-
|
|
4075
|
-
|
|
4076
|
-
|
|
4077
|
-
|
|
4078
|
-
</td>
|
|
4079
|
-
|
|
4080
|
-
|
|
4081
|
-
|
|
4082
|
-
<td class="default">
|
|
4083
|
-
|
|
4084
|
-
<code>10</code>
|
|
4085
|
-
|
|
4086
|
-
</td>
|
|
4087
|
-
|
|
4088
|
-
|
|
4089
|
-
<td class="description last">The number of results per page.</td>
|
|
4090
|
-
</tr>
|
|
4091
|
-
|
|
4092
|
-
|
|
4093
|
-
|
|
4094
|
-
<tr>
|
|
4095
|
-
|
|
4096
|
-
<td class="name"><code>tabName</code></td>
|
|
4097
|
-
|
|
4098
|
-
|
|
4099
|
-
<td class="type">
|
|
4100
|
-
|
|
4101
|
-
|
|
4102
|
-
<span class="param-type">string</span>
|
|
4103
|
-
|
|
|
4104
|
-
|
|
4105
|
-
<span class="param-type">null</span>
|
|
4106
|
-
|
|
4107
|
-
|
|
4108
|
-
|
|
4109
|
-
|
|
4110
|
-
</td>
|
|
4111
|
-
|
|
4112
|
-
|
|
4113
|
-
<td class="attributes">
|
|
4114
|
-
|
|
4115
|
-
<optional><br>
|
|
4116
|
-
|
|
4117
|
-
|
|
4118
|
-
|
|
4119
|
-
|
|
4120
|
-
|
|
4121
|
-
</td>
|
|
4122
|
-
|
|
4123
|
-
|
|
4124
|
-
|
|
4125
|
-
<td class="default">
|
|
4126
|
-
|
|
4127
|
-
<code>null</code>
|
|
4128
|
-
|
|
4129
|
-
</td>
|
|
4130
|
-
|
|
4131
|
-
|
|
4132
|
-
<td class="description last">Optional filter for activity type/tab.</td>
|
|
4133
|
-
</tr>
|
|
4134
|
-
|
|
4135
|
-
|
|
4136
|
-
</tbody>
|
|
4137
|
-
</table>
|
|
4138
|
-
|
|
4139
|
-
</td>
|
|
4140
|
-
</tr>
|
|
4141
|
-
|
|
4142
|
-
|
|
4143
|
-
</tbody>
|
|
4144
|
-
</table>
|
|
4145
|
-
|
|
4146
|
-
|
|
4147
|
-
|
|
4148
|
-
|
|
4149
|
-
|
|
4150
|
-
|
|
4151
|
-
|
|
4152
|
-
|
|
4153
|
-
|
|
4154
|
-
|
|
4155
|
-
|
|
4156
|
-
|
|
4157
|
-
|
|
4158
|
-
|
|
4159
|
-
|
|
4160
|
-
|
|
4161
|
-
<h5 class="h5-returns">Returns:</h5>
|
|
4162
|
-
|
|
4163
|
-
|
|
4164
|
-
<div class="param-desc">
|
|
4165
|
-
- A promise that resolves to a paginated object of user activities.
|
|
4166
|
-
</div>
|
|
4167
|
-
|
|
4168
|
-
|
|
4169
|
-
|
|
4170
|
-
<dl class="param-type">
|
|
4171
|
-
<dt>
|
|
4172
|
-
Type
|
|
4173
|
-
</dt>
|
|
4174
|
-
<dd>
|
|
4175
|
-
|
|
4176
|
-
<span class="param-type">Promise.<PaginatedActivities></span>
|
|
4177
|
-
|
|
4178
|
-
|
|
4179
|
-
|
|
4180
|
-
</dd>
|
|
4181
|
-
</dl>
|
|
4182
|
-
|
|
4183
|
-
|
|
4184
|
-
|
|
4185
|
-
|
|
4186
|
-
|
|
4187
|
-
|
|
4188
|
-
|
|
4189
|
-
|
|
4190
|
-
|
|
4191
|
-
|
|
4192
|
-
<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>
|
|
4193
|
-
|
|
4194
|
-
|
|
4195
|
-
|
|
4196
|
-
|
|
4197
|
-
|
|
4198
|
-
|
|
4199
|
-
<dl class="details">
|
|
4200
|
-
|
|
4201
|
-
<dt class="tag-description">Description:</dt>
|
|
4202
|
-
<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>
|
|
4203
|
-
|
|
4204
|
-
|
|
4205
|
-
|
|
4206
|
-
<dt class="tag-source">Source:</dt>
|
|
4207
|
-
<dd class="tag-source"><ul class="dummy"><li>
|
|
4208
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line103">line 103</a>
|
|
4209
|
-
</li></ul></dd>
|
|
4210
|
-
|
|
4211
|
-
|
|
4212
|
-
|
|
4213
|
-
|
|
4214
|
-
|
|
4215
|
-
|
|
4216
|
-
|
|
4217
|
-
|
|
4218
|
-
|
|
4219
|
-
|
|
4220
|
-
|
|
4221
|
-
|
|
4222
|
-
|
|
4223
|
-
|
|
4224
|
-
|
|
4225
|
-
|
|
4226
|
-
|
|
4227
|
-
|
|
4228
|
-
|
|
4229
|
-
|
|
4230
|
-
|
|
4231
|
-
|
|
4232
|
-
|
|
4233
|
-
|
|
4234
|
-
|
|
4235
|
-
|
|
4236
|
-
|
|
4237
|
-
|
|
4238
|
-
|
|
4239
|
-
|
|
4240
|
-
|
|
4241
|
-
</dl>
|
|
4242
|
-
|
|
4243
|
-
|
|
4244
|
-
|
|
4245
|
-
|
|
4246
|
-
|
|
4247
|
-
|
|
4248
|
-
|
|
4249
|
-
|
|
4250
|
-
|
|
4251
|
-
|
|
4252
|
-
|
|
4253
|
-
<h5 class="h5-examples">Example</h5>
|
|
4254
|
-
|
|
4255
|
-
<pre class="prettyprint"><code>fetchSongsInProgress('drumeo')
|
|
4256
|
-
.then(songs => console.log(songs))
|
|
4257
|
-
.catch(error => console.error(error));</code></pre>
|
|
4258
|
-
|
|
4259
|
-
|
|
4260
|
-
|
|
4261
|
-
|
|
4262
|
-
<h5 class="h5-parameters">Parameters:</h5>
|
|
4263
|
-
|
|
4264
|
-
|
|
4265
|
-
<table class="params">
|
|
4266
|
-
<thead>
|
|
4267
|
-
<tr>
|
|
4268
|
-
|
|
4269
|
-
<th>Name</th>
|
|
4270
|
-
|
|
4271
|
-
|
|
4272
|
-
<th>Type</th>
|
|
4273
|
-
|
|
4274
|
-
|
|
4275
|
-
|
|
4276
|
-
|
|
4277
|
-
|
|
4278
|
-
<th class="last">Description</th>
|
|
4279
|
-
</tr>
|
|
4280
|
-
</thead>
|
|
4281
|
-
|
|
4282
|
-
<tbody>
|
|
4283
|
-
|
|
4284
|
-
|
|
4285
|
-
<tr>
|
|
4286
|
-
|
|
4287
|
-
<td class="name"><code>brand</code></td>
|
|
4288
|
-
|
|
4289
|
-
|
|
4290
|
-
<td class="type">
|
|
4291
|
-
|
|
4292
|
-
|
|
4293
|
-
<span class="param-type">string</span>
|
|
4294
|
-
|
|
4295
|
-
|
|
4296
|
-
|
|
4297
|
-
|
|
4298
|
-
</td>
|
|
4299
|
-
|
|
4300
|
-
|
|
4301
|
-
|
|
4302
|
-
|
|
4303
|
-
|
|
4304
|
-
<td class="description last">The brand associated with the songs.</td>
|
|
4305
|
-
</tr>
|
|
4306
|
-
|
|
4307
|
-
|
|
4308
|
-
</tbody>
|
|
4309
|
-
</table>
|
|
4310
|
-
|
|
4311
|
-
|
|
4312
|
-
|
|
4313
|
-
|
|
4314
|
-
|
|
4315
|
-
|
|
4316
|
-
|
|
4317
|
-
|
|
4318
|
-
|
|
4319
|
-
|
|
4320
|
-
|
|
4321
|
-
|
|
4322
|
-
|
|
4323
|
-
|
|
4324
|
-
|
|
4325
|
-
|
|
4326
|
-
<h5 class="h5-returns">Returns:</h5>
|
|
4327
|
-
|
|
4328
|
-
|
|
4329
|
-
<div class="param-desc">
|
|
4330
|
-
- Returns an object containing in-progress songs if found, otherwise null.
|
|
4331
|
-
</div>
|
|
4332
|
-
|
|
4333
|
-
|
|
4334
|
-
|
|
4335
|
-
<dl class="param-type">
|
|
4336
|
-
<dt>
|
|
4337
|
-
Type
|
|
4338
|
-
</dt>
|
|
4339
|
-
<dd>
|
|
4340
|
-
|
|
4341
|
-
<span class="param-type">Promise.<(Object|null)></span>
|
|
4342
|
-
|
|
4343
|
-
|
|
4344
|
-
|
|
4345
|
-
</dd>
|
|
4346
|
-
</dl>
|
|
4347
|
-
|
|
4348
|
-
|
|
4349
|
-
|
|
4350
|
-
|
|
4351
|
-
|
|
4352
|
-
|
|
4353
|
-
|
|
4354
|
-
|
|
4355
|
-
|
|
4356
|
-
|
|
4357
|
-
<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>
|
|
4358
|
-
|
|
4359
|
-
|
|
4360
|
-
|
|
4361
|
-
|
|
4362
|
-
|
|
4363
|
-
|
|
4364
|
-
<dl class="details">
|
|
4365
|
-
|
|
4366
|
-
<dt class="tag-description">Description:</dt>
|
|
4367
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetch the top comment for a given content</li></ul></dd>
|
|
4368
|
-
|
|
4369
|
-
|
|
4370
|
-
|
|
4371
|
-
<dt class="tag-source">Source:</dt>
|
|
4372
|
-
<dd class="tag-source"><ul class="dummy"><li>
|
|
4373
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line605">line 605</a>
|
|
4374
|
-
</li></ul></dd>
|
|
4375
|
-
|
|
4376
|
-
|
|
4377
|
-
|
|
4378
|
-
|
|
4379
|
-
|
|
4380
|
-
|
|
4381
|
-
|
|
4382
|
-
|
|
4383
|
-
|
|
4384
|
-
|
|
4385
|
-
|
|
4386
|
-
|
|
4387
|
-
|
|
4388
|
-
|
|
4389
|
-
|
|
4390
|
-
|
|
4391
|
-
|
|
4392
|
-
|
|
4393
|
-
|
|
4394
|
-
|
|
4395
|
-
|
|
4396
|
-
|
|
4397
|
-
|
|
4398
|
-
|
|
4399
|
-
|
|
4400
|
-
|
|
4401
|
-
|
|
4402
|
-
|
|
4403
|
-
|
|
1971
|
+
<td class="description last">The brand associated with the content.</td>
|
|
1972
|
+
</tr>
|
|
4404
1973
|
|
|
4405
1974
|
|
|
4406
|
-
</dl>
|
|
4407
|
-
|
|
4408
|
-
|
|
4409
|
-
|
|
4410
|
-
|
|
4411
|
-
|
|
4412
|
-
|
|
4413
|
-
|
|
4414
|
-
|
|
4415
1975
|
|
|
1976
|
+
<tr>
|
|
1977
|
+
|
|
1978
|
+
<td class="name"><code>params.limit</code></td>
|
|
1979
|
+
|
|
4416
1980
|
|
|
1981
|
+
<td class="type">
|
|
1982
|
+
|
|
1983
|
+
|
|
1984
|
+
<span class="param-type">number</span>
|
|
4417
1985
|
|
|
4418
1986
|
|
|
4419
1987
|
|
|
4420
|
-
|
|
4421
|
-
|
|
1988
|
+
|
|
1989
|
+
</td>
|
|
4422
1990
|
|
|
4423
|
-
|
|
4424
|
-
|
|
4425
|
-
|
|
4426
|
-
|
|
4427
|
-
|
|
4428
|
-
|
|
1991
|
+
|
|
1992
|
+
<td class="attributes">
|
|
1993
|
+
|
|
1994
|
+
<optional><br>
|
|
1995
|
+
|
|
4429
1996
|
|
|
4430
|
-
|
|
1997
|
+
|
|
4431
1998
|
|
|
4432
|
-
|
|
1999
|
+
|
|
2000
|
+
</td>
|
|
2001
|
+
|
|
4433
2002
|
|
|
4434
|
-
|
|
2003
|
+
|
|
2004
|
+
<td class="default">
|
|
2005
|
+
|
|
2006
|
+
<code>20</code>
|
|
2007
|
+
|
|
2008
|
+
</td>
|
|
2009
|
+
|
|
4435
2010
|
|
|
4436
|
-
|
|
4437
|
-
|
|
4438
|
-
</thead>
|
|
2011
|
+
<td class="description last">The limit of results per page.</td>
|
|
2012
|
+
</tr>
|
|
4439
2013
|
|
|
4440
|
-
<tbody>
|
|
4441
2014
|
|
|
4442
2015
|
|
|
4443
2016
|
<tr>
|
|
4444
2017
|
|
|
4445
|
-
<td class="name"><code>
|
|
2018
|
+
<td class="name"><code>params.page</code></td>
|
|
4446
2019
|
|
|
4447
2020
|
|
|
4448
2021
|
<td class="type">
|
|
4449
2022
|
|
|
4450
2023
|
|
|
4451
|
-
<span class="param-type">
|
|
2024
|
+
<span class="param-type">number</span>
|
|
4452
2025
|
|
|
4453
2026
|
|
|
4454
2027
|
|
|
@@ -4456,10 +2029,26 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4456
2029
|
</td>
|
|
4457
2030
|
|
|
4458
2031
|
|
|
2032
|
+
<td class="attributes">
|
|
2033
|
+
|
|
2034
|
+
<optional><br>
|
|
2035
|
+
|
|
4459
2036
|
|
|
2037
|
+
|
|
2038
|
+
|
|
2039
|
+
|
|
2040
|
+
</td>
|
|
4460
2041
|
|
|
4461
2042
|
|
|
4462
|
-
|
|
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>
|
|
4463
2052
|
</tr>
|
|
4464
2053
|
|
|
4465
2054
|
|
|
@@ -4485,7 +2074,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4485
2074
|
|
|
4486
2075
|
|
|
4487
2076
|
<div class="param-desc">
|
|
4488
|
-
-
|
|
2077
|
+
- Returns an object containing in-progress content if found, otherwise null.
|
|
4489
2078
|
</div>
|
|
4490
2079
|
|
|
4491
2080
|
|
|
@@ -4512,7 +2101,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4512
2101
|
|
|
4513
2102
|
|
|
4514
2103
|
|
|
4515
|
-
<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>
|
|
4516
2105
|
|
|
4517
2106
|
|
|
4518
2107
|
|
|
@@ -4522,13 +2111,13 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4522
2111
|
<dl class="details">
|
|
4523
2112
|
|
|
4524
2113
|
<dt class="tag-description">Description:</dt>
|
|
4525
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
2114
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetches the completion status of a specific lesson for the current user.</li></ul></dd>
|
|
4526
2115
|
|
|
4527
2116
|
|
|
4528
2117
|
|
|
4529
2118
|
<dt class="tag-source">Source:</dt>
|
|
4530
2119
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
4531
|
-
<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#line34">line 34</a>
|
|
4532
2121
|
</li></ul></dd>
|
|
4533
2122
|
|
|
4534
2123
|
|
|
@@ -4573,6 +2162,13 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4573
2162
|
|
|
4574
2163
|
|
|
4575
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
|
+
|
|
4576
2172
|
|
|
4577
2173
|
|
|
4578
2174
|
<h5 class="h5-parameters">Parameters:</h5>
|
|
@@ -4600,18 +2196,24 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4600
2196
|
|
|
4601
2197
|
<tr>
|
|
4602
2198
|
|
|
4603
|
-
<td class="name"><code>
|
|
2199
|
+
<td class="name"><code>content_id</code></td>
|
|
4604
2200
|
|
|
4605
2201
|
|
|
4606
2202
|
<td class="type">
|
|
4607
2203
|
|
|
2204
|
+
|
|
2205
|
+
<span class="param-type">string</span>
|
|
2206
|
+
|
|
2207
|
+
|
|
2208
|
+
|
|
2209
|
+
|
|
4608
2210
|
</td>
|
|
4609
2211
|
|
|
4610
2212
|
|
|
4611
2213
|
|
|
4612
2214
|
|
|
4613
2215
|
|
|
4614
|
-
<td class="description last">
|
|
2216
|
+
<td class="description last">The ID of the lesson content to check.</td>
|
|
4615
2217
|
</tr>
|
|
4616
2218
|
|
|
4617
2219
|
|
|
@@ -4637,7 +2239,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4637
2239
|
|
|
4638
2240
|
|
|
4639
2241
|
<div class="param-desc">
|
|
4640
|
-
-
|
|
2242
|
+
- Returns the completion status object if found, otherwise null.
|
|
4641
2243
|
</div>
|
|
4642
2244
|
|
|
4643
2245
|
|
|
@@ -4648,7 +2250,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4648
2250
|
</dt>
|
|
4649
2251
|
<dd>
|
|
4650
2252
|
|
|
4651
|
-
<span class="param-type">Promise.<(
|
|
2253
|
+
<span class="param-type">Promise.<(Object|null)></span>
|
|
4652
2254
|
|
|
4653
2255
|
|
|
4654
2256
|
|
|
@@ -4664,7 +2266,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4664
2266
|
|
|
4665
2267
|
|
|
4666
2268
|
|
|
4667
|
-
<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>
|
|
4668
2270
|
|
|
4669
2271
|
|
|
4670
2272
|
|
|
@@ -4674,13 +2276,13 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4674
2276
|
<dl class="details">
|
|
4675
2277
|
|
|
4676
2278
|
<dt class="tag-description">Description:</dt>
|
|
4677
|
-
<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>
|
|
4678
2280
|
|
|
4679
2281
|
|
|
4680
2282
|
|
|
4681
2283
|
<dt class="tag-source">Source:</dt>
|
|
4682
2284
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
4683
|
-
<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#line138">line 138</a>
|
|
4684
2286
|
</li></ul></dd>
|
|
4685
2287
|
|
|
4686
2288
|
|
|
@@ -4725,6 +2327,13 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4725
2327
|
|
|
4726
2328
|
|
|
4727
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
|
+
|
|
4728
2337
|
|
|
4729
2338
|
|
|
4730
2339
|
<h5 class="h5-parameters">Parameters:</h5>
|
|
@@ -4740,8 +2349,12 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4740
2349
|
<th>Type</th>
|
|
4741
2350
|
|
|
4742
2351
|
|
|
2352
|
+
<th>Attributes</th>
|
|
2353
|
+
|
|
4743
2354
|
|
|
4744
2355
|
|
|
2356
|
+
<th>Default</th>
|
|
2357
|
+
|
|
4745
2358
|
|
|
4746
2359
|
<th class="last">Description</th>
|
|
4747
2360
|
</tr>
|
|
@@ -4752,16 +2365,13 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4752
2365
|
|
|
4753
2366
|
<tr>
|
|
4754
2367
|
|
|
4755
|
-
<td class="name"><code>
|
|
2368
|
+
<td class="name"><code>type</code></td>
|
|
4756
2369
|
|
|
4757
2370
|
|
|
4758
2371
|
<td class="type">
|
|
4759
2372
|
|
|
4760
2373
|
|
|
4761
2374
|
<span class="param-type">string</span>
|
|
4762
|
-
|
|
|
4763
|
-
|
|
4764
|
-
<span class="param-type">null</span>
|
|
4765
2375
|
|
|
4766
2376
|
|
|
4767
2377
|
|
|
@@ -4769,158 +2379,138 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4769
2379
|
</td>
|
|
4770
2380
|
|
|
4771
2381
|
|
|
2382
|
+
<td class="attributes">
|
|
2383
|
+
|
|
4772
2384
|
|
|
4773
|
-
|
|
4774
|
-
|
|
4775
|
-
<td class="description last">-</td>
|
|
4776
|
-
</tr>
|
|
4777
|
-
|
|
4778
|
-
|
|
4779
|
-
</tbody>
|
|
4780
|
-
</table>
|
|
4781
|
-
|
|
4782
|
-
|
|
4783
|
-
|
|
4784
|
-
|
|
4785
|
-
|
|
4786
|
-
|
|
4787
|
-
|
|
4788
|
-
|
|
4789
|
-
|
|
4790
|
-
|
|
4791
|
-
|
|
4792
|
-
|
|
4793
|
-
|
|
4794
|
-
|
|
4795
|
-
|
|
4796
|
-
|
|
4797
|
-
<h5 class="h5-returns">Returns:</h5>
|
|
4798
|
-
|
|
4799
|
-
|
|
4800
|
-
|
|
4801
|
-
|
|
4802
|
-
<dl class="param-type">
|
|
4803
|
-
<dt>
|
|
4804
|
-
Type
|
|
4805
|
-
</dt>
|
|
4806
|
-
<dd>
|
|
4807
|
-
|
|
4808
|
-
<span class="param-type">Promise.<(any|null)></span>
|
|
4809
|
-
|
|
4810
|
-
|
|
4811
|
-
|
|
4812
|
-
</dd>
|
|
4813
|
-
</dl>
|
|
4814
|
-
|
|
4815
|
-
|
|
4816
|
-
|
|
4817
|
-
|
|
2385
|
+
|
|
4818
2386
|
|
|
4819
|
-
|
|
2387
|
+
|
|
2388
|
+
</td>
|
|
4820
2389
|
|
|
4821
2390
|
|
|
4822
|
-
|
|
4823
|
-
|
|
4824
|
-
|
|
4825
|
-
|
|
4826
|
-
|
|
4827
|
-
|
|
4828
|
-
|
|
4829
|
-
|
|
4830
|
-
|
|
4831
|
-
<dl class="details">
|
|
4832
|
-
|
|
4833
|
-
<dt class="tag-description">Description:</dt>
|
|
4834
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetch challenge, lesson, and user metadata for a given challenge</li></ul></dd>
|
|
4835
|
-
|
|
4836
|
-
|
|
4837
|
-
|
|
4838
|
-
<dt class="tag-source">Source:</dt>
|
|
4839
|
-
<dd class="tag-source"><ul class="dummy"><li>
|
|
4840
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line406">line 406</a>
|
|
4841
|
-
</li></ul></dd>
|
|
4842
|
-
|
|
4843
|
-
|
|
4844
|
-
|
|
4845
|
-
|
|
4846
|
-
|
|
4847
|
-
|
|
4848
|
-
|
|
4849
|
-
|
|
4850
|
-
|
|
4851
|
-
|
|
4852
|
-
|
|
4853
|
-
|
|
4854
|
-
|
|
4855
|
-
|
|
4856
|
-
|
|
4857
|
-
|
|
4858
|
-
|
|
4859
|
-
|
|
4860
|
-
|
|
4861
|
-
|
|
4862
|
-
|
|
2391
|
+
|
|
2392
|
+
<td class="default">
|
|
2393
|
+
|
|
2394
|
+
</td>
|
|
2395
|
+
|
|
4863
2396
|
|
|
4864
|
-
|
|
2397
|
+
<td class="description last">The content type associated with the content.</td>
|
|
2398
|
+
</tr>
|
|
4865
2399
|
|
|
4866
2400
|
|
|
4867
2401
|
|
|
4868
|
-
|
|
2402
|
+
<tr>
|
|
2403
|
+
|
|
2404
|
+
<td class="name"><code>brand</code></td>
|
|
2405
|
+
|
|
4869
2406
|
|
|
4870
|
-
|
|
2407
|
+
<td class="type">
|
|
2408
|
+
|
|
2409
|
+
|
|
2410
|
+
<span class="param-type">string</span>
|
|
4871
2411
|
|
|
4872
|
-
|
|
4873
|
-
</dl>
|
|
4874
2412
|
|
|
4875
2413
|
|
|
2414
|
+
|
|
2415
|
+
</td>
|
|
4876
2416
|
|
|
2417
|
+
|
|
2418
|
+
<td class="attributes">
|
|
2419
|
+
|
|
4877
2420
|
|
|
2421
|
+
|
|
4878
2422
|
|
|
2423
|
+
|
|
2424
|
+
</td>
|
|
2425
|
+
|
|
4879
2426
|
|
|
2427
|
+
|
|
2428
|
+
<td class="default">
|
|
2429
|
+
|
|
2430
|
+
</td>
|
|
2431
|
+
|
|
4880
2432
|
|
|
2433
|
+
<td class="description last">The brand associated with the content.</td>
|
|
2434
|
+
</tr>
|
|
4881
2435
|
|
|
2436
|
+
|
|
4882
2437
|
|
|
2438
|
+
<tr>
|
|
2439
|
+
|
|
2440
|
+
<td class="name"><code>params.limit</code></td>
|
|
2441
|
+
|
|
4883
2442
|
|
|
2443
|
+
<td class="type">
|
|
2444
|
+
|
|
2445
|
+
|
|
2446
|
+
<span class="param-type">number</span>
|
|
4884
2447
|
|
|
4885
2448
|
|
|
4886
2449
|
|
|
4887
|
-
|
|
4888
|
-
|
|
2450
|
+
|
|
2451
|
+
</td>
|
|
4889
2452
|
|
|
4890
|
-
|
|
4891
|
-
|
|
4892
|
-
|
|
4893
|
-
|
|
4894
|
-
|
|
4895
|
-
|
|
2453
|
+
|
|
2454
|
+
<td class="attributes">
|
|
2455
|
+
|
|
2456
|
+
<optional><br>
|
|
2457
|
+
|
|
4896
2458
|
|
|
4897
|
-
|
|
2459
|
+
|
|
4898
2460
|
|
|
4899
|
-
|
|
2461
|
+
|
|
2462
|
+
</td>
|
|
2463
|
+
|
|
4900
2464
|
|
|
4901
|
-
|
|
2465
|
+
|
|
2466
|
+
<td class="default">
|
|
2467
|
+
|
|
2468
|
+
<code>20</code>
|
|
2469
|
+
|
|
2470
|
+
</td>
|
|
2471
|
+
|
|
4902
2472
|
|
|
4903
|
-
|
|
4904
|
-
|
|
4905
|
-
</thead>
|
|
2473
|
+
<td class="description last">The limit of results per page.</td>
|
|
2474
|
+
</tr>
|
|
4906
2475
|
|
|
4907
|
-
<tbody>
|
|
4908
2476
|
|
|
4909
2477
|
|
|
4910
2478
|
<tr>
|
|
4911
2479
|
|
|
4912
|
-
<td class="name"><code>
|
|
2480
|
+
<td class="name"><code>params.page</code></td>
|
|
4913
2481
|
|
|
4914
2482
|
|
|
4915
2483
|
<td class="type">
|
|
4916
2484
|
|
|
2485
|
+
|
|
2486
|
+
<span class="param-type">number</span>
|
|
2487
|
+
|
|
2488
|
+
|
|
2489
|
+
|
|
2490
|
+
|
|
4917
2491
|
</td>
|
|
4918
2492
|
|
|
4919
2493
|
|
|
2494
|
+
<td class="attributes">
|
|
2495
|
+
|
|
2496
|
+
<optional><br>
|
|
2497
|
+
|
|
2498
|
+
|
|
2499
|
+
|
|
4920
2500
|
|
|
2501
|
+
|
|
2502
|
+
</td>
|
|
4921
2503
|
|
|
4922
2504
|
|
|
4923
|
-
|
|
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>
|
|
4924
2514
|
</tr>
|
|
4925
2515
|
|
|
4926
2516
|
|
|
@@ -4945,6 +2535,10 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4945
2535
|
<h5 class="h5-returns">Returns:</h5>
|
|
4946
2536
|
|
|
4947
2537
|
|
|
2538
|
+
<div class="param-desc">
|
|
2539
|
+
- Returns an object containing in-progress content if found, otherwise null.
|
|
2540
|
+
</div>
|
|
2541
|
+
|
|
4948
2542
|
|
|
4949
2543
|
|
|
4950
2544
|
<dl class="param-type">
|
|
@@ -4953,7 +2547,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4953
2547
|
</dt>
|
|
4954
2548
|
<dd>
|
|
4955
2549
|
|
|
4956
|
-
<span class="param-type">Promise.<(
|
|
2550
|
+
<span class="param-type">Promise.<(Object|null)></span>
|
|
4957
2551
|
|
|
4958
2552
|
|
|
4959
2553
|
|
|
@@ -4969,7 +2563,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4969
2563
|
|
|
4970
2564
|
|
|
4971
2565
|
|
|
4972
|
-
<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>
|
|
4973
2567
|
|
|
4974
2568
|
|
|
4975
2569
|
|
|
@@ -4979,13 +2573,13 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
4979
2573
|
<dl class="details">
|
|
4980
2574
|
|
|
4981
2575
|
<dt class="tag-description">Description:</dt>
|
|
4982
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetches user
|
|
2576
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetches user context data for a specific piece of content.</li></ul></dd>
|
|
4983
2577
|
|
|
4984
2578
|
|
|
4985
2579
|
|
|
4986
2580
|
<dt class="tag-source">Source:</dt>
|
|
4987
2581
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
4988
|
-
<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#line221">line 221</a>
|
|
4989
2583
|
</li></ul></dd>
|
|
4990
2584
|
|
|
4991
2585
|
|
|
@@ -5032,8 +2626,8 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5032
2626
|
|
|
5033
2627
|
<h5 class="h5-examples">Example</h5>
|
|
5034
2628
|
|
|
5035
|
-
<pre class="prettyprint"><code>
|
|
5036
|
-
.then(
|
|
2629
|
+
<pre class="prettyprint"><code>fetchContentPageUserData(406548)
|
|
2630
|
+
.then(data => console.log(data))
|
|
5037
2631
|
.catch(error => console.error(error));</code></pre>
|
|
5038
2632
|
|
|
5039
2633
|
|
|
@@ -5064,13 +2658,13 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5064
2658
|
|
|
5065
2659
|
<tr>
|
|
5066
2660
|
|
|
5067
|
-
<td class="name"><code>
|
|
2661
|
+
<td class="name"><code>contentId</code></td>
|
|
5068
2662
|
|
|
5069
2663
|
|
|
5070
2664
|
<td class="type">
|
|
5071
2665
|
|
|
5072
2666
|
|
|
5073
|
-
<span class="param-type">
|
|
2667
|
+
<span class="param-type">int</span>
|
|
5074
2668
|
|
|
5075
2669
|
|
|
5076
2670
|
|
|
@@ -5081,7 +2675,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5081
2675
|
|
|
5082
2676
|
|
|
5083
2677
|
|
|
5084
|
-
<td class="description last">The
|
|
2678
|
+
<td class="description last">The content id.</td>
|
|
5085
2679
|
</tr>
|
|
5086
2680
|
|
|
5087
2681
|
|
|
@@ -5107,7 +2701,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5107
2701
|
|
|
5108
2702
|
|
|
5109
2703
|
<div class="param-desc">
|
|
5110
|
-
-
|
|
2704
|
+
- Returns an object containing user context data if found, otherwise null.
|
|
5111
2705
|
</div>
|
|
5112
2706
|
|
|
5113
2707
|
|
|
@@ -5134,7 +2728,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5134
2728
|
|
|
5135
2729
|
|
|
5136
2730
|
|
|
5137
|
-
<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>
|
|
5138
2732
|
|
|
5139
2733
|
|
|
5140
2734
|
|
|
@@ -5143,11 +2737,14 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5143
2737
|
|
|
5144
2738
|
<dl class="details">
|
|
5145
2739
|
|
|
2740
|
+
<dt class="tag-description">Description:</dt>
|
|
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>
|
|
2742
|
+
|
|
5146
2743
|
|
|
5147
2744
|
|
|
5148
2745
|
<dt class="tag-source">Source:</dt>
|
|
5149
2746
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
5150
|
-
<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#line250">line 250</a>
|
|
5151
2748
|
</li></ul></dd>
|
|
5152
2749
|
|
|
5153
2750
|
|
|
@@ -5219,7 +2816,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5219
2816
|
|
|
5220
2817
|
<tr>
|
|
5221
2818
|
|
|
5222
|
-
<td class="name"><code>
|
|
2819
|
+
<td class="name"><code>contentId</code></td>
|
|
5223
2820
|
|
|
5224
2821
|
|
|
5225
2822
|
<td class="type">
|
|
@@ -5236,7 +2833,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5236
2833
|
|
|
5237
2834
|
|
|
5238
2835
|
|
|
5239
|
-
<td class="description last"
|
|
2836
|
+
<td class="description last">The id of the parent (method, level, or course) piece of content.</td>
|
|
5240
2837
|
</tr>
|
|
5241
2838
|
|
|
5242
2839
|
|
|
@@ -5261,6 +2858,10 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5261
2858
|
<h5 class="h5-returns">Returns:</h5>
|
|
5262
2859
|
|
|
5263
2860
|
|
|
2861
|
+
<div class="param-desc">
|
|
2862
|
+
- Returns and Object with the id and type of the next piece of content if found, otherwise null.
|
|
2863
|
+
</div>
|
|
2864
|
+
|
|
5264
2865
|
|
|
5265
2866
|
|
|
5266
2867
|
<dl class="param-type">
|
|
@@ -5269,7 +2870,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5269
2870
|
</dt>
|
|
5270
2871
|
<dd>
|
|
5271
2872
|
|
|
5272
|
-
<span class="param-type">Promise.<(
|
|
2873
|
+
<span class="param-type">Promise.<(Object|null)></span>
|
|
5273
2874
|
|
|
5274
2875
|
|
|
5275
2876
|
|
|
@@ -5285,7 +2886,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5285
2886
|
|
|
5286
2887
|
|
|
5287
2888
|
|
|
5288
|
-
<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>
|
|
5289
2890
|
|
|
5290
2891
|
|
|
5291
2892
|
|
|
@@ -5294,11 +2895,14 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5294
2895
|
|
|
5295
2896
|
<dl class="details">
|
|
5296
2897
|
|
|
2898
|
+
<dt class="tag-description">Description:</dt>
|
|
2899
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetches a paginated list of recent user activities.</li></ul></dd>
|
|
2900
|
+
|
|
5297
2901
|
|
|
5298
2902
|
|
|
5299
2903
|
<dt class="tag-source">Source:</dt>
|
|
5300
2904
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
5301
|
-
<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#line711">line 711</a>
|
|
5302
2906
|
</li></ul></dd>
|
|
5303
2907
|
|
|
5304
2908
|
|
|
@@ -5343,6 +2947,13 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5343
2947
|
|
|
5344
2948
|
|
|
5345
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
|
+
|
|
5346
2957
|
|
|
5347
2958
|
|
|
5348
2959
|
<h5 class="h5-parameters">Parameters:</h5>
|
|
@@ -5358,8 +2969,12 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5358
2969
|
<th>Type</th>
|
|
5359
2970
|
|
|
5360
2971
|
|
|
2972
|
+
<th>Attributes</th>
|
|
2973
|
+
|
|
5361
2974
|
|
|
5362
2975
|
|
|
2976
|
+
<th>Default</th>
|
|
2977
|
+
|
|
5363
2978
|
|
|
5364
2979
|
<th class="last">Description</th>
|
|
5365
2980
|
</tr>
|
|
@@ -5370,13 +2985,13 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5370
2985
|
|
|
5371
2986
|
<tr>
|
|
5372
2987
|
|
|
5373
|
-
<td class="name"><code>
|
|
2988
|
+
<td class="name"><code>params</code></td>
|
|
5374
2989
|
|
|
5375
2990
|
|
|
5376
2991
|
<td class="type">
|
|
5377
2992
|
|
|
5378
2993
|
|
|
5379
|
-
<span class="param-type">
|
|
2994
|
+
<span class="param-type">Object</span>
|
|
5380
2995
|
|
|
5381
2996
|
|
|
5382
2997
|
|
|
@@ -5384,156 +2999,145 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5384
2999
|
</td>
|
|
5385
3000
|
|
|
5386
3001
|
|
|
3002
|
+
<td class="attributes">
|
|
3003
|
+
|
|
3004
|
+
<optional><br>
|
|
3005
|
+
|
|
5387
3006
|
|
|
5388
|
-
|
|
5389
|
-
|
|
5390
|
-
<td class="description last"></td>
|
|
5391
|
-
</tr>
|
|
5392
|
-
|
|
5393
|
-
|
|
5394
|
-
</tbody>
|
|
5395
|
-
</table>
|
|
5396
|
-
|
|
5397
|
-
|
|
5398
|
-
|
|
5399
|
-
|
|
5400
|
-
|
|
5401
|
-
|
|
5402
|
-
|
|
5403
|
-
|
|
5404
|
-
|
|
5405
|
-
|
|
5406
|
-
|
|
5407
|
-
|
|
5408
|
-
|
|
3007
|
+
|
|
5409
3008
|
|
|
3009
|
+
|
|
3010
|
+
</td>
|
|
3011
|
+
|
|
5410
3012
|
|
|
3013
|
+
|
|
3014
|
+
<td class="default">
|
|
3015
|
+
|
|
3016
|
+
<code>{}</code>
|
|
3017
|
+
|
|
3018
|
+
</td>
|
|
3019
|
+
|
|
5411
3020
|
|
|
5412
|
-
<
|
|
3021
|
+
<td class="description last">Optional parameters.
|
|
3022
|
+
<h6>Properties</h6>
|
|
3023
|
+
|
|
5413
3024
|
|
|
3025
|
+
<table class="params">
|
|
3026
|
+
<thead>
|
|
3027
|
+
<tr>
|
|
5414
3028
|
|
|
5415
|
-
|
|
5416
|
-
|
|
5417
|
-
<dl class="param-type">
|
|
5418
|
-
<dt>
|
|
5419
|
-
Type
|
|
5420
|
-
</dt>
|
|
5421
|
-
<dd>
|
|
3029
|
+
<th>Name</th>
|
|
5422
3030
|
|
|
5423
|
-
<span class="param-type">Promise.<(*|null)></span>
|
|
5424
|
-
|
|
5425
|
-
|
|
5426
|
-
|
|
5427
|
-
</dd>
|
|
5428
|
-
</dl>
|
|
5429
|
-
|
|
5430
|
-
|
|
5431
|
-
|
|
5432
3031
|
|
|
3032
|
+
<th>Type</th>
|
|
5433
3033
|
|
|
5434
3034
|
|
|
5435
|
-
|
|
5436
|
-
|
|
5437
|
-
|
|
5438
|
-
|
|
5439
|
-
<h4 class="name" id=".postChallengesCommunityNotification"><span class="type-signature type-signature-static">(static) </span>postChallengesCommunityNotification<span class="signature">(contentId)</span><span class="type-signature"> → {Promise.<(any|null)>}</span></h4>
|
|
5440
|
-
|
|
5441
|
-
|
|
5442
|
-
|
|
5443
|
-
|
|
5444
|
-
|
|
5445
|
-
|
|
5446
|
-
<dl class="details">
|
|
5447
|
-
|
|
5448
|
-
<dt class="tag-description">Description:</dt>
|
|
5449
|
-
<dd class="tag-description"><ul class="dummy"><li>Enable community notifications for the provided challenge</li></ul></dd>
|
|
5450
|
-
|
|
5451
|
-
|
|
5452
|
-
|
|
5453
|
-
<dt class="tag-source">Source:</dt>
|
|
5454
|
-
<dd class="tag-source"><ul class="dummy"><li>
|
|
5455
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line549">line 549</a>
|
|
5456
|
-
</li></ul></dd>
|
|
5457
|
-
|
|
5458
|
-
|
|
5459
|
-
|
|
5460
|
-
|
|
5461
|
-
|
|
5462
|
-
|
|
5463
|
-
|
|
5464
|
-
|
|
5465
|
-
|
|
5466
|
-
|
|
5467
|
-
|
|
5468
|
-
|
|
5469
|
-
|
|
5470
|
-
|
|
5471
|
-
|
|
5472
|
-
|
|
5473
|
-
|
|
5474
|
-
|
|
5475
|
-
|
|
3035
|
+
<th>Attributes</th>
|
|
3036
|
+
|
|
5476
3037
|
|
|
5477
|
-
|
|
3038
|
+
|
|
3039
|
+
<th>Default</th>
|
|
3040
|
+
|
|
5478
3041
|
|
|
5479
|
-
|
|
3042
|
+
<th class="last">Description</th>
|
|
3043
|
+
</tr>
|
|
3044
|
+
</thead>
|
|
5480
3045
|
|
|
3046
|
+
<tbody>
|
|
5481
3047
|
|
|
5482
3048
|
|
|
5483
|
-
|
|
3049
|
+
<tr>
|
|
3050
|
+
|
|
3051
|
+
<td class="name"><code>page</code></td>
|
|
3052
|
+
|
|
5484
3053
|
|
|
5485
|
-
|
|
3054
|
+
<td class="type">
|
|
3055
|
+
|
|
3056
|
+
|
|
3057
|
+
<span class="param-type">number</span>
|
|
5486
3058
|
|
|
5487
|
-
|
|
5488
|
-
</dl>
|
|
5489
3059
|
|
|
5490
3060
|
|
|
3061
|
+
|
|
3062
|
+
</td>
|
|
5491
3063
|
|
|
3064
|
+
|
|
3065
|
+
<td class="attributes">
|
|
3066
|
+
|
|
3067
|
+
<optional><br>
|
|
3068
|
+
|
|
5492
3069
|
|
|
3070
|
+
|
|
5493
3071
|
|
|
3072
|
+
|
|
3073
|
+
</td>
|
|
3074
|
+
|
|
5494
3075
|
|
|
3076
|
+
|
|
3077
|
+
<td class="default">
|
|
3078
|
+
|
|
3079
|
+
<code>1</code>
|
|
3080
|
+
|
|
3081
|
+
</td>
|
|
3082
|
+
|
|
5495
3083
|
|
|
3084
|
+
<td class="description last">The page number for pagination.</td>
|
|
3085
|
+
</tr>
|
|
5496
3086
|
|
|
3087
|
+
|
|
5497
3088
|
|
|
3089
|
+
<tr>
|
|
3090
|
+
|
|
3091
|
+
<td class="name"><code>limit</code></td>
|
|
3092
|
+
|
|
5498
3093
|
|
|
3094
|
+
<td class="type">
|
|
3095
|
+
|
|
3096
|
+
|
|
3097
|
+
<span class="param-type">number</span>
|
|
5499
3098
|
|
|
5500
3099
|
|
|
5501
3100
|
|
|
5502
|
-
|
|
5503
|
-
|
|
3101
|
+
|
|
3102
|
+
</td>
|
|
5504
3103
|
|
|
5505
|
-
|
|
5506
|
-
|
|
5507
|
-
|
|
5508
|
-
|
|
5509
|
-
|
|
5510
|
-
|
|
3104
|
+
|
|
3105
|
+
<td class="attributes">
|
|
3106
|
+
|
|
3107
|
+
<optional><br>
|
|
3108
|
+
|
|
5511
3109
|
|
|
5512
|
-
|
|
3110
|
+
|
|
5513
3111
|
|
|
5514
|
-
|
|
3112
|
+
|
|
3113
|
+
</td>
|
|
3114
|
+
|
|
5515
3115
|
|
|
5516
|
-
|
|
3116
|
+
|
|
3117
|
+
<td class="default">
|
|
3118
|
+
|
|
3119
|
+
<code>10</code>
|
|
3120
|
+
|
|
3121
|
+
</td>
|
|
3122
|
+
|
|
5517
3123
|
|
|
5518
|
-
|
|
5519
|
-
|
|
5520
|
-
</thead>
|
|
3124
|
+
<td class="description last">The number of results per page.</td>
|
|
3125
|
+
</tr>
|
|
5521
3126
|
|
|
5522
|
-
<tbody>
|
|
5523
3127
|
|
|
5524
3128
|
|
|
5525
3129
|
<tr>
|
|
5526
3130
|
|
|
5527
|
-
<td class="name"><code>
|
|
3131
|
+
<td class="name"><code>tabName</code></td>
|
|
5528
3132
|
|
|
5529
3133
|
|
|
5530
3134
|
<td class="type">
|
|
5531
3135
|
|
|
5532
3136
|
|
|
5533
|
-
<span class="param-type">
|
|
3137
|
+
<span class="param-type">string</span>
|
|
5534
3138
|
|
|
|
5535
3139
|
|
|
5536
|
-
<span class="param-type">
|
|
3140
|
+
<span class="param-type">null</span>
|
|
5537
3141
|
|
|
5538
3142
|
|
|
5539
3143
|
|
|
@@ -5541,10 +3145,33 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5541
3145
|
</td>
|
|
5542
3146
|
|
|
5543
3147
|
|
|
3148
|
+
<td class="attributes">
|
|
3149
|
+
|
|
3150
|
+
<optional><br>
|
|
3151
|
+
|
|
3152
|
+
|
|
3153
|
+
|
|
3154
|
+
|
|
3155
|
+
|
|
3156
|
+
</td>
|
|
3157
|
+
|
|
5544
3158
|
|
|
5545
3159
|
|
|
3160
|
+
<td class="default">
|
|
3161
|
+
|
|
3162
|
+
<code>null</code>
|
|
3163
|
+
|
|
3164
|
+
</td>
|
|
3165
|
+
|
|
5546
3166
|
|
|
5547
|
-
<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>
|
|
5548
3175
|
</tr>
|
|
5549
3176
|
|
|
5550
3177
|
|
|
@@ -5569,6 +3196,10 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5569
3196
|
<h5 class="h5-returns">Returns:</h5>
|
|
5570
3197
|
|
|
5571
3198
|
|
|
3199
|
+
<div class="param-desc">
|
|
3200
|
+
- A promise that resolves to a paginated object of user activities.
|
|
3201
|
+
</div>
|
|
3202
|
+
|
|
5572
3203
|
|
|
5573
3204
|
|
|
5574
3205
|
<dl class="param-type">
|
|
@@ -5577,7 +3208,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5577
3208
|
</dt>
|
|
5578
3209
|
<dd>
|
|
5579
3210
|
|
|
5580
|
-
<span class="param-type">Promise.<
|
|
3211
|
+
<span class="param-type">Promise.<PaginatedActivities></span>
|
|
5581
3212
|
|
|
5582
3213
|
|
|
5583
3214
|
|
|
@@ -5593,7 +3224,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5593
3224
|
|
|
5594
3225
|
|
|
5595
3226
|
|
|
5596
|
-
<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>
|
|
5597
3228
|
|
|
5598
3229
|
|
|
5599
3230
|
|
|
@@ -5603,14 +3234,13 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5603
3234
|
<dl class="details">
|
|
5604
3235
|
|
|
5605
3236
|
<dt class="tag-description">Description:</dt>
|
|
5606
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
5607
|
-
Clears any current progress data for this challenge</li></ul></dd>
|
|
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>
|
|
5608
3238
|
|
|
5609
3239
|
|
|
5610
3240
|
|
|
5611
3241
|
<dt class="tag-source">Source:</dt>
|
|
5612
3242
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
5613
|
-
<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#line101">line 101</a>
|
|
5614
3244
|
</li></ul></dd>
|
|
5615
3245
|
|
|
5616
3246
|
|
|
@@ -5655,6 +3285,13 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5655
3285
|
|
|
5656
3286
|
|
|
5657
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
|
+
|
|
5658
3295
|
|
|
5659
3296
|
|
|
5660
3297
|
<h5 class="h5-parameters">Parameters:</h5>
|
|
@@ -5682,15 +3319,12 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5682
3319
|
|
|
5683
3320
|
<tr>
|
|
5684
3321
|
|
|
5685
|
-
<td class="name"><code>
|
|
3322
|
+
<td class="name"><code>brand</code></td>
|
|
5686
3323
|
|
|
5687
3324
|
|
|
5688
3325
|
<td class="type">
|
|
5689
3326
|
|
|
5690
3327
|
|
|
5691
|
-
<span class="param-type">int</span>
|
|
5692
|
-
|
|
|
5693
|
-
|
|
5694
3328
|
<span class="param-type">string</span>
|
|
5695
3329
|
|
|
5696
3330
|
|
|
@@ -5702,7 +3336,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5702
3336
|
|
|
5703
3337
|
|
|
5704
3338
|
|
|
5705
|
-
<td class="description last">
|
|
3339
|
+
<td class="description last">The brand associated with the songs.</td>
|
|
5706
3340
|
</tr>
|
|
5707
3341
|
|
|
5708
3342
|
|
|
@@ -5727,6 +3361,10 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5727
3361
|
<h5 class="h5-returns">Returns:</h5>
|
|
5728
3362
|
|
|
5729
3363
|
|
|
3364
|
+
<div class="param-desc">
|
|
3365
|
+
- Returns an object containing in-progress songs if found, otherwise null.
|
|
3366
|
+
</div>
|
|
3367
|
+
|
|
5730
3368
|
|
|
5731
3369
|
|
|
5732
3370
|
<dl class="param-type">
|
|
@@ -5735,7 +3373,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5735
3373
|
</dt>
|
|
5736
3374
|
<dd>
|
|
5737
3375
|
|
|
5738
|
-
<span class="param-type">Promise.<(
|
|
3376
|
+
<span class="param-type">Promise.<(Object|null)></span>
|
|
5739
3377
|
|
|
5740
3378
|
|
|
5741
3379
|
|
|
@@ -5751,7 +3389,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5751
3389
|
|
|
5752
3390
|
|
|
5753
3391
|
|
|
5754
|
-
<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>
|
|
5755
3393
|
|
|
5756
3394
|
|
|
5757
3395
|
|
|
@@ -5761,13 +3399,13 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5761
3399
|
<dl class="details">
|
|
5762
3400
|
|
|
5763
3401
|
<dt class="tag-description">Description:</dt>
|
|
5764
|
-
<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>
|
|
5765
3403
|
|
|
5766
3404
|
|
|
5767
3405
|
|
|
5768
3406
|
<dt class="tag-source">Source:</dt>
|
|
5769
3407
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
5770
|
-
<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#line411">line 411</a>
|
|
5771
3409
|
</li></ul></dd>
|
|
5772
3410
|
|
|
5773
3411
|
|
|
@@ -5839,16 +3477,13 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5839
3477
|
|
|
5840
3478
|
<tr>
|
|
5841
3479
|
|
|
5842
|
-
<td class="name"><code>
|
|
3480
|
+
<td class="name"><code>railcontentId</code></td>
|
|
5843
3481
|
|
|
5844
3482
|
|
|
5845
3483
|
<td class="type">
|
|
5846
3484
|
|
|
5847
3485
|
|
|
5848
3486
|
<span class="param-type">int</span>
|
|
5849
|
-
|
|
|
5850
|
-
|
|
5851
|
-
<span class="param-type">string</span>
|
|
5852
3487
|
|
|
5853
3488
|
|
|
5854
3489
|
|
|
@@ -5859,7 +3494,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5859
3494
|
|
|
5860
3495
|
|
|
5861
3496
|
|
|
5862
|
-
<td class="description last">railcontent id
|
|
3497
|
+
<td class="description last">The railcontent id to fetch.</td>
|
|
5863
3498
|
</tr>
|
|
5864
3499
|
|
|
5865
3500
|
|
|
@@ -5884,6 +3519,10 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5884
3519
|
<h5 class="h5-returns">Returns:</h5>
|
|
5885
3520
|
|
|
5886
3521
|
|
|
3522
|
+
<div class="param-desc">
|
|
3523
|
+
- A promise that resolves to an comment object
|
|
3524
|
+
</div>
|
|
3525
|
+
|
|
5887
3526
|
|
|
5888
3527
|
|
|
5889
3528
|
<dl class="param-type">
|
|
@@ -5892,7 +3531,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5892
3531
|
</dt>
|
|
5893
3532
|
<dd>
|
|
5894
3533
|
|
|
5895
|
-
<span class="param-type">Promise.<(
|
|
3534
|
+
<span class="param-type">Promise.<(Object|null)></span>
|
|
5896
3535
|
|
|
5897
3536
|
|
|
5898
3537
|
|
|
@@ -5908,7 +3547,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5908
3547
|
|
|
5909
3548
|
|
|
5910
3549
|
|
|
5911
|
-
<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>
|
|
5912
3551
|
|
|
5913
3552
|
|
|
5914
3553
|
|
|
@@ -5918,13 +3557,13 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
5918
3557
|
<dl class="details">
|
|
5919
3558
|
|
|
5920
3559
|
<dt class="tag-description">Description:</dt>
|
|
5921
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
3560
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch the user's best award for this challenge</li></ul></dd>
|
|
5922
3561
|
|
|
5923
3562
|
|
|
5924
3563
|
|
|
5925
3564
|
<dt class="tag-source">Source:</dt>
|
|
5926
3565
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
5927
|
-
<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#line354">line 354</a>
|
|
5928
3567
|
</li></ul></dd>
|
|
5929
3568
|
|
|
5930
3569
|
|
|
@@ -6001,15 +3640,6 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
6001
3640
|
|
|
6002
3641
|
<td class="type">
|
|
6003
3642
|
|
|
6004
|
-
|
|
6005
|
-
<span class="param-type">int</span>
|
|
6006
|
-
|
|
|
6007
|
-
|
|
6008
|
-
<span class="param-type">string</span>
|
|
6009
|
-
|
|
6010
|
-
|
|
6011
|
-
|
|
6012
|
-
|
|
6013
3643
|
</td>
|
|
6014
3644
|
|
|
6015
3645
|
|
|
@@ -6041,6 +3671,10 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
6041
3671
|
<h5 class="h5-returns">Returns:</h5>
|
|
6042
3672
|
|
|
6043
3673
|
|
|
3674
|
+
<div class="param-desc">
|
|
3675
|
+
- streamed PDF
|
|
3676
|
+
</div>
|
|
3677
|
+
|
|
6044
3678
|
|
|
6045
3679
|
|
|
6046
3680
|
<dl class="param-type">
|
|
@@ -6065,7 +3699,7 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
6065
3699
|
|
|
6066
3700
|
|
|
6067
3701
|
|
|
6068
|
-
<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>
|
|
6069
3703
|
|
|
6070
3704
|
|
|
6071
3705
|
|
|
@@ -6075,14 +3709,13 @@ Intended to be used on the index page for challenges</li></ul></dd>
|
|
|
6075
3709
|
<dl class="details">
|
|
6076
3710
|
|
|
6077
3711
|
<dt class="tag-description">Description:</dt>
|
|
6078
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
6079
|
-
Clears any current progress data for this challenge</li></ul></dd>
|
|
3712
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch all completed badges for the user ordered by completion date descending</li></ul></dd>
|
|
6080
3713
|
|
|
6081
3714
|
|
|
6082
3715
|
|
|
6083
3716
|
<dt class="tag-source">Source:</dt>
|
|
6084
3717
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
6085
|
-
<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#line376">line 376</a>
|
|
6086
3719
|
</li></ul></dd>
|
|
6087
3720
|
|
|
6088
3721
|
|
|
@@ -6154,16 +3787,16 @@ Clears any current progress data for this challenge</li></ul></dd>
|
|
|
6154
3787
|
|
|
6155
3788
|
<tr>
|
|
6156
3789
|
|
|
6157
|
-
<td class="name"><code>
|
|
3790
|
+
<td class="name"><code>brand</code></td>
|
|
6158
3791
|
|
|
6159
3792
|
|
|
6160
3793
|
<td class="type">
|
|
6161
3794
|
|
|
6162
3795
|
|
|
6163
|
-
<span class="param-type">
|
|
3796
|
+
<span class="param-type">string</span>
|
|
6164
3797
|
|
|
|
6165
3798
|
|
|
6166
|
-
<span class="param-type">
|
|
3799
|
+
<span class="param-type">null</span>
|
|
6167
3800
|
|
|
6168
3801
|
|
|
6169
3802
|
|
|
@@ -6174,7 +3807,7 @@ Clears any current progress data for this challenge</li></ul></dd>
|
|
|
6174
3807
|
|
|
6175
3808
|
|
|
6176
3809
|
|
|
6177
|
-
<td class="description last"
|
|
3810
|
+
<td class="description last">-</td>
|
|
6178
3811
|
</tr>
|
|
6179
3812
|
|
|
6180
3813
|
|
|
@@ -6223,7 +3856,7 @@ Clears any current progress data for this challenge</li></ul></dd>
|
|
|
6223
3856
|
|
|
6224
3857
|
|
|
6225
3858
|
|
|
6226
|
-
<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>
|
|
6227
3860
|
|
|
6228
3861
|
|
|
6229
3862
|
|
|
@@ -6233,14 +3866,13 @@ Clears any current progress data for this challenge</li></ul></dd>
|
|
|
6233
3866
|
<dl class="details">
|
|
6234
3867
|
|
|
6235
3868
|
<dt class="tag-description">Description:</dt>
|
|
6236
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
6237
|
-
Clears any existing progress data for this challenge</li></ul></dd>
|
|
3869
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetches user practice notes for a specific date.</li></ul></dd>
|
|
6238
3870
|
|
|
6239
3871
|
|
|
6240
3872
|
|
|
6241
3873
|
<dt class="tag-source">Source:</dt>
|
|
6242
3874
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
6243
|
-
<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#line651">line 651</a>
|
|
6244
3876
|
</li></ul></dd>
|
|
6245
3877
|
|
|
6246
3878
|
|
|
@@ -6285,6 +3917,13 @@ Clears any existing progress data for this challenge</li></ul></dd>
|
|
|
6285
3917
|
|
|
6286
3918
|
|
|
6287
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
|
+
|
|
6288
3927
|
|
|
6289
3928
|
|
|
6290
3929
|
<h5 class="h5-parameters">Parameters:</h5>
|
|
@@ -6312,34 +3951,7 @@ Clears any existing progress data for this challenge</li></ul></dd>
|
|
|
6312
3951
|
|
|
6313
3952
|
<tr>
|
|
6314
3953
|
|
|
6315
|
-
<td class="name"><code>
|
|
6316
|
-
|
|
6317
|
-
|
|
6318
|
-
<td class="type">
|
|
6319
|
-
|
|
6320
|
-
|
|
6321
|
-
<span class="param-type">int</span>
|
|
6322
|
-
|
|
|
6323
|
-
|
|
6324
|
-
<span class="param-type">string</span>
|
|
6325
|
-
|
|
6326
|
-
|
|
6327
|
-
|
|
6328
|
-
|
|
6329
|
-
</td>
|
|
6330
|
-
|
|
6331
|
-
|
|
6332
|
-
|
|
6333
|
-
|
|
6334
|
-
|
|
6335
|
-
<td class="description last">railcontent id of the challenge</td>
|
|
6336
|
-
</tr>
|
|
6337
|
-
|
|
6338
|
-
|
|
6339
|
-
|
|
6340
|
-
<tr>
|
|
6341
|
-
|
|
6342
|
-
<td class="name"><code>startDate</code></td>
|
|
3954
|
+
<td class="name"><code>date</code></td>
|
|
6343
3955
|
|
|
6344
3956
|
|
|
6345
3957
|
<td class="type">
|
|
@@ -6356,7 +3968,7 @@ Clears any existing progress data for this challenge</li></ul></dd>
|
|
|
6356
3968
|
|
|
6357
3969
|
|
|
6358
3970
|
|
|
6359
|
-
<td class="description last">
|
|
3971
|
+
<td class="description last">The date for which to fetch practice notes (format: YYYY-MM-DD).</td>
|
|
6360
3972
|
</tr>
|
|
6361
3973
|
|
|
6362
3974
|
|
|
@@ -6381,6 +3993,10 @@ Clears any existing progress data for this challenge</li></ul></dd>
|
|
|
6381
3993
|
<h5 class="h5-returns">Returns:</h5>
|
|
6382
3994
|
|
|
6383
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
|
+
|
|
6384
4000
|
|
|
6385
4001
|
|
|
6386
4002
|
<dl class="param-type">
|
|
@@ -6389,7 +4005,7 @@ Clears any existing progress data for this challenge</li></ul></dd>
|
|
|
6389
4005
|
</dt>
|
|
6390
4006
|
<dd>
|
|
6391
4007
|
|
|
6392
|
-
<span class="param-type">Promise.<(
|
|
4008
|
+
<span class="param-type">Promise.<(Object|null)></span>
|
|
6393
4009
|
|
|
6394
4010
|
|
|
6395
4011
|
|
|
@@ -6405,7 +4021,7 @@ Clears any existing progress data for this challenge</li></ul></dd>
|
|
|
6405
4021
|
|
|
6406
4022
|
|
|
6407
4023
|
|
|
6408
|
-
<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>
|
|
6409
4025
|
|
|
6410
4026
|
|
|
6411
4027
|
|
|
@@ -6414,14 +4030,11 @@ Clears any existing progress data for this challenge</li></ul></dd>
|
|
|
6414
4030
|
|
|
6415
4031
|
<dl class="details">
|
|
6416
4032
|
|
|
6417
|
-
<dt class="tag-description">Description:</dt>
|
|
6418
|
-
<dd class="tag-description"><ul class="dummy"><li>Enable solo notifications for the provided challenge</li></ul></dd>
|
|
6419
|
-
|
|
6420
4033
|
|
|
6421
4034
|
|
|
6422
4035
|
<dt class="tag-source">Source:</dt>
|
|
6423
4036
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
6424
|
-
<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#line505">line 505</a>
|
|
6425
4038
|
</li></ul></dd>
|
|
6426
4039
|
|
|
6427
4040
|
|
|
@@ -6493,16 +4106,13 @@ Clears any existing progress data for this challenge</li></ul></dd>
|
|
|
6493
4106
|
|
|
6494
4107
|
<tr>
|
|
6495
4108
|
|
|
6496
|
-
<td class="name"><code>
|
|
4109
|
+
<td class="name"><code>commentId</code></td>
|
|
6497
4110
|
|
|
6498
4111
|
|
|
6499
4112
|
<td class="type">
|
|
6500
4113
|
|
|
6501
4114
|
|
|
6502
4115
|
<span class="param-type">int</span>
|
|
6503
|
-
|
|
|
6504
|
-
|
|
6505
|
-
<span class="param-type">string</span>
|
|
6506
4116
|
|
|
6507
4117
|
|
|
6508
4118
|
|
|
@@ -6513,7 +4123,7 @@ Clears any existing progress data for this challenge</li></ul></dd>
|
|
|
6513
4123
|
|
|
6514
4124
|
|
|
6515
4125
|
|
|
6516
|
-
<td class="description last"
|
|
4126
|
+
<td class="description last"></td>
|
|
6517
4127
|
</tr>
|
|
6518
4128
|
|
|
6519
4129
|
|
|
@@ -6546,7 +4156,7 @@ Clears any existing progress data for this challenge</li></ul></dd>
|
|
|
6546
4156
|
</dt>
|
|
6547
4157
|
<dd>
|
|
6548
4158
|
|
|
6549
|
-
<span class="param-type">Promise.<(
|
|
4159
|
+
<span class="param-type">Promise.<(*|null)></span>
|
|
6550
4160
|
|
|
6551
4161
|
|
|
6552
4162
|
|
|
@@ -6562,7 +4172,7 @@ Clears any existing progress data for this challenge</li></ul></dd>
|
|
|
6562
4172
|
|
|
6563
4173
|
|
|
6564
4174
|
|
|
6565
|
-
<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>
|
|
6566
4176
|
|
|
6567
4177
|
|
|
6568
4178
|
|
|
@@ -6571,15 +4181,11 @@ Clears any existing progress data for this challenge</li></ul></dd>
|
|
|
6571
4181
|
|
|
6572
4182
|
<dl class="details">
|
|
6573
4183
|
|
|
6574
|
-
<dt class="tag-description">Description:</dt>
|
|
6575
|
-
<dd class="tag-description"><ul class="dummy"><li>Enroll the user in the provided challenge and set to unlocked
|
|
6576
|
-
Clears any current progress data for this challenge</li></ul></dd>
|
|
6577
|
-
|
|
6578
4184
|
|
|
6579
4185
|
|
|
6580
4186
|
<dt class="tag-source">Source:</dt>
|
|
6581
4187
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
6582
|
-
<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#line535">line 535</a>
|
|
6583
4189
|
</li></ul></dd>
|
|
6584
4190
|
|
|
6585
4191
|
|
|
@@ -6651,16 +4257,13 @@ Clears any current progress data for this challenge</li></ul></dd>
|
|
|
6651
4257
|
|
|
6652
4258
|
<tr>
|
|
6653
4259
|
|
|
6654
|
-
<td class="name"><code>
|
|
4260
|
+
<td class="name"><code>commentId</code></td>
|
|
6655
4261
|
|
|
6656
4262
|
|
|
6657
4263
|
<td class="type">
|
|
6658
4264
|
|
|
6659
4265
|
|
|
6660
4266
|
<span class="param-type">int</span>
|
|
6661
|
-
|
|
|
6662
|
-
|
|
6663
|
-
<span class="param-type">string</span>
|
|
6664
4267
|
|
|
6665
4268
|
|
|
6666
4269
|
|
|
@@ -6671,7 +4274,7 @@ Clears any current progress data for this challenge</li></ul></dd>
|
|
|
6671
4274
|
|
|
6672
4275
|
|
|
6673
4276
|
|
|
6674
|
-
<td class="description last"
|
|
4277
|
+
<td class="description last"></td>
|
|
6675
4278
|
</tr>
|
|
6676
4279
|
|
|
6677
4280
|
|
|
@@ -6704,7 +4307,7 @@ Clears any current progress data for this challenge</li></ul></dd>
|
|
|
6704
4307
|
</dt>
|
|
6705
4308
|
<dd>
|
|
6706
4309
|
|
|
6707
|
-
<span class="param-type">Promise.<(
|
|
4310
|
+
<span class="param-type">Promise.<(*|null)></span>
|
|
6708
4311
|
|
|
6709
4312
|
|
|
6710
4313
|
|
|
@@ -6733,7 +4336,7 @@ Clears any current progress data for this challenge</li></ul></dd>
|
|
|
6733
4336
|
|
|
6734
4337
|
<dt class="tag-source">Source:</dt>
|
|
6735
4338
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
6736
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
4339
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line463">line 463</a>
|
|
6737
4340
|
</li></ul></dd>
|
|
6738
4341
|
|
|
6739
4342
|
|
|
@@ -6908,7 +4511,7 @@ Clears any current progress data for this challenge</li></ul></dd>
|
|
|
6908
4511
|
|
|
6909
4512
|
<dt class="tag-source">Source:</dt>
|
|
6910
4513
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
6911
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
4514
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line561">line 561</a>
|
|
6912
4515
|
</li></ul></dd>
|
|
6913
4516
|
|
|
6914
4517
|
|
|
@@ -7083,7 +4686,7 @@ Clears any current progress data for this challenge</li></ul></dd>
|
|
|
7083
4686
|
|
|
7084
4687
|
<dt class="tag-source">Source:</dt>
|
|
7085
4688
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
7086
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
4689
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line453">line 453</a>
|
|
7087
4690
|
</li></ul></dd>
|
|
7088
4691
|
|
|
7089
4692
|
|
|
@@ -7237,7 +4840,7 @@ Clears any current progress data for this challenge</li></ul></dd>
|
|
|
7237
4840
|
|
|
7238
4841
|
<dt class="tag-source">Source:</dt>
|
|
7239
4842
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
7240
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
4843
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line399">line 399</a>
|
|
7241
4844
|
</li></ul></dd>
|
|
7242
4845
|
|
|
7243
4846
|
|
|
@@ -7415,7 +5018,7 @@ Clears any current progress data for this challenge</li></ul></dd>
|
|
|
7415
5018
|
|
|
7416
5019
|
<dt class="tag-source">Source:</dt>
|
|
7417
5020
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
7418
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
5021
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line496">line 496</a>
|
|
7419
5022
|
</li></ul></dd>
|
|
7420
5023
|
|
|
7421
5024
|
|
|
@@ -7566,7 +5169,7 @@ Clears any current progress data for this challenge</li></ul></dd>
|
|
|
7566
5169
|
|
|
7567
5170
|
<dt class="tag-source">Source:</dt>
|
|
7568
5171
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
7569
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
5172
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line514">line 514</a>
|
|
7570
5173
|
</li></ul></dd>
|
|
7571
5174
|
|
|
7572
5175
|
|
|
@@ -7720,7 +5323,7 @@ Clears any current progress data for this challenge</li></ul></dd>
|
|
|
7720
5323
|
|
|
7721
5324
|
<dt class="tag-source">Source:</dt>
|
|
7722
5325
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
7723
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
5326
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line657">line 657</a>
|
|
7724
5327
|
</li></ul></dd>
|
|
7725
5328
|
|
|
7726
5329
|
|
|
@@ -7888,7 +5491,7 @@ Clears any current progress data for this challenge</li></ul></dd>
|
|
|
7888
5491
|
|
|
7889
5492
|
<dt class="tag-source">Source:</dt>
|
|
7890
5493
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
7891
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
5494
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line683">line 683</a>
|
|
7892
5495
|
</li></ul></dd>
|
|
7893
5496
|
|
|
7894
5497
|
|
|
@@ -8084,7 +5687,7 @@ Clears any current progress data for this challenge</li></ul></dd>
|
|
|
8084
5687
|
|
|
8085
5688
|
<dt class="tag-source">Source:</dt>
|
|
8086
5689
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
8087
|
-
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#
|
|
5690
|
+
<a href="railcontent.js.html">railcontent.js</a>, <a href="railcontent.js.html#line691">line 691</a>
|
|
8088
5691
|
</li></ul></dd>
|
|
8089
5692
|
|
|
8090
5693
|
|
|
@@ -8260,7 +5863,7 @@ Clears any current progress data for this challenge</li></ul></dd>
|
|
|
8260
5863
|
<br class="clear">
|
|
8261
5864
|
|
|
8262
5865
|
<footer>
|
|
8263
|
-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on
|
|
5866
|
+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Fri Jul 25 2025 21:19:12 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
|
|
8264
5867
|
</footer>
|
|
8265
5868
|
|
|
8266
5869
|
<script>prettyPrint();</script>
|