musora-content-services 1.7.0 → 1.7.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +9 -0
- package/docs/v2/Content.html +269 -0
- package/docs/v2/ContentOrganization.html +2 -2
- package/docs/v2/Forums.html +2 -2
- package/docs/v2/Gamification.html +2 -2
- package/docs/v2/TestUser.html +2 -2
- package/docs/v2/UserManagementSystem.html +2 -2
- package/docs/v2/api_types.js.html +2 -2
- package/docs/v2/config.js.html +5 -2
- package/docs/v2/content-org_content-org.js.html +2 -2
- package/docs/v2/content-org_guided-courses.ts.html +2 -2
- package/docs/v2/content-org_learning-paths.ts.html +194 -59
- package/docs/v2/content-org_playlists-types.js.html +2 -2
- package/docs/v2/content-org_playlists.js.html +2 -2
- package/docs/v2/content.js.html +88 -10
- package/docs/v2/content_artist.ts.html +206 -0
- package/docs/v2/content_content.ts.html +77 -0
- package/docs/v2/content_genre.ts.html +209 -0
- package/docs/v2/content_instructor.ts.html +206 -0
- package/docs/v2/forums_categories.ts.html +22 -3
- package/docs/v2/forums_forums.ts.html +2 -2
- package/docs/v2/forums_posts.ts.html +22 -3
- package/docs/v2/forums_threads.ts.html +23 -10
- package/docs/v2/gamification_awards.ts.html +26 -12
- package/docs/v2/gamification_gamification.js.html +2 -2
- package/docs/v2/global.html +56 -8
- package/docs/v2/index.html +2 -2
- package/docs/v2/liveTesting.ts.html +2 -2
- package/docs/v2/module-Accounts.html +202 -13
- package/docs/v2/module-Artist.html +993 -0
- package/docs/v2/module-Awards.html +106 -6
- package/docs/v2/module-Config.html +5 -4
- package/docs/v2/module-Content-Services-V2.html +440 -9
- package/docs/v2/module-Forums.html +1398 -192
- package/docs/v2/module-Genre.html +981 -0
- package/docs/v2/module-GuidedCourses.html +2 -2
- package/docs/v2/module-Instructor.html +929 -0
- package/docs/v2/module-Interests.html +2 -2
- package/docs/v2/module-LearningPaths.html +1276 -182
- package/docs/v2/module-Onboarding.html +32 -8
- package/docs/v2/module-Payments.html +2 -2
- package/docs/v2/module-Permissions.html +2 -2
- package/docs/v2/module-Playlists.html +2 -2
- package/docs/v2/module-ProgressRow.html +2 -2
- package/docs/v2/module-Railcontent-Services.html +34 -626
- package/docs/v2/module-Sanity-Services.html +803 -1722
- package/docs/v2/module-Sessions.html +2 -2
- package/docs/v2/module-UserActivity.html +70 -116
- package/docs/v2/module-UserChat.html +2 -2
- package/docs/v2/module-UserManagement.html +2 -2
- package/docs/v2/module-UserMemberships.html +2 -2
- package/docs/v2/module-UserNotifications.html +2 -2
- package/docs/v2/module-UserProfile.html +2 -2
- package/docs/v2/progress-row_method-card.js.html +46 -47
- package/docs/v2/railcontent.js.html +14 -125
- package/docs/v2/sanity.js.html +247 -320
- package/docs/v2/userActivity.js.html +93 -169
- package/docs/v2/user_account.ts.html +41 -13
- package/docs/v2/user_chat.js.html +2 -2
- package/docs/v2/user_interests.js.html +2 -2
- package/docs/v2/user_management.js.html +2 -2
- package/docs/v2/user_memberships.ts.html +2 -2
- package/docs/v2/user_notifications.js.html +2 -2
- package/docs/v2/user_onboarding.ts.html +99 -4
- package/docs/v2/user_payments.ts.html +2 -2
- package/docs/v2/user_permissions.js.html +3 -3
- package/docs/v2/user_profile.js.html +2 -2
- package/docs/v2/user_sessions.js.html +2 -2
- package/docs/v2/user_types.js.html +4 -2
- package/docs/v2/user_user-management-system.js.html +2 -2
- package/link_mcs.sh +0 -0
- package/package.json +1 -1
- package/src/services/sanity.js +3 -3
|
@@ -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-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></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-LearningPaths.html">LearningPaths</a><ul class='methods'><li data-type='method'><a href="module-LearningPaths.html#~fetchLearningPathLessons">fetchLearningPathLessons</a></li><li data-type='method'><a href="module-LearningPaths.html#~getActivePath">getActivePath</a></li><li data-type='method'><a href="module-LearningPaths.html#~getDailySession">getDailySession</a></li><li data-type='method'><a href="module-LearningPaths.html#~resetAllLearningPaths">resetAllLearningPaths</a></li><li data-type='method'><a href="module-LearningPaths.html#~startLearningPath">startLearningPath</a></li><li data-type='method'><a href="module-LearningPaths.html#~updateActivePath">updateActivePath</a></li><li data-type='method'><a href="module-LearningPaths.html#~updateDailySession">updateDailySession</a></li></ul></li><li><a href="module-Onboarding.html">Onboarding</a><ul class='methods'><li data-type='method'><a href="module-Onboarding.html#~getOnboardingRecommendedContent">getOnboardingRecommendedContent</a></li><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-ProgressRow.html">ProgressRow</a></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>
|
|
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><li data-type='method'><a href="module-Accounts.html#~toggleStudentView">toggleStudentView</a></li></ul></li><li><a href="module-Artist.html">Artist</a><ul class='methods'><li data-type='method'><a href="module-Artist.html#~fetchArtistBySlug">fetchArtistBySlug</a></li><li data-type='method'><a href="module-Artist.html#~fetchArtistLessons">fetchArtistLessons</a></li><li data-type='method'><a href="module-Artist.html#~fetchArtists">fetchArtists</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#.getOwnedContent">getOwnedContent</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#~deleteForumCategory">deleteForumCategory</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#~markThreadAsRead">markThreadAsRead</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-Genre.html">Genre</a><ul class='methods'><li data-type='method'><a href="module-Genre.html#~fetchGenreBySlug">fetchGenreBySlug</a></li><li data-type='method'><a href="module-Genre.html#~fetchGenreLessons">fetchGenreLessons</a></li><li data-type='method'><a href="module-Genre.html#~fetchGenres">fetchGenres</a></li></ul></li><li><a href="module-GuidedCourses.html">GuidedCourses</a></li><li><a href="module-Instructor.html">Instructor</a><ul class='methods'><li data-type='method'><a href="module-Instructor.html#~fetchInstructorBySlug">fetchInstructorBySlug</a></li><li data-type='method'><a href="module-Instructor.html#~fetchInstructorLessons">fetchInstructorLessons</a></li><li data-type='method'><a href="module-Instructor.html#~fetchInstructors">fetchInstructors</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-LearningPaths.html">LearningPaths</a><ul class='methods'><li data-type='method'><a href="module-LearningPaths.html#~completeLearningPathIntroVideo">completeLearningPathIntroVideo</a></li><li data-type='method'><a href="module-LearningPaths.html#~completeMethodIntroVideo">completeMethodIntroVideo</a></li><li data-type='method'><a href="module-LearningPaths.html#~fetchLearningPathLessons">fetchLearningPathLessons</a></li><li data-type='method'><a href="module-LearningPaths.html#~fetchLearningPathProgressCheckLessons">fetchLearningPathProgressCheckLessons</a></li><li data-type='method'><a href="module-LearningPaths.html#~getActivePath">getActivePath</a></li><li data-type='method'><a href="module-LearningPaths.html#~getDailySession">getDailySession</a></li><li data-type='method'><a href="module-LearningPaths.html#~getEnrichedLearningPath">getEnrichedLearningPath</a></li><li data-type='method'><a href="module-LearningPaths.html#~getLearningPathLessonsByIds">getLearningPathLessonsByIds</a></li><li data-type='method'><a href="module-LearningPaths.html#~mapContentToParent">mapContentToParent</a></li><li data-type='method'><a href="module-LearningPaths.html#~resetAllLearningPaths">resetAllLearningPaths</a></li><li data-type='method'><a href="module-LearningPaths.html#~startLearningPath">startLearningPath</a></li><li data-type='method'><a href="module-LearningPaths.html#~updateDailySession">updateDailySession</a></li></ul></li><li><a href="module-Onboarding.html">Onboarding</a><ul class='methods'><li data-type='method'><a href="module-Onboarding.html#~getOnboardingRecommendedContent">getOnboardingRecommendedContent</a></li><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-ProgressRow.html">ProgressRow</a></li><li><a href="module-Railcontent-Services.html">Railcontent-Services</a><ul class='methods'><li data-type='method'><a href="module-Railcontent-Services.html#.assignModeratorToComment">assignModeratorToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.closeComment">closeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.createComment">createComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.deleteComment">deleteComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.editComment">editComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchAllCompletedStates">fetchAllCompletedStates</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCarouselCardData">fetchCarouselCardData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchComment">fetchComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCommentRelies">fetchCommentRelies</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchComments">fetchComments</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedContent">fetchCompletedContent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedState">fetchCompletedState</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentInProgress">fetchContentInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentPageUserData">fetchContentPageUserData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchNextContentDataForParent">fetchNextContentDataForParent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchRecentUserActivities">fetchRecentUserActivities</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchSongsInProgress">fetchSongsInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchTopComment">fetchTopComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserAward">fetchUserAward</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserBadges">fetchUserBadges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserPracticeNotes">fetchUserPracticeNotes</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.likeComment">likeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.openComment">openComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.replyToComment">replyToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.reportComment">reportComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.restoreComment">restoreComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.setStudentViewForUser">setStudentViewForUser</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.unassignModeratorToComment">unassignModeratorToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.unlikeComment">unlikeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#~fetchLastInteractedChild">fetchLastInteractedChild</a></li></ul></li><li><a href="module-Sanity-Services.html">Sanity-Services</a><ul class='methods'><li data-type='method'><a href="module-Sanity-Services.html#.fetchAll">fetchAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllFilterOptions">fetchAllFilterOptions</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllPacks">fetchAllPacks</a></li><li data-type='method'><a href="module-Sanity-Services.html#.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#.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#.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#.fetchMethodV2StructureFromId">fetchMethodV2StructureFromId</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#.fetchOwnedContent">fetchOwnedContent</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#.fetchTopLevelParentId">fetchTopLevelParentId</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#line41">line 41</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#line571">line 571</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#line799">line 799</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#line1337">line 1337</a>
|
|
1360
1360
|
</li></ul></dd>
|
|
1361
1361
|
|
|
1362
1362
|
|
|
@@ -1674,7 +1674,7 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
1674
1674
|
|
|
1675
1675
|
|
|
1676
1676
|
|
|
1677
|
-
<h4 class="name" id=".
|
|
1677
|
+
<h4 class="name" id=".fetchByRailContentId"><span class="type-signature type-signature-static">(static) </span>fetchByRailContentId<span class="signature">(id, contentType)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
1678
1678
|
|
|
1679
1679
|
|
|
1680
1680
|
|
|
@@ -1684,13 +1684,13 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
1684
1684
|
<dl class="details">
|
|
1685
1685
|
|
|
1686
1686
|
<dt class="tag-description">Description:</dt>
|
|
1687
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetch
|
|
1687
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch content by a specific Railcontent ID.</li></ul></dd>
|
|
1688
1688
|
|
|
1689
1689
|
|
|
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#line415">line 415</a>
|
|
1694
1694
|
</li></ul></dd>
|
|
1695
1695
|
|
|
1696
1696
|
|
|
@@ -1737,8 +1737,8 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
1737
1737
|
|
|
1738
1738
|
<h5 class="h5-examples">Example</h5>
|
|
1739
1739
|
|
|
1740
|
-
<pre class="prettyprint"><code>
|
|
1741
|
-
.then(
|
|
1740
|
+
<pre class="prettyprint"><code>fetchByRailContentId('abc123')
|
|
1741
|
+
.then(content => console.log(content))
|
|
1742
1742
|
.catch(error => console.error(error));</code></pre>
|
|
1743
1743
|
|
|
1744
1744
|
|
|
@@ -1769,7 +1769,7 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
1769
1769
|
|
|
1770
1770
|
<tr>
|
|
1771
1771
|
|
|
1772
|
-
<td class="name"><code>
|
|
1772
|
+
<td class="name"><code>id</code></td>
|
|
1773
1773
|
|
|
1774
1774
|
|
|
1775
1775
|
<td class="type">
|
|
@@ -1786,14 +1786,14 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
1786
1786
|
|
|
1787
1787
|
|
|
1788
1788
|
|
|
1789
|
-
<td class="description last">The
|
|
1789
|
+
<td class="description last">The Railcontent ID of the content to fetch.</td>
|
|
1790
1790
|
</tr>
|
|
1791
1791
|
|
|
1792
1792
|
|
|
1793
1793
|
|
|
1794
1794
|
<tr>
|
|
1795
1795
|
|
|
1796
|
-
<td class="name"><code>
|
|
1796
|
+
<td class="name"><code>contentType</code></td>
|
|
1797
1797
|
|
|
1798
1798
|
|
|
1799
1799
|
<td class="type">
|
|
@@ -1810,251 +1810,163 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
1810
1810
|
|
|
1811
1811
|
|
|
1812
1812
|
|
|
1813
|
-
<td class="description last">The
|
|
1813
|
+
<td class="description last">The document type of content to fetch</td>
|
|
1814
1814
|
</tr>
|
|
1815
1815
|
|
|
1816
1816
|
|
|
1817
|
+
</tbody>
|
|
1818
|
+
</table>
|
|
1817
1819
|
|
|
1818
|
-
<tr>
|
|
1819
|
-
|
|
1820
|
-
<td class="name"><code>contentType</code></td>
|
|
1821
|
-
|
|
1822
|
-
|
|
1823
|
-
<td class="type">
|
|
1824
|
-
|
|
1825
|
-
|
|
1826
|
-
<span class="param-type">string</span>
|
|
1827
1820
|
|
|
1828
1821
|
|
|
1829
1822
|
|
|
1830
|
-
|
|
1831
|
-
</td>
|
|
1832
1823
|
|
|
1833
|
-
|
|
1834
1824
|
|
|
1835
|
-
|
|
1836
1825
|
|
|
1837
|
-
<td class="description last">The type of the lessons we need to get from the artist. If not defined, groq will get lessons from all content types</td>
|
|
1838
|
-
</tr>
|
|
1839
1826
|
|
|
1840
|
-
|
|
1841
1827
|
|
|
1842
|
-
<tr>
|
|
1843
|
-
|
|
1844
|
-
<td class="name"><code>params</code></td>
|
|
1845
|
-
|
|
1846
1828
|
|
|
1847
|
-
<td class="type">
|
|
1848
|
-
|
|
1849
|
-
|
|
1850
|
-
<span class="param-type">Object</span>
|
|
1851
1829
|
|
|
1852
1830
|
|
|
1853
1831
|
|
|
1854
|
-
|
|
1855
|
-
</td>
|
|
1856
1832
|
|
|
1857
|
-
|
|
1858
1833
|
|
|
1859
|
-
|
|
1860
1834
|
|
|
1861
|
-
|
|
1862
|
-
<h6>Properties</h6>
|
|
1863
|
-
|
|
1835
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
1864
1836
|
|
|
1865
|
-
<table class="params">
|
|
1866
|
-
<thead>
|
|
1867
|
-
<tr>
|
|
1868
|
-
|
|
1869
|
-
<th>Name</th>
|
|
1870
1837
|
|
|
1838
|
+
<div class="param-desc">
|
|
1839
|
+
- A promise that resolves to the content object or null if not found.
|
|
1840
|
+
</div>
|
|
1871
1841
|
|
|
1872
|
-
<th>Type</th>
|
|
1873
1842
|
|
|
1874
|
-
|
|
1875
|
-
<th>Attributes</th>
|
|
1876
|
-
|
|
1877
1843
|
|
|
1844
|
+
<dl class="param-type">
|
|
1845
|
+
<dt>
|
|
1846
|
+
Type
|
|
1847
|
+
</dt>
|
|
1848
|
+
<dd>
|
|
1878
1849
|
|
|
1879
|
-
|
|
1880
|
-
|
|
1850
|
+
<span class="param-type">Promise.<(Object|null)></span>
|
|
1881
1851
|
|
|
1882
|
-
<th class="last">Description</th>
|
|
1883
|
-
</tr>
|
|
1884
|
-
</thead>
|
|
1885
1852
|
|
|
1886
|
-
|
|
1853
|
+
|
|
1854
|
+
</dd>
|
|
1855
|
+
</dl>
|
|
1856
|
+
|
|
1887
1857
|
|
|
1888
1858
|
|
|
1889
|
-
<tr>
|
|
1890
|
-
|
|
1891
|
-
<td class="name"><code>sort</code></td>
|
|
1892
|
-
|
|
1893
1859
|
|
|
1894
|
-
|
|
1860
|
+
|
|
1861
|
+
|
|
1895
1862
|
|
|
1896
|
-
|
|
1897
|
-
<span class="param-type">string</span>
|
|
1898
1863
|
|
|
1864
|
+
|
|
1899
1865
|
|
|
1866
|
+
<h4 class="name" id=".fetchByRailContentIds"><span class="type-signature type-signature-static">(static) </span>fetchByRailContentIds<span class="signature">(ids, contentType<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<(Array.<Object>|null)>}</span></h4>
|
|
1900
1867
|
|
|
1901
|
-
|
|
1902
|
-
</td>
|
|
1868
|
+
|
|
1903
1869
|
|
|
1904
|
-
|
|
1905
|
-
<td class="attributes">
|
|
1906
|
-
|
|
1907
|
-
<optional><br>
|
|
1908
|
-
|
|
1909
1870
|
|
|
1910
|
-
|
|
1911
1871
|
|
|
1912
|
-
|
|
1913
|
-
</td>
|
|
1914
|
-
|
|
1915
1872
|
|
|
1916
|
-
|
|
1917
|
-
|
|
1918
|
-
|
|
1919
|
-
|
|
1920
|
-
|
|
1921
|
-
</td>
|
|
1922
|
-
|
|
1873
|
+
<dl class="details">
|
|
1874
|
+
|
|
1875
|
+
<dt class="tag-description">Description:</dt>
|
|
1876
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch content by an array of Railcontent IDs.</li></ul></dd>
|
|
1877
|
+
|
|
1923
1878
|
|
|
1924
|
-
|
|
1925
|
-
|
|
1879
|
+
|
|
1880
|
+
<dt class="tag-source">Source:</dt>
|
|
1881
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
1882
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line452">line 452</a>
|
|
1883
|
+
</li></ul></dd>
|
|
1884
|
+
|
|
1926
1885
|
|
|
1927
1886
|
|
|
1928
1887
|
|
|
1929
|
-
|
|
1930
|
-
|
|
1931
|
-
<td class="name"><code>searchTerm</code></td>
|
|
1932
|
-
|
|
1888
|
+
|
|
1933
1889
|
|
|
1934
|
-
|
|
1935
|
-
|
|
1936
|
-
|
|
1937
|
-
<span class="param-type">string</span>
|
|
1890
|
+
|
|
1938
1891
|
|
|
1892
|
+
|
|
1939
1893
|
|
|
1894
|
+
|
|
1940
1895
|
|
|
1941
|
-
|
|
1942
|
-
</td>
|
|
1896
|
+
|
|
1943
1897
|
|
|
1944
|
-
|
|
1945
|
-
<td class="attributes">
|
|
1946
|
-
|
|
1947
|
-
<optional><br>
|
|
1948
|
-
|
|
1898
|
+
|
|
1949
1899
|
|
|
1950
|
-
|
|
1900
|
+
|
|
1951
1901
|
|
|
1952
|
-
|
|
1953
|
-
</td>
|
|
1954
|
-
|
|
1902
|
+
|
|
1955
1903
|
|
|
1956
|
-
|
|
1957
|
-
<td class="default">
|
|
1958
|
-
|
|
1959
|
-
<code>""</code>
|
|
1960
|
-
|
|
1961
|
-
</td>
|
|
1962
|
-
|
|
1904
|
+
|
|
1963
1905
|
|
|
1964
|
-
|
|
1965
|
-
</tr>
|
|
1906
|
+
|
|
1966
1907
|
|
|
1967
1908
|
|
|
1968
1909
|
|
|
1969
|
-
|
|
1970
|
-
|
|
1971
|
-
<td class="name"><code>page</code></td>
|
|
1972
|
-
|
|
1910
|
+
|
|
1973
1911
|
|
|
1974
|
-
|
|
1975
|
-
|
|
1976
|
-
|
|
1977
|
-
|
|
1912
|
+
|
|
1913
|
+
|
|
1914
|
+
|
|
1915
|
+
</dl>
|
|
1978
1916
|
|
|
1979
1917
|
|
|
1980
1918
|
|
|
1981
|
-
|
|
1982
|
-
</td>
|
|
1983
1919
|
|
|
1984
|
-
|
|
1985
|
-
<td class="attributes">
|
|
1986
|
-
|
|
1987
|
-
<optional><br>
|
|
1988
|
-
|
|
1989
1920
|
|
|
1990
|
-
|
|
1991
1921
|
|
|
1992
|
-
|
|
1993
|
-
</td>
|
|
1994
|
-
|
|
1995
1922
|
|
|
1996
|
-
|
|
1997
|
-
<td class="default">
|
|
1998
|
-
|
|
1999
|
-
<code>1</code>
|
|
2000
|
-
|
|
2001
|
-
</td>
|
|
2002
|
-
|
|
2003
1923
|
|
|
2004
|
-
<td class="description last">The page number for pagination.</td>
|
|
2005
|
-
</tr>
|
|
2006
1924
|
|
|
2007
|
-
|
|
2008
1925
|
|
|
2009
|
-
<tr>
|
|
2010
|
-
|
|
2011
|
-
<td class="name"><code>limit</code></td>
|
|
2012
|
-
|
|
2013
1926
|
|
|
2014
|
-
|
|
2015
|
-
|
|
2016
|
-
|
|
2017
|
-
|
|
1927
|
+
<h5 class="h5-examples">Example</h5>
|
|
1928
|
+
|
|
1929
|
+
<pre class="prettyprint"><code>fetchByRailContentIds(['abc123', 'def456', 'ghi789'])
|
|
1930
|
+
.then(contents => console.log(contents))
|
|
1931
|
+
.catch(error => console.error(error));</code></pre>
|
|
2018
1932
|
|
|
2019
1933
|
|
|
2020
1934
|
|
|
2021
|
-
|
|
2022
|
-
</td>
|
|
2023
1935
|
|
|
2024
|
-
|
|
2025
|
-
|
|
2026
|
-
|
|
2027
|
-
<optional><br>
|
|
2028
|
-
|
|
1936
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
1937
|
+
|
|
2029
1938
|
|
|
2030
|
-
|
|
1939
|
+
<table class="params">
|
|
1940
|
+
<thead>
|
|
1941
|
+
<tr>
|
|
1942
|
+
|
|
1943
|
+
<th>Name</th>
|
|
1944
|
+
|
|
2031
1945
|
|
|
2032
|
-
|
|
2033
|
-
</td>
|
|
2034
|
-
|
|
1946
|
+
<th>Type</th>
|
|
2035
1947
|
|
|
2036
|
-
|
|
2037
|
-
|
|
2038
|
-
|
|
2039
|
-
<code>10</code>
|
|
2040
|
-
|
|
2041
|
-
</td>
|
|
2042
|
-
|
|
1948
|
+
|
|
1949
|
+
<th>Attributes</th>
|
|
1950
|
+
|
|
2043
1951
|
|
|
2044
|
-
|
|
2045
|
-
|
|
1952
|
+
|
|
1953
|
+
|
|
1954
|
+
<th class="last">Description</th>
|
|
1955
|
+
</tr>
|
|
1956
|
+
</thead>
|
|
2046
1957
|
|
|
1958
|
+
<tbody>
|
|
2047
1959
|
|
|
2048
1960
|
|
|
2049
1961
|
<tr>
|
|
2050
1962
|
|
|
2051
|
-
<td class="name"><code>
|
|
1963
|
+
<td class="name"><code>ids</code></td>
|
|
2052
1964
|
|
|
2053
1965
|
|
|
2054
1966
|
<td class="type">
|
|
2055
1967
|
|
|
2056
1968
|
|
|
2057
|
-
<span class="param-type">Array.<string></span>
|
|
1969
|
+
<span class="param-type">Array.<(string|number)></span>
|
|
2058
1970
|
|
|
2059
1971
|
|
|
2060
1972
|
|
|
@@ -2064,8 +1976,6 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
2064
1976
|
|
|
2065
1977
|
<td class="attributes">
|
|
2066
1978
|
|
|
2067
|
-
<optional><br>
|
|
2068
|
-
|
|
2069
1979
|
|
|
2070
1980
|
|
|
2071
1981
|
|
|
@@ -2074,27 +1984,21 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
2074
1984
|
|
|
2075
1985
|
|
|
2076
1986
|
|
|
2077
|
-
<td class="default">
|
|
2078
|
-
|
|
2079
|
-
<code>[]</code>
|
|
2080
|
-
|
|
2081
|
-
</td>
|
|
2082
|
-
|
|
2083
1987
|
|
|
2084
|
-
<td class="description last">
|
|
1988
|
+
<td class="description last">The array of Railcontent IDs of the content to fetch.</td>
|
|
2085
1989
|
</tr>
|
|
2086
1990
|
|
|
2087
1991
|
|
|
2088
1992
|
|
|
2089
1993
|
<tr>
|
|
2090
1994
|
|
|
2091
|
-
<td class="name"><code>
|
|
1995
|
+
<td class="name"><code>contentType</code></td>
|
|
2092
1996
|
|
|
2093
1997
|
|
|
2094
1998
|
<td class="type">
|
|
2095
1999
|
|
|
2096
2000
|
|
|
2097
|
-
<span class="param-type">
|
|
2001
|
+
<span class="param-type">string</span>
|
|
2098
2002
|
|
|
2099
2003
|
|
|
2100
2004
|
|
|
@@ -2114,19 +2018,8 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
2114
2018
|
|
|
2115
2019
|
|
|
2116
2020
|
|
|
2117
|
-
<td class="default">
|
|
2118
|
-
|
|
2119
|
-
</td>
|
|
2120
|
-
|
|
2121
2021
|
|
|
2122
|
-
<td class="description last">The
|
|
2123
|
-
</tr>
|
|
2124
|
-
|
|
2125
|
-
|
|
2126
|
-
</tbody>
|
|
2127
|
-
</table>
|
|
2128
|
-
|
|
2129
|
-
</td>
|
|
2022
|
+
<td class="description last">The content type the IDs to add needed fields to the response.</td>
|
|
2130
2023
|
</tr>
|
|
2131
2024
|
|
|
2132
2025
|
|
|
@@ -2152,7 +2045,7 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
2152
2045
|
|
|
2153
2046
|
|
|
2154
2047
|
<div class="param-desc">
|
|
2155
|
-
-
|
|
2048
|
+
- A promise that resolves to an array of content objects or null if not found.
|
|
2156
2049
|
</div>
|
|
2157
2050
|
|
|
2158
2051
|
|
|
@@ -2163,7 +2056,7 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
2163
2056
|
</dt>
|
|
2164
2057
|
<dd>
|
|
2165
2058
|
|
|
2166
|
-
<span class="param-type">Promise.<(Object
|
|
2059
|
+
<span class="param-type">Promise.<(Array.<Object>|null)></span>
|
|
2167
2060
|
|
|
2168
2061
|
|
|
2169
2062
|
|
|
@@ -2179,7 +2072,7 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
2179
2072
|
|
|
2180
2073
|
|
|
2181
2074
|
|
|
2182
|
-
<h4 class="name" id=".
|
|
2075
|
+
<h4 class="name" id=".fetchByReference"><span class="type-signature type-signature-static">(static) </span>fetchByReference<span class="signature">(id)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
2183
2076
|
|
|
2184
2077
|
|
|
2185
2078
|
|
|
@@ -2189,13 +2082,13 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
2189
2082
|
<dl class="details">
|
|
2190
2083
|
|
|
2191
2084
|
<dt class="tag-description">Description:</dt>
|
|
2192
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetch
|
|
2085
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch the data needed for the coach screen.</li></ul></dd>
|
|
2193
2086
|
|
|
2194
2087
|
|
|
2195
2088
|
|
|
2196
2089
|
<dt class="tag-source">Source:</dt>
|
|
2197
2090
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
2198
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
2091
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1476">line 1476</a>
|
|
2199
2092
|
</li></ul></dd>
|
|
2200
2093
|
|
|
2201
2094
|
|
|
@@ -2242,8 +2135,8 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
2242
2135
|
|
|
2243
2136
|
<h5 class="h5-examples">Example</h5>
|
|
2244
2137
|
|
|
2245
|
-
<pre class="prettyprint"><code>
|
|
2246
|
-
.then(
|
|
2138
|
+
<pre class="prettyprint"><code>fetchCoachLessons('coach123')
|
|
2139
|
+
.then(lessons => console.log(lessons))
|
|
2247
2140
|
.catch(error => console.error(error));</code></pre>
|
|
2248
2141
|
|
|
2249
2142
|
|
|
@@ -2274,7 +2167,7 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
2274
2167
|
|
|
2275
2168
|
<tr>
|
|
2276
2169
|
|
|
2277
|
-
<td class="name"><code>
|
|
2170
|
+
<td class="name"><code>id</code></td>
|
|
2278
2171
|
|
|
2279
2172
|
|
|
2280
2173
|
<td class="type">
|
|
@@ -2291,7 +2184,7 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
2291
2184
|
|
|
2292
2185
|
|
|
2293
2186
|
|
|
2294
|
-
<td class="description last">The
|
|
2187
|
+
<td class="description last">The Railcontent ID of the coach</td>
|
|
2295
2188
|
</tr>
|
|
2296
2189
|
|
|
2297
2190
|
|
|
@@ -2317,7 +2210,7 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
2317
2210
|
|
|
2318
2211
|
|
|
2319
2212
|
<div class="param-desc">
|
|
2320
|
-
-
|
|
2213
|
+
- The lessons for the instructor or null if not found.
|
|
2321
2214
|
</div>
|
|
2322
2215
|
|
|
2323
2216
|
|
|
@@ -2344,7 +2237,7 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
2344
2237
|
|
|
2345
2238
|
|
|
2346
2239
|
|
|
2347
|
-
<h4 class="name" id=".
|
|
2240
|
+
<h4 class="name" id=".fetchComingSoon"><span class="type-signature type-signature-static">(static) </span>fetchComingSoon<span class="signature">()</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
2348
2241
|
|
|
2349
2242
|
|
|
2350
2243
|
|
|
@@ -2354,13 +2247,13 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
2354
2247
|
<dl class="details">
|
|
2355
2248
|
|
|
2356
2249
|
<dt class="tag-description">Description:</dt>
|
|
2357
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
2250
|
+
<dd class="tag-description"><ul class="dummy"><li>fetches from Sanity all songs coming soon (new) next quarter</li></ul></dd>
|
|
2358
2251
|
|
|
2359
2252
|
|
|
2360
2253
|
|
|
2361
2254
|
<dt class="tag-source">Source:</dt>
|
|
2362
2255
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
2363
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
2256
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line131">line 131</a>
|
|
2364
2257
|
</li></ul></dd>
|
|
2365
2258
|
|
|
2366
2259
|
|
|
@@ -2405,87 +2298,6 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
2405
2298
|
|
|
2406
2299
|
|
|
2407
2300
|
|
|
2408
|
-
<h5 class="h5-examples">Example</h5>
|
|
2409
|
-
|
|
2410
|
-
<pre class="prettyprint"><code>fetchByRailContentId('abc123')
|
|
2411
|
-
.then(content => console.log(content))
|
|
2412
|
-
.catch(error => console.error(error));</code></pre>
|
|
2413
|
-
|
|
2414
|
-
|
|
2415
|
-
|
|
2416
|
-
|
|
2417
|
-
<h5 class="h5-parameters">Parameters:</h5>
|
|
2418
|
-
|
|
2419
|
-
|
|
2420
|
-
<table class="params">
|
|
2421
|
-
<thead>
|
|
2422
|
-
<tr>
|
|
2423
|
-
|
|
2424
|
-
<th>Name</th>
|
|
2425
|
-
|
|
2426
|
-
|
|
2427
|
-
<th>Type</th>
|
|
2428
|
-
|
|
2429
|
-
|
|
2430
|
-
|
|
2431
|
-
|
|
2432
|
-
|
|
2433
|
-
<th class="last">Description</th>
|
|
2434
|
-
</tr>
|
|
2435
|
-
</thead>
|
|
2436
|
-
|
|
2437
|
-
<tbody>
|
|
2438
|
-
|
|
2439
|
-
|
|
2440
|
-
<tr>
|
|
2441
|
-
|
|
2442
|
-
<td class="name"><code>id</code></td>
|
|
2443
|
-
|
|
2444
|
-
|
|
2445
|
-
<td class="type">
|
|
2446
|
-
|
|
2447
|
-
|
|
2448
|
-
<span class="param-type">string</span>
|
|
2449
|
-
|
|
2450
|
-
|
|
2451
|
-
|
|
2452
|
-
|
|
2453
|
-
</td>
|
|
2454
|
-
|
|
2455
|
-
|
|
2456
|
-
|
|
2457
|
-
|
|
2458
|
-
|
|
2459
|
-
<td class="description last">The Railcontent ID of the content to fetch.</td>
|
|
2460
|
-
</tr>
|
|
2461
|
-
|
|
2462
|
-
|
|
2463
|
-
|
|
2464
|
-
<tr>
|
|
2465
|
-
|
|
2466
|
-
<td class="name"><code>contentType</code></td>
|
|
2467
|
-
|
|
2468
|
-
|
|
2469
|
-
<td class="type">
|
|
2470
|
-
|
|
2471
|
-
|
|
2472
|
-
<span class="param-type">string</span>
|
|
2473
|
-
|
|
2474
|
-
|
|
2475
|
-
|
|
2476
|
-
|
|
2477
|
-
</td>
|
|
2478
|
-
|
|
2479
|
-
|
|
2480
|
-
|
|
2481
|
-
|
|
2482
|
-
|
|
2483
|
-
<td class="description last">The document type of content to fetch</td>
|
|
2484
|
-
</tr>
|
|
2485
|
-
|
|
2486
|
-
|
|
2487
|
-
</tbody>
|
|
2488
|
-
</table>
|
|
2489
2301
|
|
|
2490
2302
|
|
|
2491
2303
|
|
|
@@ -2505,10 +2317,6 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
2505
2317
|
<h5 class="h5-returns">Returns:</h5>
|
|
2506
2318
|
|
|
2507
2319
|
|
|
2508
|
-
<div class="param-desc">
|
|
2509
|
-
- A promise that resolves to the content object or null if not found.
|
|
2510
|
-
</div>
|
|
2511
|
-
|
|
2512
2320
|
|
|
2513
2321
|
|
|
2514
2322
|
<dl class="param-type">
|
|
@@ -2533,7 +2341,7 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
2533
2341
|
|
|
2534
2342
|
|
|
2535
2343
|
|
|
2536
|
-
<h4 class="name" id=".
|
|
2344
|
+
<h4 class="name" id=".fetchCommentModContentData"><span class="type-signature type-signature-static">(static) </span>fetchCommentModContentData<span class="signature">(ids)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
2537
2345
|
|
|
2538
2346
|
|
|
2539
2347
|
|
|
@@ -2543,13 +2351,13 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
2543
2351
|
<dl class="details">
|
|
2544
2352
|
|
|
2545
2353
|
<dt class="tag-description">Description:</dt>
|
|
2546
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetch
|
|
2354
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch data for comment mod page</li></ul></dd>
|
|
2547
2355
|
|
|
2548
2356
|
|
|
2549
2357
|
|
|
2550
2358
|
<dt class="tag-source">Source:</dt>
|
|
2551
2359
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
2552
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
2360
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1589">line 1589</a>
|
|
2553
2361
|
</li></ul></dd>
|
|
2554
2362
|
|
|
2555
2363
|
|
|
@@ -2594,13 +2402,6 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
2594
2402
|
|
|
2595
2403
|
|
|
2596
2404
|
|
|
2597
|
-
<h5 class="h5-examples">Example</h5>
|
|
2598
|
-
|
|
2599
|
-
<pre class="prettyprint"><code>fetchByRailContentIds(['abc123', 'def456', 'ghi789'])
|
|
2600
|
-
.then(contents => console.log(contents))
|
|
2601
|
-
.catch(error => console.error(error));</code></pre>
|
|
2602
|
-
|
|
2603
|
-
|
|
2604
2405
|
|
|
2605
2406
|
|
|
2606
2407
|
<h5 class="h5-parameters">Parameters:</h5>
|
|
@@ -2616,8 +2417,6 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
2616
2417
|
<th>Type</th>
|
|
2617
2418
|
|
|
2618
2419
|
|
|
2619
|
-
<th>Attributes</th>
|
|
2620
|
-
|
|
2621
2420
|
|
|
2622
2421
|
|
|
2623
2422
|
|
|
@@ -2636,39 +2435,7 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
2636
2435
|
<td class="type">
|
|
2637
2436
|
|
|
2638
2437
|
|
|
2639
|
-
<span class="param-type">
|
|
2640
|
-
|
|
2641
|
-
|
|
2642
|
-
|
|
2643
|
-
|
|
2644
|
-
</td>
|
|
2645
|
-
|
|
2646
|
-
|
|
2647
|
-
<td class="attributes">
|
|
2648
|
-
|
|
2649
|
-
|
|
2650
|
-
|
|
2651
|
-
|
|
2652
|
-
|
|
2653
|
-
</td>
|
|
2654
|
-
|
|
2655
|
-
|
|
2656
|
-
|
|
2657
|
-
|
|
2658
|
-
<td class="description last">The array of Railcontent IDs of the content to fetch.</td>
|
|
2659
|
-
</tr>
|
|
2660
|
-
|
|
2661
|
-
|
|
2662
|
-
|
|
2663
|
-
<tr>
|
|
2664
|
-
|
|
2665
|
-
<td class="name"><code>contentType</code></td>
|
|
2666
|
-
|
|
2667
|
-
|
|
2668
|
-
<td class="type">
|
|
2669
|
-
|
|
2670
|
-
|
|
2671
|
-
<span class="param-type">string</span>
|
|
2438
|
+
<span class="param-type">array</span>
|
|
2672
2439
|
|
|
2673
2440
|
|
|
2674
2441
|
|
|
@@ -2676,20 +2443,10 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
2676
2443
|
</td>
|
|
2677
2444
|
|
|
2678
2445
|
|
|
2679
|
-
<td class="attributes">
|
|
2680
|
-
|
|
2681
|
-
<optional><br>
|
|
2682
|
-
|
|
2683
|
-
|
|
2684
|
-
|
|
2685
|
-
|
|
2686
|
-
|
|
2687
|
-
</td>
|
|
2688
|
-
|
|
2689
2446
|
|
|
2690
2447
|
|
|
2691
2448
|
|
|
2692
|
-
<td class="description last">
|
|
2449
|
+
<td class="description last">List of ids get data for</td>
|
|
2693
2450
|
</tr>
|
|
2694
2451
|
|
|
2695
2452
|
|
|
@@ -2715,7 +2472,7 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
2715
2472
|
|
|
2716
2473
|
|
|
2717
2474
|
<div class="param-desc">
|
|
2718
|
-
- A promise that resolves to an
|
|
2475
|
+
- A promise that resolves to an object containing the data
|
|
2719
2476
|
</div>
|
|
2720
2477
|
|
|
2721
2478
|
|
|
@@ -2726,7 +2483,7 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
2726
2483
|
</dt>
|
|
2727
2484
|
<dd>
|
|
2728
2485
|
|
|
2729
|
-
<span class="param-type">Promise.<(
|
|
2486
|
+
<span class="param-type">Promise.<(Object|null)></span>
|
|
2730
2487
|
|
|
2731
2488
|
|
|
2732
2489
|
|
|
@@ -2742,7 +2499,7 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
2742
2499
|
|
|
2743
2500
|
|
|
2744
2501
|
|
|
2745
|
-
<h4 class="name" id=".
|
|
2502
|
+
<h4 class="name" id=".fetchFoundation"><span class="type-signature type-signature-static">(static) </span>fetchFoundation<span class="signature">(slug)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
2746
2503
|
|
|
2747
2504
|
|
|
2748
2505
|
|
|
@@ -2752,13 +2509,13 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
2752
2509
|
<dl class="details">
|
|
2753
2510
|
|
|
2754
2511
|
<dt class="tag-description">Description:</dt>
|
|
2755
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetch the
|
|
2512
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch the Foundations 2019.</li></ul></dd>
|
|
2756
2513
|
|
|
2757
2514
|
|
|
2758
2515
|
|
|
2759
2516
|
<dt class="tag-source">Source:</dt>
|
|
2760
2517
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
2761
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
2518
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line872">line 872</a>
|
|
2762
2519
|
</li></ul></dd>
|
|
2763
2520
|
|
|
2764
2521
|
|
|
@@ -2803,13 +2560,6 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
2803
2560
|
|
|
2804
2561
|
|
|
2805
2562
|
|
|
2806
|
-
<h5 class="h5-examples">Example</h5>
|
|
2807
|
-
|
|
2808
|
-
<pre class="prettyprint"><code>fetchCoachLessons('coach123')
|
|
2809
|
-
.then(lessons => console.log(lessons))
|
|
2810
|
-
.catch(error => console.error(error));</code></pre>
|
|
2811
|
-
|
|
2812
|
-
|
|
2813
2563
|
|
|
2814
2564
|
|
|
2815
2565
|
<h5 class="h5-parameters">Parameters:</h5>
|
|
@@ -2837,7 +2587,7 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
2837
2587
|
|
|
2838
2588
|
<tr>
|
|
2839
2589
|
|
|
2840
|
-
<td class="name"><code>
|
|
2590
|
+
<td class="name"><code>slug</code></td>
|
|
2841
2591
|
|
|
2842
2592
|
|
|
2843
2593
|
<td class="type">
|
|
@@ -2854,7 +2604,7 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
2854
2604
|
|
|
2855
2605
|
|
|
2856
2606
|
|
|
2857
|
-
<td class="description last">The
|
|
2607
|
+
<td class="description last">The slug of the method.</td>
|
|
2858
2608
|
</tr>
|
|
2859
2609
|
|
|
2860
2610
|
|
|
@@ -2880,7 +2630,7 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
2880
2630
|
|
|
2881
2631
|
|
|
2882
2632
|
<div class="param-desc">
|
|
2883
|
-
- The
|
|
2633
|
+
- The fetched foundation data or null if not found.
|
|
2884
2634
|
</div>
|
|
2885
2635
|
|
|
2886
2636
|
|
|
@@ -2907,7 +2657,7 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
2907
2657
|
|
|
2908
2658
|
|
|
2909
2659
|
|
|
2910
|
-
<h4 class="name" id=".
|
|
2660
|
+
<h4 class="name" id=".fetchLeaving"><span class="type-signature type-signature-static">(static) </span>fetchLeaving<span class="signature">()</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
2911
2661
|
|
|
2912
2662
|
|
|
2913
2663
|
|
|
@@ -2917,13 +2667,13 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
2917
2667
|
<dl class="details">
|
|
2918
2668
|
|
|
2919
2669
|
<dt class="tag-description">Description:</dt>
|
|
2920
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
2670
|
+
<dd class="tag-description"><ul class="dummy"><li>fetches from Sanity all content marked for removal next quarter</li></ul></dd>
|
|
2921
2671
|
|
|
2922
2672
|
|
|
2923
2673
|
|
|
2924
2674
|
<dt class="tag-source">Source:</dt>
|
|
2925
2675
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
2926
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
2676
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line76">line 76</a>
|
|
2927
2677
|
</li></ul></dd>
|
|
2928
2678
|
|
|
2929
2679
|
|
|
@@ -2968,302 +2718,151 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
2968
2718
|
|
|
2969
2719
|
|
|
2970
2720
|
|
|
2971
|
-
<h5 class="h5-examples">Example</h5>
|
|
2972
|
-
|
|
2973
|
-
<pre class="prettyprint"><code>fetchCoachLessons('coach123')
|
|
2974
|
-
.then(lessons => console.log(lessons))
|
|
2975
|
-
.catch(error => console.error(error));</code></pre>
|
|
2976
2721
|
|
|
2977
2722
|
|
|
2978
2723
|
|
|
2979
2724
|
|
|
2980
|
-
<h5 class="h5-parameters">Parameters:</h5>
|
|
2981
|
-
|
|
2982
2725
|
|
|
2983
|
-
<table class="params">
|
|
2984
|
-
<thead>
|
|
2985
|
-
<tr>
|
|
2986
|
-
|
|
2987
|
-
<th>Name</th>
|
|
2988
|
-
|
|
2989
2726
|
|
|
2990
|
-
<th>Type</th>
|
|
2991
2727
|
|
|
2992
|
-
|
|
2993
2728
|
|
|
2994
|
-
|
|
2995
2729
|
|
|
2996
|
-
<th class="last">Description</th>
|
|
2997
|
-
</tr>
|
|
2998
|
-
</thead>
|
|
2999
2730
|
|
|
3000
|
-
<tbody>
|
|
3001
|
-
|
|
3002
2731
|
|
|
3003
|
-
<tr>
|
|
3004
|
-
|
|
3005
|
-
<td class="name"><code>brand</code></td>
|
|
3006
|
-
|
|
3007
2732
|
|
|
3008
|
-
<td class="type">
|
|
3009
|
-
|
|
3010
|
-
|
|
3011
|
-
<span class="param-type">string</span>
|
|
3012
2733
|
|
|
3013
2734
|
|
|
3014
2735
|
|
|
3015
|
-
|
|
3016
|
-
</td>
|
|
3017
2736
|
|
|
3018
|
-
|
|
2737
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
3019
2738
|
|
|
3020
|
-
|
|
2739
|
+
|
|
3021
2740
|
|
|
3022
|
-
<td class="description last">The brand for which to fetch coach lessons</td>
|
|
3023
|
-
</tr>
|
|
3024
2741
|
|
|
3025
|
-
|
|
2742
|
+
<dl class="param-type">
|
|
2743
|
+
<dt>
|
|
2744
|
+
Type
|
|
2745
|
+
</dt>
|
|
2746
|
+
<dd>
|
|
2747
|
+
|
|
2748
|
+
<span class="param-type">Promise.<(Object|null)></span>
|
|
3026
2749
|
|
|
3027
|
-
<tr>
|
|
3028
|
-
|
|
3029
|
-
<td class="name"><code>id</code></td>
|
|
3030
|
-
|
|
3031
2750
|
|
|
3032
|
-
<td class="type">
|
|
3033
|
-
|
|
3034
|
-
|
|
3035
|
-
<span class="param-type">string</span>
|
|
3036
2751
|
|
|
2752
|
+
</dd>
|
|
2753
|
+
</dl>
|
|
3037
2754
|
|
|
2755
|
+
|
|
3038
2756
|
|
|
3039
|
-
|
|
3040
|
-
</td>
|
|
3041
2757
|
|
|
3042
|
-
|
|
3043
2758
|
|
|
2759
|
+
|
|
3044
2760
|
|
|
3045
2761
|
|
|
3046
|
-
<td class="description last">The Railcontent ID of the coach</td>
|
|
3047
|
-
</tr>
|
|
3048
|
-
|
|
3049
2762
|
|
|
3050
2763
|
|
|
3051
|
-
|
|
3052
|
-
|
|
3053
|
-
<td class="name"><code>params</code></td>
|
|
3054
|
-
|
|
2764
|
+
<h4 class="name" id=".fetchLessonContent"><span class="type-signature type-signature-static">(static) </span>fetchLessonContent<span class="signature">(railContentId)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
3055
2765
|
|
|
3056
|
-
<td class="type">
|
|
3057
|
-
|
|
3058
|
-
|
|
3059
|
-
<span class="param-type">Object</span>
|
|
3060
|
-
|
|
3061
|
-
|
|
3062
|
-
|
|
3063
|
-
|
|
3064
|
-
</td>
|
|
3065
|
-
|
|
3066
|
-
|
|
3067
|
-
|
|
3068
|
-
|
|
3069
|
-
|
|
3070
|
-
<td class="description last">Parameters for pagination, filtering and sorting.
|
|
3071
|
-
<h6>Properties</h6>
|
|
3072
|
-
|
|
3073
|
-
|
|
3074
|
-
<table class="params">
|
|
3075
|
-
<thead>
|
|
3076
|
-
<tr>
|
|
3077
|
-
|
|
3078
|
-
<th>Name</th>
|
|
3079
|
-
|
|
3080
|
-
|
|
3081
|
-
<th>Type</th>
|
|
3082
|
-
|
|
3083
|
-
|
|
3084
|
-
<th>Attributes</th>
|
|
3085
|
-
|
|
3086
|
-
|
|
3087
|
-
|
|
3088
|
-
<th>Default</th>
|
|
3089
|
-
|
|
3090
|
-
|
|
3091
|
-
<th class="last">Description</th>
|
|
3092
|
-
</tr>
|
|
3093
|
-
</thead>
|
|
3094
|
-
|
|
3095
|
-
<tbody>
|
|
3096
2766
|
|
|
3097
2767
|
|
|
3098
|
-
<tr>
|
|
3099
|
-
|
|
3100
|
-
<td class="name"><code>sortOrder</code></td>
|
|
3101
|
-
|
|
3102
|
-
|
|
3103
|
-
<td class="type">
|
|
3104
|
-
|
|
3105
|
-
|
|
3106
|
-
<span class="param-type">string</span>
|
|
3107
|
-
|
|
3108
2768
|
|
|
3109
2769
|
|
|
3110
|
-
|
|
3111
|
-
</td>
|
|
3112
2770
|
|
|
3113
|
-
|
|
3114
|
-
|
|
3115
|
-
|
|
3116
|
-
|
|
3117
|
-
|
|
2771
|
+
<dl class="details">
|
|
2772
|
+
|
|
2773
|
+
<dt class="tag-description">Description:</dt>
|
|
2774
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch the page data for a specific lesson by Railcontent ID.</li></ul></dd>
|
|
2775
|
+
|
|
3118
2776
|
|
|
3119
|
-
|
|
2777
|
+
|
|
2778
|
+
<dt class="tag-source">Source:</dt>
|
|
2779
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
2780
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1095">line 1095</a>
|
|
2781
|
+
</li></ul></dd>
|
|
2782
|
+
|
|
3120
2783
|
|
|
3121
|
-
|
|
3122
|
-
</td>
|
|
3123
|
-
|
|
2784
|
+
|
|
3124
2785
|
|
|
3125
|
-
|
|
3126
|
-
<td class="default">
|
|
3127
|
-
|
|
3128
|
-
<code>"-published_on"</code>
|
|
3129
|
-
|
|
3130
|
-
</td>
|
|
3131
|
-
|
|
2786
|
+
|
|
3132
2787
|
|
|
3133
|
-
|
|
3134
|
-
</tr>
|
|
2788
|
+
|
|
3135
2789
|
|
|
3136
2790
|
|
|
3137
2791
|
|
|
3138
|
-
|
|
3139
|
-
|
|
3140
|
-
<td class="name"><code>searchTerm</code></td>
|
|
3141
|
-
|
|
2792
|
+
|
|
3142
2793
|
|
|
3143
|
-
|
|
3144
|
-
|
|
3145
|
-
|
|
3146
|
-
<span class="param-type">string</span>
|
|
2794
|
+
|
|
3147
2795
|
|
|
2796
|
+
|
|
3148
2797
|
|
|
2798
|
+
|
|
3149
2799
|
|
|
3150
|
-
|
|
3151
|
-
</td>
|
|
2800
|
+
|
|
3152
2801
|
|
|
3153
|
-
|
|
3154
|
-
<td class="attributes">
|
|
3155
|
-
|
|
3156
|
-
<optional><br>
|
|
3157
|
-
|
|
2802
|
+
|
|
3158
2803
|
|
|
3159
|
-
|
|
2804
|
+
|
|
3160
2805
|
|
|
3161
|
-
|
|
3162
|
-
</td>
|
|
3163
|
-
|
|
2806
|
+
|
|
3164
2807
|
|
|
3165
|
-
|
|
3166
|
-
<td class="default">
|
|
3167
|
-
|
|
3168
|
-
<code>""</code>
|
|
3169
|
-
|
|
3170
|
-
</td>
|
|
3171
|
-
|
|
2808
|
+
|
|
3172
2809
|
|
|
3173
|
-
|
|
3174
|
-
</tr>
|
|
2810
|
+
|
|
3175
2811
|
|
|
3176
2812
|
|
|
2813
|
+
</dl>
|
|
3177
2814
|
|
|
3178
|
-
<tr>
|
|
3179
|
-
|
|
3180
|
-
<td class="name"><code>page</code></td>
|
|
3181
|
-
|
|
3182
2815
|
|
|
3183
|
-
<td class="type">
|
|
3184
|
-
|
|
3185
|
-
|
|
3186
|
-
<span class="param-type">number</span>
|
|
3187
2816
|
|
|
3188
2817
|
|
|
3189
2818
|
|
|
3190
|
-
|
|
3191
|
-
</td>
|
|
3192
2819
|
|
|
3193
|
-
|
|
3194
|
-
<td class="attributes">
|
|
3195
|
-
|
|
3196
|
-
<optional><br>
|
|
3197
|
-
|
|
3198
2820
|
|
|
3199
|
-
|
|
3200
2821
|
|
|
3201
|
-
|
|
3202
|
-
</td>
|
|
3203
|
-
|
|
3204
2822
|
|
|
3205
|
-
|
|
3206
|
-
<td class="default">
|
|
3207
|
-
|
|
3208
|
-
<code>1</code>
|
|
3209
|
-
|
|
3210
|
-
</td>
|
|
3211
|
-
|
|
3212
2823
|
|
|
3213
|
-
<td class="description last">The page number for pagination.</td>
|
|
3214
|
-
</tr>
|
|
3215
2824
|
|
|
2825
|
+
<h5 class="h5-examples">Example</h5>
|
|
3216
2826
|
|
|
2827
|
+
<pre class="prettyprint"><code>fetchLessonContent('lesson123')
|
|
2828
|
+
.then(data => console.log(data))
|
|
2829
|
+
.catch(error => console.error(error));</code></pre>
|
|
3217
2830
|
|
|
3218
|
-
<tr>
|
|
3219
|
-
|
|
3220
|
-
<td class="name"><code>limit</code></td>
|
|
3221
|
-
|
|
3222
|
-
|
|
3223
|
-
<td class="type">
|
|
3224
|
-
|
|
3225
|
-
|
|
3226
|
-
<span class="param-type">number</span>
|
|
3227
2831
|
|
|
3228
2832
|
|
|
3229
2833
|
|
|
3230
|
-
|
|
3231
|
-
|
|
2834
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
2835
|
+
|
|
3232
2836
|
|
|
3233
|
-
|
|
3234
|
-
|
|
3235
|
-
|
|
3236
|
-
|
|
3237
|
-
|
|
2837
|
+
<table class="params">
|
|
2838
|
+
<thead>
|
|
2839
|
+
<tr>
|
|
2840
|
+
|
|
2841
|
+
<th>Name</th>
|
|
2842
|
+
|
|
3238
2843
|
|
|
3239
|
-
|
|
2844
|
+
<th>Type</th>
|
|
3240
2845
|
|
|
3241
|
-
|
|
3242
|
-
</td>
|
|
3243
|
-
|
|
2846
|
+
|
|
3244
2847
|
|
|
3245
|
-
|
|
3246
|
-
<td class="default">
|
|
3247
|
-
|
|
3248
|
-
<code>10</code>
|
|
3249
|
-
|
|
3250
|
-
</td>
|
|
3251
|
-
|
|
2848
|
+
|
|
3252
2849
|
|
|
3253
|
-
|
|
3254
|
-
|
|
2850
|
+
<th class="last">Description</th>
|
|
2851
|
+
</tr>
|
|
2852
|
+
</thead>
|
|
3255
2853
|
|
|
2854
|
+
<tbody>
|
|
3256
2855
|
|
|
3257
2856
|
|
|
3258
2857
|
<tr>
|
|
3259
2858
|
|
|
3260
|
-
<td class="name"><code>
|
|
2859
|
+
<td class="name"><code>railContentId</code></td>
|
|
3261
2860
|
|
|
3262
2861
|
|
|
3263
2862
|
<td class="type">
|
|
3264
2863
|
|
|
3265
2864
|
|
|
3266
|
-
<span class="param-type">
|
|
2865
|
+
<span class="param-type">string</span>
|
|
3267
2866
|
|
|
3268
2867
|
|
|
3269
2868
|
|
|
@@ -3271,33 +2870,10 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
3271
2870
|
</td>
|
|
3272
2871
|
|
|
3273
2872
|
|
|
3274
|
-
<td class="attributes">
|
|
3275
|
-
|
|
3276
|
-
<optional><br>
|
|
3277
|
-
|
|
3278
|
-
|
|
3279
|
-
|
|
3280
|
-
|
|
3281
|
-
|
|
3282
|
-
</td>
|
|
3283
|
-
|
|
3284
2873
|
|
|
3285
2874
|
|
|
3286
|
-
<td class="default">
|
|
3287
|
-
|
|
3288
|
-
<code>[]</code>
|
|
3289
|
-
|
|
3290
|
-
</td>
|
|
3291
|
-
|
|
3292
|
-
|
|
3293
|
-
<td class="description last">Additional filters to apply to the query in the format of a key,value array. eg. ['difficulty,Intermediate', 'genre,rock'].</td>
|
|
3294
|
-
</tr>
|
|
3295
2875
|
|
|
3296
|
-
|
|
3297
|
-
</tbody>
|
|
3298
|
-
</table>
|
|
3299
|
-
|
|
3300
|
-
</td>
|
|
2876
|
+
<td class="description last">The Railcontent ID of the current lesson.</td>
|
|
3301
2877
|
</tr>
|
|
3302
2878
|
|
|
3303
2879
|
|
|
@@ -3323,7 +2899,7 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
3323
2899
|
|
|
3324
2900
|
|
|
3325
2901
|
<div class="param-desc">
|
|
3326
|
-
- The
|
|
2902
|
+
- The fetched page data or null if found.
|
|
3327
2903
|
</div>
|
|
3328
2904
|
|
|
3329
2905
|
|
|
@@ -3350,7 +2926,7 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
3350
2926
|
|
|
3351
2927
|
|
|
3352
2928
|
|
|
3353
|
-
<h4 class="name" id=".
|
|
2929
|
+
<h4 class="name" id=".fetchLessonsFeaturingThisContent"><span class="type-signature type-signature-static">(static) </span>fetchLessonsFeaturingThisContent<span class="signature">(railcontentId, brand, count)</span><span class="type-signature"> → {Promise.<Array.<Object>>}</span></h4>
|
|
3354
2930
|
|
|
3355
2931
|
|
|
3356
2932
|
|
|
@@ -3360,13 +2936,14 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
3360
2936
|
<dl class="details">
|
|
3361
2937
|
|
|
3362
2938
|
<dt class="tag-description">Description:</dt>
|
|
3363
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
2939
|
+
<dd class="tag-description"><ul class="dummy"><li>Get non-song content documents that share content information with the provided railcontent document.
|
|
2940
|
+
These are linked through content that shares a license with the provided railcontent document</li></ul></dd>
|
|
3364
2941
|
|
|
3365
2942
|
|
|
3366
2943
|
|
|
3367
2944
|
<dt class="tag-source">Source:</dt>
|
|
3368
2945
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
3369
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
2946
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1206">line 1206</a>
|
|
3370
2947
|
</li></ul></dd>
|
|
3371
2948
|
|
|
3372
2949
|
|
|
@@ -3413,905 +2990,102 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
3413
2990
|
|
|
3414
2991
|
|
|
3415
2992
|
|
|
2993
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
2994
|
+
|
|
3416
2995
|
|
|
2996
|
+
<table class="params">
|
|
2997
|
+
<thead>
|
|
2998
|
+
<tr>
|
|
2999
|
+
|
|
3000
|
+
<th>Name</th>
|
|
3001
|
+
|
|
3417
3002
|
|
|
3003
|
+
<th>Type</th>
|
|
3418
3004
|
|
|
3005
|
+
|
|
3419
3006
|
|
|
3007
|
+
|
|
3420
3008
|
|
|
3009
|
+
<th class="last">Description</th>
|
|
3010
|
+
</tr>
|
|
3011
|
+
</thead>
|
|
3421
3012
|
|
|
3013
|
+
<tbody>
|
|
3014
|
+
|
|
3422
3015
|
|
|
3016
|
+
<tr>
|
|
3017
|
+
|
|
3018
|
+
<td class="name"><code>railcontentId</code></td>
|
|
3019
|
+
|
|
3423
3020
|
|
|
3021
|
+
<td class="type">
|
|
3022
|
+
|
|
3023
|
+
|
|
3024
|
+
<span class="param-type">integer</span>
|
|
3424
3025
|
|
|
3425
3026
|
|
|
3426
3027
|
|
|
3028
|
+
|
|
3029
|
+
</td>
|
|
3427
3030
|
|
|
3031
|
+
|
|
3428
3032
|
|
|
3429
|
-
|
|
3430
|
-
<h5 class="h5-returns">Returns:</h5>
|
|
3431
|
-
|
|
3432
|
-
|
|
3433
|
-
|
|
3434
|
-
|
|
3435
|
-
<dl class="param-type">
|
|
3436
|
-
<dt>
|
|
3437
|
-
Type
|
|
3438
|
-
</dt>
|
|
3439
|
-
<dd>
|
|
3440
|
-
|
|
3441
|
-
<span class="param-type">Promise.<(Object|null)></span>
|
|
3442
|
-
|
|
3443
|
-
|
|
3444
|
-
|
|
3445
|
-
</dd>
|
|
3446
|
-
</dl>
|
|
3447
|
-
|
|
3448
|
-
|
|
3449
|
-
|
|
3450
|
-
|
|
3451
|
-
|
|
3452
|
-
|
|
3453
|
-
|
|
3454
|
-
|
|
3455
|
-
|
|
3456
|
-
|
|
3457
|
-
<h4 class="name" id=".fetchCommentModContentData"><span class="type-signature type-signature-static">(static) </span>fetchCommentModContentData<span class="signature">(ids)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
3458
|
-
|
|
3459
|
-
|
|
3460
|
-
|
|
3461
|
-
|
|
3462
|
-
|
|
3463
|
-
|
|
3464
|
-
<dl class="details">
|
|
3465
|
-
|
|
3466
|
-
<dt class="tag-description">Description:</dt>
|
|
3467
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetch data for comment mod page</li></ul></dd>
|
|
3468
|
-
|
|
3469
|
-
|
|
3470
|
-
|
|
3471
|
-
<dt class="tag-source">Source:</dt>
|
|
3472
|
-
<dd class="tag-source"><ul class="dummy"><li>
|
|
3473
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1740">line 1740</a>
|
|
3474
|
-
</li></ul></dd>
|
|
3475
|
-
|
|
3476
|
-
|
|
3477
|
-
|
|
3478
|
-
|
|
3479
|
-
|
|
3480
|
-
|
|
3481
|
-
|
|
3482
|
-
|
|
3483
|
-
|
|
3484
|
-
|
|
3485
|
-
|
|
3486
|
-
|
|
3487
|
-
|
|
3488
|
-
|
|
3489
|
-
|
|
3490
|
-
|
|
3491
|
-
|
|
3492
|
-
|
|
3493
|
-
|
|
3494
|
-
|
|
3495
|
-
|
|
3496
|
-
|
|
3497
|
-
|
|
3498
|
-
|
|
3499
|
-
|
|
3500
|
-
|
|
3501
|
-
|
|
3502
|
-
|
|
3503
|
-
|
|
3504
|
-
|
|
3505
|
-
|
|
3506
|
-
</dl>
|
|
3507
|
-
|
|
3508
|
-
|
|
3509
|
-
|
|
3510
|
-
|
|
3511
|
-
|
|
3512
|
-
|
|
3513
|
-
|
|
3514
|
-
|
|
3515
|
-
|
|
3516
|
-
|
|
3517
|
-
|
|
3518
|
-
|
|
3519
|
-
|
|
3520
|
-
<h5 class="h5-parameters">Parameters:</h5>
|
|
3521
|
-
|
|
3522
|
-
|
|
3523
|
-
<table class="params">
|
|
3524
|
-
<thead>
|
|
3525
|
-
<tr>
|
|
3526
|
-
|
|
3527
|
-
<th>Name</th>
|
|
3528
|
-
|
|
3529
|
-
|
|
3530
|
-
<th>Type</th>
|
|
3531
|
-
|
|
3532
|
-
|
|
3533
|
-
|
|
3534
|
-
|
|
3535
|
-
|
|
3536
|
-
<th class="last">Description</th>
|
|
3537
|
-
</tr>
|
|
3538
|
-
</thead>
|
|
3539
|
-
|
|
3540
|
-
<tbody>
|
|
3541
|
-
|
|
3542
|
-
|
|
3543
|
-
<tr>
|
|
3544
|
-
|
|
3545
|
-
<td class="name"><code>ids</code></td>
|
|
3546
|
-
|
|
3547
|
-
|
|
3548
|
-
<td class="type">
|
|
3549
|
-
|
|
3550
|
-
|
|
3551
|
-
<span class="param-type">array</span>
|
|
3552
|
-
|
|
3553
|
-
|
|
3554
|
-
|
|
3555
|
-
|
|
3556
|
-
</td>
|
|
3557
|
-
|
|
3558
|
-
|
|
3559
|
-
|
|
3560
|
-
|
|
3561
|
-
|
|
3562
|
-
<td class="description last">List of ids get data for</td>
|
|
3563
|
-
</tr>
|
|
3564
|
-
|
|
3565
|
-
|
|
3566
|
-
</tbody>
|
|
3567
|
-
</table>
|
|
3568
|
-
|
|
3569
|
-
|
|
3570
|
-
|
|
3571
|
-
|
|
3572
|
-
|
|
3573
|
-
|
|
3574
|
-
|
|
3575
|
-
|
|
3576
|
-
|
|
3577
|
-
|
|
3578
|
-
|
|
3579
|
-
|
|
3580
|
-
|
|
3581
|
-
|
|
3582
|
-
|
|
3583
|
-
|
|
3584
|
-
<h5 class="h5-returns">Returns:</h5>
|
|
3585
|
-
|
|
3586
|
-
|
|
3587
|
-
<div class="param-desc">
|
|
3588
|
-
- A promise that resolves to an object containing the data
|
|
3589
|
-
</div>
|
|
3590
|
-
|
|
3591
|
-
|
|
3592
|
-
|
|
3593
|
-
<dl class="param-type">
|
|
3594
|
-
<dt>
|
|
3595
|
-
Type
|
|
3596
|
-
</dt>
|
|
3597
|
-
<dd>
|
|
3598
|
-
|
|
3599
|
-
<span class="param-type">Promise.<(Object|null)></span>
|
|
3600
|
-
|
|
3601
|
-
|
|
3602
|
-
|
|
3603
|
-
</dd>
|
|
3604
|
-
</dl>
|
|
3605
|
-
|
|
3606
|
-
|
|
3607
|
-
|
|
3608
|
-
|
|
3609
|
-
|
|
3610
|
-
|
|
3611
|
-
|
|
3612
|
-
|
|
3613
|
-
|
|
3614
|
-
|
|
3615
|
-
<h4 class="name" id=".fetchFoundation"><span class="type-signature type-signature-static">(static) </span>fetchFoundation<span class="signature">(slug)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
3616
|
-
|
|
3617
|
-
|
|
3618
|
-
|
|
3619
|
-
|
|
3620
|
-
|
|
3621
|
-
|
|
3622
|
-
<dl class="details">
|
|
3623
|
-
|
|
3624
|
-
<dt class="tag-description">Description:</dt>
|
|
3625
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetch the Foundations 2019.</li></ul></dd>
|
|
3626
|
-
|
|
3627
|
-
|
|
3628
|
-
|
|
3629
|
-
<dt class="tag-source">Source:</dt>
|
|
3630
|
-
<dd class="tag-source"><ul class="dummy"><li>
|
|
3631
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line886">line 886</a>
|
|
3632
|
-
</li></ul></dd>
|
|
3633
|
-
|
|
3634
|
-
|
|
3635
|
-
|
|
3636
|
-
|
|
3637
|
-
|
|
3638
|
-
|
|
3639
|
-
|
|
3640
|
-
|
|
3641
|
-
|
|
3642
|
-
|
|
3643
|
-
|
|
3644
|
-
|
|
3645
|
-
|
|
3646
|
-
|
|
3647
|
-
|
|
3648
|
-
|
|
3649
|
-
|
|
3650
|
-
|
|
3651
|
-
|
|
3652
|
-
|
|
3653
|
-
|
|
3654
|
-
|
|
3655
|
-
|
|
3656
|
-
|
|
3657
|
-
|
|
3658
|
-
|
|
3659
|
-
|
|
3660
|
-
|
|
3661
|
-
|
|
3662
|
-
|
|
3663
|
-
|
|
3664
|
-
</dl>
|
|
3665
|
-
|
|
3666
|
-
|
|
3667
|
-
|
|
3668
|
-
|
|
3669
|
-
|
|
3670
|
-
|
|
3671
|
-
|
|
3672
|
-
|
|
3673
|
-
|
|
3674
|
-
|
|
3675
|
-
|
|
3676
|
-
|
|
3677
|
-
|
|
3678
|
-
<h5 class="h5-parameters">Parameters:</h5>
|
|
3679
|
-
|
|
3680
|
-
|
|
3681
|
-
<table class="params">
|
|
3682
|
-
<thead>
|
|
3683
|
-
<tr>
|
|
3684
|
-
|
|
3685
|
-
<th>Name</th>
|
|
3686
|
-
|
|
3687
|
-
|
|
3688
|
-
<th>Type</th>
|
|
3689
|
-
|
|
3690
|
-
|
|
3691
|
-
|
|
3692
|
-
|
|
3693
|
-
|
|
3694
|
-
<th class="last">Description</th>
|
|
3695
|
-
</tr>
|
|
3696
|
-
</thead>
|
|
3697
|
-
|
|
3698
|
-
<tbody>
|
|
3699
|
-
|
|
3700
|
-
|
|
3701
|
-
<tr>
|
|
3702
|
-
|
|
3703
|
-
<td class="name"><code>slug</code></td>
|
|
3704
|
-
|
|
3705
|
-
|
|
3706
|
-
<td class="type">
|
|
3707
|
-
|
|
3708
|
-
|
|
3709
|
-
<span class="param-type">string</span>
|
|
3710
|
-
|
|
3711
|
-
|
|
3712
|
-
|
|
3713
|
-
|
|
3714
|
-
</td>
|
|
3715
|
-
|
|
3716
|
-
|
|
3717
|
-
|
|
3718
|
-
|
|
3719
|
-
|
|
3720
|
-
<td class="description last">The slug of the method.</td>
|
|
3721
|
-
</tr>
|
|
3722
|
-
|
|
3723
|
-
|
|
3724
|
-
</tbody>
|
|
3725
|
-
</table>
|
|
3726
|
-
|
|
3727
|
-
|
|
3728
|
-
|
|
3729
|
-
|
|
3730
|
-
|
|
3731
|
-
|
|
3732
|
-
|
|
3733
|
-
|
|
3734
|
-
|
|
3735
|
-
|
|
3736
|
-
|
|
3737
|
-
|
|
3738
|
-
|
|
3739
|
-
|
|
3740
|
-
|
|
3741
|
-
|
|
3742
|
-
<h5 class="h5-returns">Returns:</h5>
|
|
3743
|
-
|
|
3744
|
-
|
|
3745
|
-
<div class="param-desc">
|
|
3746
|
-
- The fetched foundation data or null if not found.
|
|
3747
|
-
</div>
|
|
3748
|
-
|
|
3749
|
-
|
|
3750
|
-
|
|
3751
|
-
<dl class="param-type">
|
|
3752
|
-
<dt>
|
|
3753
|
-
Type
|
|
3754
|
-
</dt>
|
|
3755
|
-
<dd>
|
|
3756
|
-
|
|
3757
|
-
<span class="param-type">Promise.<(Object|null)></span>
|
|
3758
|
-
|
|
3759
|
-
|
|
3760
|
-
|
|
3761
|
-
</dd>
|
|
3762
|
-
</dl>
|
|
3763
|
-
|
|
3764
|
-
|
|
3765
|
-
|
|
3766
|
-
|
|
3767
|
-
|
|
3768
|
-
|
|
3769
|
-
|
|
3770
|
-
|
|
3771
|
-
|
|
3772
|
-
|
|
3773
|
-
<h4 class="name" id=".fetchGenreLessons"><span class="type-signature type-signature-static">(static) </span>fetchGenreLessons<span class="signature">(brand, name, params)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
3774
|
-
|
|
3775
|
-
|
|
3776
|
-
|
|
3777
|
-
|
|
3778
|
-
|
|
3779
|
-
|
|
3780
|
-
<dl class="details">
|
|
3781
|
-
|
|
3782
|
-
<dt class="tag-description">Description:</dt>
|
|
3783
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetch the genre's lessons.</li></ul></dd>
|
|
3784
|
-
|
|
3785
|
-
|
|
3786
|
-
|
|
3787
|
-
<dt class="tag-source">Source:</dt>
|
|
3788
|
-
<dd class="tag-source"><ul class="dummy"><li>
|
|
3789
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1610">line 1610</a>
|
|
3790
|
-
</li></ul></dd>
|
|
3791
|
-
|
|
3792
|
-
|
|
3793
|
-
|
|
3794
|
-
|
|
3795
|
-
|
|
3796
|
-
|
|
3797
|
-
|
|
3798
|
-
|
|
3799
|
-
|
|
3800
|
-
|
|
3801
|
-
|
|
3802
|
-
|
|
3803
|
-
|
|
3804
|
-
|
|
3805
|
-
|
|
3806
|
-
|
|
3807
|
-
|
|
3808
|
-
|
|
3809
|
-
|
|
3810
|
-
|
|
3811
|
-
|
|
3812
|
-
|
|
3813
|
-
|
|
3814
|
-
|
|
3815
|
-
|
|
3816
|
-
|
|
3817
|
-
|
|
3818
|
-
|
|
3819
|
-
|
|
3820
|
-
|
|
3821
|
-
|
|
3822
|
-
</dl>
|
|
3823
|
-
|
|
3824
|
-
|
|
3825
|
-
|
|
3826
|
-
|
|
3827
|
-
|
|
3828
|
-
|
|
3829
|
-
|
|
3830
|
-
|
|
3831
|
-
|
|
3832
|
-
|
|
3833
|
-
|
|
3834
|
-
<h5 class="h5-examples">Example</h5>
|
|
3835
|
-
|
|
3836
|
-
<pre class="prettyprint"><code>fetchGenreLessons('drumeo', 'Blues', 'song', {'-published_on', '', 1, 10, ["difficulty,Intermediate"], [232168, 232824, 303375, 232194, 393125]})
|
|
3837
|
-
.then(lessons => console.log(lessons))
|
|
3838
|
-
.catch(error => console.error(error));</code></pre>
|
|
3839
|
-
|
|
3840
|
-
|
|
3841
|
-
|
|
3842
|
-
|
|
3843
|
-
<h5 class="h5-parameters">Parameters:</h5>
|
|
3844
|
-
|
|
3845
|
-
|
|
3846
|
-
<table class="params">
|
|
3847
|
-
<thead>
|
|
3848
|
-
<tr>
|
|
3849
|
-
|
|
3850
|
-
<th>Name</th>
|
|
3851
|
-
|
|
3852
|
-
|
|
3853
|
-
<th>Type</th>
|
|
3854
|
-
|
|
3855
|
-
|
|
3856
|
-
|
|
3857
|
-
|
|
3858
|
-
|
|
3859
|
-
<th class="last">Description</th>
|
|
3860
|
-
</tr>
|
|
3861
|
-
</thead>
|
|
3862
|
-
|
|
3863
|
-
<tbody>
|
|
3864
|
-
|
|
3865
|
-
|
|
3866
|
-
<tr>
|
|
3867
|
-
|
|
3868
|
-
<td class="name"><code>brand</code></td>
|
|
3869
|
-
|
|
3870
|
-
|
|
3871
|
-
<td class="type">
|
|
3872
|
-
|
|
3873
|
-
|
|
3874
|
-
<span class="param-type">string</span>
|
|
3875
|
-
|
|
3876
|
-
|
|
3877
|
-
|
|
3878
|
-
|
|
3879
|
-
</td>
|
|
3880
|
-
|
|
3881
|
-
|
|
3882
|
-
|
|
3883
|
-
|
|
3884
|
-
|
|
3885
|
-
<td class="description last">The brand for which to fetch lessons.</td>
|
|
3886
|
-
</tr>
|
|
3887
|
-
|
|
3888
|
-
|
|
3889
|
-
|
|
3890
|
-
<tr>
|
|
3891
|
-
|
|
3892
|
-
<td class="name"><code>name</code></td>
|
|
3893
|
-
|
|
3894
|
-
|
|
3895
|
-
<td class="type">
|
|
3896
|
-
|
|
3897
|
-
|
|
3898
|
-
<span class="param-type">string</span>
|
|
3899
|
-
|
|
3900
|
-
|
|
3901
|
-
|
|
3902
|
-
|
|
3903
|
-
</td>
|
|
3904
|
-
|
|
3905
|
-
|
|
3906
|
-
|
|
3907
|
-
|
|
3908
|
-
|
|
3909
|
-
<td class="description last">The name of the genre</td>
|
|
3910
|
-
</tr>
|
|
3911
|
-
|
|
3912
|
-
|
|
3913
|
-
|
|
3914
|
-
<tr>
|
|
3915
|
-
|
|
3916
|
-
<td class="name"><code>params</code></td>
|
|
3917
|
-
|
|
3918
|
-
|
|
3919
|
-
<td class="type">
|
|
3920
|
-
|
|
3921
|
-
|
|
3922
|
-
<span class="param-type">Object</span>
|
|
3923
|
-
|
|
3924
|
-
|
|
3925
|
-
|
|
3926
|
-
|
|
3927
|
-
</td>
|
|
3928
|
-
|
|
3929
|
-
|
|
3930
|
-
|
|
3931
|
-
|
|
3932
|
-
|
|
3933
|
-
<td class="description last">Parameters for sorting, searching, pagination and filtering.
|
|
3934
|
-
<h6>Properties</h6>
|
|
3935
|
-
|
|
3936
|
-
|
|
3937
|
-
<table class="params">
|
|
3938
|
-
<thead>
|
|
3939
|
-
<tr>
|
|
3940
|
-
|
|
3941
|
-
<th>Name</th>
|
|
3942
|
-
|
|
3943
|
-
|
|
3944
|
-
<th>Type</th>
|
|
3945
|
-
|
|
3946
|
-
|
|
3947
|
-
<th>Attributes</th>
|
|
3948
|
-
|
|
3949
|
-
|
|
3950
|
-
|
|
3951
|
-
<th>Default</th>
|
|
3952
|
-
|
|
3953
|
-
|
|
3954
|
-
<th class="last">Description</th>
|
|
3955
|
-
</tr>
|
|
3956
|
-
</thead>
|
|
3957
|
-
|
|
3958
|
-
<tbody>
|
|
3959
|
-
|
|
3960
|
-
|
|
3961
|
-
<tr>
|
|
3962
|
-
|
|
3963
|
-
<td class="name"><code>sort</code></td>
|
|
3964
|
-
|
|
3965
|
-
|
|
3966
|
-
<td class="type">
|
|
3967
|
-
|
|
3968
|
-
|
|
3969
|
-
<span class="param-type">string</span>
|
|
3970
|
-
|
|
3971
|
-
|
|
3972
|
-
|
|
3973
|
-
|
|
3974
|
-
</td>
|
|
3975
|
-
|
|
3976
|
-
|
|
3977
|
-
<td class="attributes">
|
|
3978
|
-
|
|
3979
|
-
<optional><br>
|
|
3980
|
-
|
|
3981
|
-
|
|
3982
|
-
|
|
3983
|
-
|
|
3984
|
-
|
|
3985
|
-
</td>
|
|
3986
|
-
|
|
3987
|
-
|
|
3988
|
-
|
|
3989
|
-
<td class="default">
|
|
3990
|
-
|
|
3991
|
-
<code>"-published_on"</code>
|
|
3992
|
-
|
|
3993
|
-
</td>
|
|
3994
|
-
|
|
3995
|
-
|
|
3996
|
-
<td class="description last">The field to sort the lessons by.</td>
|
|
3997
|
-
</tr>
|
|
3998
|
-
|
|
3999
|
-
|
|
4000
|
-
|
|
4001
|
-
<tr>
|
|
4002
|
-
|
|
4003
|
-
<td class="name"><code>searchTerm</code></td>
|
|
4004
|
-
|
|
4005
|
-
|
|
4006
|
-
<td class="type">
|
|
4007
|
-
|
|
4008
|
-
|
|
4009
|
-
<span class="param-type">string</span>
|
|
4010
|
-
|
|
4011
|
-
|
|
4012
|
-
|
|
4013
|
-
|
|
4014
|
-
</td>
|
|
4015
|
-
|
|
4016
|
-
|
|
4017
|
-
<td class="attributes">
|
|
4018
|
-
|
|
4019
|
-
<optional><br>
|
|
4020
|
-
|
|
4021
|
-
|
|
4022
|
-
|
|
4023
|
-
|
|
4024
|
-
|
|
4025
|
-
</td>
|
|
4026
|
-
|
|
4027
|
-
|
|
4028
|
-
|
|
4029
|
-
<td class="default">
|
|
4030
|
-
|
|
4031
|
-
<code>""</code>
|
|
4032
|
-
|
|
4033
|
-
</td>
|
|
4034
|
-
|
|
4035
|
-
|
|
4036
|
-
<td class="description last">The search term to filter the lessons.</td>
|
|
4037
|
-
</tr>
|
|
4038
|
-
|
|
4039
|
-
|
|
4040
|
-
|
|
4041
|
-
<tr>
|
|
4042
|
-
|
|
4043
|
-
<td class="name"><code>page</code></td>
|
|
4044
|
-
|
|
4045
|
-
|
|
4046
|
-
<td class="type">
|
|
4047
|
-
|
|
4048
|
-
|
|
4049
|
-
<span class="param-type">number</span>
|
|
4050
|
-
|
|
4051
|
-
|
|
4052
|
-
|
|
4053
|
-
|
|
4054
|
-
</td>
|
|
4055
|
-
|
|
4056
|
-
|
|
4057
|
-
<td class="attributes">
|
|
4058
|
-
|
|
4059
|
-
<optional><br>
|
|
4060
|
-
|
|
4061
|
-
|
|
4062
|
-
|
|
4063
|
-
|
|
4064
|
-
|
|
4065
|
-
</td>
|
|
4066
|
-
|
|
4067
|
-
|
|
4068
|
-
|
|
4069
|
-
<td class="default">
|
|
4070
|
-
|
|
4071
|
-
<code>1</code>
|
|
4072
|
-
|
|
4073
|
-
</td>
|
|
4074
|
-
|
|
4075
|
-
|
|
4076
|
-
<td class="description last">The page number for pagination.</td>
|
|
4077
|
-
</tr>
|
|
4078
|
-
|
|
4079
|
-
|
|
4080
|
-
|
|
4081
|
-
<tr>
|
|
4082
|
-
|
|
4083
|
-
<td class="name"><code>limit</code></td>
|
|
4084
|
-
|
|
4085
|
-
|
|
4086
|
-
<td class="type">
|
|
4087
|
-
|
|
4088
|
-
|
|
4089
|
-
<span class="param-type">number</span>
|
|
4090
|
-
|
|
4091
|
-
|
|
4092
|
-
|
|
4093
|
-
|
|
4094
|
-
</td>
|
|
4095
|
-
|
|
4096
|
-
|
|
4097
|
-
<td class="attributes">
|
|
4098
|
-
|
|
4099
|
-
<optional><br>
|
|
4100
|
-
|
|
4101
|
-
|
|
4102
|
-
|
|
4103
|
-
|
|
4104
|
-
|
|
4105
|
-
</td>
|
|
4106
|
-
|
|
4107
|
-
|
|
4108
|
-
|
|
4109
|
-
<td class="default">
|
|
4110
|
-
|
|
4111
|
-
<code>10</code>
|
|
4112
|
-
|
|
4113
|
-
</td>
|
|
4114
|
-
|
|
4115
|
-
|
|
4116
|
-
<td class="description last">The number of items per page.</td>
|
|
4117
|
-
</tr>
|
|
4118
|
-
|
|
4119
|
-
|
|
4120
|
-
|
|
4121
|
-
<tr>
|
|
4122
|
-
|
|
4123
|
-
<td class="name"><code>includedFields</code></td>
|
|
4124
|
-
|
|
4125
|
-
|
|
4126
|
-
<td class="type">
|
|
4127
|
-
|
|
4128
|
-
|
|
4129
|
-
<span class="param-type">Array.<string></span>
|
|
4130
|
-
|
|
4131
|
-
|
|
4132
|
-
|
|
4133
|
-
|
|
4134
|
-
</td>
|
|
4135
|
-
|
|
4136
|
-
|
|
4137
|
-
<td class="attributes">
|
|
4138
|
-
|
|
4139
|
-
<optional><br>
|
|
4140
|
-
|
|
4141
|
-
|
|
4142
|
-
|
|
4143
|
-
|
|
4144
|
-
|
|
4145
|
-
</td>
|
|
4146
|
-
|
|
4147
|
-
|
|
4148
|
-
|
|
4149
|
-
<td class="default">
|
|
4150
|
-
|
|
4151
|
-
<code>[]</code>
|
|
4152
|
-
|
|
4153
|
-
</td>
|
|
4154
3033
|
|
|
4155
3034
|
|
|
4156
|
-
<td class="description last"
|
|
3035
|
+
<td class="description last"></td>
|
|
4157
3036
|
</tr>
|
|
4158
3037
|
|
|
4159
3038
|
|
|
4160
3039
|
|
|
4161
3040
|
<tr>
|
|
4162
3041
|
|
|
4163
|
-
<td class="name"><code>
|
|
3042
|
+
<td class="name"><code>brand</code></td>
|
|
4164
3043
|
|
|
4165
3044
|
|
|
4166
3045
|
<td class="type">
|
|
4167
3046
|
|
|
4168
3047
|
|
|
4169
|
-
<span class="param-type">
|
|
4170
|
-
|
|
4171
|
-
|
|
4172
|
-
|
|
4173
|
-
|
|
4174
|
-
</td>
|
|
4175
|
-
|
|
4176
|
-
|
|
4177
|
-
<td class="attributes">
|
|
4178
|
-
|
|
4179
|
-
<optional><br>
|
|
4180
|
-
|
|
4181
|
-
|
|
4182
|
-
|
|
4183
|
-
|
|
4184
|
-
|
|
4185
|
-
</td>
|
|
4186
|
-
|
|
4187
|
-
|
|
4188
|
-
|
|
4189
|
-
<td class="default">
|
|
4190
|
-
|
|
4191
|
-
</td>
|
|
4192
|
-
|
|
4193
|
-
|
|
4194
|
-
<td class="description last">The ids of the lessons that are in progress or completed</td>
|
|
4195
|
-
</tr>
|
|
4196
|
-
|
|
4197
|
-
|
|
4198
|
-
</tbody>
|
|
4199
|
-
</table>
|
|
4200
|
-
|
|
4201
|
-
</td>
|
|
4202
|
-
</tr>
|
|
4203
|
-
|
|
4204
|
-
|
|
4205
|
-
</tbody>
|
|
4206
|
-
</table>
|
|
4207
|
-
|
|
4208
|
-
|
|
4209
|
-
|
|
4210
|
-
|
|
4211
|
-
|
|
4212
|
-
|
|
4213
|
-
|
|
4214
|
-
|
|
4215
|
-
|
|
4216
|
-
|
|
4217
|
-
|
|
4218
|
-
|
|
4219
|
-
|
|
4220
|
-
|
|
4221
|
-
|
|
4222
|
-
|
|
4223
|
-
<h5 class="h5-returns">Returns:</h5>
|
|
4224
|
-
|
|
4225
|
-
|
|
4226
|
-
<div class="param-desc">
|
|
4227
|
-
- The lessons for the artist and some details about the artist (name and thumbnail).
|
|
4228
|
-
</div>
|
|
4229
|
-
|
|
4230
|
-
|
|
4231
|
-
|
|
4232
|
-
<dl class="param-type">
|
|
4233
|
-
<dt>
|
|
4234
|
-
Type
|
|
4235
|
-
</dt>
|
|
4236
|
-
<dd>
|
|
4237
|
-
|
|
4238
|
-
<span class="param-type">Promise.<(Object|null)></span>
|
|
4239
|
-
|
|
4240
|
-
|
|
4241
|
-
|
|
4242
|
-
</dd>
|
|
4243
|
-
</dl>
|
|
4244
|
-
|
|
4245
|
-
|
|
4246
|
-
|
|
4247
|
-
|
|
4248
|
-
|
|
4249
|
-
|
|
4250
|
-
|
|
4251
|
-
|
|
4252
|
-
|
|
4253
|
-
|
|
4254
|
-
<h4 class="name" id=".fetchLeaving"><span class="type-signature type-signature-static">(static) </span>fetchLeaving<span class="signature">()</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
4255
|
-
|
|
4256
|
-
|
|
4257
|
-
|
|
4258
|
-
|
|
4259
|
-
|
|
4260
|
-
|
|
4261
|
-
<dl class="details">
|
|
4262
|
-
|
|
4263
|
-
<dt class="tag-description">Description:</dt>
|
|
4264
|
-
<dd class="tag-description"><ul class="dummy"><li>fetches from Sanity all content marked for removal next quarter</li></ul></dd>
|
|
4265
|
-
|
|
4266
|
-
|
|
4267
|
-
|
|
4268
|
-
<dt class="tag-source">Source:</dt>
|
|
4269
|
-
<dd class="tag-source"><ul class="dummy"><li>
|
|
4270
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line79">line 79</a>
|
|
4271
|
-
</li></ul></dd>
|
|
4272
|
-
|
|
4273
|
-
|
|
4274
|
-
|
|
4275
|
-
|
|
4276
|
-
|
|
4277
|
-
|
|
4278
|
-
|
|
4279
|
-
|
|
4280
|
-
|
|
4281
|
-
|
|
4282
|
-
|
|
4283
|
-
|
|
4284
|
-
|
|
4285
|
-
|
|
4286
|
-
|
|
4287
|
-
|
|
4288
|
-
|
|
4289
|
-
|
|
4290
|
-
|
|
4291
|
-
|
|
4292
|
-
|
|
3048
|
+
<span class="param-type">string</span>
|
|
4293
3049
|
|
|
4294
|
-
|
|
4295
3050
|
|
|
4296
|
-
|
|
4297
3051
|
|
|
4298
|
-
|
|
3052
|
+
|
|
3053
|
+
</td>
|
|
4299
3054
|
|
|
4300
|
-
|
|
3055
|
+
|
|
4301
3056
|
|
|
4302
|
-
|
|
4303
|
-
</dl>
|
|
3057
|
+
|
|
4304
3058
|
|
|
3059
|
+
<td class="description last"></td>
|
|
3060
|
+
</tr>
|
|
4305
3061
|
|
|
3062
|
+
|
|
4306
3063
|
|
|
3064
|
+
<tr>
|
|
3065
|
+
|
|
3066
|
+
<td class="name"><code>count</code></td>
|
|
3067
|
+
|
|
4307
3068
|
|
|
3069
|
+
<td class="type">
|
|
3070
|
+
|
|
3071
|
+
|
|
3072
|
+
<span class="param-type">integer:3</span>
|
|
4308
3073
|
|
|
4309
3074
|
|
|
4310
3075
|
|
|
3076
|
+
|
|
3077
|
+
</td>
|
|
4311
3078
|
|
|
3079
|
+
|
|
4312
3080
|
|
|
3081
|
+
|
|
4313
3082
|
|
|
3083
|
+
<td class="description last"></td>
|
|
3084
|
+
</tr>
|
|
4314
3085
|
|
|
3086
|
+
|
|
3087
|
+
</tbody>
|
|
3088
|
+
</table>
|
|
4315
3089
|
|
|
4316
3090
|
|
|
4317
3091
|
|
|
@@ -4339,7 +3113,7 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
4339
3113
|
</dt>
|
|
4340
3114
|
<dd>
|
|
4341
3115
|
|
|
4342
|
-
<span class="param-type">Promise.<
|
|
3116
|
+
<span class="param-type">Promise.<Array.<Object>></span>
|
|
4343
3117
|
|
|
4344
3118
|
|
|
4345
3119
|
|
|
@@ -4355,7 +3129,7 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
4355
3129
|
|
|
4356
3130
|
|
|
4357
3131
|
|
|
4358
|
-
<h4 class="name" id=".
|
|
3132
|
+
<h4 class="name" id=".fetchMetadata"><span class="type-signature type-signature-static">(static) </span>fetchMetadata<span class="signature">(brand, type)</span><span class="type-signature"> → {Promise.<{name, description, type: *, thumbnailUrl}>}</span></h4>
|
|
4359
3133
|
|
|
4360
3134
|
|
|
4361
3135
|
|
|
@@ -4365,13 +3139,14 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
4365
3139
|
<dl class="details">
|
|
4366
3140
|
|
|
4367
3141
|
<dt class="tag-description">Description:</dt>
|
|
4368
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetch
|
|
3142
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch metadata from the contentMetaData.js based on brand and type.
|
|
3143
|
+
For v2 you need to provide page type('lessons' or 'songs') in type parameter</li></ul></dd>
|
|
4369
3144
|
|
|
4370
3145
|
|
|
4371
3146
|
|
|
4372
3147
|
<dt class="tag-source">Source:</dt>
|
|
4373
3148
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
4374
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
3149
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1779">line 1779</a>
|
|
4375
3150
|
</li></ul></dd>
|
|
4376
3151
|
|
|
4377
3152
|
|
|
@@ -4418,7 +3193,7 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
4418
3193
|
|
|
4419
3194
|
<h5 class="h5-examples">Example</h5>
|
|
4420
3195
|
|
|
4421
|
-
<pre class="prettyprint"><code>
|
|
3196
|
+
<pre class="prettyprint"><code>fetchMetadata('drumeo','song')
|
|
4422
3197
|
.then(data => console.log(data))
|
|
4423
3198
|
.catch(error => console.error(error));</code></pre>
|
|
4424
3199
|
|
|
@@ -4450,7 +3225,7 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
4450
3225
|
|
|
4451
3226
|
<tr>
|
|
4452
3227
|
|
|
4453
|
-
<td class="name"><code>
|
|
3228
|
+
<td class="name"><code>brand</code></td>
|
|
4454
3229
|
|
|
4455
3230
|
|
|
4456
3231
|
<td class="type">
|
|
@@ -4467,7 +3242,31 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
4467
3242
|
|
|
4468
3243
|
|
|
4469
3244
|
|
|
4470
|
-
<td class="description last">The
|
|
3245
|
+
<td class="description last">The brand for which to fetch metadata.</td>
|
|
3246
|
+
</tr>
|
|
3247
|
+
|
|
3248
|
+
|
|
3249
|
+
|
|
3250
|
+
<tr>
|
|
3251
|
+
|
|
3252
|
+
<td class="name"><code>type</code></td>
|
|
3253
|
+
|
|
3254
|
+
|
|
3255
|
+
<td class="type">
|
|
3256
|
+
|
|
3257
|
+
|
|
3258
|
+
<span class="param-type">string</span>
|
|
3259
|
+
|
|
3260
|
+
|
|
3261
|
+
|
|
3262
|
+
|
|
3263
|
+
</td>
|
|
3264
|
+
|
|
3265
|
+
|
|
3266
|
+
|
|
3267
|
+
|
|
3268
|
+
|
|
3269
|
+
<td class="description last">The type for which to fetch metadata.</td>
|
|
4471
3270
|
</tr>
|
|
4472
3271
|
|
|
4473
3272
|
|
|
@@ -4492,10 +3291,6 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
4492
3291
|
<h5 class="h5-returns">Returns:</h5>
|
|
4493
3292
|
|
|
4494
3293
|
|
|
4495
|
-
<div class="param-desc">
|
|
4496
|
-
- The fetched page data or null if found.
|
|
4497
|
-
</div>
|
|
4498
|
-
|
|
4499
3294
|
|
|
4500
3295
|
|
|
4501
3296
|
<dl class="param-type">
|
|
@@ -4504,7 +3299,7 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
4504
3299
|
</dt>
|
|
4505
3300
|
<dd>
|
|
4506
3301
|
|
|
4507
|
-
<span class="param-type">Promise.<
|
|
3302
|
+
<span class="param-type">Promise.<{name, description, type: *, thumbnailUrl}></span>
|
|
4508
3303
|
|
|
4509
3304
|
|
|
4510
3305
|
|
|
@@ -4520,7 +3315,7 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
4520
3315
|
|
|
4521
3316
|
|
|
4522
3317
|
|
|
4523
|
-
<h4 class="name" id=".
|
|
3318
|
+
<h4 class="name" id=".fetchMethod"><span class="type-signature type-signature-static">(static) </span>fetchMethod<span class="signature">(brand, slug)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
4524
3319
|
|
|
4525
3320
|
|
|
4526
3321
|
|
|
@@ -4530,14 +3325,13 @@ fetchAllFilterOptions('myBrand', [], 'Rock', 'John Doe', 'coach-lessons', 'Love'
|
|
|
4530
3325
|
<dl class="details">
|
|
4531
3326
|
|
|
4532
3327
|
<dt class="tag-description">Description:</dt>
|
|
4533
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
4534
|
-
These are linked through content that shares a license with the provided railcontent document</li></ul></dd>
|
|
3328
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch the Method (learning-paths) for a specific brand.</li></ul></dd>
|
|
4535
3329
|
|
|
4536
3330
|
|
|
4537
3331
|
|
|
4538
3332
|
<dt class="tag-source">Source:</dt>
|
|
4539
3333
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
4540
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
3334
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line893">line 893</a>
|
|
4541
3335
|
</li></ul></dd>
|
|
4542
3336
|
|
|
4543
3337
|
|
|
@@ -4607,30 +3401,6 @@ These are linked through content that shares a license with the provided railcon
|
|
|
4607
3401
|
<tbody>
|
|
4608
3402
|
|
|
4609
3403
|
|
|
4610
|
-
<tr>
|
|
4611
|
-
|
|
4612
|
-
<td class="name"><code>railcontentId</code></td>
|
|
4613
|
-
|
|
4614
|
-
|
|
4615
|
-
<td class="type">
|
|
4616
|
-
|
|
4617
|
-
|
|
4618
|
-
<span class="param-type">integer</span>
|
|
4619
|
-
|
|
4620
|
-
|
|
4621
|
-
|
|
4622
|
-
|
|
4623
|
-
</td>
|
|
4624
|
-
|
|
4625
|
-
|
|
4626
|
-
|
|
4627
|
-
|
|
4628
|
-
|
|
4629
|
-
<td class="description last"></td>
|
|
4630
|
-
</tr>
|
|
4631
|
-
|
|
4632
|
-
|
|
4633
|
-
|
|
4634
3404
|
<tr>
|
|
4635
3405
|
|
|
4636
3406
|
<td class="name"><code>brand</code></td>
|
|
@@ -4650,20 +3420,20 @@ These are linked through content that shares a license with the provided railcon
|
|
|
4650
3420
|
|
|
4651
3421
|
|
|
4652
3422
|
|
|
4653
|
-
<td class="description last"
|
|
3423
|
+
<td class="description last">The brand for which to fetch methods.</td>
|
|
4654
3424
|
</tr>
|
|
4655
3425
|
|
|
4656
3426
|
|
|
4657
3427
|
|
|
4658
3428
|
<tr>
|
|
4659
3429
|
|
|
4660
|
-
<td class="name"><code>
|
|
3430
|
+
<td class="name"><code>slug</code></td>
|
|
4661
3431
|
|
|
4662
3432
|
|
|
4663
3433
|
<td class="type">
|
|
4664
3434
|
|
|
4665
3435
|
|
|
4666
|
-
<span class="param-type">
|
|
3436
|
+
<span class="param-type">string</span>
|
|
4667
3437
|
|
|
4668
3438
|
|
|
4669
3439
|
|
|
@@ -4674,7 +3444,7 @@ These are linked through content that shares a license with the provided railcon
|
|
|
4674
3444
|
|
|
4675
3445
|
|
|
4676
3446
|
|
|
4677
|
-
<td class="description last"
|
|
3447
|
+
<td class="description last">The slug of the method.</td>
|
|
4678
3448
|
</tr>
|
|
4679
3449
|
|
|
4680
3450
|
|
|
@@ -4699,6 +3469,10 @@ These are linked through content that shares a license with the provided railcon
|
|
|
4699
3469
|
<h5 class="h5-returns">Returns:</h5>
|
|
4700
3470
|
|
|
4701
3471
|
|
|
3472
|
+
<div class="param-desc">
|
|
3473
|
+
- The fetched methods data or null if not found.
|
|
3474
|
+
</div>
|
|
3475
|
+
|
|
4702
3476
|
|
|
4703
3477
|
|
|
4704
3478
|
<dl class="param-type">
|
|
@@ -4707,7 +3481,7 @@ These are linked through content that shares a license with the provided railcon
|
|
|
4707
3481
|
</dt>
|
|
4708
3482
|
<dd>
|
|
4709
3483
|
|
|
4710
|
-
<span class="param-type">Promise.<
|
|
3484
|
+
<span class="param-type">Promise.<(Object|null)></span>
|
|
4711
3485
|
|
|
4712
3486
|
|
|
4713
3487
|
|
|
@@ -4723,7 +3497,7 @@ These are linked through content that shares a license with the provided railcon
|
|
|
4723
3497
|
|
|
4724
3498
|
|
|
4725
3499
|
|
|
4726
|
-
<h4 class="name" id=".
|
|
3500
|
+
<h4 class="name" id=".fetchMethodChildren"><span class="type-signature type-signature-static">(static) </span>fetchMethodChildren<span class="signature">(railcontentId)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
4727
3501
|
|
|
4728
3502
|
|
|
4729
3503
|
|
|
@@ -4733,14 +3507,13 @@ These are linked through content that shares a license with the provided railcon
|
|
|
4733
3507
|
<dl class="details">
|
|
4734
3508
|
|
|
4735
3509
|
<dt class="tag-description">Description:</dt>
|
|
4736
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetch
|
|
4737
|
-
For v2 you need to provide page type('lessons' or 'songs') in type parameter</li></ul></dd>
|
|
3510
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch the child courses for a specific method by Railcontent ID.</li></ul></dd>
|
|
4738
3511
|
|
|
4739
3512
|
|
|
4740
3513
|
|
|
4741
3514
|
<dt class="tag-source">Source:</dt>
|
|
4742
3515
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
4743
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
3516
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line941">line 941</a>
|
|
4744
3517
|
</li></ul></dd>
|
|
4745
3518
|
|
|
4746
3519
|
|
|
@@ -4785,13 +3558,6 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
4785
3558
|
|
|
4786
3559
|
|
|
4787
3560
|
|
|
4788
|
-
<h5 class="h5-examples">Example</h5>
|
|
4789
|
-
|
|
4790
|
-
<pre class="prettyprint"><code>fetchMetadata('drumeo','song')
|
|
4791
|
-
.then(data => console.log(data))
|
|
4792
|
-
.catch(error => console.error(error));</code></pre>
|
|
4793
|
-
|
|
4794
|
-
|
|
4795
3561
|
|
|
4796
3562
|
|
|
4797
3563
|
<h5 class="h5-parameters">Parameters:</h5>
|
|
@@ -4819,31 +3585,7 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
4819
3585
|
|
|
4820
3586
|
<tr>
|
|
4821
3587
|
|
|
4822
|
-
<td class="name"><code>
|
|
4823
|
-
|
|
4824
|
-
|
|
4825
|
-
<td class="type">
|
|
4826
|
-
|
|
4827
|
-
|
|
4828
|
-
<span class="param-type">string</span>
|
|
4829
|
-
|
|
4830
|
-
|
|
4831
|
-
|
|
4832
|
-
|
|
4833
|
-
</td>
|
|
4834
|
-
|
|
4835
|
-
|
|
4836
|
-
|
|
4837
|
-
|
|
4838
|
-
|
|
4839
|
-
<td class="description last">The brand for which to fetch metadata.</td>
|
|
4840
|
-
</tr>
|
|
4841
|
-
|
|
4842
|
-
|
|
4843
|
-
|
|
4844
|
-
<tr>
|
|
4845
|
-
|
|
4846
|
-
<td class="name"><code>type</code></td>
|
|
3588
|
+
<td class="name"><code>railcontentId</code></td>
|
|
4847
3589
|
|
|
4848
3590
|
|
|
4849
3591
|
<td class="type">
|
|
@@ -4860,7 +3602,7 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
4860
3602
|
|
|
4861
3603
|
|
|
4862
3604
|
|
|
4863
|
-
<td class="description last">The
|
|
3605
|
+
<td class="description last">The Railcontent ID of the current lesson.</td>
|
|
4864
3606
|
</tr>
|
|
4865
3607
|
|
|
4866
3608
|
|
|
@@ -4885,6 +3627,10 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
4885
3627
|
<h5 class="h5-returns">Returns:</h5>
|
|
4886
3628
|
|
|
4887
3629
|
|
|
3630
|
+
<div class="param-desc">
|
|
3631
|
+
- The fetched next lesson data or null if not found.
|
|
3632
|
+
</div>
|
|
3633
|
+
|
|
4888
3634
|
|
|
4889
3635
|
|
|
4890
3636
|
<dl class="param-type">
|
|
@@ -4893,7 +3639,7 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
4893
3639
|
</dt>
|
|
4894
3640
|
<dd>
|
|
4895
3641
|
|
|
4896
|
-
<span class="param-type">Promise.<
|
|
3642
|
+
<span class="param-type">Promise.<(Object|null)></span>
|
|
4897
3643
|
|
|
4898
3644
|
|
|
4899
3645
|
|
|
@@ -4909,7 +3655,7 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
4909
3655
|
|
|
4910
3656
|
|
|
4911
3657
|
|
|
4912
|
-
<h4 class="name" id=".
|
|
3658
|
+
<h4 class="name" id=".fetchMethodChildrenIds"><span class="type-signature type-signature-static">(static) </span>fetchMethodChildrenIds<span class="signature">(railcontentId)</span><span class="type-signature"> → {Promise.<(Array.<Object>|null)>}</span></h4>
|
|
4913
3659
|
|
|
4914
3660
|
|
|
4915
3661
|
|
|
@@ -4919,13 +3665,13 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
4919
3665
|
<dl class="details">
|
|
4920
3666
|
|
|
4921
3667
|
<dt class="tag-description">Description:</dt>
|
|
4922
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetch
|
|
3668
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch all children of a specific method by Railcontent ID.</li></ul></dd>
|
|
4923
3669
|
|
|
4924
3670
|
|
|
4925
3671
|
|
|
4926
3672
|
<dt class="tag-source">Source:</dt>
|
|
4927
3673
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
4928
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
3674
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line999">line 999</a>
|
|
4929
3675
|
</li></ul></dd>
|
|
4930
3676
|
|
|
4931
3677
|
|
|
@@ -4997,31 +3743,7 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
4997
3743
|
|
|
4998
3744
|
<tr>
|
|
4999
3745
|
|
|
5000
|
-
<td class="name"><code>
|
|
5001
|
-
|
|
5002
|
-
|
|
5003
|
-
<td class="type">
|
|
5004
|
-
|
|
5005
|
-
|
|
5006
|
-
<span class="param-type">string</span>
|
|
5007
|
-
|
|
5008
|
-
|
|
5009
|
-
|
|
5010
|
-
|
|
5011
|
-
</td>
|
|
5012
|
-
|
|
5013
|
-
|
|
5014
|
-
|
|
5015
|
-
|
|
5016
|
-
|
|
5017
|
-
<td class="description last">The brand for which to fetch methods.</td>
|
|
5018
|
-
</tr>
|
|
5019
|
-
|
|
5020
|
-
|
|
5021
|
-
|
|
5022
|
-
<tr>
|
|
5023
|
-
|
|
5024
|
-
<td class="name"><code>slug</code></td>
|
|
3746
|
+
<td class="name"><code>railcontentId</code></td>
|
|
5025
3747
|
|
|
5026
3748
|
|
|
5027
3749
|
<td class="type">
|
|
@@ -5038,7 +3760,7 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
5038
3760
|
|
|
5039
3761
|
|
|
5040
3762
|
|
|
5041
|
-
<td class="description last">The
|
|
3763
|
+
<td class="description last">The Railcontent ID of the method.</td>
|
|
5042
3764
|
</tr>
|
|
5043
3765
|
|
|
5044
3766
|
|
|
@@ -5064,7 +3786,7 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
5064
3786
|
|
|
5065
3787
|
|
|
5066
3788
|
<div class="param-desc">
|
|
5067
|
-
- The fetched
|
|
3789
|
+
- The fetched children data or null if not found.
|
|
5068
3790
|
</div>
|
|
5069
3791
|
|
|
5070
3792
|
|
|
@@ -5075,7 +3797,7 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
5075
3797
|
</dt>
|
|
5076
3798
|
<dd>
|
|
5077
3799
|
|
|
5078
|
-
<span class="param-type">Promise.<(Object
|
|
3800
|
+
<span class="param-type">Promise.<(Array.<Object>|null)></span>
|
|
5079
3801
|
|
|
5080
3802
|
|
|
5081
3803
|
|
|
@@ -5091,7 +3813,7 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
5091
3813
|
|
|
5092
3814
|
|
|
5093
3815
|
|
|
5094
|
-
<h4 class="name" id=".
|
|
3816
|
+
<h4 class="name" id=".fetchMethodPreviousNextLesson"><span class="type-signature type-signature-static">(static) </span>fetchMethodPreviousNextLesson<span class="signature">(railcontentId, methodId)</span><span class="type-signature"> → {Promise.<(Object|null)>}</span></h4>
|
|
5095
3817
|
|
|
5096
3818
|
|
|
5097
3819
|
|
|
@@ -5101,13 +3823,13 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
5101
3823
|
<dl class="details">
|
|
5102
3824
|
|
|
5103
3825
|
<dt class="tag-description">Description:</dt>
|
|
5104
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetch the
|
|
3826
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch the next lesson for a specific method by Railcontent ID.</li></ul></dd>
|
|
5105
3827
|
|
|
5106
3828
|
|
|
5107
3829
|
|
|
5108
3830
|
<dt class="tag-source">Source:</dt>
|
|
5109
3831
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
5110
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
3832
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line976">line 976</a>
|
|
5111
3833
|
</li></ul></dd>
|
|
5112
3834
|
|
|
5113
3835
|
|
|
@@ -5152,6 +3874,13 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
5152
3874
|
|
|
5153
3875
|
|
|
5154
3876
|
|
|
3877
|
+
<h5 class="h5-examples">Example</h5>
|
|
3878
|
+
|
|
3879
|
+
<pre class="prettyprint"><code>fetchMethodPreviousNextLesson(241284, 241247)
|
|
3880
|
+
.then(data => { console.log('nextLesson', data.nextLesson); console.log('prevlesson', data.prevLesson);})
|
|
3881
|
+
.catch(error => console.error(error));</code></pre>
|
|
3882
|
+
|
|
3883
|
+
|
|
5155
3884
|
|
|
5156
3885
|
|
|
5157
3886
|
<h5 class="h5-parameters">Parameters:</h5>
|
|
@@ -5200,6 +3929,30 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
5200
3929
|
</tr>
|
|
5201
3930
|
|
|
5202
3931
|
|
|
3932
|
+
|
|
3933
|
+
<tr>
|
|
3934
|
+
|
|
3935
|
+
<td class="name"><code>methodId</code></td>
|
|
3936
|
+
|
|
3937
|
+
|
|
3938
|
+
<td class="type">
|
|
3939
|
+
|
|
3940
|
+
|
|
3941
|
+
<span class="param-type">string</span>
|
|
3942
|
+
|
|
3943
|
+
|
|
3944
|
+
|
|
3945
|
+
|
|
3946
|
+
</td>
|
|
3947
|
+
|
|
3948
|
+
|
|
3949
|
+
|
|
3950
|
+
|
|
3951
|
+
|
|
3952
|
+
<td class="description last">The RailcontentID of the method</td>
|
|
3953
|
+
</tr>
|
|
3954
|
+
|
|
3955
|
+
|
|
5203
3956
|
</tbody>
|
|
5204
3957
|
</table>
|
|
5205
3958
|
|
|
@@ -5222,7 +3975,7 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
5222
3975
|
|
|
5223
3976
|
|
|
5224
3977
|
<div class="param-desc">
|
|
5225
|
-
-
|
|
3978
|
+
- object with `nextLesson` and `previousLesson` attributes
|
|
5226
3979
|
</div>
|
|
5227
3980
|
|
|
5228
3981
|
|
|
@@ -5249,7 +4002,7 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
5249
4002
|
|
|
5250
4003
|
|
|
5251
4004
|
|
|
5252
|
-
<h4 class="name" id=".
|
|
4005
|
+
<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>
|
|
5253
4006
|
|
|
5254
4007
|
|
|
5255
4008
|
|
|
@@ -5259,13 +4012,13 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
5259
4012
|
<dl class="details">
|
|
5260
4013
|
|
|
5261
4014
|
<dt class="tag-description">Description:</dt>
|
|
5262
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetch
|
|
4015
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch the method intro video for a given brand.</li></ul></dd>
|
|
5263
4016
|
|
|
5264
4017
|
|
|
5265
4018
|
|
|
5266
4019
|
<dt class="tag-source">Source:</dt>
|
|
5267
4020
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
5268
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
4021
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line2161">line 2161</a>
|
|
5269
4022
|
</li></ul></dd>
|
|
5270
4023
|
|
|
5271
4024
|
|
|
@@ -5337,24 +4090,18 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
5337
4090
|
|
|
5338
4091
|
<tr>
|
|
5339
4092
|
|
|
5340
|
-
<td class="name"><code>
|
|
4093
|
+
<td class="name"><code>brand</code></td>
|
|
5341
4094
|
|
|
5342
4095
|
|
|
5343
4096
|
<td class="type">
|
|
5344
4097
|
|
|
5345
|
-
|
|
5346
|
-
<span class="param-type">string</span>
|
|
5347
|
-
|
|
5348
|
-
|
|
5349
|
-
|
|
5350
|
-
|
|
5351
4098
|
</td>
|
|
5352
4099
|
|
|
5353
4100
|
|
|
5354
4101
|
|
|
5355
4102
|
|
|
5356
4103
|
|
|
5357
|
-
<td class="description last"
|
|
4104
|
+
<td class="description last"></td>
|
|
5358
4105
|
</tr>
|
|
5359
4106
|
|
|
5360
4107
|
|
|
@@ -5379,10 +4126,6 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
5379
4126
|
<h5 class="h5-returns">Returns:</h5>
|
|
5380
4127
|
|
|
5381
4128
|
|
|
5382
|
-
<div class="param-desc">
|
|
5383
|
-
- The fetched children data or null if not found.
|
|
5384
|
-
</div>
|
|
5385
|
-
|
|
5386
4129
|
|
|
5387
4130
|
|
|
5388
4131
|
<dl class="param-type">
|
|
@@ -5391,7 +4134,7 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
5391
4134
|
</dt>
|
|
5392
4135
|
<dd>
|
|
5393
4136
|
|
|
5394
|
-
<span class="param-type">Promise.<(
|
|
4137
|
+
<span class="param-type">Promise.<(*|null)></span>
|
|
5395
4138
|
|
|
5396
4139
|
|
|
5397
4140
|
|
|
@@ -5407,7 +4150,7 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
5407
4150
|
|
|
5408
4151
|
|
|
5409
4152
|
|
|
5410
|
-
<h4 class="name" id=".
|
|
4153
|
+
<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>
|
|
5411
4154
|
|
|
5412
4155
|
|
|
5413
4156
|
|
|
@@ -5417,13 +4160,13 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
5417
4160
|
<dl class="details">
|
|
5418
4161
|
|
|
5419
4162
|
<dt class="tag-description">Description:</dt>
|
|
5420
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetch the
|
|
4163
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch the structure (just ids) of the Method for a given brand.</li></ul></dd>
|
|
5421
4164
|
|
|
5422
4165
|
|
|
5423
4166
|
|
|
5424
4167
|
<dt class="tag-source">Source:</dt>
|
|
5425
4168
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
5426
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
4169
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line2175">line 2175</a>
|
|
5427
4170
|
</li></ul></dd>
|
|
5428
4171
|
|
|
5429
4172
|
|
|
@@ -5468,13 +4211,6 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
5468
4211
|
|
|
5469
4212
|
|
|
5470
4213
|
|
|
5471
|
-
<h5 class="h5-examples">Example</h5>
|
|
5472
|
-
|
|
5473
|
-
<pre class="prettyprint"><code>fetchMethodPreviousNextLesson(241284, 241247)
|
|
5474
|
-
.then(data => { console.log('nextLesson', data.nextLesson); console.log('prevlesson', data.prevLesson);})
|
|
5475
|
-
.catch(error => console.error(error));</code></pre>
|
|
5476
|
-
|
|
5477
|
-
|
|
5478
4214
|
|
|
5479
4215
|
|
|
5480
4216
|
<h5 class="h5-parameters">Parameters:</h5>
|
|
@@ -5502,48 +4238,18 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
5502
4238
|
|
|
5503
4239
|
<tr>
|
|
5504
4240
|
|
|
5505
|
-
<td class="name"><code>
|
|
5506
|
-
|
|
5507
|
-
|
|
5508
|
-
<td class="type">
|
|
5509
|
-
|
|
5510
|
-
|
|
5511
|
-
<span class="param-type">string</span>
|
|
5512
|
-
|
|
5513
|
-
|
|
5514
|
-
|
|
5515
|
-
|
|
5516
|
-
</td>
|
|
5517
|
-
|
|
5518
|
-
|
|
5519
|
-
|
|
5520
|
-
|
|
5521
|
-
|
|
5522
|
-
<td class="description last">The Railcontent ID of the current lesson.</td>
|
|
5523
|
-
</tr>
|
|
5524
|
-
|
|
5525
|
-
|
|
5526
|
-
|
|
5527
|
-
<tr>
|
|
5528
|
-
|
|
5529
|
-
<td class="name"><code>methodId</code></td>
|
|
4241
|
+
<td class="name"><code>brand</code></td>
|
|
5530
4242
|
|
|
5531
4243
|
|
|
5532
4244
|
<td class="type">
|
|
5533
4245
|
|
|
5534
|
-
|
|
5535
|
-
<span class="param-type">string</span>
|
|
5536
|
-
|
|
5537
|
-
|
|
5538
|
-
|
|
5539
|
-
|
|
5540
4246
|
</td>
|
|
5541
4247
|
|
|
5542
4248
|
|
|
5543
4249
|
|
|
5544
4250
|
|
|
5545
4251
|
|
|
5546
|
-
<td class="description last"
|
|
4252
|
+
<td class="description last"></td>
|
|
5547
4253
|
</tr>
|
|
5548
4254
|
|
|
5549
4255
|
|
|
@@ -5568,10 +4274,6 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
5568
4274
|
<h5 class="h5-returns">Returns:</h5>
|
|
5569
4275
|
|
|
5570
4276
|
|
|
5571
|
-
<div class="param-desc">
|
|
5572
|
-
- object with `nextLesson` and `previousLesson` attributes
|
|
5573
|
-
</div>
|
|
5574
|
-
|
|
5575
4277
|
|
|
5576
4278
|
|
|
5577
4279
|
<dl class="param-type">
|
|
@@ -5580,7 +4282,7 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
5580
4282
|
</dt>
|
|
5581
4283
|
<dd>
|
|
5582
4284
|
|
|
5583
|
-
<span class="param-type">Promise.<(
|
|
4285
|
+
<span class="param-type">Promise.<(*|null)></span>
|
|
5584
4286
|
|
|
5585
4287
|
|
|
5586
4288
|
|
|
@@ -5596,7 +4298,7 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
5596
4298
|
|
|
5597
4299
|
|
|
5598
4300
|
|
|
5599
|
-
<h4 class="name" id=".
|
|
4301
|
+
<h4 class="name" id=".fetchMethodV2StructureFromId"><span class="type-signature type-signature-static">(static) </span>fetchMethodV2StructureFromId<span class="signature">(contentId)</span><span class="type-signature"> → {Promise.<(*|null)>}</span></h4>
|
|
5600
4302
|
|
|
5601
4303
|
|
|
5602
4304
|
|
|
@@ -5606,13 +4308,13 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
5606
4308
|
<dl class="details">
|
|
5607
4309
|
|
|
5608
4310
|
<dt class="tag-description">Description:</dt>
|
|
5609
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetch the
|
|
4311
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch the structure (just ids) of the Method of a given learning path or learning path lesson.</li></ul></dd>
|
|
5610
4312
|
|
|
5611
4313
|
|
|
5612
4314
|
|
|
5613
4315
|
<dt class="tag-source">Source:</dt>
|
|
5614
4316
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
5615
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
4317
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line2192">line 2192</a>
|
|
5616
4318
|
</li></ul></dd>
|
|
5617
4319
|
|
|
5618
4320
|
|
|
@@ -5684,7 +4386,7 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
5684
4386
|
|
|
5685
4387
|
<tr>
|
|
5686
4388
|
|
|
5687
|
-
<td class="name"><code>
|
|
4389
|
+
<td class="name"><code>contentId</code></td>
|
|
5688
4390
|
|
|
5689
4391
|
|
|
5690
4392
|
<td class="type">
|
|
@@ -5744,7 +4446,7 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
5744
4446
|
|
|
5745
4447
|
|
|
5746
4448
|
|
|
5747
|
-
<h4 class="name" id=".
|
|
4449
|
+
<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>
|
|
5748
4450
|
|
|
5749
4451
|
|
|
5750
4452
|
|
|
@@ -5754,13 +4456,13 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
5754
4456
|
<dl class="details">
|
|
5755
4457
|
|
|
5756
4458
|
<dt class="tag-description">Description:</dt>
|
|
5757
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetch the
|
|
4459
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch the latest new releases for a specific brand.</li></ul></dd>
|
|
5758
4460
|
|
|
5759
4461
|
|
|
5760
4462
|
|
|
5761
4463
|
<dt class="tag-source">Source:</dt>
|
|
5762
4464
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
5763
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
4465
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line285">line 285</a>
|
|
5764
4466
|
</li></ul></dd>
|
|
5765
4467
|
|
|
5766
4468
|
|
|
@@ -5837,13 +4539,19 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
5837
4539
|
|
|
5838
4540
|
<td class="type">
|
|
5839
4541
|
|
|
4542
|
+
|
|
4543
|
+
<span class="param-type">string</span>
|
|
4544
|
+
|
|
4545
|
+
|
|
4546
|
+
|
|
4547
|
+
|
|
5840
4548
|
</td>
|
|
5841
4549
|
|
|
5842
4550
|
|
|
5843
4551
|
|
|
5844
4552
|
|
|
5845
4553
|
|
|
5846
|
-
<td class="description last"
|
|
4554
|
+
<td class="description last">The brand for which to fetch new releases.</td>
|
|
5847
4555
|
</tr>
|
|
5848
4556
|
|
|
5849
4557
|
|
|
@@ -5868,6 +4576,10 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
5868
4576
|
<h5 class="h5-returns">Returns:</h5>
|
|
5869
4577
|
|
|
5870
4578
|
|
|
4579
|
+
<div class="param-desc">
|
|
4580
|
+
- The fetched new releases data or null if not found.
|
|
4581
|
+
</div>
|
|
4582
|
+
|
|
5871
4583
|
|
|
5872
4584
|
|
|
5873
4585
|
<dl class="param-type">
|
|
@@ -5876,7 +4588,7 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
5876
4588
|
</dt>
|
|
5877
4589
|
<dd>
|
|
5878
4590
|
|
|
5879
|
-
<span class="param-type">Promise.<(
|
|
4591
|
+
<span class="param-type">Promise.<(Object|null)></span>
|
|
5880
4592
|
|
|
5881
4593
|
|
|
5882
4594
|
|
|
@@ -5892,7 +4604,7 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
5892
4604
|
|
|
5893
4605
|
|
|
5894
4606
|
|
|
5895
|
-
<h4 class="name" id=".
|
|
4607
|
+
<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>
|
|
5896
4608
|
|
|
5897
4609
|
|
|
5898
4610
|
|
|
@@ -5902,13 +4614,13 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
5902
4614
|
<dl class="details">
|
|
5903
4615
|
|
|
5904
4616
|
<dt class="tag-description">Description:</dt>
|
|
5905
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetch the
|
|
4617
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch the next and previous lessons for a specific lesson by Railcontent ID.</li></ul></dd>
|
|
5906
4618
|
|
|
5907
4619
|
|
|
5908
4620
|
|
|
5909
4621
|
<dt class="tag-source">Source:</dt>
|
|
5910
4622
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
5911
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
4623
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1038">line 1038</a>
|
|
5912
4624
|
</li></ul></dd>
|
|
5913
4625
|
|
|
5914
4626
|
|
|
@@ -5980,7 +4692,7 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
5980
4692
|
|
|
5981
4693
|
<tr>
|
|
5982
4694
|
|
|
5983
|
-
<td class="name"><code>
|
|
4695
|
+
<td class="name"><code>railcontentId</code></td>
|
|
5984
4696
|
|
|
5985
4697
|
|
|
5986
4698
|
<td class="type">
|
|
@@ -5997,7 +4709,7 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
5997
4709
|
|
|
5998
4710
|
|
|
5999
4711
|
|
|
6000
|
-
<td class="description last">The
|
|
4712
|
+
<td class="description last">The Railcontent ID of the current lesson.</td>
|
|
6001
4713
|
</tr>
|
|
6002
4714
|
|
|
6003
4715
|
|
|
@@ -6023,7 +4735,7 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
6023
4735
|
|
|
6024
4736
|
|
|
6025
4737
|
<div class="param-desc">
|
|
6026
|
-
- The fetched
|
|
4738
|
+
- The fetched next and previous lesson data or null if found.
|
|
6027
4739
|
</div>
|
|
6028
4740
|
|
|
6029
4741
|
|
|
@@ -6050,7 +4762,7 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
6050
4762
|
|
|
6051
4763
|
|
|
6052
4764
|
|
|
6053
|
-
<h4 class="name" id=".
|
|
4765
|
+
<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>
|
|
6054
4766
|
|
|
6055
4767
|
|
|
6056
4768
|
|
|
@@ -6060,13 +4772,14 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
6060
4772
|
<dl class="details">
|
|
6061
4773
|
|
|
6062
4774
|
<dt class="tag-description">Description:</dt>
|
|
6063
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
4775
|
+
<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.
|
|
4776
|
+
These are linked through content that shares a license with the provided railcontent document</li></ul></dd>
|
|
6064
4777
|
|
|
6065
4778
|
|
|
6066
4779
|
|
|
6067
4780
|
<dt class="tag-source">Source:</dt>
|
|
6068
4781
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
6069
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
4782
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1193">line 1193</a>
|
|
6070
4783
|
</li></ul></dd>
|
|
6071
4784
|
|
|
6072
4785
|
|
|
@@ -6143,11 +4856,23 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
6143
4856
|
|
|
6144
4857
|
<td class="type">
|
|
6145
4858
|
|
|
6146
|
-
|
|
6147
|
-
|
|
4859
|
+
</td>
|
|
4860
|
+
|
|
4861
|
+
|
|
4862
|
+
|
|
4863
|
+
|
|
4864
|
+
|
|
4865
|
+
<td class="description last"></td>
|
|
4866
|
+
</tr>
|
|
6148
4867
|
|
|
4868
|
+
|
|
6149
4869
|
|
|
4870
|
+
<tr>
|
|
4871
|
+
|
|
4872
|
+
<td class="name"><code>brand</code></td>
|
|
4873
|
+
|
|
6150
4874
|
|
|
4875
|
+
<td class="type">
|
|
6151
4876
|
|
|
6152
4877
|
</td>
|
|
6153
4878
|
|
|
@@ -6155,7 +4880,25 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
6155
4880
|
|
|
6156
4881
|
|
|
6157
4882
|
|
|
6158
|
-
<td class="description last"
|
|
4883
|
+
<td class="description last"></td>
|
|
4884
|
+
</tr>
|
|
4885
|
+
|
|
4886
|
+
|
|
4887
|
+
|
|
4888
|
+
<tr>
|
|
4889
|
+
|
|
4890
|
+
<td class="name"><code>count</code></td>
|
|
4891
|
+
|
|
4892
|
+
|
|
4893
|
+
<td class="type">
|
|
4894
|
+
|
|
4895
|
+
</td>
|
|
4896
|
+
|
|
4897
|
+
|
|
4898
|
+
|
|
4899
|
+
|
|
4900
|
+
|
|
4901
|
+
<td class="description last"></td>
|
|
6159
4902
|
</tr>
|
|
6160
4903
|
|
|
6161
4904
|
|
|
@@ -6180,10 +4923,6 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
6180
4923
|
<h5 class="h5-returns">Returns:</h5>
|
|
6181
4924
|
|
|
6182
4925
|
|
|
6183
|
-
<div class="param-desc">
|
|
6184
|
-
- The fetched next and previous lesson data or null if found.
|
|
6185
|
-
</div>
|
|
6186
|
-
|
|
6187
4926
|
|
|
6188
4927
|
|
|
6189
4928
|
<dl class="param-type">
|
|
@@ -6192,7 +4931,7 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
6192
4931
|
</dt>
|
|
6193
4932
|
<dd>
|
|
6194
4933
|
|
|
6195
|
-
<span class="param-type">Promise.<
|
|
4934
|
+
<span class="param-type">Promise.<Array.<Object>></span>
|
|
6196
4935
|
|
|
6197
4936
|
|
|
6198
4937
|
|
|
@@ -6208,7 +4947,7 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
6208
4947
|
|
|
6209
4948
|
|
|
6210
4949
|
|
|
6211
|
-
<h4 class="name" id=".
|
|
4950
|
+
<h4 class="name" id=".fetchOwnedContent"><span class="type-signature type-signature-static">(static) </span>fetchOwnedContent<span class="signature">(brand, options)</span><span class="type-signature"> → {Promise.<Object>}</span></h4>
|
|
6212
4951
|
|
|
6213
4952
|
|
|
6214
4953
|
|
|
@@ -6218,14 +4957,14 @@ For v2 you need to provide page type('lessons' or 'songs') in type parameter</li
|
|
|
6218
4957
|
<dl class="details">
|
|
6219
4958
|
|
|
6220
4959
|
<dt class="tag-description">Description:</dt>
|
|
6221
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
6222
|
-
|
|
4960
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetch content owned by the user (excluding membership content).
|
|
4961
|
+
Shows only content accessible through purchases/entitlements, not through membership.</li></ul></dd>
|
|
6223
4962
|
|
|
6224
4963
|
|
|
6225
4964
|
|
|
6226
4965
|
<dt class="tag-source">Source:</dt>
|
|
6227
4966
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
6228
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
4967
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line2216">line 2216</a>
|
|
6229
4968
|
</li></ul></dd>
|
|
6230
4969
|
|
|
6231
4970
|
|
|
@@ -6297,54 +5036,170 @@ These are linked through content that shares a license with the provided railcon
|
|
|
6297
5036
|
|
|
6298
5037
|
<tr>
|
|
6299
5038
|
|
|
6300
|
-
<td class="name"><code>
|
|
5039
|
+
<td class="name"><code>brand</code></td>
|
|
6301
5040
|
|
|
6302
5041
|
|
|
6303
5042
|
<td class="type">
|
|
6304
5043
|
|
|
5044
|
+
|
|
5045
|
+
<span class="param-type">string</span>
|
|
5046
|
+
|
|
5047
|
+
|
|
5048
|
+
|
|
5049
|
+
|
|
6305
5050
|
</td>
|
|
6306
5051
|
|
|
6307
5052
|
|
|
6308
5053
|
|
|
6309
5054
|
|
|
6310
5055
|
|
|
6311
|
-
<td class="description last"
|
|
5056
|
+
<td class="description last">The brand to filter content by</td>
|
|
6312
5057
|
</tr>
|
|
6313
5058
|
|
|
6314
5059
|
|
|
6315
5060
|
|
|
6316
5061
|
<tr>
|
|
6317
5062
|
|
|
6318
|
-
<td class="name"><code>
|
|
5063
|
+
<td class="name"><code>options</code></td>
|
|
6319
5064
|
|
|
6320
5065
|
|
|
6321
5066
|
<td class="type">
|
|
6322
5067
|
|
|
5068
|
+
|
|
5069
|
+
<span class="param-type">Object</span>
|
|
5070
|
+
|
|
5071
|
+
|
|
5072
|
+
|
|
5073
|
+
|
|
6323
5074
|
</td>
|
|
6324
5075
|
|
|
6325
5076
|
|
|
6326
5077
|
|
|
6327
5078
|
|
|
6328
5079
|
|
|
6329
|
-
<td class="description last"
|
|
5080
|
+
<td class="description last">Fetch options
|
|
5081
|
+
<h6>Properties</h6>
|
|
5082
|
+
|
|
5083
|
+
|
|
5084
|
+
<table class="params">
|
|
5085
|
+
<thead>
|
|
5086
|
+
<tr>
|
|
5087
|
+
|
|
5088
|
+
<th>Name</th>
|
|
5089
|
+
|
|
5090
|
+
|
|
5091
|
+
<th>Type</th>
|
|
5092
|
+
|
|
5093
|
+
|
|
5094
|
+
|
|
5095
|
+
|
|
5096
|
+
|
|
5097
|
+
<th class="last">Description</th>
|
|
5098
|
+
</tr>
|
|
5099
|
+
</thead>
|
|
5100
|
+
|
|
5101
|
+
<tbody>
|
|
5102
|
+
|
|
5103
|
+
|
|
5104
|
+
<tr>
|
|
5105
|
+
|
|
5106
|
+
<td class="name"><code>type</code></td>
|
|
5107
|
+
|
|
5108
|
+
|
|
5109
|
+
<td class="type">
|
|
5110
|
+
|
|
5111
|
+
|
|
5112
|
+
<span class="param-type">Array.<string></span>
|
|
5113
|
+
|
|
5114
|
+
|
|
5115
|
+
|
|
5116
|
+
|
|
5117
|
+
</td>
|
|
5118
|
+
|
|
5119
|
+
|
|
5120
|
+
|
|
5121
|
+
|
|
5122
|
+
|
|
5123
|
+
<td class="description last">Content type(s) to filter (optional array, default: [])</td>
|
|
6330
5124
|
</tr>
|
|
6331
5125
|
|
|
6332
5126
|
|
|
6333
5127
|
|
|
6334
5128
|
<tr>
|
|
6335
5129
|
|
|
6336
|
-
<td class="name"><code>
|
|
5130
|
+
<td class="name"><code>page</code></td>
|
|
6337
5131
|
|
|
6338
5132
|
|
|
6339
5133
|
<td class="type">
|
|
6340
5134
|
|
|
5135
|
+
|
|
5136
|
+
<span class="param-type">number</span>
|
|
5137
|
+
|
|
5138
|
+
|
|
5139
|
+
|
|
5140
|
+
|
|
6341
5141
|
</td>
|
|
6342
5142
|
|
|
6343
5143
|
|
|
6344
5144
|
|
|
6345
5145
|
|
|
6346
5146
|
|
|
6347
|
-
<td class="description last"
|
|
5147
|
+
<td class="description last">Page number (default: 1)</td>
|
|
5148
|
+
</tr>
|
|
5149
|
+
|
|
5150
|
+
|
|
5151
|
+
|
|
5152
|
+
<tr>
|
|
5153
|
+
|
|
5154
|
+
<td class="name"><code>limit</code></td>
|
|
5155
|
+
|
|
5156
|
+
|
|
5157
|
+
<td class="type">
|
|
5158
|
+
|
|
5159
|
+
|
|
5160
|
+
<span class="param-type">number</span>
|
|
5161
|
+
|
|
5162
|
+
|
|
5163
|
+
|
|
5164
|
+
|
|
5165
|
+
</td>
|
|
5166
|
+
|
|
5167
|
+
|
|
5168
|
+
|
|
5169
|
+
|
|
5170
|
+
|
|
5171
|
+
<td class="description last">Items per page (default: 10)</td>
|
|
5172
|
+
</tr>
|
|
5173
|
+
|
|
5174
|
+
|
|
5175
|
+
|
|
5176
|
+
<tr>
|
|
5177
|
+
|
|
5178
|
+
<td class="name"><code>sort</code></td>
|
|
5179
|
+
|
|
5180
|
+
|
|
5181
|
+
<td class="type">
|
|
5182
|
+
|
|
5183
|
+
|
|
5184
|
+
<span class="param-type">string</span>
|
|
5185
|
+
|
|
5186
|
+
|
|
5187
|
+
|
|
5188
|
+
|
|
5189
|
+
</td>
|
|
5190
|
+
|
|
5191
|
+
|
|
5192
|
+
|
|
5193
|
+
|
|
5194
|
+
|
|
5195
|
+
<td class="description last">Sort field and direction (default: '-published_on')</td>
|
|
5196
|
+
</tr>
|
|
5197
|
+
|
|
5198
|
+
|
|
5199
|
+
</tbody>
|
|
5200
|
+
</table>
|
|
5201
|
+
|
|
5202
|
+
</td>
|
|
6348
5203
|
</tr>
|
|
6349
5204
|
|
|
6350
5205
|
|
|
@@ -6369,6 +5224,10 @@ These are linked through content that shares a license with the provided railcon
|
|
|
6369
5224
|
<h5 class="h5-returns">Returns:</h5>
|
|
6370
5225
|
|
|
6371
5226
|
|
|
5227
|
+
<div class="param-desc">
|
|
5228
|
+
Object with 'entity' (content array) and 'total' (count)
|
|
5229
|
+
</div>
|
|
5230
|
+
|
|
6372
5231
|
|
|
6373
5232
|
|
|
6374
5233
|
<dl class="param-type">
|
|
@@ -6377,7 +5236,7 @@ These are linked through content that shares a license with the provided railcon
|
|
|
6377
5236
|
</dt>
|
|
6378
5237
|
<dd>
|
|
6379
5238
|
|
|
6380
|
-
<span class="param-type">Promise.<
|
|
5239
|
+
<span class="param-type">Promise.<Object></span>
|
|
6381
5240
|
|
|
6382
5241
|
|
|
6383
5242
|
|
|
@@ -6409,7 +5268,7 @@ These are linked through content that shares a license with the provided railcon
|
|
|
6409
5268
|
|
|
6410
5269
|
<dt class="tag-source">Source:</dt>
|
|
6411
5270
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
6412
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
5271
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1368">line 1368</a>
|
|
6413
5272
|
</li></ul></dd>
|
|
6414
5273
|
|
|
6415
5274
|
|
|
@@ -6567,7 +5426,7 @@ These are linked through content that shares a license with the provided railcon
|
|
|
6567
5426
|
|
|
6568
5427
|
<dt class="tag-source">Source:</dt>
|
|
6569
5428
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
6570
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
5429
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1457">line 1457</a>
|
|
6571
5430
|
</li></ul></dd>
|
|
6572
5431
|
|
|
6573
5432
|
|
|
@@ -6732,7 +5591,7 @@ These are linked through content that shares a license with the provided railcon
|
|
|
6732
5591
|
|
|
6733
5592
|
<dt class="tag-source">Source:</dt>
|
|
6734
5593
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
6735
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
5594
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1304">line 1304</a>
|
|
6736
5595
|
</li></ul></dd>
|
|
6737
5596
|
|
|
6738
5597
|
|
|
@@ -6891,7 +5750,7 @@ If no recommendations found in recsys, falls back to fetching related lessons.</
|
|
|
6891
5750
|
|
|
6892
5751
|
<dt class="tag-source">Source:</dt>
|
|
6893
5752
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
6894
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
5753
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1173">line 1173</a>
|
|
6895
5754
|
</li></ul></dd>
|
|
6896
5755
|
|
|
6897
5756
|
|
|
@@ -7075,7 +5934,7 @@ If no recommendations found in recsys, falls back to fetching related lessons.</
|
|
|
7075
5934
|
|
|
7076
5935
|
<dt class="tag-source">Source:</dt>
|
|
7077
5936
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
7078
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
5937
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line209">line 209</a>
|
|
7079
5938
|
</li></ul></dd>
|
|
7080
5939
|
|
|
7081
5940
|
|
|
@@ -7264,7 +6123,7 @@ If no recommendations found in recsys, falls back to fetching related lessons.</
|
|
|
7264
6123
|
|
|
7265
6124
|
<dt class="tag-source">Source:</dt>
|
|
7266
6125
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
7267
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
6126
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line103">line 103</a>
|
|
7268
6127
|
</li></ul></dd>
|
|
7269
6128
|
|
|
7270
6129
|
|
|
@@ -7352,7 +6211,7 @@ If no recommendations found in recsys, falls back to fetching related lessons.</
|
|
|
7352
6211
|
|
|
7353
6212
|
|
|
7354
6213
|
|
|
7355
|
-
<h4 class="name" id=".fetchSanity"><span class="type-signature type-signature-static">(static) </span>fetchSanity<span class="signature">(query, isList,
|
|
6214
|
+
<h4 class="name" id=".fetchSanity"><span class="type-signature type-signature-static">(static) </span>fetchSanity<span class="signature">(query, isList, options)</span><span class="type-signature"> → {Promise.<(*|null)>}</span></h4>
|
|
7356
6215
|
|
|
7357
6216
|
|
|
7358
6217
|
|
|
@@ -7365,7 +6224,7 @@ If no recommendations found in recsys, falls back to fetching related lessons.</
|
|
|
7365
6224
|
|
|
7366
6225
|
<dt class="tag-source">Source:</dt>
|
|
7367
6226
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
7368
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
6227
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1629">line 1629</a>
|
|
7369
6228
|
</li></ul></dd>
|
|
7370
6229
|
|
|
7371
6230
|
|
|
@@ -7433,12 +6292,8 @@ fetchSanity(query, true)
|
|
|
7433
6292
|
<th>Type</th>
|
|
7434
6293
|
|
|
7435
6294
|
|
|
7436
|
-
<th>Attributes</th>
|
|
7437
|
-
|
|
7438
6295
|
|
|
7439
6296
|
|
|
7440
|
-
<th>Default</th>
|
|
7441
|
-
|
|
7442
6297
|
|
|
7443
6298
|
<th class="last">Description</th>
|
|
7444
6299
|
</tr>
|
|
@@ -7463,35 +6318,94 @@ fetchSanity(query, true)
|
|
|
7463
6318
|
</td>
|
|
7464
6319
|
|
|
7465
6320
|
|
|
7466
|
-
<td class="attributes">
|
|
7467
|
-
|
|
7468
6321
|
|
|
7469
|
-
|
|
6322
|
+
|
|
7470
6323
|
|
|
7471
|
-
|
|
7472
|
-
|
|
6324
|
+
<td class="description last">The GROQ query to execute against the Sanity API.</td>
|
|
6325
|
+
</tr>
|
|
6326
|
+
|
|
6327
|
+
|
|
6328
|
+
|
|
6329
|
+
<tr>
|
|
6330
|
+
|
|
6331
|
+
<td class="name"><code>isList</code></td>
|
|
7473
6332
|
|
|
7474
6333
|
|
|
6334
|
+
<td class="type">
|
|
7475
6335
|
|
|
7476
|
-
<td class="default">
|
|
7477
6336
|
|
|
7478
|
-
|
|
6337
|
+
<span class="param-type">boolean</span>
|
|
6338
|
+
|
|
6339
|
+
|
|
6340
|
+
|
|
7479
6341
|
|
|
6342
|
+
</td>
|
|
7480
6343
|
|
|
7481
|
-
|
|
6344
|
+
|
|
6345
|
+
|
|
6346
|
+
|
|
6347
|
+
|
|
6348
|
+
<td class="description last">Whether to return an array or a single result.</td>
|
|
7482
6349
|
</tr>
|
|
7483
6350
|
|
|
7484
6351
|
|
|
7485
6352
|
|
|
7486
6353
|
<tr>
|
|
7487
6354
|
|
|
7488
|
-
<td class="name"><code>
|
|
6355
|
+
<td class="name"><code>options</code></td>
|
|
7489
6356
|
|
|
7490
6357
|
|
|
7491
6358
|
<td class="type">
|
|
7492
6359
|
|
|
7493
6360
|
|
|
7494
|
-
<span class="param-type">
|
|
6361
|
+
<span class="param-type">Object</span>
|
|
6362
|
+
|
|
6363
|
+
|
|
6364
|
+
|
|
6365
|
+
|
|
6366
|
+
</td>
|
|
6367
|
+
|
|
6368
|
+
|
|
6369
|
+
|
|
6370
|
+
|
|
6371
|
+
|
|
6372
|
+
<td class="description last">Additional options for fetching data.
|
|
6373
|
+
<h6>Properties</h6>
|
|
6374
|
+
|
|
6375
|
+
|
|
6376
|
+
<table class="params">
|
|
6377
|
+
<thead>
|
|
6378
|
+
<tr>
|
|
6379
|
+
|
|
6380
|
+
<th>Name</th>
|
|
6381
|
+
|
|
6382
|
+
|
|
6383
|
+
<th>Type</th>
|
|
6384
|
+
|
|
6385
|
+
|
|
6386
|
+
<th>Attributes</th>
|
|
6387
|
+
|
|
6388
|
+
|
|
6389
|
+
|
|
6390
|
+
<th>Default</th>
|
|
6391
|
+
|
|
6392
|
+
|
|
6393
|
+
<th class="last">Description</th>
|
|
6394
|
+
</tr>
|
|
6395
|
+
</thead>
|
|
6396
|
+
|
|
6397
|
+
<tbody>
|
|
6398
|
+
|
|
6399
|
+
|
|
6400
|
+
<tr>
|
|
6401
|
+
|
|
6402
|
+
<td class="name"><code>customPostProcess</code></td>
|
|
6403
|
+
|
|
6404
|
+
|
|
6405
|
+
<td class="type">
|
|
6406
|
+
|
|
6407
|
+
|
|
6408
|
+
<span class="param-type">function</span>
|
|
7495
6409
|
|
|
7496
6410
|
|
|
7497
6411
|
|
|
@@ -7501,6 +6415,8 @@ fetchSanity(query, true)
|
|
|
7501
6415
|
|
|
7502
6416
|
<td class="attributes">
|
|
7503
6417
|
|
|
6418
|
+
<optional><br>
|
|
6419
|
+
|
|
7504
6420
|
|
|
7505
6421
|
|
|
7506
6422
|
|
|
@@ -7511,23 +6427,25 @@ fetchSanity(query, true)
|
|
|
7511
6427
|
|
|
7512
6428
|
<td class="default">
|
|
7513
6429
|
|
|
6430
|
+
<code>null</code>
|
|
6431
|
+
|
|
7514
6432
|
</td>
|
|
7515
6433
|
|
|
7516
6434
|
|
|
7517
|
-
<td class="description last">
|
|
6435
|
+
<td class="description last">custom post process callback</td>
|
|
7518
6436
|
</tr>
|
|
7519
6437
|
|
|
7520
6438
|
|
|
7521
6439
|
|
|
7522
6440
|
<tr>
|
|
7523
6441
|
|
|
7524
|
-
<td class="name"><code>
|
|
6442
|
+
<td class="name"><code>processNeedAccess</code></td>
|
|
7525
6443
|
|
|
7526
6444
|
|
|
7527
6445
|
<td class="type">
|
|
7528
6446
|
|
|
7529
6447
|
|
|
7530
|
-
<span class="param-type">
|
|
6448
|
+
<span class="param-type">boolean</span>
|
|
7531
6449
|
|
|
7532
6450
|
|
|
7533
6451
|
|
|
@@ -7549,19 +6467,19 @@ fetchSanity(query, true)
|
|
|
7549
6467
|
|
|
7550
6468
|
<td class="default">
|
|
7551
6469
|
|
|
7552
|
-
<code>
|
|
6470
|
+
<code>true</code>
|
|
7553
6471
|
|
|
7554
6472
|
</td>
|
|
7555
6473
|
|
|
7556
6474
|
|
|
7557
|
-
<td class="description last">
|
|
6475
|
+
<td class="description last">execute the needs_access callback</td>
|
|
7558
6476
|
</tr>
|
|
7559
6477
|
|
|
7560
6478
|
|
|
7561
6479
|
|
|
7562
6480
|
<tr>
|
|
7563
6481
|
|
|
7564
|
-
<td class="name"><code>
|
|
6482
|
+
<td class="name"><code>processPageType</code></td>
|
|
7565
6483
|
|
|
7566
6484
|
|
|
7567
6485
|
<td class="type">
|
|
@@ -7594,7 +6512,14 @@ fetchSanity(query, true)
|
|
|
7594
6512
|
</td>
|
|
7595
6513
|
|
|
7596
6514
|
|
|
7597
|
-
<td class="description last">execute the
|
|
6515
|
+
<td class="description last">execute the page_type callback</td>
|
|
6516
|
+
</tr>
|
|
6517
|
+
|
|
6518
|
+
|
|
6519
|
+
</tbody>
|
|
6520
|
+
</table>
|
|
6521
|
+
|
|
6522
|
+
</td>
|
|
7598
6523
|
</tr>
|
|
7599
6524
|
|
|
7600
6525
|
|
|
@@ -7663,7 +6588,7 @@ fetchSanity(query, true)
|
|
|
7663
6588
|
|
|
7664
6589
|
<dt class="tag-source">Source:</dt>
|
|
7665
6590
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
7666
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
6591
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line376">line 376</a>
|
|
7667
6592
|
</li></ul></dd>
|
|
7668
6593
|
|
|
7669
6594
|
|
|
@@ -7831,7 +6756,7 @@ fetchSanity(query, true)
|
|
|
7831
6756
|
|
|
7832
6757
|
<dt class="tag-source">Source:</dt>
|
|
7833
6758
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
7834
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
6759
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1753">line 1753</a>
|
|
7835
6760
|
</li></ul></dd>
|
|
7836
6761
|
|
|
7837
6762
|
|
|
@@ -7986,7 +6911,7 @@ fetchSanity(query, true)
|
|
|
7986
6911
|
|
|
7987
6912
|
<dt class="tag-source">Source:</dt>
|
|
7988
6913
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
7989
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
6914
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1249">line 1249</a>
|
|
7990
6915
|
</li></ul></dd>
|
|
7991
6916
|
|
|
7992
6917
|
|
|
@@ -8168,7 +7093,7 @@ fetchSanity(query, true)
|
|
|
8168
7093
|
|
|
8169
7094
|
<dt class="tag-source">Source:</dt>
|
|
8170
7095
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
8171
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
7096
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line167">line 167</a>
|
|
8172
7097
|
</li></ul></dd>
|
|
8173
7098
|
|
|
8174
7099
|
|
|
@@ -8326,7 +7251,7 @@ fetchSanity(query, true)
|
|
|
8326
7251
|
|
|
8327
7252
|
<dt class="tag-source">Source:</dt>
|
|
8328
7253
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
8329
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
7254
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line54">line 54</a>
|
|
8330
7255
|
</li></ul></dd>
|
|
8331
7256
|
|
|
8332
7257
|
|
|
@@ -8475,6 +7400,162 @@ fetchSanity(query, true)
|
|
|
8475
7400
|
|
|
8476
7401
|
|
|
8477
7402
|
|
|
7403
|
+
<h4 class="name" id=".fetchTopLevelParentId"><span class="type-signature type-signature-static">(static) </span>fetchTopLevelParentId<span class="signature">(railcontentId)</span><span class="type-signature"> → {Promise.<(int|null)>}</span></h4>
|
|
7404
|
+
|
|
7405
|
+
|
|
7406
|
+
|
|
7407
|
+
|
|
7408
|
+
|
|
7409
|
+
|
|
7410
|
+
<dl class="details">
|
|
7411
|
+
|
|
7412
|
+
<dt class="tag-description">Description:</dt>
|
|
7413
|
+
<dd class="tag-description"><ul class="dummy"><li>Return the top level parent content railcontent_id.
|
|
7414
|
+
Ignores learning-path-v2 parents.
|
|
7415
|
+
ex: if railcontentId is of type 'skill-pack-lesson', return the corresponding 'skill-pack' railcontent_id</li></ul></dd>
|
|
7416
|
+
|
|
7417
|
+
|
|
7418
|
+
|
|
7419
|
+
<dt class="tag-source">Source:</dt>
|
|
7420
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
7421
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1505">line 1505</a>
|
|
7422
|
+
</li></ul></dd>
|
|
7423
|
+
|
|
7424
|
+
|
|
7425
|
+
|
|
7426
|
+
|
|
7427
|
+
|
|
7428
|
+
|
|
7429
|
+
|
|
7430
|
+
|
|
7431
|
+
|
|
7432
|
+
|
|
7433
|
+
|
|
7434
|
+
|
|
7435
|
+
|
|
7436
|
+
|
|
7437
|
+
|
|
7438
|
+
|
|
7439
|
+
|
|
7440
|
+
|
|
7441
|
+
|
|
7442
|
+
|
|
7443
|
+
|
|
7444
|
+
|
|
7445
|
+
|
|
7446
|
+
|
|
7447
|
+
|
|
7448
|
+
|
|
7449
|
+
|
|
7450
|
+
|
|
7451
|
+
|
|
7452
|
+
|
|
7453
|
+
|
|
7454
|
+
</dl>
|
|
7455
|
+
|
|
7456
|
+
|
|
7457
|
+
|
|
7458
|
+
|
|
7459
|
+
|
|
7460
|
+
|
|
7461
|
+
|
|
7462
|
+
|
|
7463
|
+
|
|
7464
|
+
|
|
7465
|
+
|
|
7466
|
+
|
|
7467
|
+
|
|
7468
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
7469
|
+
|
|
7470
|
+
|
|
7471
|
+
<table class="params">
|
|
7472
|
+
<thead>
|
|
7473
|
+
<tr>
|
|
7474
|
+
|
|
7475
|
+
<th>Name</th>
|
|
7476
|
+
|
|
7477
|
+
|
|
7478
|
+
<th>Type</th>
|
|
7479
|
+
|
|
7480
|
+
|
|
7481
|
+
|
|
7482
|
+
|
|
7483
|
+
|
|
7484
|
+
<th class="last">Description</th>
|
|
7485
|
+
</tr>
|
|
7486
|
+
</thead>
|
|
7487
|
+
|
|
7488
|
+
<tbody>
|
|
7489
|
+
|
|
7490
|
+
|
|
7491
|
+
<tr>
|
|
7492
|
+
|
|
7493
|
+
<td class="name"><code>railcontentId</code></td>
|
|
7494
|
+
|
|
7495
|
+
|
|
7496
|
+
<td class="type">
|
|
7497
|
+
|
|
7498
|
+
|
|
7499
|
+
<span class="param-type">int</span>
|
|
7500
|
+
|
|
7501
|
+
|
|
7502
|
+
|
|
7503
|
+
|
|
7504
|
+
</td>
|
|
7505
|
+
|
|
7506
|
+
|
|
7507
|
+
|
|
7508
|
+
|
|
7509
|
+
|
|
7510
|
+
<td class="description last"></td>
|
|
7511
|
+
</tr>
|
|
7512
|
+
|
|
7513
|
+
|
|
7514
|
+
</tbody>
|
|
7515
|
+
</table>
|
|
7516
|
+
|
|
7517
|
+
|
|
7518
|
+
|
|
7519
|
+
|
|
7520
|
+
|
|
7521
|
+
|
|
7522
|
+
|
|
7523
|
+
|
|
7524
|
+
|
|
7525
|
+
|
|
7526
|
+
|
|
7527
|
+
|
|
7528
|
+
|
|
7529
|
+
|
|
7530
|
+
|
|
7531
|
+
|
|
7532
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
7533
|
+
|
|
7534
|
+
|
|
7535
|
+
|
|
7536
|
+
|
|
7537
|
+
<dl class="param-type">
|
|
7538
|
+
<dt>
|
|
7539
|
+
Type
|
|
7540
|
+
</dt>
|
|
7541
|
+
<dd>
|
|
7542
|
+
|
|
7543
|
+
<span class="param-type">Promise.<(int|null)></span>
|
|
7544
|
+
|
|
7545
|
+
|
|
7546
|
+
|
|
7547
|
+
</dd>
|
|
7548
|
+
</dl>
|
|
7549
|
+
|
|
7550
|
+
|
|
7551
|
+
|
|
7552
|
+
|
|
7553
|
+
|
|
7554
|
+
|
|
7555
|
+
|
|
7556
|
+
|
|
7557
|
+
|
|
7558
|
+
|
|
8478
7559
|
<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>
|
|
8479
7560
|
|
|
8480
7561
|
|
|
@@ -8491,7 +7572,7 @@ fetchSanity(query, true)
|
|
|
8491
7572
|
|
|
8492
7573
|
<dt class="tag-source">Source:</dt>
|
|
8493
7574
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
8494
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
7575
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line329">line 329</a>
|
|
8495
7576
|
</li></ul></dd>
|
|
8496
7577
|
|
|
8497
7578
|
|
|
@@ -8659,7 +7740,7 @@ fetchSanity(query, true)
|
|
|
8659
7740
|
|
|
8660
7741
|
<dt class="tag-source">Source:</dt>
|
|
8661
7742
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
8662
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
7743
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1075">line 1075</a>
|
|
8663
7744
|
</li></ul></dd>
|
|
8664
7745
|
|
|
8665
7746
|
|
|
@@ -8824,7 +7905,7 @@ fetchSanity(query, true)
|
|
|
8824
7905
|
|
|
8825
7906
|
<dt class="tag-source">Source:</dt>
|
|
8826
7907
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
8827
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
7908
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line1219">line 1219</a>
|
|
8828
7909
|
</li></ul></dd>
|
|
8829
7910
|
|
|
8830
7911
|
|
|
@@ -9047,7 +8128,7 @@ fetchSanity(query, true)
|
|
|
9047
8128
|
|
|
9048
8129
|
<dt class="tag-source">Source:</dt>
|
|
9049
8130
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
9050
|
-
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#
|
|
8131
|
+
<a href="sanity.js.html">sanity.js</a>, <a href="sanity.js.html#line153">line 153</a>
|
|
9051
8132
|
</li></ul></dd>
|
|
9052
8133
|
|
|
9053
8134
|
|
|
@@ -9150,7 +8231,7 @@ fetchSanity(query, true)
|
|
|
9150
8231
|
<br class="clear">
|
|
9151
8232
|
|
|
9152
8233
|
<footer>
|
|
9153
|
-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on
|
|
8234
|
+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Fri Nov 28 2025 11:22:56 GMT-0800 (Pacific Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
|
|
9154
8235
|
</footer>
|
|
9155
8236
|
|
|
9156
8237
|
<script>prettyPrint();</script>
|