musora-content-services 1.6.7 → 1.6.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/conventional-commits.yaml +0 -0
- package/.github/workflows/docs.js.yml +0 -0
- package/.github/workflows/sync-docs.yml +0 -0
- package/CHANGELOG.md +4 -0
- package/README.md +0 -0
- package/docs/algolia.js.html +0 -0
- package/docs/config.js.html +0 -0
- package/docs/index.html +0 -0
- package/docs/module-Config.html +0 -0
- package/docs/module-Railcontent-Services.html +0 -0
- package/docs/module-Sanity-Services.html +0 -0
- package/docs/module-Search-Engine-Services.html +0 -0
- package/docs/railcontent.js.html +0 -0
- package/docs/sanity.js.html +0 -0
- package/docs/v2/ContentOrganization.html +2 -2
- package/docs/v2/Forums.html +269 -0
- package/docs/v2/Gamification.html +2 -2
- package/docs/v2/TestUser.html +260 -0
- package/docs/v2/UserManagementSystem.html +2 -2
- package/docs/v2/api_types.js.html +2 -2
- package/docs/v2/config.js.html +2 -8
- package/docs/v2/content-org_content-org.js.html +2 -2
- package/docs/v2/content-org_guided-courses.ts.html +110 -0
- package/docs/v2/content-org_learning-paths.ts.html +123 -0
- package/docs/v2/content-org_playlists-types.js.html +14 -2
- package/docs/v2/content-org_playlists.js.html +39 -17
- package/docs/v2/content.js.html +111 -52
- package/docs/v2/fonts/Montserrat/Montserrat-Bold.eot +0 -0
- package/docs/v2/fonts/Montserrat/Montserrat-Bold.ttf +0 -0
- package/docs/v2/fonts/Montserrat/Montserrat-Bold.woff +0 -0
- package/docs/v2/fonts/Montserrat/Montserrat-Bold.woff2 +0 -0
- package/docs/v2/fonts/Montserrat/Montserrat-Regular.eot +0 -0
- package/docs/v2/fonts/Montserrat/Montserrat-Regular.ttf +0 -0
- package/docs/v2/fonts/Montserrat/Montserrat-Regular.woff +0 -0
- package/docs/v2/fonts/Montserrat/Montserrat-Regular.woff2 +0 -0
- package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.eot +0 -0
- package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.svg +0 -0
- package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.ttf +0 -0
- package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff +0 -0
- package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff2 +0 -0
- package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.eot +0 -0
- package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.svg +0 -0
- package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.ttf +0 -0
- package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff +0 -0
- package/docs/v2/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff2 +0 -0
- package/docs/v2/forums_categories.ts.html +137 -0
- package/docs/v2/forums_discussions.js.html +95 -0
- package/docs/v2/forums_forum.js.html +95 -0
- package/docs/v2/forums_forums.ts.html +160 -0
- package/docs/v2/forums_posts.ts.html +258 -0
- package/docs/v2/forums_threads.ts.html +271 -0
- package/docs/v2/gamification_awards.js.html +35 -534
- package/docs/v2/gamification_awards.ts.html +181 -0
- package/docs/v2/gamification_gamification.js.html +2 -2
- package/docs/v2/gamification_types.js.html +7 -25
- package/docs/v2/global.html +849 -690
- package/docs/v2/index.html +2 -3
- package/docs/v2/liveTesting.ts.html +102 -0
- package/docs/v2/module-Accounts.html +2094 -0
- package/docs/v2/module-Awards.html +396 -14
- package/docs/v2/module-Categories.html +711 -0
- package/docs/v2/module-Config.html +4 -8
- package/docs/v2/module-Content-Services-V2.html +182 -49
- package/docs/v2/module-ForumCategories.html +687 -0
- package/docs/v2/module-ForumDiscussions.html +370 -0
- package/docs/v2/module-Forums.html +15393 -0
- package/docs/v2/module-GuidedCourses.html +1304 -0
- package/docs/v2/module-Interests.html +2 -2
- package/docs/v2/module-Onboarding.html +670 -0
- package/docs/v2/module-Payments.html +250 -0
- package/docs/v2/module-Permissions.html +2 -2
- package/docs/v2/module-Playlists.html +212 -44
- package/docs/v2/module-Railcontent-Services.html +689 -2175
- package/docs/v2/module-Sanity-Services.html +480 -925
- package/docs/v2/module-Sessions.html +3 -3
- package/docs/v2/module-Threads.html +1119 -0
- package/docs/v2/module-UserActivity.html +193 -23
- package/docs/v2/module-UserChat.html +410 -0
- package/docs/v2/module-UserManagement.html +1028 -11
- package/docs/v2/module-UserMemberships.html +829 -0
- package/docs/v2/module-UserNotifications.html +1399 -27
- package/docs/v2/module-UserProfile.html +106 -2
- package/docs/v2/railcontent.js.html +87 -236
- package/docs/v2/sanity.js.html +342 -415
- package/docs/v2/scripts/collapse.js +0 -0
- package/docs/v2/scripts/commonNav.js +0 -0
- package/docs/v2/scripts/linenumber.js +0 -0
- package/docs/v2/scripts/nav.js +0 -0
- package/docs/v2/scripts/polyfill.js +0 -0
- package/docs/v2/scripts/prettify/Apache-License-2.0.txt +0 -0
- package/docs/v2/scripts/prettify/lang-css.js +0 -0
- package/docs/v2/scripts/prettify/prettify.js +0 -0
- package/docs/v2/scripts/search.js +0 -0
- package/docs/v2/styles/jsdoc.css +0 -0
- package/docs/v2/styles/prettify.css +0 -0
- package/docs/v2/userActivity.js.html +532 -451
- package/docs/v2/user_account.ts.html +237 -0
- package/docs/v2/user_chat.js.html +98 -0
- package/docs/v2/user_interests.js.html +2 -2
- package/docs/v2/user_management.js.html +82 -2
- package/docs/v2/user_memberships.js.html +144 -0
- package/docs/v2/user_memberships.ts.html +292 -0
- package/docs/v2/user_notifications.js.html +203 -21
- package/docs/v2/user_onboarding.ts.html +183 -0
- package/docs/v2/user_payments.ts.html +97 -0
- package/docs/v2/user_permissions.js.html +2 -2
- package/docs/v2/user_profile.js.html +12 -2
- package/docs/v2/user_sessions.js.html +33 -2
- package/docs/v2/user_types.js.html +16 -2
- package/docs/v2/user_user-management-system.js.html +2 -2
- package/jsdoc.json +0 -0
- package/link_mcs.sh +0 -0
- package/package.json +1 -1
- package/src/contentMetaData.js +0 -0
- package/src/contentTypeConfig.js +3 -3
- package/src/filterBuilder.js +0 -0
- package/src/index.d.ts +0 -0
- package/src/index.js +0 -0
- package/src/services/algolia.js +0 -0
- package/src/services/config.js +0 -0
- package/src/services/contentLikes.js +0 -0
- package/src/services/contentProgress.js +0 -0
- package/src/services/dataContext.js +0 -0
- package/src/services/imageSRCBuilder.js +1 -1
- package/src/services/imageSRCVerify.js +1 -1
- package/src/services/lastUpdated.js +0 -0
- package/src/services/railcontent.js +0 -0
- package/src/services/recommendations.js +0 -0
- package/src/services/userPermissions.js +0 -0
- package/test/config.test.js +0 -0
- package/test/contentLikes.test.js +0 -0
- package/test/contentProgress.test.js +0 -0
- package/test/imageSRCBuilder.test.js +1 -1
- package/test/imageSRCVerify.test.js +4 -4
- package/test/initializeTests.js +0 -0
- package/test/lastUpdated.test.js +0 -0
- package/test/sanityQueryService.test.js +0 -0
- package/test/userPermissions.test.js +0 -0
- package/tools/generate-index.cjs +0 -0
- package/.yarnrc.yml +0 -1
- package/docs/v2/Content-Organization.html +0 -245
- package/docs/v2/UserManagement.html +0 -269
- package/docs/v2/global.html#User +0 -293
- package/docs/v2/module-Notifications.html +0 -1183
- package/docs/v2/module-Session-Management.html +0 -575
- package/docs/v2/module-User-Activity.html +0 -4410
- package/docs/v2/module-User-Management.html +0 -490
- package/docs/v2/module-User-Permissions.html +0 -406
- package/docs/v2/types.js.html +0 -122
- package/docs/v2/user_user-management.js.html +0 -78
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
<nav >
|
|
30
30
|
|
|
31
31
|
|
|
32
|
-
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Awards.html">Awards</a><ul class='methods'><li data-type='method'><a href="module-Awards.html#.fetchAwardsForUser">fetchAwardsForUser</a></li></ul></li><li><a href="module-Config.html">Config</a><ul class='methods'><li data-type='method'><a href="module-Config.html#.initializeService">initializeService</a></li></ul></li><li><a href="module-Content-Services-V2.html">Content-Services-V2</a><ul class='methods'><li data-type='method'><a href="module-Content-Services-V2.html#.getContentRows">getContentRows</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getNewAndUpcoming">getNewAndUpcoming</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getRecent">getRecent</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getRecommendedForYou">getRecommendedForYou</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getScheduleContentRows">getScheduleContentRows</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getTabResults">getTabResults</a></li></ul></li><li><a href="module-Interests.html">Interests</a><ul class='methods'><li data-type='method'><a href="module-Interests.html#.fetchInterests">fetchInterests</a></li><li data-type='method'><a href="module-Interests.html#.fetchUninterests">fetchUninterests</a></li><li data-type='method'><a href="module-Interests.html#.markContentAsInterested">markContentAsInterested</a></li><li data-type='method'><a href="module-Interests.html#.markContentAsNotInterested">markContentAsNotInterested</a></li><li data-type='method'><a href="module-Interests.html#.removeContentAsInterested">removeContentAsInterested</a></li><li data-type='method'><a href="module-Interests.html#.removeContentAsNotInterested">removeContentAsNotInterested</a></li></ul></li><li><a href="module-Permissions.html">Permissions</a><ul class='methods'><li data-type='method'><a href="module-Permissions.html#.fetchUserPermissions">fetchUserPermissions</a></li><li data-type='method'><a href="module-Permissions.html#.reset">reset</a></li></ul></li><li><a href="module-Playlists.html">Playlists</a><ul class='methods'><li data-type='method'><a href="module-Playlists.html#.addItemToPlaylist">addItemToPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.createPlaylist">createPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.deletePlaylist">deletePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.duplicatePlaylist">duplicatePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.fetchPlaylist">fetchPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.fetchPlaylistItems">fetchPlaylistItems</a></li><li data-type='method'><a href="module-Playlists.html#.fetchUserPlaylists">fetchUserPlaylists</a></li><li data-type='method'><a href="module-Playlists.html#.togglePlaylistPrivate">togglePlaylistPrivate</a></li><li data-type='method'><a href="module-Playlists.html#.undeletePlaylist">undeletePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.updatePlaylist">updatePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~likePlaylist">likePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~reportPlaylist">reportPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~togglePlaylistPrivate">togglePlaylistPrivate</a></li><li data-type='method'><a href="module-Playlists.html#~unlikePlaylist">unlikePlaylist</a></li></ul></li><li><a href="module-Railcontent-Services.html">Railcontent-Services</a><ul class='methods'><li data-type='method'><a href="module-Railcontent-Services.html#.assignModeratorToComment">assignModeratorToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.closeComment">closeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.createComment">createComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.deleteComment">deleteComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.editComment">editComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchAllCompletedStates">fetchAllCompletedStates</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCarouselCardData">fetchCarouselCardData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchChallengeIndexMetadata">fetchChallengeIndexMetadata</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchChallengeLessonData">fetchChallengeLessonData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchChallengeMetadata">fetchChallengeMetadata</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchChallengeUserActiveChallenges">fetchChallengeUserActiveChallenges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCommentRelies">fetchCommentRelies</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchComments">fetchComments</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedChallenges">fetchCompletedChallenges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedContent">fetchCompletedContent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedState">fetchCompletedState</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentInProgress">fetchContentInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentPageUserData">fetchContentPageUserData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchNextContentDataForParent">fetchNextContentDataForParent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchOwnedChallenges">fetchOwnedChallenges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchRecentUserActivities">fetchRecentUserActivities</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchSongsInProgress">fetchSongsInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchTopComment">fetchTopComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserAward">fetchUserAward</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserBadges">fetchUserBadges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserChallengeProgress">fetchUserChallengeProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserPracticeNotes">fetchUserPracticeNotes</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.likeComment">likeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.openComment">openComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesCommunityNotification">postChallengesCommunityNotification</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesEnroll">postChallengesEnroll</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesEnrollmentNotification">postChallengesEnrollmentNotification</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesHideCompletedBanner">postChallengesHideCompletedBanner</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesLeave">postChallengesLeave</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesSetStartDate">postChallengesSetStartDate</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesSoloNotification">postChallengesSoloNotification</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postChallengesUnlock">postChallengesUnlock</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.replyToComment">replyToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.reportComment">reportComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.setStudentViewForUser">setStudentViewForUser</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.unassignModeratorToComment">unassignModeratorToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.unlikeComment">unlikeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#~fetchLastInteractedChild">fetchLastInteractedChild</a></li></ul></li><li><a href="module-Sanity-Services.html">Sanity-Services</a><ul class='methods'><li data-type='method'><a href="module-Sanity-Services.html#.fetchAll">fetchAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllFilterOptions">fetchAllFilterOptions</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllPacks">fetchAllPacks</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchArtistLessons">fetchArtistLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchArtists">fetchArtists</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByRailContentId">fetchByRailContentId</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByRailContentIds">fetchByRailContentIds</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByReference">fetchByReference</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchCoachLessons">fetchCoachLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchComingSoon">fetchComingSoon</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchCommentModContentData">fetchCommentModContentData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchFoundation">fetchFoundation</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchGenreLessons">fetchGenreLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLeaving">fetchLeaving</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLessonContent">fetchLessonContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLessonsFeaturingThisContent">fetchLessonsFeaturingThisContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMetadata">fetchMetadata</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethod">fetchMethod</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodChildren">fetchMethodChildren</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodChildrenIds">fetchMethodChildrenIds</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodPreviousNextLesson">fetchMethodPreviousNextLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchNewReleases">fetchNewReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchNextPreviousLesson">fetchNextPreviousLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchOtherSongVersions">fetchOtherSongVersions</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackAll">fetchPackAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackData">fetchPackData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchParentForDownload">fetchParentForDownload</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedLessons">fetchRelatedLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedRecommendedContent">fetchRelatedRecommendedContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedSongs">fetchRelatedSongs</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchReturning">fetchReturning</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSanity">fetchSanity</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchScheduledReleases">fetchScheduledReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchShowsData">fetchShowsData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongArtistCount">fetchSongArtistCount</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongById">fetchSongById</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchUpcomingEvents">fetchUpcomingEvents</a></li><li data-type='method'><a href="module-Sanity-Services.html#.jumpToContinueContent">jumpToContinueContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#~fetchRelatedByLicense">fetchRelatedByLicense</a></li><li data-type='method'><a href="module-Sanity-Services.html#~getNextAndPreviousQuarterDates">getNextAndPreviousQuarterDates</a></li><li data-type='method'><a href="module-Sanity-Services.html#~getQueryFromPage">getQueryFromPage</a></li><li data-type='method'><a href="module-Sanity-Services.html#~handleCustomFetchAll">handleCustomFetchAll</a></li></ul></li><li><a href="module-Sessions.html">Sessions</a><ul class='methods'><li data-type='method'><a href="module-Sessions.html#.login">login</a></li><li data-type='method'><a href="module-Sessions.html#.logout">logout</a></li></ul></li><li><a href="module-UserActivity.html">UserActivity</a><ul class='methods'><li data-type='method'><a href="module-UserActivity.html#.calculateLongestStreaks">calculateLongestStreaks</a></li><li data-type='method'><a href="module-UserActivity.html#.createPracticeNotes">createPracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.deletePracticeSession">deletePracticeSession</a></li><li data-type='method'><a href="module-UserActivity.html#.deleteUserActivity">deleteUserActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.getPracticeNotes">getPracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.getPracticeSessions">getPracticeSessions</a></li><li data-type='method'><a href="module-UserActivity.html#.getProgressRows">getProgressRows</a></li><li data-type='method'><a href="module-UserActivity.html#.getRecentActivity">getRecentActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.getUserMonthlyStats">getUserMonthlyStats</a></li><li data-type='method'><a href="module-UserActivity.html#.getUserWeeklyStats">getUserWeeklyStats</a></li><li data-type='method'><a href="module-UserActivity.html#.pinProgressRow">pinProgressRow</a></li><li data-type='method'><a href="module-UserActivity.html#.recordUserActivity">recordUserActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.recordUserPractice">recordUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.removeUserPractice">removeUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.restorePracticeSession">restorePracticeSession</a></li><li data-type='method'><a href="module-UserActivity.html#.restoreUserPractice">restoreUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.unpinProgressRow">unpinProgressRow</a></li><li data-type='method'><a href="module-UserActivity.html#.updatePracticeNotes">updatePracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.updateUserPractice">updateUserPractice</a></li></ul></li><li><a href="module-UserChat.html">UserChat</a><ul class='methods'><li data-type='method'><a href="module-UserChat.html#.fetchChatSettings">fetchChatSettings</a></li></ul></li><li><a href="module-UserManagement.html">UserManagement</a><ul class='methods'><li data-type='method'><a href="module-UserManagement.html#.blockUser">blockUser</a></li><li data-type='method'><a href="module-UserManagement.html#.deletePicture">deletePicture</a></li><li data-type='method'><a href="module-UserManagement.html#.unblockUser">unblockUser</a></li><li data-type='method'><a href="module-UserManagement.html#.uploadPicture">uploadPicture</a></li><li data-type='method'><a href="module-UserManagement.html#.uploadPictureFromS3">uploadPictureFromS3</a></li></ul></li><li><a href="module-UserNotifications.html">UserNotifications</a><ul class='methods'><li data-type='method'><a href="module-UserNotifications.html#.deleteNotification">deleteNotification</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchNotifications">fetchNotifications</a></li><li data-type='method'><a href="module-UserNotifications.html#.markAllNotificationsAsRead">markAllNotificationsAsRead</a></li><li data-type='method'><a href="module-UserNotifications.html#.markNotificationAsRead">markNotificationAsRead</a></li><li data-type='method'><a href="module-UserNotifications.html#.markNotificationAsUnread">markNotificationAsUnread</a></li></ul></li><li><a href="module-UserProfile.html">UserProfile</a><ul class='methods'><li data-type='method'><a href="module-UserProfile.html#.otherStats">otherStats</a></li></ul></li></ul><h3>Namespaces</h3><ul><li><a href="ContentOrganization.html">ContentOrganization</a></li><li><a href="Gamification.html">Gamification</a></li><li><a href="UserManagementSystem.html">UserManagementSystem</a></li></ul><h3><a href="global.html">Global</a></h3>
|
|
32
|
+
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Accounts.html">Accounts</a><ul class='methods'><li data-type='method'><a href="module-Accounts.html#~confirmEmailChange">confirmEmailChange</a></li><li data-type='method'><a href="module-Accounts.html#~deleteAccount">deleteAccount</a></li><li data-type='method'><a href="module-Accounts.html#~numberOfActiveUsers">numberOfActiveUsers</a></li><li data-type='method'><a href="module-Accounts.html#~requestEmailChange">requestEmailChange</a></li><li data-type='method'><a href="module-Accounts.html#~resetPassword">resetPassword</a></li><li data-type='method'><a href="module-Accounts.html#~sendAccountSetupEmail">sendAccountSetupEmail</a></li><li data-type='method'><a href="module-Accounts.html#~sendPasswordResetEmail">sendPasswordResetEmail</a></li><li data-type='method'><a href="module-Accounts.html#~setupAccount">setupAccount</a></li><li data-type='method'><a href="module-Accounts.html#~status">status</a></li></ul></li><li><a href="module-Awards.html">Awards</a><ul class='methods'><li data-type='method'><a href="module-Awards.html#~fetchAwardsForUser">fetchAwardsForUser</a></li><li data-type='method'><a href="module-Awards.html#~fetchCertificate">fetchCertificate</a></li><li data-type='method'><a href="module-Awards.html#~getAwardDataForGuidedContent">getAwardDataForGuidedContent</a></li></ul></li><li><a href="module-Config.html">Config</a><ul class='methods'><li data-type='method'><a href="module-Config.html#.initializeService">initializeService</a></li></ul></li><li><a href="module-Content-Services-V2.html">Content-Services-V2</a><ul class='methods'><li data-type='method'><a href="module-Content-Services-V2.html#.getContentRows">getContentRows</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getLegacyMethods">getLegacyMethods</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getNewAndUpcoming">getNewAndUpcoming</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getRecent">getRecent</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getRecommendedForYou">getRecommendedForYou</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getScheduleContentRows">getScheduleContentRows</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getTabResults">getTabResults</a></li></ul></li><li><a href="module-Forums.html">Forums</a><ul class='methods'><li data-type='method'><a href="module-Forums.html#~createForumCategory">createForumCategory</a></li><li data-type='method'><a href="module-Forums.html#~createPost">createPost</a></li><li data-type='method'><a href="module-Forums.html#~createThread">createThread</a></li><li data-type='method'><a href="module-Forums.html#~deletePost">deletePost</a></li><li data-type='method'><a href="module-Forums.html#~deleteThread">deleteThread</a></li><li data-type='method'><a href="module-Forums.html#~fetchCommunityGuidelines">fetchCommunityGuidelines</a></li><li data-type='method'><a href="module-Forums.html#~fetchFollowedThreads">fetchFollowedThreads</a></li><li data-type='method'><a href="module-Forums.html#~fetchForumCategories">fetchForumCategories</a></li><li data-type='method'><a href="module-Forums.html#~fetchLatestThreads">fetchLatestThreads</a></li><li data-type='method'><a href="module-Forums.html#~fetchPosts">fetchPosts</a></li><li data-type='method'><a href="module-Forums.html#~fetchThreads">fetchThreads</a></li><li data-type='method'><a href="module-Forums.html#~followThread">followThread</a></li><li data-type='method'><a href="module-Forums.html#~jumpToPost">jumpToPost</a></li><li data-type='method'><a href="module-Forums.html#~likePost">likePost</a></li><li data-type='method'><a href="module-Forums.html#~lockThread">lockThread</a></li><li data-type='method'><a href="module-Forums.html#~pinThread">pinThread</a></li><li data-type='method'><a href="module-Forums.html#~search">search</a></li><li data-type='method'><a href="module-Forums.html#~unfollowThread">unfollowThread</a></li><li data-type='method'><a href="module-Forums.html#~unlikePost">unlikePost</a></li><li data-type='method'><a href="module-Forums.html#~unlockThread">unlockThread</a></li><li data-type='method'><a href="module-Forums.html#~unpinThread">unpinThread</a></li><li data-type='method'><a href="module-Forums.html#~updateForumCategory">updateForumCategory</a></li><li data-type='method'><a href="module-Forums.html#~updatePost">updatePost</a></li><li data-type='method'><a href="module-Forums.html#~updateThread">updateThread</a></li></ul></li><li></li><li></li><li><a href="module-GuidedCourses.html">GuidedCourses</a><ul class='methods'><li data-type='method'><a href="module-GuidedCourses.html#~getActivePath">getActivePath</a></li><li data-type='method'><a href="module-GuidedCourses.html#~getDailySession">getDailySession</a></li><li data-type='method'><a href="module-GuidedCourses.html#~updateActivePath">updateActivePath</a></li><li data-type='method'><a href="module-GuidedCourses.html#~updateDailySession">updateDailySession</a></li></ul></li><li></li><li><a href="module-Interests.html">Interests</a><ul class='methods'><li data-type='method'><a href="module-Interests.html#.fetchInterests">fetchInterests</a></li><li data-type='method'><a href="module-Interests.html#.fetchUninterests">fetchUninterests</a></li><li data-type='method'><a href="module-Interests.html#.markContentAsInterested">markContentAsInterested</a></li><li data-type='method'><a href="module-Interests.html#.markContentAsNotInterested">markContentAsNotInterested</a></li><li data-type='method'><a href="module-Interests.html#.removeContentAsInterested">removeContentAsInterested</a></li><li data-type='method'><a href="module-Interests.html#.removeContentAsNotInterested">removeContentAsNotInterested</a></li></ul></li><li><a href="module-Onboarding.html">Onboarding</a><ul class='methods'><li data-type='method'><a href="module-Onboarding.html#~startOnboarding">startOnboarding</a></li><li data-type='method'><a href="module-Onboarding.html#~updateOnboarding">updateOnboarding</a></li><li data-type='method'><a href="module-Onboarding.html#~userOnboardingForBrand">userOnboardingForBrand</a></li></ul></li><li><a href="module-Payments.html">Payments</a><ul class='methods'><li data-type='method'><a href="module-Payments.html#~fetchCustomerPayments">fetchCustomerPayments</a></li></ul></li><li><a href="module-Permissions.html">Permissions</a><ul class='methods'><li data-type='method'><a href="module-Permissions.html#.fetchUserPermissions">fetchUserPermissions</a></li><li data-type='method'><a href="module-Permissions.html#.reset">reset</a></li></ul></li><li><a href="module-Playlists.html">Playlists</a><ul class='methods'><li data-type='method'><a href="module-Playlists.html#.addItemToPlaylist">addItemToPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.createPlaylist">createPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.deletePlaylist">deletePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.duplicatePlaylist">duplicatePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.fetchPlaylist">fetchPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.fetchPlaylistItems">fetchPlaylistItems</a></li><li data-type='method'><a href="module-Playlists.html#.fetchUserPlaylists">fetchUserPlaylists</a></li><li data-type='method'><a href="module-Playlists.html#.togglePlaylistPrivate">togglePlaylistPrivate</a></li><li data-type='method'><a href="module-Playlists.html#.undeletePlaylist">undeletePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.updatePlaylist">updatePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~deleteItemsFromPlaylist">deleteItemsFromPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~likePlaylist">likePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~reportPlaylist">reportPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~restoreItemFromPlaylist">restoreItemFromPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~unlikePlaylist">unlikePlaylist</a></li></ul></li><li><a href="module-Railcontent-Services.html">Railcontent-Services</a><ul class='methods'><li data-type='method'><a href="module-Railcontent-Services.html#.assignModeratorToComment">assignModeratorToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.closeComment">closeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.createComment">createComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.deleteComment">deleteComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.editComment">editComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchAllCompletedStates">fetchAllCompletedStates</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCarouselCardData">fetchCarouselCardData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchComment">fetchComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCommentRelies">fetchCommentRelies</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchComments">fetchComments</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedContent">fetchCompletedContent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedState">fetchCompletedState</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentInProgress">fetchContentInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentPageUserData">fetchContentPageUserData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchNextContentDataForParent">fetchNextContentDataForParent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchRecentUserActivities">fetchRecentUserActivities</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchSongsInProgress">fetchSongsInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchTopComment">fetchTopComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserAward">fetchUserAward</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserBadges">fetchUserBadges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserPracticeNotes">fetchUserPracticeNotes</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.likeComment">likeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.openComment">openComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentComplete">postContentComplete</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentReset">postContentReset</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentRestore">postContentRestore</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentStart">postContentStart</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.replyToComment">replyToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.reportComment">reportComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.restoreComment">restoreComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.setStudentViewForUser">setStudentViewForUser</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.unassignModeratorToComment">unassignModeratorToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.unlikeComment">unlikeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#~fetchLastInteractedChild">fetchLastInteractedChild</a></li></ul></li><li><a href="module-Sanity-Services.html">Sanity-Services</a><ul class='methods'><li data-type='method'><a href="module-Sanity-Services.html#.fetchAll">fetchAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllFilterOptions">fetchAllFilterOptions</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllPacks">fetchAllPacks</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchArtistLessons">fetchArtistLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchArtists">fetchArtists</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByRailContentId">fetchByRailContentId</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByRailContentIds">fetchByRailContentIds</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByReference">fetchByReference</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchCoachLessons">fetchCoachLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchComingSoon">fetchComingSoon</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchCommentModContentData">fetchCommentModContentData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchFoundation">fetchFoundation</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchGenreLessons">fetchGenreLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLeaving">fetchLeaving</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLessonContent">fetchLessonContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLessonsFeaturingThisContent">fetchLessonsFeaturingThisContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMetadata">fetchMetadata</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethod">fetchMethod</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodChildren">fetchMethodChildren</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodChildrenIds">fetchMethodChildrenIds</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodPreviousNextLesson">fetchMethodPreviousNextLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodV2IntroVideo">fetchMethodV2IntroVideo</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodV2Structure">fetchMethodV2Structure</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchNewReleases">fetchNewReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchNextPreviousLesson">fetchNextPreviousLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchOtherSongVersions">fetchOtherSongVersions</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackAll">fetchPackAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackData">fetchPackData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedLessons">fetchRelatedLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedRecommendedContent">fetchRelatedRecommendedContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedSongs">fetchRelatedSongs</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchReturning">fetchReturning</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSanity">fetchSanity</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchScheduledReleases">fetchScheduledReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchShowsData">fetchShowsData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSiblingContent">fetchSiblingContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongArtistCount">fetchSongArtistCount</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongById">fetchSongById</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchUpcomingEvents">fetchUpcomingEvents</a></li><li data-type='method'><a href="module-Sanity-Services.html#.jumpToContinueContent">jumpToContinueContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#~fetchRelatedByLicense">fetchRelatedByLicense</a></li><li data-type='method'><a href="module-Sanity-Services.html#~getQueryFromPage">getQueryFromPage</a></li></ul></li><li><a href="module-Sessions.html">Sessions</a><ul class='methods'><li data-type='method'><a href="module-Sessions.html#.login">login</a></li><li data-type='method'><a href="module-Sessions.html#.logout">logout</a></li></ul></li><li><a href="module-UserActivity.html">UserActivity</a><ul class='methods'><li data-type='method'><a href="module-UserActivity.html#.calculateLongestStreaks">calculateLongestStreaks</a></li><li data-type='method'><a href="module-UserActivity.html#.createPracticeNotes">createPracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.deletePracticeSession">deletePracticeSession</a></li><li data-type='method'><a href="module-UserActivity.html#.deleteUserActivity">deleteUserActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.getPracticeNotes">getPracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.getPracticeSessions">getPracticeSessions</a></li><li data-type='method'><a href="module-UserActivity.html#.getProgressRows">getProgressRows</a></li><li data-type='method'><a href="module-UserActivity.html#.getRecentActivity">getRecentActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.getUserMonthlyStats">getUserMonthlyStats</a></li><li data-type='method'><a href="module-UserActivity.html#.getUserWeeklyStats">getUserWeeklyStats</a></li><li data-type='method'><a href="module-UserActivity.html#.pinProgressRow">pinProgressRow</a></li><li data-type='method'><a href="module-UserActivity.html#.recordUserActivity">recordUserActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.recordUserPractice">recordUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.removeUserPractice">removeUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.restorePracticeSession">restorePracticeSession</a></li><li data-type='method'><a href="module-UserActivity.html#.restoreUserActivity">restoreUserActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.restoreUserPractice">restoreUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.unpinProgressRow">unpinProgressRow</a></li><li data-type='method'><a href="module-UserActivity.html#.updatePracticeNotes">updatePracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.updateUserPractice">updateUserPractice</a></li></ul></li><li><a href="module-UserChat.html">UserChat</a><ul class='methods'><li data-type='method'><a href="module-UserChat.html#.fetchChatSettings">fetchChatSettings</a></li></ul></li><li><a href="module-UserManagement.html">UserManagement</a><ul class='methods'><li data-type='method'><a href="module-UserManagement.html#.blockUser">blockUser</a></li><li data-type='method'><a href="module-UserManagement.html#.blockedUsers">blockedUsers</a></li><li data-type='method'><a href="module-UserManagement.html#.deletePicture">deletePicture</a></li><li data-type='method'><a href="module-UserManagement.html#.getUserData">getUserData</a></li><li data-type='method'><a href="module-UserManagement.html#.getUserSignature">getUserSignature</a></li><li data-type='method'><a href="module-UserManagement.html#.isUsernameAvailable">isUsernameAvailable</a></li><li data-type='method'><a href="module-UserManagement.html#.setUserSignature">setUserSignature</a></li><li data-type='method'><a href="module-UserManagement.html#.toggleSignaturePrivate">toggleSignaturePrivate</a></li><li data-type='method'><a href="module-UserManagement.html#.unblockUser">unblockUser</a></li><li data-type='method'><a href="module-UserManagement.html#.updateDisplayName">updateDisplayName</a></li><li data-type='method'><a href="module-UserManagement.html#.uploadPicture">uploadPicture</a></li><li data-type='method'><a href="module-UserManagement.html#.uploadPictureFromS3">uploadPictureFromS3</a></li></ul></li><li><a href="module-UserMemberships.html">UserMemberships</a><ul class='methods'><li data-type='method'><a href="module-UserMemberships.html#~fetchMemberships">fetchMemberships</a></li><li data-type='method'><a href="module-UserMemberships.html#~fetchRechargeTokens">fetchRechargeTokens</a></li><li data-type='method'><a href="module-UserMemberships.html#~restorePurchases">restorePurchases</a></li><li data-type='method'><a href="module-UserMemberships.html#~upgradeSubscription">upgradeSubscription</a></li></ul></li><li><a href="module-UserNotifications.html">UserNotifications</a><ul class='methods'><li data-type='method'><a href="module-UserNotifications.html#.deleteNotification">deleteNotification</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchLiveEventPollingState">fetchLiveEventPollingState</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchNotificationSettings">fetchNotificationSettings</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchNotifications">fetchNotifications</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchUnreadCount">fetchUnreadCount</a></li><li data-type='method'><a href="module-UserNotifications.html#.markAllNotificationsAsRead">markAllNotificationsAsRead</a></li><li data-type='method'><a href="module-UserNotifications.html#.markNotificationAsRead">markNotificationAsRead</a></li><li data-type='method'><a href="module-UserNotifications.html#.markNotificationAsUnread">markNotificationAsUnread</a></li><li data-type='method'><a href="module-UserNotifications.html#.pauseLiveEventPolling">pauseLiveEventPolling</a></li><li data-type='method'><a href="module-UserNotifications.html#.restoreNotification">restoreNotification</a></li><li data-type='method'><a href="module-UserNotifications.html#.startLiveEventPolling">startLiveEventPolling</a></li><li data-type='method'><a href="module-UserNotifications.html#.updateNotificationSetting">updateNotificationSetting</a></li></ul></li><li><a href="module-UserProfile.html">UserProfile</a><ul class='methods'><li data-type='method'><a href="module-UserProfile.html#.deleteProfilePicture">deleteProfilePicture</a></li><li data-type='method'><a href="module-UserProfile.html#.otherStats">otherStats</a></li></ul></li></ul><h3>Namespaces</h3><ul><li><a href="ContentOrganization.html">ContentOrganization</a></li><li><a href="Forums.html">Forums</a></li><li><a href="Gamification.html">Gamification</a></li><li><a href="UserManagementSystem.html">UserManagementSystem</a></li></ul><h3>Interfaces</h3><ul><li><a href="TestUser.html">TestUser</a></li></ul><h3>Global</h3><ul><li><a href="global.html#createTestUser">createTestUser</a></li></ul>
|
|
33
33
|
|
|
34
34
|
</nav>
|
|
35
35
|
|
|
@@ -94,7 +94,7 @@
|
|
|
94
94
|
|
|
95
95
|
<dt class="tag-source">Source:</dt>
|
|
96
96
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
97
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
97
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line43">line 43</a>
|
|
98
98
|
</li></ul></dd>
|
|
99
99
|
|
|
100
100
|
|
|
@@ -182,7 +182,7 @@
|
|
|
182
182
|
|
|
183
183
|
<dt class="tag-source">Source:</dt>
|
|
184
184
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
185
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
185
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line587">line 587</a>
|
|
186
186
|
</li></ul></dd>
|
|
187
187
|
|
|
188
188
|
|
|
@@ -837,7 +837,7 @@ If a coachId is provided, the content type must be 'coach-lessons'.</li></ul></d
|
|
|
837
837
|
|
|
838
838
|
<dt class="tag-source">Source:</dt>
|
|
839
839
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
840
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
840
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line817">line 817</a>
|
|
841
841
|
</li></ul></dd>
|
|
842
842
|
|
|
843
843
|
|
|
@@ -1356,7 +1356,7 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
1356
1356
|
|
|
1357
1357
|
<dt class="tag-source">Source:</dt>
|
|
1358
1358
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
1359
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
1359
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1339">line 1339</a>
|
|
1360
1360
|
</li></ul></dd>
|
|
1361
1361
|
|
|
1362
1362
|
|
|
@@ -1690,7 +1690,7 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
1690
1690
|
|
|
1691
1691
|
<dt class="tag-source">Source:</dt>
|
|
1692
1692
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
1693
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
1693
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1551">line 1551</a>
|
|
1694
1694
|
</li></ul></dd>
|
|
1695
1695
|
|
|
1696
1696
|
|
|
@@ -2195,7 +2195,7 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
2195
2195
|
|
|
2196
2196
|
<dt class="tag-source">Source:</dt>
|
|
2197
2197
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
2198
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
2198
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line175">line 175</a>
|
|
2199
2199
|
</li></ul></dd>
|
|
2200
2200
|
|
|
2201
2201
|
|
|
@@ -2360,7 +2360,7 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
2360
2360
|
|
|
2361
2361
|
<dt class="tag-source">Source:</dt>
|
|
2362
2362
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
2363
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
2363
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line441">line 441</a>
|
|
2364
2364
|
</li></ul></dd>
|
|
2365
2365
|
|
|
2366
2366
|
|
|
@@ -2549,7 +2549,7 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
2549
2549
|
|
|
2550
2550
|
<dt class="tag-source">Source:</dt>
|
|
2551
2551
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
2552
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
2552
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line480">line 480</a>
|
|
2553
2553
|
</li></ul></dd>
|
|
2554
2554
|
|
|
2555
2555
|
|
|
@@ -2636,7 +2636,7 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
2636
2636
|
<td class="type">
|
|
2637
2637
|
|
|
2638
2638
|
|
|
2639
|
-
<span class="param-type">Array.<string></span>
|
|
2639
|
+
<span class="param-type">Array.<(string|number)></span>
|
|
2640
2640
|
|
|
2641
2641
|
|
|
2642
2642
|
|
|
@@ -2758,7 +2758,7 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
2758
2758
|
|
|
2759
2759
|
<dt class="tag-source">Source:</dt>
|
|
2760
2760
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
2761
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
2761
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1512">line 1512</a>
|
|
2762
2762
|
</li></ul></dd>
|
|
2763
2763
|
|
|
2764
2764
|
|
|
@@ -2923,7 +2923,7 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
2923
2923
|
|
|
2924
2924
|
<dt class="tag-source">Source:</dt>
|
|
2925
2925
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
2926
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
2926
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1479">line 1479</a>
|
|
2927
2927
|
</li></ul></dd>
|
|
2928
2928
|
|
|
2929
2929
|
|
|
@@ -3366,7 +3366,7 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
3366
3366
|
|
|
3367
3367
|
<dt class="tag-source">Source:</dt>
|
|
3368
3368
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
3369
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
3369
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line133">line 133</a>
|
|
3370
3370
|
</li></ul></dd>
|
|
3371
3371
|
|
|
3372
3372
|
|
|
@@ -3470,7 +3470,7 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
3470
3470
|
|
|
3471
3471
|
<dt class="tag-source">Source:</dt>
|
|
3472
3472
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
3473
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
3473
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1741">line 1741</a>
|
|
3474
3474
|
</li></ul></dd>
|
|
3475
3475
|
|
|
3476
3476
|
|
|
@@ -3628,7 +3628,7 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
3628
3628
|
|
|
3629
3629
|
<dt class="tag-source">Source:</dt>
|
|
3630
3630
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
3631
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
3631
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line887">line 887</a>
|
|
3632
3632
|
</li></ul></dd>
|
|
3633
3633
|
|
|
3634
3634
|
|
|
@@ -3786,7 +3786,7 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
3786
3786
|
|
|
3787
3787
|
<dt class="tag-source">Source:</dt>
|
|
3788
3788
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
3789
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
3789
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1611">line 1611</a>
|
|
3790
3790
|
</li></ul></dd>
|
|
3791
3791
|
|
|
3792
3792
|
|
|
@@ -4267,7 +4267,7 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
4267
4267
|
|
|
4268
4268
|
<dt class="tag-source">Source:</dt>
|
|
4269
4269
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
4270
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
4270
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line78">line 78</a>
|
|
4271
4271
|
</li></ul></dd>
|
|
4272
4272
|
|
|
4273
4273
|
|
|
@@ -4371,7 +4371,7 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
4371
4371
|
|
|
4372
4372
|
<dt class="tag-source">Source:</dt>
|
|
4373
4373
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
4374
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
4374
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1109">line 1109</a>
|
|
4375
4375
|
</li></ul></dd>
|
|
4376
4376
|
|
|
4377
4377
|
|
|
@@ -4537,7 +4537,7 @@ These are linked through content that shares a license with the provided railcon
|
|
|
4537
4537
|
|
|
4538
4538
|
<dt class="tag-source">Source:</dt>
|
|
4539
4539
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
4540
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
4540
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1216">line 1216</a>
|
|
4541
4541
|
</li></ul></dd>
|
|
4542
4542
|
|
|
4543
4543
|
|
|
@@ -4740,7 +4740,7 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
4740
4740
|
|
|
4741
4741
|
<dt class="tag-source">Source:</dt>
|
|
4742
4742
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
4743
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
4743
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1919">line 1919</a>
|
|
4744
4744
|
</li></ul></dd>
|
|
4745
4745
|
|
|
4746
4746
|
|
|
@@ -4925,7 +4925,7 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
4925
4925
|
|
|
4926
4926
|
<dt class="tag-source">Source:</dt>
|
|
4927
4927
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
4928
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
4928
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line907">line 907</a>
|
|
4929
4929
|
</li></ul></dd>
|
|
4930
4930
|
|
|
4931
4931
|
|
|
@@ -5107,7 +5107,7 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
5107
5107
|
|
|
5108
5108
|
<dt class="tag-source">Source:</dt>
|
|
5109
5109
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
5110
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
5110
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line955">line 955</a>
|
|
5111
5111
|
</li></ul></dd>
|
|
5112
5112
|
|
|
5113
5113
|
|
|
@@ -5265,7 +5265,7 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
5265
5265
|
|
|
5266
5266
|
<dt class="tag-source">Source:</dt>
|
|
5267
5267
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
5268
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
5268
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1013">line 1013</a>
|
|
5269
5269
|
</li></ul></dd>
|
|
5270
5270
|
|
|
5271
5271
|
|
|
@@ -5423,7 +5423,7 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
5423
5423
|
|
|
5424
5424
|
<dt class="tag-source">Source:</dt>
|
|
5425
5425
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
5426
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
5426
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line990">line 990</a>
|
|
5427
5427
|
</li></ul></dd>
|
|
5428
5428
|
|
|
5429
5429
|
|
|
@@ -5596,7 +5596,7 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
5596
5596
|
|
|
5597
5597
|
|
|
5598
5598
|
|
|
5599
|
-
<h4 class="name" id=".
|
|
5599
|
+
<h4 class="name" id=".fetchMethodV2IntroVideo"><span class="type-signature type-signature-static">(static) </span>fetchMethodV2IntroVideo<span class="signature">(brand)</span><span class="type-signature"> → {Promise.<(*|null)>}</span></h4>
|
|
5600
5600
|
|
|
5601
5601
|
|
|
5602
5602
|
|
|
@@ -5606,13 +5606,13 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
5606
5606
|
<dl class="details">
|
|
5607
5607
|
|
|
5608
5608
|
<dt class="tag-description">Description:</dt>
|
|
5609
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetch the
|
|
5609
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch the method intro video for a given brand.</li></ul></dd>
|
|
5610
5610
|
|
|
5611
5611
|
|
|
5612
5612
|
|
|
5613
5613
|
<dt class="tag-source">Source:</dt>
|
|
5614
5614
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
5615
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
5615
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line2290">line 2290</a>
|
|
5616
5616
|
</li></ul></dd>
|
|
5617
5617
|
|
|
5618
5618
|
|
|
@@ -5689,19 +5689,13 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
5689
5689
|
|
|
5690
5690
|
<td class="type">
|
|
5691
5691
|
|
|
5692
|
-
|
|
5693
|
-
<span class="param-type">string</span>
|
|
5694
|
-
|
|
5695
|
-
|
|
5696
|
-
|
|
5697
|
-
|
|
5698
5692
|
</td>
|
|
5699
5693
|
|
|
5700
5694
|
|
|
5701
5695
|
|
|
5702
5696
|
|
|
5703
5697
|
|
|
5704
|
-
<td class="description last"
|
|
5698
|
+
<td class="description last"></td>
|
|
5705
5699
|
</tr>
|
|
5706
5700
|
|
|
5707
5701
|
|
|
@@ -5726,10 +5720,6 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
5726
5720
|
<h5 class="h5-returns">Returns:</h5>
|
|
5727
5721
|
|
|
5728
5722
|
|
|
5729
|
-
<div class="param-desc">
|
|
5730
|
-
- The fetched new releases data or null if not found.
|
|
5731
|
-
</div>
|
|
5732
|
-
|
|
5733
5723
|
|
|
5734
5724
|
|
|
5735
5725
|
<dl class="param-type">
|
|
@@ -5738,7 +5728,7 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
5738
5728
|
</dt>
|
|
5739
5729
|
<dd>
|
|
5740
5730
|
|
|
5741
|
-
<span class="param-type">Promise.<(
|
|
5731
|
+
<span class="param-type">Promise.<(*|null)></span>
|
|
5742
5732
|
|
|
5743
5733
|
|
|
5744
5734
|
|
|
@@ -5754,7 +5744,7 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
5754
5744
|
|
|
5755
5745
|
|
|
5756
5746
|
|
|
5757
|
-
<h4 class="name" id=".
|
|
5747
|
+
<h4 class="name" id=".fetchMethodV2Structure"><span class="type-signature type-signature-static">(static) </span>fetchMethodV2Structure<span class="signature">(brand)</span><span class="type-signature"> → {Promise.<(*|null)>}</span></h4>
|
|
5758
5748
|
|
|
5759
5749
|
|
|
5760
5750
|
|
|
@@ -5764,13 +5754,13 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
5764
5754
|
<dl class="details">
|
|
5765
5755
|
|
|
5766
5756
|
<dt class="tag-description">Description:</dt>
|
|
5767
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetch the
|
|
5757
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch the structure (just ids) of the Method for a given brand.</li></ul></dd>
|
|
5768
5758
|
|
|
5769
5759
|
|
|
5770
5760
|
|
|
5771
5761
|
<dt class="tag-source">Source:</dt>
|
|
5772
5762
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
5773
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
5763
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line2304">line 2304</a>
|
|
5774
5764
|
</li></ul></dd>
|
|
5775
5765
|
|
|
5776
5766
|
|
|
@@ -5842,24 +5832,18 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
5842
5832
|
|
|
5843
5833
|
<tr>
|
|
5844
5834
|
|
|
5845
|
-
<td class="name"><code>
|
|
5835
|
+
<td class="name"><code>brand</code></td>
|
|
5846
5836
|
|
|
5847
5837
|
|
|
5848
5838
|
<td class="type">
|
|
5849
5839
|
|
|
5850
|
-
|
|
5851
|
-
<span class="param-type">string</span>
|
|
5852
|
-
|
|
5853
|
-
|
|
5854
|
-
|
|
5855
|
-
|
|
5856
5840
|
</td>
|
|
5857
5841
|
|
|
5858
5842
|
|
|
5859
5843
|
|
|
5860
5844
|
|
|
5861
5845
|
|
|
5862
|
-
<td class="description last"
|
|
5846
|
+
<td class="description last"></td>
|
|
5863
5847
|
</tr>
|
|
5864
5848
|
|
|
5865
5849
|
|
|
@@ -5884,10 +5868,6 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
5884
5868
|
<h5 class="h5-returns">Returns:</h5>
|
|
5885
5869
|
|
|
5886
5870
|
|
|
5887
|
-
<div class="param-desc">
|
|
5888
|
-
- The fetched next and previous lesson data or null if found.
|
|
5889
|
-
</div>
|
|
5890
|
-
|
|
5891
5871
|
|
|
5892
5872
|
|
|
5893
5873
|
<dl class="param-type">
|
|
@@ -5896,7 +5876,7 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
5896
5876
|
</dt>
|
|
5897
5877
|
<dd>
|
|
5898
5878
|
|
|
5899
|
-
<span class="param-type">Promise.<(
|
|
5879
|
+
<span class="param-type">Promise.<(*|null)></span>
|
|
5900
5880
|
|
|
5901
5881
|
|
|
5902
5882
|
|
|
@@ -5912,7 +5892,7 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
5912
5892
|
|
|
5913
5893
|
|
|
5914
5894
|
|
|
5915
|
-
<h4 class="name" id=".
|
|
5895
|
+
<h4 class="name" id=".fetchNewReleases"><span class="type-signature type-signature-static">(static) </span>fetchNewReleases<span class="signature">(brand)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
5916
5896
|
|
|
5917
5897
|
|
|
5918
5898
|
|
|
@@ -5922,14 +5902,13 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
5922
5902
|
<dl class="details">
|
|
5923
5903
|
|
|
5924
5904
|
<dt class="tag-description">Description:</dt>
|
|
5925
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
5926
|
-
These are linked through content that shares a license with the provided railcontent document</li></ul></dd>
|
|
5905
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch the latest new releases for a specific brand.</li></ul></dd>
|
|
5927
5906
|
|
|
5928
5907
|
|
|
5929
5908
|
|
|
5930
5909
|
<dt class="tag-source">Source:</dt>
|
|
5931
5910
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
5932
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
5911
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line311">line 311</a>
|
|
5933
5912
|
</li></ul></dd>
|
|
5934
5913
|
|
|
5935
5914
|
|
|
@@ -5999,24 +5978,6 @@ These are linked through content that shares a license with the provided railcon
|
|
|
5999
5978
|
<tbody>
|
|
6000
5979
|
|
|
6001
5980
|
|
|
6002
|
-
<tr>
|
|
6003
|
-
|
|
6004
|
-
<td class="name"><code>railcontentId</code></td>
|
|
6005
|
-
|
|
6006
|
-
|
|
6007
|
-
<td class="type">
|
|
6008
|
-
|
|
6009
|
-
</td>
|
|
6010
|
-
|
|
6011
|
-
|
|
6012
|
-
|
|
6013
|
-
|
|
6014
|
-
|
|
6015
|
-
<td class="description last"></td>
|
|
6016
|
-
</tr>
|
|
6017
|
-
|
|
6018
|
-
|
|
6019
|
-
|
|
6020
5981
|
<tr>
|
|
6021
5982
|
|
|
6022
5983
|
<td class="name"><code>brand</code></td>
|
|
@@ -6024,23 +5985,11 @@ These are linked through content that shares a license with the provided railcon
|
|
|
6024
5985
|
|
|
6025
5986
|
<td class="type">
|
|
6026
5987
|
|
|
6027
|
-
|
|
6028
|
-
|
|
6029
|
-
|
|
6030
|
-
|
|
6031
|
-
|
|
6032
|
-
|
|
6033
|
-
<td class="description last"></td>
|
|
6034
|
-
</tr>
|
|
5988
|
+
|
|
5989
|
+
<span class="param-type">string</span>
|
|
6035
5990
|
|
|
6036
|
-
|
|
6037
5991
|
|
|
6038
|
-
<tr>
|
|
6039
|
-
|
|
6040
|
-
<td class="name"><code>count</code></td>
|
|
6041
|
-
|
|
6042
5992
|
|
|
6043
|
-
<td class="type">
|
|
6044
5993
|
|
|
6045
5994
|
</td>
|
|
6046
5995
|
|
|
@@ -6048,7 +5997,7 @@ These are linked through content that shares a license with the provided railcon
|
|
|
6048
5997
|
|
|
6049
5998
|
|
|
6050
5999
|
|
|
6051
|
-
<td class="description last"
|
|
6000
|
+
<td class="description last">The brand for which to fetch new releases.</td>
|
|
6052
6001
|
</tr>
|
|
6053
6002
|
|
|
6054
6003
|
|
|
@@ -6073,6 +6022,10 @@ These are linked through content that shares a license with the provided railcon
|
|
|
6073
6022
|
<h5 class="h5-returns">Returns:</h5>
|
|
6074
6023
|
|
|
6075
6024
|
|
|
6025
|
+
<div class="param-desc">
|
|
6026
|
+
- The fetched new releases data or null if not found.
|
|
6027
|
+
</div>
|
|
6028
|
+
|
|
6076
6029
|
|
|
6077
6030
|
|
|
6078
6031
|
<dl class="param-type">
|
|
@@ -6081,7 +6034,7 @@ These are linked through content that shares a license with the provided railcon
|
|
|
6081
6034
|
</dt>
|
|
6082
6035
|
<dd>
|
|
6083
6036
|
|
|
6084
|
-
<span class="param-type">Promise.<
|
|
6037
|
+
<span class="param-type">Promise.<(Object|null)></span>
|
|
6085
6038
|
|
|
6086
6039
|
|
|
6087
6040
|
|
|
@@ -6097,7 +6050,7 @@ These are linked through content that shares a license with the provided railcon
|
|
|
6097
6050
|
|
|
6098
6051
|
|
|
6099
6052
|
|
|
6100
|
-
<h4 class="name" id=".
|
|
6053
|
+
<h4 class="name" id=".fetchNextPreviousLesson"><span class="type-signature type-signature-static">(static) </span>fetchNextPreviousLesson<span class="signature">(railcontentId)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
6101
6054
|
|
|
6102
6055
|
|
|
6103
6056
|
|
|
@@ -6107,13 +6060,13 @@ These are linked through content that shares a license with the provided railcon
|
|
|
6107
6060
|
<dl class="details">
|
|
6108
6061
|
|
|
6109
6062
|
<dt class="tag-description">Description:</dt>
|
|
6110
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetch
|
|
6063
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch the next and previous lessons for a specific lesson by Railcontent ID.</li></ul></dd>
|
|
6111
6064
|
|
|
6112
6065
|
|
|
6113
6066
|
|
|
6114
6067
|
<dt class="tag-source">Source:</dt>
|
|
6115
6068
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
6116
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
6069
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1052">line 1052</a>
|
|
6117
6070
|
</li></ul></dd>
|
|
6118
6071
|
|
|
6119
6072
|
|
|
@@ -6202,7 +6155,7 @@ These are linked through content that shares a license with the provided railcon
|
|
|
6202
6155
|
|
|
6203
6156
|
|
|
6204
6157
|
|
|
6205
|
-
<td class="description last">The Railcontent ID of the
|
|
6158
|
+
<td class="description last">The Railcontent ID of the current lesson.</td>
|
|
6206
6159
|
</tr>
|
|
6207
6160
|
|
|
6208
6161
|
|
|
@@ -6228,7 +6181,7 @@ These are linked through content that shares a license with the provided railcon
|
|
|
6228
6181
|
|
|
6229
6182
|
|
|
6230
6183
|
<div class="param-desc">
|
|
6231
|
-
- The fetched
|
|
6184
|
+
- The fetched next and previous lesson data or null if found.
|
|
6232
6185
|
</div>
|
|
6233
6186
|
|
|
6234
6187
|
|
|
@@ -6239,7 +6192,7 @@ These are linked through content that shares a license with the provided railcon
|
|
|
6239
6192
|
</dt>
|
|
6240
6193
|
<dd>
|
|
6241
6194
|
|
|
6242
|
-
<span class="param-type">Promise.<(
|
|
6195
|
+
<span class="param-type">Promise.<(Object|null)></span>
|
|
6243
6196
|
|
|
6244
6197
|
|
|
6245
6198
|
|
|
@@ -6255,7 +6208,7 @@ These are linked through content that shares a license with the provided railcon
|
|
|
6255
6208
|
|
|
6256
6209
|
|
|
6257
6210
|
|
|
6258
|
-
<h4 class="name" id=".
|
|
6211
|
+
<h4 class="name" id=".fetchOtherSongVersions"><span class="type-signature type-signature-static">(static) </span>fetchOtherSongVersions<span class="signature">(railcontentId, brand, count)</span><span class="type-signature"> → {Promise.<Array.<Object>>}</span></h4>
|
|
6259
6212
|
|
|
6260
6213
|
|
|
6261
6214
|
|
|
@@ -6265,13 +6218,14 @@ These are linked through content that shares a license with the provided railcon
|
|
|
6265
6218
|
<dl class="details">
|
|
6266
6219
|
|
|
6267
6220
|
<dt class="tag-description">Description:</dt>
|
|
6268
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
6221
|
+
<dd class="tag-description"><ul class="dummy"><li>Get song type (transcriptions, jam packs, play alongs, tutorial children) content documents that share content information with the provided railcontent document.
|
|
6222
|
+
These are linked through content that shares a license with the provided railcontent document</li></ul></dd>
|
|
6269
6223
|
|
|
6270
6224
|
|
|
6271
6225
|
|
|
6272
6226
|
<dt class="tag-source">Source:</dt>
|
|
6273
6227
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
6274
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
6228
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1203">line 1203</a>
|
|
6275
6229
|
</li></ul></dd>
|
|
6276
6230
|
|
|
6277
6231
|
|
|
@@ -6316,13 +6270,6 @@ These are linked through content that shares a license with the provided railcon
|
|
|
6316
6270
|
|
|
6317
6271
|
|
|
6318
6272
|
|
|
6319
|
-
<h5 class="h5-examples">Example</h5>
|
|
6320
|
-
|
|
6321
|
-
<pre class="prettyprint"><code>fetchPackData(404048)
|
|
6322
|
-
.then(challenge => console.log(challenge))
|
|
6323
|
-
.catch(error => console.error(error));</code></pre>
|
|
6324
|
-
|
|
6325
|
-
|
|
6326
6273
|
|
|
6327
6274
|
|
|
6328
6275
|
<h5 class="h5-parameters">Parameters:</h5>
|
|
@@ -6350,16 +6297,28 @@ These are linked through content that shares a license with the provided railcon
|
|
|
6350
6297
|
|
|
6351
6298
|
<tr>
|
|
6352
6299
|
|
|
6353
|
-
<td class="name"><code>
|
|
6300
|
+
<td class="name"><code>railcontentId</code></td>
|
|
6354
6301
|
|
|
6355
6302
|
|
|
6356
6303
|
<td class="type">
|
|
6357
6304
|
|
|
6358
|
-
|
|
6359
|
-
|
|
6305
|
+
</td>
|
|
6306
|
+
|
|
6307
|
+
|
|
6360
6308
|
|
|
6309
|
+
|
|
6310
|
+
|
|
6311
|
+
<td class="description last"></td>
|
|
6312
|
+
</tr>
|
|
6361
6313
|
|
|
6314
|
+
|
|
6315
|
+
|
|
6316
|
+
<tr>
|
|
6317
|
+
|
|
6318
|
+
<td class="name"><code>brand</code></td>
|
|
6319
|
+
|
|
6362
6320
|
|
|
6321
|
+
<td class="type">
|
|
6363
6322
|
|
|
6364
6323
|
</td>
|
|
6365
6324
|
|
|
@@ -6367,7 +6326,25 @@ These are linked through content that shares a license with the provided railcon
|
|
|
6367
6326
|
|
|
6368
6327
|
|
|
6369
6328
|
|
|
6370
|
-
<td class="description last"
|
|
6329
|
+
<td class="description last"></td>
|
|
6330
|
+
</tr>
|
|
6331
|
+
|
|
6332
|
+
|
|
6333
|
+
|
|
6334
|
+
<tr>
|
|
6335
|
+
|
|
6336
|
+
<td class="name"><code>count</code></td>
|
|
6337
|
+
|
|
6338
|
+
|
|
6339
|
+
<td class="type">
|
|
6340
|
+
|
|
6341
|
+
</td>
|
|
6342
|
+
|
|
6343
|
+
|
|
6344
|
+
|
|
6345
|
+
|
|
6346
|
+
|
|
6347
|
+
<td class="description last"></td>
|
|
6371
6348
|
</tr>
|
|
6372
6349
|
|
|
6373
6350
|
|
|
@@ -6392,10 +6369,6 @@ These are linked through content that shares a license with the provided railcon
|
|
|
6392
6369
|
<h5 class="h5-returns">Returns:</h5>
|
|
6393
6370
|
|
|
6394
6371
|
|
|
6395
|
-
<div class="param-desc">
|
|
6396
|
-
- The pack information and lessons or null if not found.
|
|
6397
|
-
</div>
|
|
6398
|
-
|
|
6399
6372
|
|
|
6400
6373
|
|
|
6401
6374
|
<dl class="param-type">
|
|
@@ -6404,7 +6377,7 @@ These are linked through content that shares a license with the provided railcon
|
|
|
6404
6377
|
</dt>
|
|
6405
6378
|
<dd>
|
|
6406
6379
|
|
|
6407
|
-
<span class="param-type">Promise.<
|
|
6380
|
+
<span class="param-type">Promise.<Array.<Object>></span>
|
|
6408
6381
|
|
|
6409
6382
|
|
|
6410
6383
|
|
|
@@ -6420,7 +6393,7 @@ These are linked through content that shares a license with the provided railcon
|
|
|
6420
6393
|
|
|
6421
6394
|
|
|
6422
6395
|
|
|
6423
|
-
<h4 class="name" id=".
|
|
6396
|
+
<h4 class="name" id=".fetchPackAll"><span class="type-signature type-signature-static">(static) </span>fetchPackAll<span class="signature">(railcontentId)</span><span class="type-signature"> → {Promise.<(Array.<Object>|null)>}</span></h4>
|
|
6424
6397
|
|
|
6425
6398
|
|
|
6426
6399
|
|
|
@@ -6430,13 +6403,13 @@ These are linked through content that shares a license with the provided railcon
|
|
|
6430
6403
|
<dl class="details">
|
|
6431
6404
|
|
|
6432
6405
|
<dt class="tag-description">Description:</dt>
|
|
6433
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetch
|
|
6406
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch all content for a specific pack by Railcontent ID.</li></ul></dd>
|
|
6434
6407
|
|
|
6435
6408
|
|
|
6436
6409
|
|
|
6437
6410
|
<dt class="tag-source">Source:</dt>
|
|
6438
6411
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
6439
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
6412
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1365">line 1365</a>
|
|
6440
6413
|
</li></ul></dd>
|
|
6441
6414
|
|
|
6442
6415
|
|
|
@@ -6481,13 +6454,6 @@ These are linked through content that shares a license with the provided railcon
|
|
|
6481
6454
|
|
|
6482
6455
|
|
|
6483
6456
|
|
|
6484
|
-
<h5 class="h5-examples">Example</h5>
|
|
6485
|
-
|
|
6486
|
-
<pre class="prettyprint"><code>fetchParentForDownload('course123')
|
|
6487
|
-
.then(course => console.log(course))
|
|
6488
|
-
.catch(error => console.error(error));</code></pre>
|
|
6489
|
-
|
|
6490
|
-
|
|
6491
6457
|
|
|
6492
6458
|
|
|
6493
6459
|
<h5 class="h5-parameters">Parameters:</h5>
|
|
@@ -6515,7 +6481,7 @@ These are linked through content that shares a license with the provided railcon
|
|
|
6515
6481
|
|
|
6516
6482
|
<tr>
|
|
6517
6483
|
|
|
6518
|
-
<td class="name"><code>
|
|
6484
|
+
<td class="name"><code>railcontentId</code></td>
|
|
6519
6485
|
|
|
6520
6486
|
|
|
6521
6487
|
<td class="type">
|
|
@@ -6532,7 +6498,7 @@ These are linked through content that shares a license with the provided railcon
|
|
|
6532
6498
|
|
|
6533
6499
|
|
|
6534
6500
|
|
|
6535
|
-
<td class="description last">The Railcontent ID of the
|
|
6501
|
+
<td class="description last">The Railcontent ID of the pack.</td>
|
|
6536
6502
|
</tr>
|
|
6537
6503
|
|
|
6538
6504
|
|
|
@@ -6558,7 +6524,7 @@ These are linked through content that shares a license with the provided railcon
|
|
|
6558
6524
|
|
|
6559
6525
|
|
|
6560
6526
|
<div class="param-desc">
|
|
6561
|
-
- The
|
|
6527
|
+
- The fetched pack content data or null if not found.
|
|
6562
6528
|
</div>
|
|
6563
6529
|
|
|
6564
6530
|
|
|
@@ -6569,7 +6535,7 @@ These are linked through content that shares a license with the provided railcon
|
|
|
6569
6535
|
</dt>
|
|
6570
6536
|
<dd>
|
|
6571
6537
|
|
|
6572
|
-
<span class="param-type">Promise.<(Object
|
|
6538
|
+
<span class="param-type">Promise.<(Array.<Object>|null)></span>
|
|
6573
6539
|
|
|
6574
6540
|
|
|
6575
6541
|
|
|
@@ -6585,7 +6551,7 @@ These are linked through content that shares a license with the provided railcon
|
|
|
6585
6551
|
|
|
6586
6552
|
|
|
6587
6553
|
|
|
6588
|
-
<h4 class="name" id=".
|
|
6554
|
+
<h4 class="name" id=".fetchPackData"><span class="type-signature type-signature-static">(static) </span>fetchPackData<span class="signature">(id)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
6589
6555
|
|
|
6590
6556
|
|
|
6591
6557
|
|
|
@@ -6595,13 +6561,13 @@ These are linked through content that shares a license with the provided railcon
|
|
|
6595
6561
|
<dl class="details">
|
|
6596
6562
|
|
|
6597
6563
|
<dt class="tag-description">Description:</dt>
|
|
6598
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetch
|
|
6564
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch the data needed for the Pack Overview screen.</li></ul></dd>
|
|
6599
6565
|
|
|
6600
6566
|
|
|
6601
6567
|
|
|
6602
6568
|
<dt class="tag-source">Source:</dt>
|
|
6603
6569
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
6604
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
6570
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1454">line 1454</a>
|
|
6605
6571
|
</li></ul></dd>
|
|
6606
6572
|
|
|
6607
6573
|
|
|
@@ -6646,6 +6612,13 @@ These are linked through content that shares a license with the provided railcon
|
|
|
6646
6612
|
|
|
6647
6613
|
|
|
6648
6614
|
|
|
6615
|
+
<h5 class="h5-examples">Example</h5>
|
|
6616
|
+
|
|
6617
|
+
<pre class="prettyprint"><code>fetchPackData(404048)
|
|
6618
|
+
.then(pack => console.log(pack))
|
|
6619
|
+
.catch(error => console.error(error));</code></pre>
|
|
6620
|
+
|
|
6621
|
+
|
|
6649
6622
|
|
|
6650
6623
|
|
|
6651
6624
|
<h5 class="h5-parameters">Parameters:</h5>
|
|
@@ -6673,37 +6646,13 @@ These are linked through content that shares a license with the provided railcon
|
|
|
6673
6646
|
|
|
6674
6647
|
<tr>
|
|
6675
6648
|
|
|
6676
|
-
<td class="name"><code>
|
|
6677
|
-
|
|
6678
|
-
|
|
6679
|
-
<td class="type">
|
|
6680
|
-
|
|
6681
|
-
|
|
6682
|
-
<span class="param-type">string</span>
|
|
6683
|
-
|
|
6684
|
-
|
|
6685
|
-
|
|
6686
|
-
|
|
6687
|
-
</td>
|
|
6688
|
-
|
|
6689
|
-
|
|
6690
|
-
|
|
6691
|
-
|
|
6692
|
-
|
|
6693
|
-
<td class="description last">The RailContent ID of the current lesson.</td>
|
|
6694
|
-
</tr>
|
|
6695
|
-
|
|
6696
|
-
|
|
6697
|
-
|
|
6698
|
-
<tr>
|
|
6699
|
-
|
|
6700
|
-
<td class="name"><code>brand</code></td>
|
|
6649
|
+
<td class="name"><code>id</code></td>
|
|
6701
6650
|
|
|
6702
6651
|
|
|
6703
6652
|
<td class="type">
|
|
6704
6653
|
|
|
6705
6654
|
|
|
6706
|
-
<span class="param-type">
|
|
6655
|
+
<span class="param-type">number</span>
|
|
6707
6656
|
|
|
6708
6657
|
|
|
6709
6658
|
|
|
@@ -6714,7 +6663,7 @@ These are linked through content that shares a license with the provided railcon
|
|
|
6714
6663
|
|
|
6715
6664
|
|
|
6716
6665
|
|
|
6717
|
-
<td class="description last">The
|
|
6666
|
+
<td class="description last">The Railcontent ID of the pack</td>
|
|
6718
6667
|
</tr>
|
|
6719
6668
|
|
|
6720
6669
|
|
|
@@ -6740,7 +6689,7 @@ These are linked through content that shares a license with the provided railcon
|
|
|
6740
6689
|
|
|
6741
6690
|
|
|
6742
6691
|
<div class="param-desc">
|
|
6743
|
-
- The
|
|
6692
|
+
- The pack information and lessons or null if not found.
|
|
6744
6693
|
</div>
|
|
6745
6694
|
|
|
6746
6695
|
|
|
@@ -6751,7 +6700,7 @@ These are linked through content that shares a license with the provided railcon
|
|
|
6751
6700
|
</dt>
|
|
6752
6701
|
<dd>
|
|
6753
6702
|
|
|
6754
|
-
<span class="param-type">Promise.<(
|
|
6703
|
+
<span class="param-type">Promise.<(Object|null)></span>
|
|
6755
6704
|
|
|
6756
6705
|
|
|
6757
6706
|
|
|
@@ -6767,7 +6716,7 @@ These are linked through content that shares a license with the provided railcon
|
|
|
6767
6716
|
|
|
6768
6717
|
|
|
6769
6718
|
|
|
6770
|
-
<h4 class="name" id=".
|
|
6719
|
+
<h4 class="name" id=".fetchRelatedLessons"><span class="type-signature type-signature-static">(static) </span>fetchRelatedLessons<span class="signature">(railContentId)</span><span class="type-signature"> → {Promise.<(Array.<Object>|null)>}</span></h4>
|
|
6771
6720
|
|
|
6772
6721
|
|
|
6773
6722
|
|
|
@@ -6776,11 +6725,14 @@ These are linked through content that shares a license with the provided railcon
|
|
|
6776
6725
|
|
|
6777
6726
|
<dl class="details">
|
|
6778
6727
|
|
|
6728
|
+
<dt class="tag-description">Description:</dt>
|
|
6729
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch lessons related to a specific lesson by RailContent ID and type.</li></ul></dd>
|
|
6730
|
+
|
|
6779
6731
|
|
|
6780
6732
|
|
|
6781
6733
|
<dt class="tag-source">Source:</dt>
|
|
6782
6734
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
6783
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
6735
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1307">line 1307</a>
|
|
6784
6736
|
</li></ul></dd>
|
|
6785
6737
|
|
|
6786
6738
|
|
|
@@ -6857,41 +6809,11 @@ These are linked through content that shares a license with the provided railcon
|
|
|
6857
6809
|
|
|
6858
6810
|
<td class="type">
|
|
6859
6811
|
|
|
6860
|
-
|
|
6861
|
-
|
|
6862
|
-
|
|
6863
|
-
|
|
6864
|
-
|
|
6865
|
-
|
|
6866
|
-
<td class="description last"></td>
|
|
6867
|
-
</tr>
|
|
6868
|
-
|
|
6869
|
-
|
|
6870
|
-
|
|
6871
|
-
<tr>
|
|
6872
|
-
|
|
6873
|
-
<td class="name"><code>brand</code></td>
|
|
6874
|
-
|
|
6875
|
-
|
|
6876
|
-
<td class="type">
|
|
6877
|
-
|
|
6878
|
-
</td>
|
|
6879
|
-
|
|
6880
|
-
|
|
6881
|
-
|
|
6882
|
-
|
|
6883
|
-
|
|
6884
|
-
<td class="description last"></td>
|
|
6885
|
-
</tr>
|
|
6812
|
+
|
|
6813
|
+
<span class="param-type">string</span>
|
|
6886
6814
|
|
|
6887
|
-
|
|
6888
6815
|
|
|
6889
|
-
<tr>
|
|
6890
|
-
|
|
6891
|
-
<td class="name"><code>count</code></td>
|
|
6892
|
-
|
|
6893
6816
|
|
|
6894
|
-
<td class="type">
|
|
6895
6817
|
|
|
6896
6818
|
</td>
|
|
6897
6819
|
|
|
@@ -6899,7 +6821,7 @@ These are linked through content that shares a license with the provided railcon
|
|
|
6899
6821
|
|
|
6900
6822
|
|
|
6901
6823
|
|
|
6902
|
-
<td class="description last"
|
|
6824
|
+
<td class="description last">The RailContent ID of the current lesson.</td>
|
|
6903
6825
|
</tr>
|
|
6904
6826
|
|
|
6905
6827
|
|
|
@@ -6924,6 +6846,10 @@ These are linked through content that shares a license with the provided railcon
|
|
|
6924
6846
|
<h5 class="h5-returns">Returns:</h5>
|
|
6925
6847
|
|
|
6926
6848
|
|
|
6849
|
+
<div class="param-desc">
|
|
6850
|
+
- The fetched related lessons data or null if not found.
|
|
6851
|
+
</div>
|
|
6852
|
+
|
|
6927
6853
|
|
|
6928
6854
|
|
|
6929
6855
|
<dl class="param-type">
|
|
@@ -6948,7 +6874,7 @@ These are linked through content that shares a license with the provided railcon
|
|
|
6948
6874
|
|
|
6949
6875
|
|
|
6950
6876
|
|
|
6951
|
-
<h4 class="name" id=".
|
|
6877
|
+
<h4 class="name" id=".fetchRelatedRecommendedContent"><span class="type-signature type-signature-static">(static) </span>fetchRelatedRecommendedContent<span class="signature">(railContentId, brand, count)</span><span class="type-signature"> → {Promise.<Array.<Object>>}</span></h4>
|
|
6952
6878
|
|
|
6953
6879
|
|
|
6954
6880
|
|
|
@@ -6958,13 +6884,14 @@ These are linked through content that shares a license with the provided railcon
|
|
|
6958
6884
|
<dl class="details">
|
|
6959
6885
|
|
|
6960
6886
|
<dt class="tag-description">Description:</dt>
|
|
6961
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
6887
|
+
<dd class="tag-description"><ul class="dummy"><li>Returns a list of recommended content based on the provided railContentId.
|
|
6888
|
+
If no recommendations found in recsys, falls back to fetching related lessons.</li></ul></dd>
|
|
6962
6889
|
|
|
6963
6890
|
|
|
6964
6891
|
|
|
6965
6892
|
<dt class="tag-source">Source:</dt>
|
|
6966
6893
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
6967
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
6894
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1183">line 1183</a>
|
|
6968
6895
|
</li></ul></dd>
|
|
6969
6896
|
|
|
6970
6897
|
|
|
@@ -7009,13 +6936,6 @@ These are linked through content that shares a license with the provided railcon
|
|
|
7009
6936
|
|
|
7010
6937
|
|
|
7011
6938
|
|
|
7012
|
-
<h5 class="h5-examples">Example</h5>
|
|
7013
|
-
|
|
7014
|
-
<pre class="prettyprint"><code>fetchRelatedSongs('drumeo', '12345')
|
|
7015
|
-
.then(relatedSongs => console.log(relatedSongs))
|
|
7016
|
-
.catch(error => console.error(error));</code></pre>
|
|
7017
|
-
|
|
7018
|
-
|
|
7019
6939
|
|
|
7020
6940
|
|
|
7021
6941
|
<h5 class="h5-parameters">Parameters:</h5>
|
|
@@ -7043,7 +6963,198 @@ These are linked through content that shares a license with the provided railcon
|
|
|
7043
6963
|
|
|
7044
6964
|
<tr>
|
|
7045
6965
|
|
|
7046
|
-
<td class="name"><code>
|
|
6966
|
+
<td class="name"><code>railContentId</code></td>
|
|
6967
|
+
|
|
6968
|
+
|
|
6969
|
+
<td class="type">
|
|
6970
|
+
|
|
6971
|
+
</td>
|
|
6972
|
+
|
|
6973
|
+
|
|
6974
|
+
|
|
6975
|
+
|
|
6976
|
+
|
|
6977
|
+
<td class="description last"></td>
|
|
6978
|
+
</tr>
|
|
6979
|
+
|
|
6980
|
+
|
|
6981
|
+
|
|
6982
|
+
<tr>
|
|
6983
|
+
|
|
6984
|
+
<td class="name"><code>brand</code></td>
|
|
6985
|
+
|
|
6986
|
+
|
|
6987
|
+
<td class="type">
|
|
6988
|
+
|
|
6989
|
+
</td>
|
|
6990
|
+
|
|
6991
|
+
|
|
6992
|
+
|
|
6993
|
+
|
|
6994
|
+
|
|
6995
|
+
<td class="description last"></td>
|
|
6996
|
+
</tr>
|
|
6997
|
+
|
|
6998
|
+
|
|
6999
|
+
|
|
7000
|
+
<tr>
|
|
7001
|
+
|
|
7002
|
+
<td class="name"><code>count</code></td>
|
|
7003
|
+
|
|
7004
|
+
|
|
7005
|
+
<td class="type">
|
|
7006
|
+
|
|
7007
|
+
</td>
|
|
7008
|
+
|
|
7009
|
+
|
|
7010
|
+
|
|
7011
|
+
|
|
7012
|
+
|
|
7013
|
+
<td class="description last"></td>
|
|
7014
|
+
</tr>
|
|
7015
|
+
|
|
7016
|
+
|
|
7017
|
+
</tbody>
|
|
7018
|
+
</table>
|
|
7019
|
+
|
|
7020
|
+
|
|
7021
|
+
|
|
7022
|
+
|
|
7023
|
+
|
|
7024
|
+
|
|
7025
|
+
|
|
7026
|
+
|
|
7027
|
+
|
|
7028
|
+
|
|
7029
|
+
|
|
7030
|
+
|
|
7031
|
+
|
|
7032
|
+
|
|
7033
|
+
|
|
7034
|
+
|
|
7035
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
7036
|
+
|
|
7037
|
+
|
|
7038
|
+
|
|
7039
|
+
|
|
7040
|
+
<dl class="param-type">
|
|
7041
|
+
<dt>
|
|
7042
|
+
Type
|
|
7043
|
+
</dt>
|
|
7044
|
+
<dd>
|
|
7045
|
+
|
|
7046
|
+
<span class="param-type">Promise.<Array.<Object>></span>
|
|
7047
|
+
|
|
7048
|
+
|
|
7049
|
+
|
|
7050
|
+
</dd>
|
|
7051
|
+
</dl>
|
|
7052
|
+
|
|
7053
|
+
|
|
7054
|
+
|
|
7055
|
+
|
|
7056
|
+
|
|
7057
|
+
|
|
7058
|
+
|
|
7059
|
+
|
|
7060
|
+
|
|
7061
|
+
|
|
7062
|
+
<h4 class="name" id=".fetchRelatedSongs"><span class="type-signature type-signature-static">(static) </span>fetchRelatedSongs<span class="signature">(brand, songId)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
7063
|
+
|
|
7064
|
+
|
|
7065
|
+
|
|
7066
|
+
|
|
7067
|
+
|
|
7068
|
+
|
|
7069
|
+
<dl class="details">
|
|
7070
|
+
|
|
7071
|
+
<dt class="tag-description">Description:</dt>
|
|
7072
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch related songs for a specific brand and song ID.</li></ul></dd>
|
|
7073
|
+
|
|
7074
|
+
|
|
7075
|
+
|
|
7076
|
+
<dt class="tag-source">Source:</dt>
|
|
7077
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
7078
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line235">line 235</a>
|
|
7079
|
+
</li></ul></dd>
|
|
7080
|
+
|
|
7081
|
+
|
|
7082
|
+
|
|
7083
|
+
|
|
7084
|
+
|
|
7085
|
+
|
|
7086
|
+
|
|
7087
|
+
|
|
7088
|
+
|
|
7089
|
+
|
|
7090
|
+
|
|
7091
|
+
|
|
7092
|
+
|
|
7093
|
+
|
|
7094
|
+
|
|
7095
|
+
|
|
7096
|
+
|
|
7097
|
+
|
|
7098
|
+
|
|
7099
|
+
|
|
7100
|
+
|
|
7101
|
+
|
|
7102
|
+
|
|
7103
|
+
|
|
7104
|
+
|
|
7105
|
+
|
|
7106
|
+
|
|
7107
|
+
|
|
7108
|
+
|
|
7109
|
+
|
|
7110
|
+
|
|
7111
|
+
</dl>
|
|
7112
|
+
|
|
7113
|
+
|
|
7114
|
+
|
|
7115
|
+
|
|
7116
|
+
|
|
7117
|
+
|
|
7118
|
+
|
|
7119
|
+
|
|
7120
|
+
|
|
7121
|
+
|
|
7122
|
+
|
|
7123
|
+
<h5 class="h5-examples">Example</h5>
|
|
7124
|
+
|
|
7125
|
+
<pre class="prettyprint"><code>fetchRelatedSongs('drumeo', '12345')
|
|
7126
|
+
.then(relatedSongs => console.log(relatedSongs))
|
|
7127
|
+
.catch(error => console.error(error));</code></pre>
|
|
7128
|
+
|
|
7129
|
+
|
|
7130
|
+
|
|
7131
|
+
|
|
7132
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
7133
|
+
|
|
7134
|
+
|
|
7135
|
+
<table class="params">
|
|
7136
|
+
<thead>
|
|
7137
|
+
<tr>
|
|
7138
|
+
|
|
7139
|
+
<th>Name</th>
|
|
7140
|
+
|
|
7141
|
+
|
|
7142
|
+
<th>Type</th>
|
|
7143
|
+
|
|
7144
|
+
|
|
7145
|
+
|
|
7146
|
+
|
|
7147
|
+
|
|
7148
|
+
<th class="last">Description</th>
|
|
7149
|
+
</tr>
|
|
7150
|
+
</thead>
|
|
7151
|
+
|
|
7152
|
+
<tbody>
|
|
7153
|
+
|
|
7154
|
+
|
|
7155
|
+
<tr>
|
|
7156
|
+
|
|
7157
|
+
<td class="name"><code>brand</code></td>
|
|
7047
7158
|
|
|
7048
7159
|
|
|
7049
7160
|
<td class="type">
|
|
@@ -7153,7 +7264,7 @@ These are linked through content that shares a license with the provided railcon
|
|
|
7153
7264
|
|
|
7154
7265
|
<dt class="tag-source">Source:</dt>
|
|
7155
7266
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
7156
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
7267
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line105">line 105</a>
|
|
7157
7268
|
</li></ul></dd>
|
|
7158
7269
|
|
|
7159
7270
|
|
|
@@ -7254,7 +7365,7 @@ These are linked through content that shares a license with the provided railcon
|
|
|
7254
7365
|
|
|
7255
7366
|
<dt class="tag-source">Source:</dt>
|
|
7256
7367
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
7257
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
7368
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1779">line 1779</a>
|
|
7258
7369
|
</li></ul></dd>
|
|
7259
7370
|
|
|
7260
7371
|
|
|
@@ -7552,7 +7663,7 @@ fetchSanity(query, true)
|
|
|
7552
7663
|
|
|
7553
7664
|
<dt class="tag-source">Source:</dt>
|
|
7554
7665
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
7555
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
7666
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line402">line 402</a>
|
|
7556
7667
|
</li></ul></dd>
|
|
7557
7668
|
|
|
7558
7669
|
|
|
@@ -7720,7 +7831,7 @@ fetchSanity(query, true)
|
|
|
7720
7831
|
|
|
7721
7832
|
<dt class="tag-source">Source:</dt>
|
|
7722
7833
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
7723
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
7834
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1893">line 1893</a>
|
|
7724
7835
|
</li></ul></dd>
|
|
7725
7836
|
|
|
7726
7837
|
|
|
@@ -7859,7 +7970,7 @@ fetchSanity(query, true)
|
|
|
7859
7970
|
|
|
7860
7971
|
|
|
7861
7972
|
|
|
7862
|
-
<h4 class="name" id=".
|
|
7973
|
+
<h4 class="name" id=".fetchSiblingContent"><span class="type-signature type-signature-static">(static) </span>fetchSiblingContent<span class="signature">(railContentId, brand)</span><span class="type-signature"> → {Promise.<(Array.<Object>|null)>}</span></h4>
|
|
7863
7974
|
|
|
7864
7975
|
|
|
7865
7976
|
|
|
@@ -7869,13 +7980,13 @@ fetchSanity(query, true)
|
|
|
7869
7980
|
<dl class="details">
|
|
7870
7981
|
|
|
7871
7982
|
<dt class="tag-description">Description:</dt>
|
|
7872
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetch
|
|
7983
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch sibling lessons to a specific lesson</li></ul></dd>
|
|
7873
7984
|
|
|
7874
7985
|
|
|
7875
7986
|
|
|
7876
7987
|
<dt class="tag-source">Source:</dt>
|
|
7877
7988
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
7878
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
7989
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1259">line 1259</a>
|
|
7879
7990
|
</li></ul></dd>
|
|
7880
7991
|
|
|
7881
7992
|
|
|
@@ -7945,6 +8056,30 @@ fetchSanity(query, true)
|
|
|
7945
8056
|
<tbody>
|
|
7946
8057
|
|
|
7947
8058
|
|
|
8059
|
+
<tr>
|
|
8060
|
+
|
|
8061
|
+
<td class="name"><code>railContentId</code></td>
|
|
8062
|
+
|
|
8063
|
+
|
|
8064
|
+
<td class="type">
|
|
8065
|
+
|
|
8066
|
+
|
|
8067
|
+
<span class="param-type">string</span>
|
|
8068
|
+
|
|
8069
|
+
|
|
8070
|
+
|
|
8071
|
+
|
|
8072
|
+
</td>
|
|
8073
|
+
|
|
8074
|
+
|
|
8075
|
+
|
|
8076
|
+
|
|
8077
|
+
|
|
8078
|
+
<td class="description last">The RailContent ID of the current lesson.</td>
|
|
8079
|
+
</tr>
|
|
8080
|
+
|
|
8081
|
+
|
|
8082
|
+
|
|
7948
8083
|
<tr>
|
|
7949
8084
|
|
|
7950
8085
|
<td class="name"><code>brand</code></td>
|
|
@@ -7990,7 +8125,7 @@ fetchSanity(query, true)
|
|
|
7990
8125
|
|
|
7991
8126
|
|
|
7992
8127
|
<div class="param-desc">
|
|
7993
|
-
- The fetched
|
|
8128
|
+
- The fetched related lessons data or null if not found.
|
|
7994
8129
|
</div>
|
|
7995
8130
|
|
|
7996
8131
|
|
|
@@ -8001,7 +8136,7 @@ fetchSanity(query, true)
|
|
|
8001
8136
|
</dt>
|
|
8002
8137
|
<dd>
|
|
8003
8138
|
|
|
8004
|
-
<span class="param-type">Promise.<(
|
|
8139
|
+
<span class="param-type">Promise.<(Array.<Object>|null)></span>
|
|
8005
8140
|
|
|
8006
8141
|
|
|
8007
8142
|
|
|
@@ -8017,7 +8152,7 @@ fetchSanity(query, true)
|
|
|
8017
8152
|
|
|
8018
8153
|
|
|
8019
8154
|
|
|
8020
|
-
<h4 class="name" id=".
|
|
8155
|
+
<h4 class="name" id=".fetchSongArtistCount"><span class="type-signature type-signature-static">(static) </span>fetchSongArtistCount<span class="signature">(brand)</span><span class="type-signature"> → {Promise.<(int|null)>}</span></h4>
|
|
8021
8156
|
|
|
8022
8157
|
|
|
8023
8158
|
|
|
@@ -8027,13 +8162,13 @@ fetchSanity(query, true)
|
|
|
8027
8162
|
<dl class="details">
|
|
8028
8163
|
|
|
8029
8164
|
<dt class="tag-description">Description:</dt>
|
|
8030
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetch
|
|
8165
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch current number of artists for songs within a brand.</li></ul></dd>
|
|
8031
8166
|
|
|
8032
8167
|
|
|
8033
8168
|
|
|
8034
8169
|
<dt class="tag-source">Source:</dt>
|
|
8035
8170
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
8036
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
8171
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line193">line 193</a>
|
|
8037
8172
|
</li></ul></dd>
|
|
8038
8173
|
|
|
8039
8174
|
|
|
@@ -8078,13 +8213,6 @@ fetchSanity(query, true)
|
|
|
8078
8213
|
|
|
8079
8214
|
|
|
8080
8215
|
|
|
8081
|
-
<h5 class="h5-examples">Example</h5>
|
|
8082
|
-
|
|
8083
|
-
<pre class="prettyprint"><code>fetchSongById('abc123')
|
|
8084
|
-
.then(song => console.log(song))
|
|
8085
|
-
.catch(error => console.error(error));</code></pre>
|
|
8086
|
-
|
|
8087
|
-
|
|
8088
8216
|
|
|
8089
8217
|
|
|
8090
8218
|
<h5 class="h5-parameters">Parameters:</h5>
|
|
@@ -8112,7 +8240,7 @@ fetchSanity(query, true)
|
|
|
8112
8240
|
|
|
8113
8241
|
<tr>
|
|
8114
8242
|
|
|
8115
|
-
<td class="name"><code>
|
|
8243
|
+
<td class="name"><code>brand</code></td>
|
|
8116
8244
|
|
|
8117
8245
|
|
|
8118
8246
|
<td class="type">
|
|
@@ -8129,7 +8257,7 @@ fetchSanity(query, true)
|
|
|
8129
8257
|
|
|
8130
8258
|
|
|
8131
8259
|
|
|
8132
|
-
<td class="description last">The
|
|
8260
|
+
<td class="description last">The current brand.</td>
|
|
8133
8261
|
</tr>
|
|
8134
8262
|
|
|
8135
8263
|
|
|
@@ -8155,7 +8283,7 @@ fetchSanity(query, true)
|
|
|
8155
8283
|
|
|
8156
8284
|
|
|
8157
8285
|
<div class="param-desc">
|
|
8158
|
-
-
|
|
8286
|
+
- The fetched count of artists.
|
|
8159
8287
|
</div>
|
|
8160
8288
|
|
|
8161
8289
|
|
|
@@ -8166,7 +8294,7 @@ fetchSanity(query, true)
|
|
|
8166
8294
|
</dt>
|
|
8167
8295
|
<dd>
|
|
8168
8296
|
|
|
8169
|
-
<span class="param-type">Promise.<(
|
|
8297
|
+
<span class="param-type">Promise.<(int|null)></span>
|
|
8170
8298
|
|
|
8171
8299
|
|
|
8172
8300
|
|
|
@@ -8182,7 +8310,7 @@ fetchSanity(query, true)
|
|
|
8182
8310
|
|
|
8183
8311
|
|
|
8184
8312
|
|
|
8185
|
-
<h4 class="name" id=".
|
|
8313
|
+
<h4 class="name" id=".fetchSongById"><span class="type-signature type-signature-static">(static) </span>fetchSongById<span class="signature">(documentId)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
8186
8314
|
|
|
8187
8315
|
|
|
8188
8316
|
|
|
@@ -8192,13 +8320,13 @@ fetchSanity(query, true)
|
|
|
8192
8320
|
<dl class="details">
|
|
8193
8321
|
|
|
8194
8322
|
<dt class="tag-description">Description:</dt>
|
|
8195
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetch
|
|
8323
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch a song by its document ID from Sanity.</li></ul></dd>
|
|
8196
8324
|
|
|
8197
8325
|
|
|
8198
8326
|
|
|
8199
8327
|
<dt class="tag-source">Source:</dt>
|
|
8200
8328
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
8201
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
8329
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line56">line 56</a>
|
|
8202
8330
|
</li></ul></dd>
|
|
8203
8331
|
|
|
8204
8332
|
|
|
@@ -8245,11 +8373,8 @@ fetchSanity(query, true)
|
|
|
8245
8373
|
|
|
8246
8374
|
<h5 class="h5-examples">Example</h5>
|
|
8247
8375
|
|
|
8248
|
-
<pre class="prettyprint"><code>
|
|
8249
|
-
|
|
8250
|
-
limit: 20,
|
|
8251
|
-
})
|
|
8252
|
-
.then(events => console.log(events))
|
|
8376
|
+
<pre class="prettyprint"><code>fetchSongById('abc123')
|
|
8377
|
+
.then(song => console.log(song))
|
|
8253
8378
|
.catch(error => console.error(error));</code></pre>
|
|
8254
8379
|
|
|
8255
8380
|
|
|
@@ -8280,7 +8405,7 @@ fetchSanity(query, true)
|
|
|
8280
8405
|
|
|
8281
8406
|
<tr>
|
|
8282
8407
|
|
|
8283
|
-
<td class="name"><code>
|
|
8408
|
+
<td class="name"><code>documentId</code></td>
|
|
8284
8409
|
|
|
8285
8410
|
|
|
8286
8411
|
<td class="type">
|
|
@@ -8297,7 +8422,7 @@ fetchSanity(query, true)
|
|
|
8297
8422
|
|
|
8298
8423
|
|
|
8299
8424
|
|
|
8300
|
-
<td class="description last">The
|
|
8425
|
+
<td class="description last">The ID of the document to fetch.</td>
|
|
8301
8426
|
</tr>
|
|
8302
8427
|
|
|
8303
8428
|
|
|
@@ -8323,7 +8448,7 @@ fetchSanity(query, true)
|
|
|
8323
8448
|
|
|
8324
8449
|
|
|
8325
8450
|
<div class="param-desc">
|
|
8326
|
-
- A promise that resolves to an
|
|
8451
|
+
- A promise that resolves to an object containing the song data or null if not found.
|
|
8327
8452
|
</div>
|
|
8328
8453
|
|
|
8329
8454
|
|
|
@@ -8350,7 +8475,7 @@ fetchSanity(query, true)
|
|
|
8350
8475
|
|
|
8351
8476
|
|
|
8352
8477
|
|
|
8353
|
-
<h4 class="name" id=".
|
|
8478
|
+
<h4 class="name" id=".fetchUpcomingEvents"><span class="type-signature type-signature-static">(static) </span>fetchUpcomingEvents<span class="signature">(brand)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
8354
8479
|
|
|
8355
8480
|
|
|
8356
8481
|
|
|
@@ -8360,13 +8485,13 @@ fetchSanity(query, true)
|
|
|
8360
8485
|
<dl class="details">
|
|
8361
8486
|
|
|
8362
8487
|
<dt class="tag-description">Description:</dt>
|
|
8363
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetch
|
|
8488
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch upcoming events for a specific brand.</li></ul></dd>
|
|
8364
8489
|
|
|
8365
8490
|
|
|
8366
8491
|
|
|
8367
8492
|
<dt class="tag-source">Source:</dt>
|
|
8368
8493
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
8369
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
8494
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line355">line 355</a>
|
|
8370
8495
|
</li></ul></dd>
|
|
8371
8496
|
|
|
8372
8497
|
|
|
@@ -8413,9 +8538,12 @@ fetchSanity(query, true)
|
|
|
8413
8538
|
|
|
8414
8539
|
<h5 class="h5-examples">Example</h5>
|
|
8415
8540
|
|
|
8416
|
-
<pre class="prettyprint"><code>
|
|
8417
|
-
|
|
8418
|
-
|
|
8541
|
+
<pre class="prettyprint"><code>fetchUpcomingEvents('drumeo', {
|
|
8542
|
+
page: 2,
|
|
8543
|
+
limit: 20,
|
|
8544
|
+
})
|
|
8545
|
+
.then(events => console.log(events))
|
|
8546
|
+
.catch(error => console.error(error));</code></pre>
|
|
8419
8547
|
|
|
8420
8548
|
|
|
8421
8549
|
|
|
@@ -8445,13 +8573,13 @@ fetchSanity(query, true)
|
|
|
8445
8573
|
|
|
8446
8574
|
<tr>
|
|
8447
8575
|
|
|
8448
|
-
<td class="name"><code>
|
|
8576
|
+
<td class="name"><code>brand</code></td>
|
|
8449
8577
|
|
|
8450
8578
|
|
|
8451
8579
|
<td class="type">
|
|
8452
8580
|
|
|
8453
8581
|
|
|
8454
|
-
<span class="param-type">
|
|
8582
|
+
<span class="param-type">string</span>
|
|
8455
8583
|
|
|
8456
8584
|
|
|
8457
8585
|
|
|
@@ -8462,7 +8590,7 @@ fetchSanity(query, true)
|
|
|
8462
8590
|
|
|
8463
8591
|
|
|
8464
8592
|
|
|
8465
|
-
<td class="description last">The
|
|
8593
|
+
<td class="description last">The brand for which to fetch upcoming events.</td>
|
|
8466
8594
|
</tr>
|
|
8467
8595
|
|
|
8468
8596
|
|
|
@@ -8488,7 +8616,7 @@ fetchSanity(query, true)
|
|
|
8488
8616
|
|
|
8489
8617
|
|
|
8490
8618
|
<div class="param-desc">
|
|
8491
|
-
-
|
|
8619
|
+
- A promise that resolves to an array of upcoming event objects or null if not found.
|
|
8492
8620
|
</div>
|
|
8493
8621
|
|
|
8494
8622
|
|
|
@@ -8499,7 +8627,7 @@ fetchSanity(query, true)
|
|
|
8499
8627
|
</dt>
|
|
8500
8628
|
<dd>
|
|
8501
8629
|
|
|
8502
|
-
<span class="param-type">Promise.<(
|
|
8630
|
+
<span class="param-type">Promise.<(Object|null)></span>
|
|
8503
8631
|
|
|
8504
8632
|
|
|
8505
8633
|
|
|
@@ -8515,7 +8643,7 @@ fetchSanity(query, true)
|
|
|
8515
8643
|
|
|
8516
8644
|
|
|
8517
8645
|
|
|
8518
|
-
<h4 class="name" id="
|
|
8646
|
+
<h4 class="name" id=".jumpToContinueContent"><span class="type-signature type-signature-static">(static) </span>jumpToContinueContent<span class="signature">(railcontentId)</span><span class="type-signature"> → {Promise.<({next: (Object|null)}|null)>}</span></h4>
|
|
8519
8647
|
|
|
8520
8648
|
|
|
8521
8649
|
|
|
@@ -8525,13 +8653,13 @@ fetchSanity(query, true)
|
|
|
8525
8653
|
<dl class="details">
|
|
8526
8654
|
|
|
8527
8655
|
<dt class="tag-description">Description:</dt>
|
|
8528
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
8656
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch the next piece of content under a parent by Railcontent ID</li></ul></dd>
|
|
8529
8657
|
|
|
8530
8658
|
|
|
8531
8659
|
|
|
8532
8660
|
<dt class="tag-source">Source:</dt>
|
|
8533
8661
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
8534
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
8662
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1089">line 1089</a>
|
|
8535
8663
|
</li></ul></dd>
|
|
8536
8664
|
|
|
8537
8665
|
|
|
@@ -8576,6 +8704,13 @@ fetchSanity(query, true)
|
|
|
8576
8704
|
|
|
8577
8705
|
|
|
8578
8706
|
|
|
8707
|
+
<h5 class="h5-examples">Example</h5>
|
|
8708
|
+
|
|
8709
|
+
<pre class="prettyprint"><code>jumpToContinueContent(296693)
|
|
8710
|
+
then.(data => { console.log('next', data.next);})
|
|
8711
|
+
.catch(error => console.error(error));</code></pre>
|
|
8712
|
+
|
|
8713
|
+
|
|
8579
8714
|
|
|
8580
8715
|
|
|
8581
8716
|
<h5 class="h5-parameters">Parameters:</h5>
|
|
@@ -8609,79 +8744,7 @@ fetchSanity(query, true)
|
|
|
8609
8744
|
<td class="type">
|
|
8610
8745
|
|
|
8611
8746
|
|
|
8612
|
-
<span class="param-type">
|
|
8613
|
-
|
|
8614
|
-
|
|
8615
|
-
|
|
8616
|
-
|
|
8617
|
-
</td>
|
|
8618
|
-
|
|
8619
|
-
|
|
8620
|
-
|
|
8621
|
-
|
|
8622
|
-
|
|
8623
|
-
<td class="description last"></td>
|
|
8624
|
-
</tr>
|
|
8625
|
-
|
|
8626
|
-
|
|
8627
|
-
|
|
8628
|
-
<tr>
|
|
8629
|
-
|
|
8630
|
-
<td class="name"><code>brand</code></td>
|
|
8631
|
-
|
|
8632
|
-
|
|
8633
|
-
<td class="type">
|
|
8634
|
-
|
|
8635
|
-
|
|
8636
|
-
<span class="param-type">string</span>
|
|
8637
|
-
|
|
8638
|
-
|
|
8639
|
-
|
|
8640
|
-
|
|
8641
|
-
</td>
|
|
8642
|
-
|
|
8643
|
-
|
|
8644
|
-
|
|
8645
|
-
|
|
8646
|
-
|
|
8647
|
-
<td class="description last"></td>
|
|
8648
|
-
</tr>
|
|
8649
|
-
|
|
8650
|
-
|
|
8651
|
-
|
|
8652
|
-
<tr>
|
|
8653
|
-
|
|
8654
|
-
<td class="name"><code>onlyUseSongTypes</code></td>
|
|
8655
|
-
|
|
8656
|
-
|
|
8657
|
-
<td class="type">
|
|
8658
|
-
|
|
8659
|
-
|
|
8660
|
-
<span class="param-type">boolean</span>
|
|
8661
|
-
|
|
8662
|
-
|
|
8663
|
-
|
|
8664
|
-
|
|
8665
|
-
</td>
|
|
8666
|
-
|
|
8667
|
-
|
|
8668
|
-
|
|
8669
|
-
|
|
8670
|
-
|
|
8671
|
-
<td class="description last">if true, only return the song type documents. If false, return everything except those</td>
|
|
8672
|
-
</tr>
|
|
8673
|
-
|
|
8674
|
-
|
|
8675
|
-
|
|
8676
|
-
<tr>
|
|
8677
|
-
|
|
8678
|
-
<td class="name"><code>count</code></td>
|
|
8679
|
-
|
|
8680
|
-
|
|
8681
|
-
<td class="type">
|
|
8682
|
-
|
|
8683
|
-
|
|
8684
|
-
<span class="param-type">integer:3</span>
|
|
8747
|
+
<span class="param-type">int</span>
|
|
8685
8748
|
|
|
8686
8749
|
|
|
8687
8750
|
|
|
@@ -8692,7 +8755,7 @@ fetchSanity(query, true)
|
|
|
8692
8755
|
|
|
8693
8756
|
|
|
8694
8757
|
|
|
8695
|
-
<td class="description last"
|
|
8758
|
+
<td class="description last">The Railcontent ID of the parent content</td>
|
|
8696
8759
|
</tr>
|
|
8697
8760
|
|
|
8698
8761
|
|
|
@@ -8717,6 +8780,10 @@ fetchSanity(query, true)
|
|
|
8717
8780
|
<h5 class="h5-returns">Returns:</h5>
|
|
8718
8781
|
|
|
8719
8782
|
|
|
8783
|
+
<div class="param-desc">
|
|
8784
|
+
- object with 'next' attribute
|
|
8785
|
+
</div>
|
|
8786
|
+
|
|
8720
8787
|
|
|
8721
8788
|
|
|
8722
8789
|
<dl class="param-type">
|
|
@@ -8725,7 +8792,7 @@ fetchSanity(query, true)
|
|
|
8725
8792
|
</dt>
|
|
8726
8793
|
<dd>
|
|
8727
8794
|
|
|
8728
|
-
<span class="param-type">Promise.<
|
|
8795
|
+
<span class="param-type">Promise.<({next: (Object|null)}|null)></span>
|
|
8729
8796
|
|
|
8730
8797
|
|
|
8731
8798
|
|
|
@@ -8741,7 +8808,7 @@ fetchSanity(query, true)
|
|
|
8741
8808
|
|
|
8742
8809
|
|
|
8743
8810
|
|
|
8744
|
-
<h4 class="name" id="~
|
|
8811
|
+
<h4 class="name" id="~fetchRelatedByLicense"><span class="type-signature type-signature-async, inner">(async, inner) </span>fetchRelatedByLicense<span class="signature">(railcontentId, brand, onlyUseSongTypes, count)</span><span class="type-signature"> → {Promise.<Array.<Object>>}</span></h4>
|
|
8745
8812
|
|
|
8746
8813
|
|
|
8747
8814
|
|
|
@@ -8751,13 +8818,13 @@ fetchSanity(query, true)
|
|
|
8751
8818
|
<dl class="details">
|
|
8752
8819
|
|
|
8753
8820
|
<dt class="tag-description">Description:</dt>
|
|
8754
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
8821
|
+
<dd class="tag-description"><ul class="dummy"><li>Get content documents that share license information with the provided railcontent id</li></ul></dd>
|
|
8755
8822
|
|
|
8756
8823
|
|
|
8757
8824
|
|
|
8758
8825
|
<dt class="tag-source">Source:</dt>
|
|
8759
8826
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
8760
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
8827
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1229">line 1229</a>
|
|
8761
8828
|
</li></ul></dd>
|
|
8762
8829
|
|
|
8763
8830
|
|
|
@@ -8804,105 +8871,126 @@ fetchSanity(query, true)
|
|
|
8804
8871
|
|
|
8805
8872
|
|
|
8806
8873
|
|
|
8874
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
8875
|
+
|
|
8807
8876
|
|
|
8808
|
-
|
|
8809
|
-
|
|
8810
|
-
|
|
8811
|
-
|
|
8812
|
-
|
|
8813
|
-
|
|
8814
|
-
|
|
8815
|
-
|
|
8816
|
-
|
|
8817
|
-
|
|
8818
|
-
|
|
8819
|
-
|
|
8820
|
-
|
|
8821
|
-
<h5 class="h5-returns">Returns:</h5>
|
|
8822
|
-
|
|
8877
|
+
<table class="params">
|
|
8878
|
+
<thead>
|
|
8879
|
+
<tr>
|
|
8880
|
+
|
|
8881
|
+
<th>Name</th>
|
|
8823
8882
|
|
|
8824
8883
|
|
|
8884
|
+
<th>Type</th>
|
|
8825
8885
|
|
|
8826
|
-
<dl class="param-type">
|
|
8827
|
-
<dt>
|
|
8828
|
-
Type
|
|
8829
|
-
</dt>
|
|
8830
|
-
<dd>
|
|
8831
8886
|
|
|
8832
|
-
<span class="param-type">Array.<string></span>
|
|
8833
|
-
|
|
8834
8887
|
|
|
8888
|
+
|
|
8835
8889
|
|
|
8836
|
-
|
|
8837
|
-
</
|
|
8890
|
+
<th class="last">Description</th>
|
|
8891
|
+
</tr>
|
|
8892
|
+
</thead>
|
|
8838
8893
|
|
|
8894
|
+
<tbody>
|
|
8839
8895
|
|
|
8840
8896
|
|
|
8897
|
+
<tr>
|
|
8898
|
+
|
|
8899
|
+
<td class="name"><code>railcontentId</code></td>
|
|
8900
|
+
|
|
8841
8901
|
|
|
8842
|
-
|
|
8843
|
-
|
|
8902
|
+
<td class="type">
|
|
8844
8903
|
|
|
8904
|
+
|
|
8905
|
+
<span class="param-type">integer</span>
|
|
8845
8906
|
|
|
8846
|
-
|
|
8847
8907
|
|
|
8848
|
-
<h4 class="name" id="~getQueryFromPage"><span class="type-signature type-signature-inner">(inner) </span>getQueryFromPage<span class="signature">()</span><span class="type-signature"> → {Array.<number>}</span></h4>
|
|
8849
8908
|
|
|
8850
|
-
|
|
8909
|
+
|
|
8910
|
+
</td>
|
|
8851
8911
|
|
|
8912
|
+
|
|
8852
8913
|
|
|
8914
|
+
|
|
8853
8915
|
|
|
8916
|
+
<td class="description last"></td>
|
|
8917
|
+
</tr>
|
|
8854
8918
|
|
|
8855
|
-
<dl class="details">
|
|
8856
8919
|
|
|
8857
8920
|
|
|
8858
|
-
|
|
8859
|
-
|
|
8860
|
-
|
|
8861
|
-
|
|
8862
|
-
</li></ul></dd>
|
|
8863
|
-
|
|
8921
|
+
<tr>
|
|
8922
|
+
|
|
8923
|
+
<td class="name"><code>brand</code></td>
|
|
8924
|
+
|
|
8864
8925
|
|
|
8865
|
-
|
|
8926
|
+
<td class="type">
|
|
8927
|
+
|
|
8928
|
+
|
|
8929
|
+
<span class="param-type">string</span>
|
|
8866
8930
|
|
|
8867
|
-
|
|
8868
8931
|
|
|
8869
|
-
|
|
8870
8932
|
|
|
8871
|
-
|
|
8933
|
+
|
|
8934
|
+
</td>
|
|
8872
8935
|
|
|
8873
|
-
|
|
8936
|
+
|
|
8874
8937
|
|
|
8875
|
-
|
|
8938
|
+
|
|
8876
8939
|
|
|
8877
|
-
|
|
8940
|
+
<td class="description last"></td>
|
|
8941
|
+
</tr>
|
|
8878
8942
|
|
|
8879
8943
|
|
|
8880
8944
|
|
|
8881
|
-
|
|
8945
|
+
<tr>
|
|
8946
|
+
|
|
8947
|
+
<td class="name"><code>onlyUseSongTypes</code></td>
|
|
8948
|
+
|
|
8882
8949
|
|
|
8883
|
-
|
|
8950
|
+
<td class="type">
|
|
8951
|
+
|
|
8952
|
+
|
|
8953
|
+
<span class="param-type">boolean</span>
|
|
8884
8954
|
|
|
8885
|
-
|
|
8886
8955
|
|
|
8887
|
-
|
|
8888
8956
|
|
|
8889
|
-
|
|
8957
|
+
|
|
8958
|
+
</td>
|
|
8890
8959
|
|
|
8891
|
-
|
|
8960
|
+
|
|
8892
8961
|
|
|
8893
|
-
|
|
8894
|
-
</dl>
|
|
8962
|
+
|
|
8895
8963
|
|
|
8964
|
+
<td class="description last">if true, only return the song type documents. If false, return everything except those</td>
|
|
8965
|
+
</tr>
|
|
8896
8966
|
|
|
8967
|
+
|
|
8897
8968
|
|
|
8969
|
+
<tr>
|
|
8970
|
+
|
|
8971
|
+
<td class="name"><code>count</code></td>
|
|
8972
|
+
|
|
8898
8973
|
|
|
8974
|
+
<td class="type">
|
|
8975
|
+
|
|
8976
|
+
|
|
8977
|
+
<span class="param-type">integer:3</span>
|
|
8899
8978
|
|
|
8900
8979
|
|
|
8901
8980
|
|
|
8981
|
+
|
|
8982
|
+
</td>
|
|
8902
8983
|
|
|
8984
|
+
|
|
8903
8985
|
|
|
8986
|
+
|
|
8904
8987
|
|
|
8988
|
+
<td class="description last"></td>
|
|
8989
|
+
</tr>
|
|
8905
8990
|
|
|
8991
|
+
|
|
8992
|
+
</tbody>
|
|
8993
|
+
</table>
|
|
8906
8994
|
|
|
8907
8995
|
|
|
8908
8996
|
|
|
@@ -8930,7 +9018,7 @@ fetchSanity(query, true)
|
|
|
8930
9018
|
</dt>
|
|
8931
9019
|
<dd>
|
|
8932
9020
|
|
|
8933
|
-
<span class="param-type">Array.<
|
|
9021
|
+
<span class="param-type">Promise.<Array.<Object>></span>
|
|
8934
9022
|
|
|
8935
9023
|
|
|
8936
9024
|
|
|
@@ -8946,7 +9034,7 @@ fetchSanity(query, true)
|
|
|
8946
9034
|
|
|
8947
9035
|
|
|
8948
9036
|
|
|
8949
|
-
<h4 class="name" id="~
|
|
9037
|
+
<h4 class="name" id="~getQueryFromPage"><span class="type-signature type-signature-inner">(inner) </span>getQueryFromPage<span class="signature">()</span><span class="type-signature"> → {Array.<number>}</span></h4>
|
|
8950
9038
|
|
|
8951
9039
|
|
|
8952
9040
|
|
|
@@ -8955,14 +9043,11 @@ fetchSanity(query, true)
|
|
|
8955
9043
|
|
|
8956
9044
|
<dl class="details">
|
|
8957
9045
|
|
|
8958
|
-
<dt class="tag-description">Description:</dt>
|
|
8959
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetch all content that requires custom handling or a distinct external call</li></ul></dd>
|
|
8960
|
-
|
|
8961
9046
|
|
|
8962
9047
|
|
|
8963
9048
|
<dt class="tag-source">Source:</dt>
|
|
8964
9049
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
8965
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
9050
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line155">line 155</a>
|
|
8966
9051
|
</li></ul></dd>
|
|
8967
9052
|
|
|
8968
9053
|
|
|
@@ -9009,532 +9094,6 @@ fetchSanity(query, true)
|
|
|
9009
9094
|
|
|
9010
9095
|
|
|
9011
9096
|
|
|
9012
|
-
<h5 class="h5-parameters">Parameters:</h5>
|
|
9013
|
-
|
|
9014
|
-
|
|
9015
|
-
<table class="params">
|
|
9016
|
-
<thead>
|
|
9017
|
-
<tr>
|
|
9018
|
-
|
|
9019
|
-
<th>Name</th>
|
|
9020
|
-
|
|
9021
|
-
|
|
9022
|
-
<th>Type</th>
|
|
9023
|
-
|
|
9024
|
-
|
|
9025
|
-
|
|
9026
|
-
|
|
9027
|
-
|
|
9028
|
-
<th class="last">Description</th>
|
|
9029
|
-
</tr>
|
|
9030
|
-
</thead>
|
|
9031
|
-
|
|
9032
|
-
<tbody>
|
|
9033
|
-
|
|
9034
|
-
|
|
9035
|
-
<tr>
|
|
9036
|
-
|
|
9037
|
-
<td class="name"><code>brand</code></td>
|
|
9038
|
-
|
|
9039
|
-
|
|
9040
|
-
<td class="type">
|
|
9041
|
-
|
|
9042
|
-
|
|
9043
|
-
<span class="param-type">string</span>
|
|
9044
|
-
|
|
9045
|
-
|
|
9046
|
-
|
|
9047
|
-
|
|
9048
|
-
</td>
|
|
9049
|
-
|
|
9050
|
-
|
|
9051
|
-
|
|
9052
|
-
|
|
9053
|
-
|
|
9054
|
-
<td class="description last">The brand for which to fetch content.</td>
|
|
9055
|
-
</tr>
|
|
9056
|
-
|
|
9057
|
-
|
|
9058
|
-
|
|
9059
|
-
<tr>
|
|
9060
|
-
|
|
9061
|
-
<td class="name"><code>type</code></td>
|
|
9062
|
-
|
|
9063
|
-
|
|
9064
|
-
<td class="type">
|
|
9065
|
-
|
|
9066
|
-
|
|
9067
|
-
<span class="param-type">string</span>
|
|
9068
|
-
|
|
9069
|
-
|
|
9070
|
-
|
|
9071
|
-
|
|
9072
|
-
</td>
|
|
9073
|
-
|
|
9074
|
-
|
|
9075
|
-
|
|
9076
|
-
|
|
9077
|
-
|
|
9078
|
-
<td class="description last">The content type to fetch (e.g., 'song', 'artist').</td>
|
|
9079
|
-
</tr>
|
|
9080
|
-
|
|
9081
|
-
|
|
9082
|
-
|
|
9083
|
-
<tr>
|
|
9084
|
-
|
|
9085
|
-
<td class="name"><code>params</code></td>
|
|
9086
|
-
|
|
9087
|
-
|
|
9088
|
-
<td class="type">
|
|
9089
|
-
|
|
9090
|
-
|
|
9091
|
-
<span class="param-type">Object</span>
|
|
9092
|
-
|
|
9093
|
-
|
|
9094
|
-
|
|
9095
|
-
|
|
9096
|
-
</td>
|
|
9097
|
-
|
|
9098
|
-
|
|
9099
|
-
|
|
9100
|
-
|
|
9101
|
-
|
|
9102
|
-
<td class="description last">Parameters for pagination, filtering, sorting, and grouping.
|
|
9103
|
-
<h6>Properties</h6>
|
|
9104
|
-
|
|
9105
|
-
|
|
9106
|
-
<table class="params">
|
|
9107
|
-
<thead>
|
|
9108
|
-
<tr>
|
|
9109
|
-
|
|
9110
|
-
<th>Name</th>
|
|
9111
|
-
|
|
9112
|
-
|
|
9113
|
-
<th>Type</th>
|
|
9114
|
-
|
|
9115
|
-
|
|
9116
|
-
<th>Attributes</th>
|
|
9117
|
-
|
|
9118
|
-
|
|
9119
|
-
|
|
9120
|
-
<th>Default</th>
|
|
9121
|
-
|
|
9122
|
-
|
|
9123
|
-
<th class="last">Description</th>
|
|
9124
|
-
</tr>
|
|
9125
|
-
</thead>
|
|
9126
|
-
|
|
9127
|
-
<tbody>
|
|
9128
|
-
|
|
9129
|
-
|
|
9130
|
-
<tr>
|
|
9131
|
-
|
|
9132
|
-
<td class="name"><code>page</code></td>
|
|
9133
|
-
|
|
9134
|
-
|
|
9135
|
-
<td class="type">
|
|
9136
|
-
|
|
9137
|
-
|
|
9138
|
-
<span class="param-type">number</span>
|
|
9139
|
-
|
|
9140
|
-
|
|
9141
|
-
|
|
9142
|
-
|
|
9143
|
-
</td>
|
|
9144
|
-
|
|
9145
|
-
|
|
9146
|
-
<td class="attributes">
|
|
9147
|
-
|
|
9148
|
-
<optional><br>
|
|
9149
|
-
|
|
9150
|
-
|
|
9151
|
-
|
|
9152
|
-
|
|
9153
|
-
|
|
9154
|
-
</td>
|
|
9155
|
-
|
|
9156
|
-
|
|
9157
|
-
|
|
9158
|
-
<td class="default">
|
|
9159
|
-
|
|
9160
|
-
<code>1</code>
|
|
9161
|
-
|
|
9162
|
-
</td>
|
|
9163
|
-
|
|
9164
|
-
|
|
9165
|
-
<td class="description last">The page number for pagination.</td>
|
|
9166
|
-
</tr>
|
|
9167
|
-
|
|
9168
|
-
|
|
9169
|
-
|
|
9170
|
-
<tr>
|
|
9171
|
-
|
|
9172
|
-
<td class="name"><code>limit</code></td>
|
|
9173
|
-
|
|
9174
|
-
|
|
9175
|
-
<td class="type">
|
|
9176
|
-
|
|
9177
|
-
|
|
9178
|
-
<span class="param-type">number</span>
|
|
9179
|
-
|
|
9180
|
-
|
|
9181
|
-
|
|
9182
|
-
|
|
9183
|
-
</td>
|
|
9184
|
-
|
|
9185
|
-
|
|
9186
|
-
<td class="attributes">
|
|
9187
|
-
|
|
9188
|
-
<optional><br>
|
|
9189
|
-
|
|
9190
|
-
|
|
9191
|
-
|
|
9192
|
-
|
|
9193
|
-
|
|
9194
|
-
</td>
|
|
9195
|
-
|
|
9196
|
-
|
|
9197
|
-
|
|
9198
|
-
<td class="default">
|
|
9199
|
-
|
|
9200
|
-
<code>10</code>
|
|
9201
|
-
|
|
9202
|
-
</td>
|
|
9203
|
-
|
|
9204
|
-
|
|
9205
|
-
<td class="description last">The number of items per page.</td>
|
|
9206
|
-
</tr>
|
|
9207
|
-
|
|
9208
|
-
|
|
9209
|
-
|
|
9210
|
-
<tr>
|
|
9211
|
-
|
|
9212
|
-
<td class="name"><code>searchTerm</code></td>
|
|
9213
|
-
|
|
9214
|
-
|
|
9215
|
-
<td class="type">
|
|
9216
|
-
|
|
9217
|
-
|
|
9218
|
-
<span class="param-type">string</span>
|
|
9219
|
-
|
|
9220
|
-
|
|
9221
|
-
|
|
9222
|
-
|
|
9223
|
-
</td>
|
|
9224
|
-
|
|
9225
|
-
|
|
9226
|
-
<td class="attributes">
|
|
9227
|
-
|
|
9228
|
-
<optional><br>
|
|
9229
|
-
|
|
9230
|
-
|
|
9231
|
-
|
|
9232
|
-
|
|
9233
|
-
|
|
9234
|
-
</td>
|
|
9235
|
-
|
|
9236
|
-
|
|
9237
|
-
|
|
9238
|
-
<td class="default">
|
|
9239
|
-
|
|
9240
|
-
<code>""</code>
|
|
9241
|
-
|
|
9242
|
-
</td>
|
|
9243
|
-
|
|
9244
|
-
|
|
9245
|
-
<td class="description last">The search term to filter content by title or artist.</td>
|
|
9246
|
-
</tr>
|
|
9247
|
-
|
|
9248
|
-
|
|
9249
|
-
|
|
9250
|
-
<tr>
|
|
9251
|
-
|
|
9252
|
-
<td class="name"><code>sort</code></td>
|
|
9253
|
-
|
|
9254
|
-
|
|
9255
|
-
<td class="type">
|
|
9256
|
-
|
|
9257
|
-
|
|
9258
|
-
<span class="param-type">string</span>
|
|
9259
|
-
|
|
9260
|
-
|
|
9261
|
-
|
|
9262
|
-
|
|
9263
|
-
</td>
|
|
9264
|
-
|
|
9265
|
-
|
|
9266
|
-
<td class="attributes">
|
|
9267
|
-
|
|
9268
|
-
<optional><br>
|
|
9269
|
-
|
|
9270
|
-
|
|
9271
|
-
|
|
9272
|
-
|
|
9273
|
-
|
|
9274
|
-
</td>
|
|
9275
|
-
|
|
9276
|
-
|
|
9277
|
-
|
|
9278
|
-
<td class="default">
|
|
9279
|
-
|
|
9280
|
-
<code>"-published_on"</code>
|
|
9281
|
-
|
|
9282
|
-
</td>
|
|
9283
|
-
|
|
9284
|
-
|
|
9285
|
-
<td class="description last">The field to sort the content by.</td>
|
|
9286
|
-
</tr>
|
|
9287
|
-
|
|
9288
|
-
|
|
9289
|
-
|
|
9290
|
-
<tr>
|
|
9291
|
-
|
|
9292
|
-
<td class="name"><code>includedFields</code></td>
|
|
9293
|
-
|
|
9294
|
-
|
|
9295
|
-
<td class="type">
|
|
9296
|
-
|
|
9297
|
-
|
|
9298
|
-
<span class="param-type">Array.<string></span>
|
|
9299
|
-
|
|
9300
|
-
|
|
9301
|
-
|
|
9302
|
-
|
|
9303
|
-
</td>
|
|
9304
|
-
|
|
9305
|
-
|
|
9306
|
-
<td class="attributes">
|
|
9307
|
-
|
|
9308
|
-
<optional><br>
|
|
9309
|
-
|
|
9310
|
-
|
|
9311
|
-
|
|
9312
|
-
|
|
9313
|
-
|
|
9314
|
-
</td>
|
|
9315
|
-
|
|
9316
|
-
|
|
9317
|
-
|
|
9318
|
-
<td class="default">
|
|
9319
|
-
|
|
9320
|
-
<code>[]</code>
|
|
9321
|
-
|
|
9322
|
-
</td>
|
|
9323
|
-
|
|
9324
|
-
|
|
9325
|
-
<td class="description last">The fields to include in the query.</td>
|
|
9326
|
-
</tr>
|
|
9327
|
-
|
|
9328
|
-
|
|
9329
|
-
|
|
9330
|
-
<tr>
|
|
9331
|
-
|
|
9332
|
-
<td class="name"><code>groupBy</code></td>
|
|
9333
|
-
|
|
9334
|
-
|
|
9335
|
-
<td class="type">
|
|
9336
|
-
|
|
9337
|
-
|
|
9338
|
-
<span class="param-type">string</span>
|
|
9339
|
-
|
|
9340
|
-
|
|
9341
|
-
|
|
9342
|
-
|
|
9343
|
-
</td>
|
|
9344
|
-
|
|
9345
|
-
|
|
9346
|
-
<td class="attributes">
|
|
9347
|
-
|
|
9348
|
-
<optional><br>
|
|
9349
|
-
|
|
9350
|
-
|
|
9351
|
-
|
|
9352
|
-
|
|
9353
|
-
|
|
9354
|
-
</td>
|
|
9355
|
-
|
|
9356
|
-
|
|
9357
|
-
|
|
9358
|
-
<td class="default">
|
|
9359
|
-
|
|
9360
|
-
<code>""</code>
|
|
9361
|
-
|
|
9362
|
-
</td>
|
|
9363
|
-
|
|
9364
|
-
|
|
9365
|
-
<td class="description last">The field to group the results by (e.g., 'artist', 'genre').</td>
|
|
9366
|
-
</tr>
|
|
9367
|
-
|
|
9368
|
-
|
|
9369
|
-
|
|
9370
|
-
<tr>
|
|
9371
|
-
|
|
9372
|
-
<td class="name"><code>progressIds</code></td>
|
|
9373
|
-
|
|
9374
|
-
|
|
9375
|
-
<td class="type">
|
|
9376
|
-
|
|
9377
|
-
|
|
9378
|
-
<span class="param-type">Array.<string></span>
|
|
9379
|
-
|
|
9380
|
-
|
|
9381
|
-
|
|
9382
|
-
|
|
9383
|
-
</td>
|
|
9384
|
-
|
|
9385
|
-
|
|
9386
|
-
<td class="attributes">
|
|
9387
|
-
|
|
9388
|
-
<optional><br>
|
|
9389
|
-
|
|
9390
|
-
|
|
9391
|
-
|
|
9392
|
-
|
|
9393
|
-
|
|
9394
|
-
</td>
|
|
9395
|
-
|
|
9396
|
-
|
|
9397
|
-
|
|
9398
|
-
<td class="default">
|
|
9399
|
-
|
|
9400
|
-
</td>
|
|
9401
|
-
|
|
9402
|
-
|
|
9403
|
-
<td class="description last">An array of railcontent IDs to filter the results by. Used for filtering by progress.</td>
|
|
9404
|
-
</tr>
|
|
9405
|
-
|
|
9406
|
-
|
|
9407
|
-
|
|
9408
|
-
<tr>
|
|
9409
|
-
|
|
9410
|
-
<td class="name"><code>useDefaultFields</code></td>
|
|
9411
|
-
|
|
9412
|
-
|
|
9413
|
-
<td class="type">
|
|
9414
|
-
|
|
9415
|
-
|
|
9416
|
-
<span class="param-type">boolean</span>
|
|
9417
|
-
|
|
9418
|
-
|
|
9419
|
-
|
|
9420
|
-
|
|
9421
|
-
</td>
|
|
9422
|
-
|
|
9423
|
-
|
|
9424
|
-
<td class="attributes">
|
|
9425
|
-
|
|
9426
|
-
<optional><br>
|
|
9427
|
-
|
|
9428
|
-
|
|
9429
|
-
|
|
9430
|
-
|
|
9431
|
-
|
|
9432
|
-
</td>
|
|
9433
|
-
|
|
9434
|
-
|
|
9435
|
-
|
|
9436
|
-
<td class="default">
|
|
9437
|
-
|
|
9438
|
-
<code>true</code>
|
|
9439
|
-
|
|
9440
|
-
</td>
|
|
9441
|
-
|
|
9442
|
-
|
|
9443
|
-
<td class="description last">use the default sanity fields for content Type</td>
|
|
9444
|
-
</tr>
|
|
9445
|
-
|
|
9446
|
-
|
|
9447
|
-
|
|
9448
|
-
<tr>
|
|
9449
|
-
|
|
9450
|
-
<td class="name"><code>customFields</code></td>
|
|
9451
|
-
|
|
9452
|
-
|
|
9453
|
-
<td class="type">
|
|
9454
|
-
|
|
9455
|
-
|
|
9456
|
-
<span class="param-type">Array.<string></span>
|
|
9457
|
-
|
|
9458
|
-
|
|
9459
|
-
|
|
9460
|
-
|
|
9461
|
-
</td>
|
|
9462
|
-
|
|
9463
|
-
|
|
9464
|
-
<td class="attributes">
|
|
9465
|
-
|
|
9466
|
-
<optional><br>
|
|
9467
|
-
|
|
9468
|
-
|
|
9469
|
-
|
|
9470
|
-
|
|
9471
|
-
|
|
9472
|
-
</td>
|
|
9473
|
-
|
|
9474
|
-
|
|
9475
|
-
|
|
9476
|
-
<td class="default">
|
|
9477
|
-
|
|
9478
|
-
<code>[]</code>
|
|
9479
|
-
|
|
9480
|
-
</td>
|
|
9481
|
-
|
|
9482
|
-
|
|
9483
|
-
<td class="description last">An array of sanity fields to include in the request</td>
|
|
9484
|
-
</tr>
|
|
9485
|
-
|
|
9486
|
-
|
|
9487
|
-
|
|
9488
|
-
<tr>
|
|
9489
|
-
|
|
9490
|
-
<td class="name"><code>progress</code></td>
|
|
9491
|
-
|
|
9492
|
-
|
|
9493
|
-
<td class="type">
|
|
9494
|
-
|
|
9495
|
-
|
|
9496
|
-
<span class="param-type">string</span>
|
|
9497
|
-
|
|
9498
|
-
|
|
9499
|
-
|
|
9500
|
-
|
|
9501
|
-
</td>
|
|
9502
|
-
|
|
9503
|
-
|
|
9504
|
-
<td class="attributes">
|
|
9505
|
-
|
|
9506
|
-
<optional><br>
|
|
9507
|
-
|
|
9508
|
-
|
|
9509
|
-
|
|
9510
|
-
|
|
9511
|
-
|
|
9512
|
-
</td>
|
|
9513
|
-
|
|
9514
|
-
|
|
9515
|
-
|
|
9516
|
-
<td class="default">
|
|
9517
|
-
|
|
9518
|
-
<code>"all"</code>
|
|
9519
|
-
|
|
9520
|
-
</td>
|
|
9521
|
-
|
|
9522
|
-
|
|
9523
|
-
<td class="description last">An string representing which progress filter to use ("all", "in progress", "complete", "not started").</td>
|
|
9524
|
-
</tr>
|
|
9525
|
-
|
|
9526
|
-
|
|
9527
|
-
</tbody>
|
|
9528
|
-
</table>
|
|
9529
|
-
|
|
9530
|
-
</td>
|
|
9531
|
-
</tr>
|
|
9532
|
-
|
|
9533
|
-
|
|
9534
|
-
</tbody>
|
|
9535
|
-
</table>
|
|
9536
|
-
|
|
9537
|
-
|
|
9538
9097
|
|
|
9539
9098
|
|
|
9540
9099
|
|
|
@@ -9552,10 +9111,6 @@ fetchSanity(query, true)
|
|
|
9552
9111
|
<h5 class="h5-returns">Returns:</h5>
|
|
9553
9112
|
|
|
9554
9113
|
|
|
9555
|
-
<div class="param-desc">
|
|
9556
|
-
- The fetched content data or null if not found.
|
|
9557
|
-
</div>
|
|
9558
|
-
|
|
9559
9114
|
|
|
9560
9115
|
|
|
9561
9116
|
<dl class="param-type">
|
|
@@ -9564,7 +9119,7 @@ fetchSanity(query, true)
|
|
|
9564
9119
|
</dt>
|
|
9565
9120
|
<dd>
|
|
9566
9121
|
|
|
9567
|
-
<span class="param-type">
|
|
9122
|
+
<span class="param-type">Array.<number></span>
|
|
9568
9123
|
|
|
9569
9124
|
|
|
9570
9125
|
|
|
@@ -9595,7 +9150,7 @@ fetchSanity(query, true)
|
|
|
9595
9150
|
<br class="clear">
|
|
9596
9151
|
|
|
9597
9152
|
<footer>
|
|
9598
|
-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on
|
|
9153
|
+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Tue Nov 04 2025 18:21:55 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
|
|
9599
9154
|
</footer>
|
|
9600
9155
|
|
|
9601
9156
|
<script>prettyPrint();</script>
|