musora-content-services 2.82.0 → 2.83.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.coderabbit.yaml +0 -0
- package/.editorconfig +0 -0
- package/.github/pull_request_template.md +0 -0
- package/.github/workflows/conventional-commits.yaml +0 -0
- package/.github/workflows/docs.js.yml +0 -0
- package/.github/workflows/node.js.yml +0 -0
- package/.prettierignore +0 -0
- package/.prettierrc +0 -0
- package/CHANGELOG.md +7 -0
- package/README.md +0 -0
- package/babel.config.cjs +0 -0
- package/docs/Content.html +0 -0
- package/docs/ContentOrganization.html +2 -2
- package/docs/Forums.html +2 -2
- package/docs/Gamification.html +2 -2
- package/docs/TestUser.html +2 -2
- package/docs/UserManagementSystem.html +2 -2
- package/docs/api_types.js.html +2 -2
- package/docs/config.js.html +2 -2
- package/docs/content-org_content-org.js.html +2 -2
- package/docs/content-org_guided-courses.ts.html +2 -2
- package/docs/content-org_learning-paths.ts.html +2 -2
- package/docs/content-org_playlists-types.js.html +2 -2
- package/docs/content-org_playlists.js.html +2 -3
- package/docs/content.js.html +2 -2
- package/docs/content_artist.ts.html +8 -8
- package/docs/content_content.ts.html +0 -0
- package/docs/content_genre.ts.html +18 -15
- package/docs/content_instructor.ts.html +21 -16
- package/docs/fonts/Montserrat/Montserrat-Bold.eot +0 -0
- package/docs/fonts/Montserrat/Montserrat-Bold.ttf +0 -0
- package/docs/fonts/Montserrat/Montserrat-Bold.woff +0 -0
- package/docs/fonts/Montserrat/Montserrat-Bold.woff2 +0 -0
- package/docs/fonts/Montserrat/Montserrat-Regular.eot +0 -0
- package/docs/fonts/Montserrat/Montserrat-Regular.ttf +0 -0
- package/docs/fonts/Montserrat/Montserrat-Regular.woff +0 -0
- package/docs/fonts/Montserrat/Montserrat-Regular.woff2 +0 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.eot +0 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.svg +0 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.ttf +0 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff +0 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff2 +0 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.eot +0 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.svg +0 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.ttf +0 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff +0 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff2 +0 -0
- package/docs/forums_categories.ts.html +21 -2
- package/docs/forums_discussions.js.html +0 -0
- package/docs/forums_forum.js.html +0 -0
- package/docs/forums_forums.ts.html +2 -2
- package/docs/forums_posts.ts.html +2 -2
- package/docs/forums_threads.ts.html +2 -2
- package/docs/gamification_awards.js.html +0 -0
- package/docs/gamification_awards.ts.html +2 -2
- package/docs/gamification_gamification.js.html +2 -2
- package/docs/gamification_types.js.html +0 -0
- package/docs/global.html +2 -2
- package/docs/index.html +2 -2
- package/docs/liveTesting.ts.html +2 -2
- package/docs/module-Accounts.html +2 -2
- package/docs/module-Artist.html +8 -8
- package/docs/module-Awards.html +2 -2
- package/docs/module-Categories.html +0 -0
- package/docs/module-Config.html +2 -2
- package/docs/module-Content-Services-V2.html +2 -2
- package/docs/module-ForumCategories.html +0 -0
- package/docs/module-ForumDiscussions.html +0 -0
- package/docs/module-Forums.html +607 -43
- package/docs/module-Genre.html +9 -9
- package/docs/module-GuidedCourses.html +2 -2
- package/docs/module-Instructor.html +6 -6
- package/docs/module-Interests.html +2 -2
- package/docs/module-LearningPaths.html +2 -2
- package/docs/module-Onboarding.html +2 -2
- package/docs/module-Payments.html +2 -2
- package/docs/module-Permissions.html +2 -2
- package/docs/module-Playlists.html +16 -16
- package/docs/module-ProgressRow.html +2 -2
- package/docs/module-Railcontent-Services.html +2 -2
- package/docs/module-Sanity-Services.html +16 -1452
- package/docs/module-Sessions.html +2 -2
- package/docs/module-Threads.html +0 -0
- package/docs/module-UserActivity.html +2 -2
- package/docs/module-UserChat.html +2 -2
- package/docs/module-UserManagement.html +2 -2
- package/docs/module-UserMemberships.html +2 -2
- package/docs/module-UserNotifications.html +2 -2
- package/docs/module-UserProfile.html +2 -2
- package/docs/progress-row_method-card.js.html +2 -2
- package/docs/railcontent.js.html +2 -2
- package/docs/sanity.js.html +13 -52
- package/docs/scripts/collapse.js +0 -0
- package/docs/scripts/commonNav.js +0 -0
- package/docs/scripts/linenumber.js +0 -0
- package/docs/scripts/nav.js +0 -0
- package/docs/scripts/polyfill.js +0 -0
- package/docs/scripts/prettify/Apache-License-2.0.txt +0 -0
- package/docs/scripts/prettify/lang-css.js +0 -0
- package/docs/scripts/prettify/prettify.js +0 -0
- package/docs/scripts/search.js +0 -0
- package/docs/styles/jsdoc.css +0 -0
- package/docs/styles/prettify.css +0 -0
- package/docs/userActivity.js.html +2 -2
- package/docs/user_account.ts.html +2 -2
- package/docs/user_chat.js.html +2 -2
- package/docs/user_interests.js.html +2 -2
- package/docs/user_management.js.html +2 -2
- package/docs/user_memberships.js.html +0 -0
- package/docs/user_memberships.ts.html +2 -2
- package/docs/user_notifications.js.html +2 -2
- package/docs/user_onboarding.ts.html +2 -2
- package/docs/user_payments.ts.html +2 -2
- package/docs/user_permissions.js.html +3 -3
- package/docs/user_profile.js.html +2 -2
- package/docs/user_sessions.js.html +2 -2
- package/docs/user_types.js.html +2 -2
- package/docs/user_user-management-system.js.html +2 -2
- package/jest.config.js +0 -0
- package/jsdoc.json +0 -0
- package/package.json +1 -1
- package/src/contentMetaData.js +0 -0
- package/src/filterBuilder.js +0 -0
- package/src/index.d.ts +2 -0
- package/src/index.js +2 -0
- package/src/infrastructure/http/HttpClient.ts +0 -0
- package/src/infrastructure/http/executors/FetchRequestExecutor.ts +0 -0
- package/src/infrastructure/http/index.ts +0 -0
- package/src/infrastructure/http/interfaces/HeaderProvider.ts +0 -0
- package/src/infrastructure/http/interfaces/HttpError.ts +0 -0
- package/src/infrastructure/http/interfaces/NetworkError.ts +0 -0
- package/src/infrastructure/http/interfaces/RequestExecutor.ts +0 -0
- package/src/infrastructure/http/interfaces/RequestOptions.ts +0 -0
- package/src/infrastructure/http/providers/DefaultHeaderProvider.ts +0 -0
- package/src/lib/httpHelper.js +0 -0
- package/src/lib/lastUpdated.js +0 -0
- package/src/services/api/types.js +0 -0
- package/src/services/api/types.ts +0 -0
- package/src/services/config.js +0 -0
- package/src/services/content/artist.ts +6 -6
- package/src/services/content/content.ts +0 -0
- package/src/services/content/genre.ts +16 -13
- package/src/services/content/instructor.ts +19 -14
- package/src/services/content-org/content-org.js +0 -0
- package/src/services/content-org/guided-courses.ts +0 -0
- package/src/services/content-org/learning-paths.ts +0 -0
- package/src/services/content-org/playlists-types.js +0 -0
- package/src/services/content-org/playlists.js +0 -0
- package/src/services/content.js +0 -0
- package/src/services/contentAggregator.js +0 -0
- package/src/services/contentLikes.js +0 -0
- package/src/services/contentProgress.js +0 -0
- package/src/services/dataContext.js +0 -0
- package/src/services/dateUtils.js +0 -0
- package/src/services/eventsAPI.js +0 -0
- package/src/services/forums/categories.ts +19 -0
- package/src/services/forums/forums.ts +0 -0
- package/src/services/forums/posts.ts +0 -0
- package/src/services/forums/threads.ts +0 -0
- package/src/services/forums/types.ts +0 -0
- package/src/services/gamification/awards.ts +0 -0
- package/src/services/gamification/gamification.js +0 -0
- package/src/services/imageSRCBuilder.js +0 -0
- package/src/services/imageSRCVerify.js +0 -0
- package/src/services/liveTesting.ts +0 -0
- package/src/services/permissions/PermissionsAdapter.ts +0 -0
- package/src/services/permissions/PermissionsAdapterFactory.ts +0 -0
- package/src/services/permissions/PermissionsV1Adapter.ts +0 -0
- package/src/services/permissions/PermissionsV2Adapter.ts +0 -0
- package/src/services/permissions/README.md +0 -0
- package/src/services/permissions/index.ts +0 -0
- package/src/services/progress-row/method-card.js +0 -0
- package/src/services/railcontent.js +0 -0
- package/src/services/recommendations.js +0 -0
- package/src/services/types.js +0 -0
- package/src/services/user/account.ts +0 -0
- package/src/services/user/chat.js +0 -0
- package/src/services/user/interests.js +0 -0
- package/src/services/user/management.js +0 -0
- package/src/services/user/memberships.ts +0 -0
- package/src/services/user/notifications.js +0 -0
- package/src/services/user/onboarding.ts +0 -0
- package/src/services/user/payments.ts +0 -0
- package/src/services/user/permissions.js +0 -0
- package/src/services/user/profile.js +0 -0
- package/src/services/user/sessions.js +0 -0
- package/src/services/user/types.d.ts +0 -0
- package/src/services/user/types.js +0 -0
- package/src/services/user/user-management-system.js +0 -0
- package/src/services/userActivity.js +0 -0
- package/test/HttpClient.test.js +0 -0
- package/test/content.test.js +0 -0
- package/test/contentLikes.test.js +0 -0
- package/test/contentProgress.test.js +0 -0
- package/test/dataContext.test.js +0 -0
- package/test/forum.test.js +0 -0
- package/test/imageSRCBuilder.test.js +0 -0
- package/test/imageSRCVerify.test.js +0 -0
- package/test/initializeTests.js +0 -0
- package/test/learningPaths.test.js +0 -0
- package/test/lib/lastUpdated.test.js +0 -0
- package/test/live/contentProgressLive.test.js +0 -0
- package/test/live/railcontentLive.test.js +0 -0
- package/test/localStorageMock.js +0 -0
- package/test/log.js +0 -0
- package/test/mockData/mockData_fetchByRailContentIds_one_content.json +0 -0
- package/test/mockData/mockData_progress_content.json +0 -0
- package/test/mockData/mockData_sanity_progress_content.json +0 -0
- package/test/mockData/mockData_user_practices.json +0 -0
- package/test/notifications.test.js +0 -0
- package/test/progressRows.test.js +0 -0
- package/test/sanityQueryService.test.js +0 -0
- package/test/streakMessage.test.js +0 -0
- package/test/user/permissions.test.js +0 -0
- package/test/userActivity.test.js +0 -0
- package/tools/generate-index.cjs +0 -0
- package/.claude/settings.local.json +0 -14
- package/.yarnrc.yml +0 -1
package/docs/module-Forums.html
CHANGED
|
@@ -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><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#~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#~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#~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-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#~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#~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#.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#.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#.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
|
|
|
@@ -666,6 +666,194 @@
|
|
|
666
666
|
|
|
667
667
|
|
|
668
668
|
|
|
669
|
+
<h4 class="name" id="~deleteForumCategory"><span class="type-signature type-signature-async, inner">(async, inner) </span>deleteForumCategory<span class="signature">(params)</span><span class="type-signature"> → {Promise.<void>}</span></h4>
|
|
670
|
+
|
|
671
|
+
|
|
672
|
+
|
|
673
|
+
|
|
674
|
+
|
|
675
|
+
|
|
676
|
+
<dl class="details">
|
|
677
|
+
|
|
678
|
+
<dt class="tag-description">Description:</dt>
|
|
679
|
+
<dd class="tag-description"><ul class="dummy"><li>Deletes a forum category.</li></ul></dd>
|
|
680
|
+
|
|
681
|
+
|
|
682
|
+
|
|
683
|
+
<dt class="tag-source">Source:</dt>
|
|
684
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
685
|
+
<a href="forums_categories.ts.html">forums/categories.ts</a>, <a href="forums_categories.ts.html#line72">line 72</a>
|
|
686
|
+
</li></ul></dd>
|
|
687
|
+
|
|
688
|
+
|
|
689
|
+
|
|
690
|
+
|
|
691
|
+
|
|
692
|
+
|
|
693
|
+
|
|
694
|
+
|
|
695
|
+
|
|
696
|
+
|
|
697
|
+
|
|
698
|
+
|
|
699
|
+
|
|
700
|
+
|
|
701
|
+
|
|
702
|
+
|
|
703
|
+
|
|
704
|
+
|
|
705
|
+
|
|
706
|
+
|
|
707
|
+
|
|
708
|
+
|
|
709
|
+
|
|
710
|
+
|
|
711
|
+
|
|
712
|
+
|
|
713
|
+
|
|
714
|
+
|
|
715
|
+
|
|
716
|
+
|
|
717
|
+
|
|
718
|
+
</dl>
|
|
719
|
+
|
|
720
|
+
|
|
721
|
+
|
|
722
|
+
|
|
723
|
+
|
|
724
|
+
|
|
725
|
+
|
|
726
|
+
|
|
727
|
+
|
|
728
|
+
|
|
729
|
+
|
|
730
|
+
|
|
731
|
+
|
|
732
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
733
|
+
|
|
734
|
+
|
|
735
|
+
<table class="params">
|
|
736
|
+
<thead>
|
|
737
|
+
<tr>
|
|
738
|
+
|
|
739
|
+
<th>Name</th>
|
|
740
|
+
|
|
741
|
+
|
|
742
|
+
<th>Type</th>
|
|
743
|
+
|
|
744
|
+
|
|
745
|
+
|
|
746
|
+
|
|
747
|
+
|
|
748
|
+
<th class="last">Description</th>
|
|
749
|
+
</tr>
|
|
750
|
+
</thead>
|
|
751
|
+
|
|
752
|
+
<tbody>
|
|
753
|
+
|
|
754
|
+
|
|
755
|
+
<tr>
|
|
756
|
+
|
|
757
|
+
<td class="name"><code>params</code></td>
|
|
758
|
+
|
|
759
|
+
|
|
760
|
+
<td class="type">
|
|
761
|
+
|
|
762
|
+
|
|
763
|
+
<span class="param-type">DeleteForumCategoryParams</span>
|
|
764
|
+
|
|
765
|
+
|
|
766
|
+
|
|
767
|
+
|
|
768
|
+
</td>
|
|
769
|
+
|
|
770
|
+
|
|
771
|
+
|
|
772
|
+
|
|
773
|
+
|
|
774
|
+
<td class="description last">The parameters for deleting the forum category.</td>
|
|
775
|
+
</tr>
|
|
776
|
+
|
|
777
|
+
|
|
778
|
+
</tbody>
|
|
779
|
+
</table>
|
|
780
|
+
|
|
781
|
+
|
|
782
|
+
|
|
783
|
+
|
|
784
|
+
|
|
785
|
+
|
|
786
|
+
|
|
787
|
+
|
|
788
|
+
|
|
789
|
+
|
|
790
|
+
|
|
791
|
+
|
|
792
|
+
|
|
793
|
+
|
|
794
|
+
<h5 class="h5-throws">Throws:</h5>
|
|
795
|
+
|
|
796
|
+
|
|
797
|
+
|
|
798
|
+
<dl>
|
|
799
|
+
<dt>
|
|
800
|
+
<div class="param-desc usertext">
|
|
801
|
+
- If the request fails.
|
|
802
|
+
</div>
|
|
803
|
+
</dt>
|
|
804
|
+
<dd></dd>
|
|
805
|
+
<dt>
|
|
806
|
+
<dl class="param-type">
|
|
807
|
+
<dt>
|
|
808
|
+
Type
|
|
809
|
+
</dt>
|
|
810
|
+
<dd>
|
|
811
|
+
|
|
812
|
+
<span class="param-type">HttpError</span>
|
|
813
|
+
|
|
814
|
+
|
|
815
|
+
|
|
816
|
+
</dd>
|
|
817
|
+
</dl>
|
|
818
|
+
</dt>
|
|
819
|
+
<dd></dd>
|
|
820
|
+
</dl>
|
|
821
|
+
|
|
822
|
+
|
|
823
|
+
|
|
824
|
+
|
|
825
|
+
|
|
826
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
827
|
+
|
|
828
|
+
|
|
829
|
+
<div class="param-desc">
|
|
830
|
+
- A promise that resolves when the category is deleted.
|
|
831
|
+
</div>
|
|
832
|
+
|
|
833
|
+
|
|
834
|
+
|
|
835
|
+
<dl class="param-type">
|
|
836
|
+
<dt>
|
|
837
|
+
Type
|
|
838
|
+
</dt>
|
|
839
|
+
<dd>
|
|
840
|
+
|
|
841
|
+
<span class="param-type">Promise.<void></span>
|
|
842
|
+
|
|
843
|
+
|
|
844
|
+
|
|
845
|
+
</dd>
|
|
846
|
+
</dl>
|
|
847
|
+
|
|
848
|
+
|
|
849
|
+
|
|
850
|
+
|
|
851
|
+
|
|
852
|
+
|
|
853
|
+
|
|
854
|
+
|
|
855
|
+
|
|
856
|
+
|
|
669
857
|
<h4 class="name" id="~deletePost"><span class="type-signature type-signature-async, inner">(async, inner) </span>deletePost<span class="signature">(postId, brand)</span><span class="type-signature"> → {Promise.<void>}</span></h4>
|
|
670
858
|
|
|
671
859
|
|
|
@@ -5401,15 +5589,203 @@ Automatically marks the thread as read when posts are fetched.</li></ul></dd>
|
|
|
5401
5589
|
|
|
5402
5590
|
|
|
5403
5591
|
|
|
5404
|
-
|
|
5405
|
-
<h3 class="subsection-title">Methods</h3>
|
|
5592
|
+
|
|
5593
|
+
<h3 class="subsection-title">Methods</h3>
|
|
5594
|
+
|
|
5595
|
+
|
|
5596
|
+
|
|
5597
|
+
|
|
5598
|
+
|
|
5599
|
+
|
|
5600
|
+
<h4 class="name" id="~createForumCategory"><span class="type-signature type-signature-async, inner">(async, inner) </span>createForumCategory<span class="signature">(params)</span><span class="type-signature"> → {Promise.<ForumCategory>}</span></h4>
|
|
5601
|
+
|
|
5602
|
+
|
|
5603
|
+
|
|
5604
|
+
|
|
5605
|
+
|
|
5606
|
+
|
|
5607
|
+
<dl class="details">
|
|
5608
|
+
|
|
5609
|
+
<dt class="tag-description">Description:</dt>
|
|
5610
|
+
<dd class="tag-description"><ul class="dummy"><li>Creates a new forum category.</li></ul></dd>
|
|
5611
|
+
|
|
5612
|
+
|
|
5613
|
+
|
|
5614
|
+
<dt class="tag-source">Source:</dt>
|
|
5615
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
5616
|
+
<a href="forums_categories.ts.html">forums/categories.ts</a>, <a href="forums_categories.ts.html#line30">line 30</a>
|
|
5617
|
+
</li></ul></dd>
|
|
5618
|
+
|
|
5619
|
+
|
|
5620
|
+
|
|
5621
|
+
|
|
5622
|
+
|
|
5623
|
+
|
|
5624
|
+
|
|
5625
|
+
|
|
5626
|
+
|
|
5627
|
+
|
|
5628
|
+
|
|
5629
|
+
|
|
5630
|
+
|
|
5631
|
+
|
|
5632
|
+
|
|
5633
|
+
|
|
5634
|
+
|
|
5635
|
+
|
|
5636
|
+
|
|
5637
|
+
|
|
5638
|
+
|
|
5639
|
+
|
|
5640
|
+
|
|
5641
|
+
|
|
5642
|
+
|
|
5643
|
+
|
|
5644
|
+
|
|
5645
|
+
|
|
5646
|
+
|
|
5647
|
+
|
|
5648
|
+
|
|
5649
|
+
</dl>
|
|
5650
|
+
|
|
5651
|
+
|
|
5652
|
+
|
|
5653
|
+
|
|
5654
|
+
|
|
5655
|
+
|
|
5656
|
+
|
|
5657
|
+
|
|
5658
|
+
|
|
5659
|
+
|
|
5660
|
+
|
|
5661
|
+
|
|
5662
|
+
|
|
5663
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
5664
|
+
|
|
5665
|
+
|
|
5666
|
+
<table class="params">
|
|
5667
|
+
<thead>
|
|
5668
|
+
<tr>
|
|
5669
|
+
|
|
5670
|
+
<th>Name</th>
|
|
5671
|
+
|
|
5672
|
+
|
|
5673
|
+
<th>Type</th>
|
|
5674
|
+
|
|
5675
|
+
|
|
5676
|
+
|
|
5677
|
+
|
|
5678
|
+
|
|
5679
|
+
<th class="last">Description</th>
|
|
5680
|
+
</tr>
|
|
5681
|
+
</thead>
|
|
5682
|
+
|
|
5683
|
+
<tbody>
|
|
5684
|
+
|
|
5685
|
+
|
|
5686
|
+
<tr>
|
|
5687
|
+
|
|
5688
|
+
<td class="name"><code>params</code></td>
|
|
5689
|
+
|
|
5690
|
+
|
|
5691
|
+
<td class="type">
|
|
5692
|
+
|
|
5693
|
+
|
|
5694
|
+
<span class="param-type">CreateForumCategoryParams</span>
|
|
5695
|
+
|
|
5696
|
+
|
|
5697
|
+
|
|
5698
|
+
|
|
5699
|
+
</td>
|
|
5700
|
+
|
|
5701
|
+
|
|
5702
|
+
|
|
5703
|
+
|
|
5704
|
+
|
|
5705
|
+
<td class="description last">The parameters for creating the forum category.</td>
|
|
5706
|
+
</tr>
|
|
5707
|
+
|
|
5708
|
+
|
|
5709
|
+
</tbody>
|
|
5710
|
+
</table>
|
|
5711
|
+
|
|
5712
|
+
|
|
5713
|
+
|
|
5714
|
+
|
|
5715
|
+
|
|
5716
|
+
|
|
5717
|
+
|
|
5718
|
+
|
|
5719
|
+
|
|
5720
|
+
|
|
5721
|
+
|
|
5722
|
+
|
|
5723
|
+
|
|
5724
|
+
|
|
5725
|
+
<h5 class="h5-throws">Throws:</h5>
|
|
5726
|
+
|
|
5727
|
+
|
|
5728
|
+
|
|
5729
|
+
<dl>
|
|
5730
|
+
<dt>
|
|
5731
|
+
<div class="param-desc usertext">
|
|
5732
|
+
- If the request fails.
|
|
5733
|
+
</div>
|
|
5734
|
+
</dt>
|
|
5735
|
+
<dd></dd>
|
|
5736
|
+
<dt>
|
|
5737
|
+
<dl class="param-type">
|
|
5738
|
+
<dt>
|
|
5739
|
+
Type
|
|
5740
|
+
</dt>
|
|
5741
|
+
<dd>
|
|
5742
|
+
|
|
5743
|
+
<span class="param-type">HttpError</span>
|
|
5744
|
+
|
|
5745
|
+
|
|
5746
|
+
|
|
5747
|
+
</dd>
|
|
5748
|
+
</dl>
|
|
5749
|
+
</dt>
|
|
5750
|
+
<dd></dd>
|
|
5751
|
+
</dl>
|
|
5752
|
+
|
|
5753
|
+
|
|
5754
|
+
|
|
5755
|
+
|
|
5756
|
+
|
|
5757
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
5758
|
+
|
|
5759
|
+
|
|
5760
|
+
<div class="param-desc">
|
|
5761
|
+
- A promise that resolves to the created forum category.
|
|
5762
|
+
</div>
|
|
5763
|
+
|
|
5764
|
+
|
|
5765
|
+
|
|
5766
|
+
<dl class="param-type">
|
|
5767
|
+
<dt>
|
|
5768
|
+
Type
|
|
5769
|
+
</dt>
|
|
5770
|
+
<dd>
|
|
5771
|
+
|
|
5772
|
+
<span class="param-type">Promise.<ForumCategory></span>
|
|
5773
|
+
|
|
5774
|
+
|
|
5775
|
+
|
|
5776
|
+
</dd>
|
|
5777
|
+
</dl>
|
|
5778
|
+
|
|
5779
|
+
|
|
5780
|
+
|
|
5781
|
+
|
|
5406
5782
|
|
|
5407
5783
|
|
|
5408
5784
|
|
|
5409
5785
|
|
|
5410
5786
|
|
|
5411
5787
|
|
|
5412
|
-
<h4 class="name" id="~
|
|
5788
|
+
<h4 class="name" id="~createPost"><span class="type-signature type-signature-async, inner">(async, inner) </span>createPost<span class="signature">(threadId, params)</span><span class="type-signature"> → {Promise.<ForumPost>}</span></h4>
|
|
5413
5789
|
|
|
5414
5790
|
|
|
5415
5791
|
|
|
@@ -5419,13 +5795,13 @@ Automatically marks the thread as read when posts are fetched.</li></ul></dd>
|
|
|
5419
5795
|
<dl class="details">
|
|
5420
5796
|
|
|
5421
5797
|
<dt class="tag-description">Description:</dt>
|
|
5422
|
-
<dd class="tag-description"><ul class="dummy"><li>Creates a new forum
|
|
5798
|
+
<dd class="tag-description"><ul class="dummy"><li>Creates a new post under a forum thread.</li></ul></dd>
|
|
5423
5799
|
|
|
5424
5800
|
|
|
5425
5801
|
|
|
5426
5802
|
<dt class="tag-source">Source:</dt>
|
|
5427
5803
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
5428
|
-
<a href="
|
|
5804
|
+
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line17">line 17</a>
|
|
5429
5805
|
</li></ul></dd>
|
|
5430
5806
|
|
|
5431
5807
|
|
|
@@ -5495,6 +5871,24 @@ Automatically marks the thread as read when posts are fetched.</li></ul></dd>
|
|
|
5495
5871
|
<tbody>
|
|
5496
5872
|
|
|
5497
5873
|
|
|
5874
|
+
<tr>
|
|
5875
|
+
|
|
5876
|
+
<td class="name"><code>threadId</code></td>
|
|
5877
|
+
|
|
5878
|
+
|
|
5879
|
+
<td class="type">
|
|
5880
|
+
|
|
5881
|
+
</td>
|
|
5882
|
+
|
|
5883
|
+
|
|
5884
|
+
|
|
5885
|
+
|
|
5886
|
+
|
|
5887
|
+
<td class="description last"></td>
|
|
5888
|
+
</tr>
|
|
5889
|
+
|
|
5890
|
+
|
|
5891
|
+
|
|
5498
5892
|
<tr>
|
|
5499
5893
|
|
|
5500
5894
|
<td class="name"><code>params</code></td>
|
|
@@ -5503,7 +5897,7 @@ Automatically marks the thread as read when posts are fetched.</li></ul></dd>
|
|
|
5503
5897
|
<td class="type">
|
|
5504
5898
|
|
|
5505
5899
|
|
|
5506
|
-
<span class="param-type">
|
|
5900
|
+
<span class="param-type">CreatePostParams</span>
|
|
5507
5901
|
|
|
5508
5902
|
|
|
5509
5903
|
|
|
@@ -5514,7 +5908,7 @@ Automatically marks the thread as read when posts are fetched.</li></ul></dd>
|
|
|
5514
5908
|
|
|
5515
5909
|
|
|
5516
5910
|
|
|
5517
|
-
<td class="description last">The parameters for creating the
|
|
5911
|
+
<td class="description last">The parameters for creating the post.</td>
|
|
5518
5912
|
</tr>
|
|
5519
5913
|
|
|
5520
5914
|
|
|
@@ -5570,7 +5964,7 @@ Automatically marks the thread as read when posts are fetched.</li></ul></dd>
|
|
|
5570
5964
|
|
|
5571
5965
|
|
|
5572
5966
|
<div class="param-desc">
|
|
5573
|
-
- A promise that resolves to the created
|
|
5967
|
+
- A promise that resolves to the created post.
|
|
5574
5968
|
</div>
|
|
5575
5969
|
|
|
5576
5970
|
|
|
@@ -5581,7 +5975,7 @@ Automatically marks the thread as read when posts are fetched.</li></ul></dd>
|
|
|
5581
5975
|
</dt>
|
|
5582
5976
|
<dd>
|
|
5583
5977
|
|
|
5584
|
-
<span class="param-type">Promise.<
|
|
5978
|
+
<span class="param-type">Promise.<ForumPost></span>
|
|
5585
5979
|
|
|
5586
5980
|
|
|
5587
5981
|
|
|
@@ -5597,7 +5991,7 @@ Automatically marks the thread as read when posts are fetched.</li></ul></dd>
|
|
|
5597
5991
|
|
|
5598
5992
|
|
|
5599
5993
|
|
|
5600
|
-
<h4 class="name" id="~
|
|
5994
|
+
<h4 class="name" id="~createThread"><span class="type-signature type-signature-async, inner">(async, inner) </span>createThread<span class="signature">(params)</span><span class="type-signature"> → {Promise.<ForumThread>}</span></h4>
|
|
5601
5995
|
|
|
5602
5996
|
|
|
5603
5997
|
|
|
@@ -5607,13 +6001,13 @@ Automatically marks the thread as read when posts are fetched.</li></ul></dd>
|
|
|
5607
6001
|
<dl class="details">
|
|
5608
6002
|
|
|
5609
6003
|
<dt class="tag-description">Description:</dt>
|
|
5610
|
-
<dd class="tag-description"><ul class="dummy"><li>Creates a new
|
|
6004
|
+
<dd class="tag-description"><ul class="dummy"><li>Creates a new thread under a forum category.</li></ul></dd>
|
|
5611
6005
|
|
|
5612
6006
|
|
|
5613
6007
|
|
|
5614
6008
|
<dt class="tag-source">Source:</dt>
|
|
5615
6009
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
5616
|
-
<a href="
|
|
6010
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line17">line 17</a>
|
|
5617
6011
|
</li></ul></dd>
|
|
5618
6012
|
|
|
5619
6013
|
|
|
@@ -5683,24 +6077,6 @@ Automatically marks the thread as read when posts are fetched.</li></ul></dd>
|
|
|
5683
6077
|
<tbody>
|
|
5684
6078
|
|
|
5685
6079
|
|
|
5686
|
-
<tr>
|
|
5687
|
-
|
|
5688
|
-
<td class="name"><code>threadId</code></td>
|
|
5689
|
-
|
|
5690
|
-
|
|
5691
|
-
<td class="type">
|
|
5692
|
-
|
|
5693
|
-
</td>
|
|
5694
|
-
|
|
5695
|
-
|
|
5696
|
-
|
|
5697
|
-
|
|
5698
|
-
|
|
5699
|
-
<td class="description last"></td>
|
|
5700
|
-
</tr>
|
|
5701
|
-
|
|
5702
|
-
|
|
5703
|
-
|
|
5704
6080
|
<tr>
|
|
5705
6081
|
|
|
5706
6082
|
<td class="name"><code>params</code></td>
|
|
@@ -5709,7 +6085,7 @@ Automatically marks the thread as read when posts are fetched.</li></ul></dd>
|
|
|
5709
6085
|
<td class="type">
|
|
5710
6086
|
|
|
5711
6087
|
|
|
5712
|
-
<span class="param-type">
|
|
6088
|
+
<span class="param-type">CreateThreadParams</span>
|
|
5713
6089
|
|
|
5714
6090
|
|
|
5715
6091
|
|
|
@@ -5720,7 +6096,7 @@ Automatically marks the thread as read when posts are fetched.</li></ul></dd>
|
|
|
5720
6096
|
|
|
5721
6097
|
|
|
5722
6098
|
|
|
5723
|
-
<td class="description last">The parameters for creating the
|
|
6099
|
+
<td class="description last">The parameters for creating the thread.</td>
|
|
5724
6100
|
</tr>
|
|
5725
6101
|
|
|
5726
6102
|
|
|
@@ -5776,7 +6152,7 @@ Automatically marks the thread as read when posts are fetched.</li></ul></dd>
|
|
|
5776
6152
|
|
|
5777
6153
|
|
|
5778
6154
|
<div class="param-desc">
|
|
5779
|
-
- A promise that resolves to the created
|
|
6155
|
+
- A promise that resolves to the created thread.
|
|
5780
6156
|
</div>
|
|
5781
6157
|
|
|
5782
6158
|
|
|
@@ -5787,7 +6163,7 @@ Automatically marks the thread as read when posts are fetched.</li></ul></dd>
|
|
|
5787
6163
|
</dt>
|
|
5788
6164
|
<dd>
|
|
5789
6165
|
|
|
5790
|
-
<span class="param-type">Promise.<
|
|
6166
|
+
<span class="param-type">Promise.<ForumThread></span>
|
|
5791
6167
|
|
|
5792
6168
|
|
|
5793
6169
|
|
|
@@ -5803,7 +6179,7 @@ Automatically marks the thread as read when posts are fetched.</li></ul></dd>
|
|
|
5803
6179
|
|
|
5804
6180
|
|
|
5805
6181
|
|
|
5806
|
-
<h4 class="name" id="~
|
|
6182
|
+
<h4 class="name" id="~deleteForumCategory"><span class="type-signature type-signature-async, inner">(async, inner) </span>deleteForumCategory<span class="signature">(params)</span><span class="type-signature"> → {Promise.<void>}</span></h4>
|
|
5807
6183
|
|
|
5808
6184
|
|
|
5809
6185
|
|
|
@@ -5813,13 +6189,13 @@ Automatically marks the thread as read when posts are fetched.</li></ul></dd>
|
|
|
5813
6189
|
<dl class="details">
|
|
5814
6190
|
|
|
5815
6191
|
<dt class="tag-description">Description:</dt>
|
|
5816
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
6192
|
+
<dd class="tag-description"><ul class="dummy"><li>Deletes a forum category.</li></ul></dd>
|
|
5817
6193
|
|
|
5818
6194
|
|
|
5819
6195
|
|
|
5820
6196
|
<dt class="tag-source">Source:</dt>
|
|
5821
6197
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
5822
|
-
<a href="
|
|
6198
|
+
<a href="forums_categories.ts.html">forums/categories.ts</a>, <a href="forums_categories.ts.html#line72">line 72</a>
|
|
5823
6199
|
</li></ul></dd>
|
|
5824
6200
|
|
|
5825
6201
|
|
|
@@ -5897,7 +6273,7 @@ Automatically marks the thread as read when posts are fetched.</li></ul></dd>
|
|
|
5897
6273
|
<td class="type">
|
|
5898
6274
|
|
|
5899
6275
|
|
|
5900
|
-
<span class="param-type">
|
|
6276
|
+
<span class="param-type">DeleteForumCategoryParams</span>
|
|
5901
6277
|
|
|
5902
6278
|
|
|
5903
6279
|
|
|
@@ -5908,7 +6284,7 @@ Automatically marks the thread as read when posts are fetched.</li></ul></dd>
|
|
|
5908
6284
|
|
|
5909
6285
|
|
|
5910
6286
|
|
|
5911
|
-
<td class="description last">The parameters for
|
|
6287
|
+
<td class="description last">The parameters for deleting the forum category.</td>
|
|
5912
6288
|
</tr>
|
|
5913
6289
|
|
|
5914
6290
|
|
|
@@ -5964,7 +6340,7 @@ Automatically marks the thread as read when posts are fetched.</li></ul></dd>
|
|
|
5964
6340
|
|
|
5965
6341
|
|
|
5966
6342
|
<div class="param-desc">
|
|
5967
|
-
- A promise that resolves
|
|
6343
|
+
- A promise that resolves when the category is deleted.
|
|
5968
6344
|
</div>
|
|
5969
6345
|
|
|
5970
6346
|
|
|
@@ -5975,7 +6351,7 @@ Automatically marks the thread as read when posts are fetched.</li></ul></dd>
|
|
|
5975
6351
|
</dt>
|
|
5976
6352
|
<dd>
|
|
5977
6353
|
|
|
5978
|
-
<span class="param-type">Promise.<
|
|
6354
|
+
<span class="param-type">Promise.<void></span>
|
|
5979
6355
|
|
|
5980
6356
|
|
|
5981
6357
|
|
|
@@ -11316,6 +11692,194 @@ Automatically marks the thread as read when posts are fetched.</li></ul></dd>
|
|
|
11316
11692
|
|
|
11317
11693
|
|
|
11318
11694
|
|
|
11695
|
+
<h4 class="name" id="~deleteForumCategory"><span class="type-signature type-signature-async, inner">(async, inner) </span>deleteForumCategory<span class="signature">(params)</span><span class="type-signature"> → {Promise.<void>}</span></h4>
|
|
11696
|
+
|
|
11697
|
+
|
|
11698
|
+
|
|
11699
|
+
|
|
11700
|
+
|
|
11701
|
+
|
|
11702
|
+
<dl class="details">
|
|
11703
|
+
|
|
11704
|
+
<dt class="tag-description">Description:</dt>
|
|
11705
|
+
<dd class="tag-description"><ul class="dummy"><li>Deletes a forum category.</li></ul></dd>
|
|
11706
|
+
|
|
11707
|
+
|
|
11708
|
+
|
|
11709
|
+
<dt class="tag-source">Source:</dt>
|
|
11710
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
11711
|
+
<a href="forums_categories.ts.html">forums/categories.ts</a>, <a href="forums_categories.ts.html#line72">line 72</a>
|
|
11712
|
+
</li></ul></dd>
|
|
11713
|
+
|
|
11714
|
+
|
|
11715
|
+
|
|
11716
|
+
|
|
11717
|
+
|
|
11718
|
+
|
|
11719
|
+
|
|
11720
|
+
|
|
11721
|
+
|
|
11722
|
+
|
|
11723
|
+
|
|
11724
|
+
|
|
11725
|
+
|
|
11726
|
+
|
|
11727
|
+
|
|
11728
|
+
|
|
11729
|
+
|
|
11730
|
+
|
|
11731
|
+
|
|
11732
|
+
|
|
11733
|
+
|
|
11734
|
+
|
|
11735
|
+
|
|
11736
|
+
|
|
11737
|
+
|
|
11738
|
+
|
|
11739
|
+
|
|
11740
|
+
|
|
11741
|
+
|
|
11742
|
+
|
|
11743
|
+
|
|
11744
|
+
</dl>
|
|
11745
|
+
|
|
11746
|
+
|
|
11747
|
+
|
|
11748
|
+
|
|
11749
|
+
|
|
11750
|
+
|
|
11751
|
+
|
|
11752
|
+
|
|
11753
|
+
|
|
11754
|
+
|
|
11755
|
+
|
|
11756
|
+
|
|
11757
|
+
|
|
11758
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
11759
|
+
|
|
11760
|
+
|
|
11761
|
+
<table class="params">
|
|
11762
|
+
<thead>
|
|
11763
|
+
<tr>
|
|
11764
|
+
|
|
11765
|
+
<th>Name</th>
|
|
11766
|
+
|
|
11767
|
+
|
|
11768
|
+
<th>Type</th>
|
|
11769
|
+
|
|
11770
|
+
|
|
11771
|
+
|
|
11772
|
+
|
|
11773
|
+
|
|
11774
|
+
<th class="last">Description</th>
|
|
11775
|
+
</tr>
|
|
11776
|
+
</thead>
|
|
11777
|
+
|
|
11778
|
+
<tbody>
|
|
11779
|
+
|
|
11780
|
+
|
|
11781
|
+
<tr>
|
|
11782
|
+
|
|
11783
|
+
<td class="name"><code>params</code></td>
|
|
11784
|
+
|
|
11785
|
+
|
|
11786
|
+
<td class="type">
|
|
11787
|
+
|
|
11788
|
+
|
|
11789
|
+
<span class="param-type">DeleteForumCategoryParams</span>
|
|
11790
|
+
|
|
11791
|
+
|
|
11792
|
+
|
|
11793
|
+
|
|
11794
|
+
</td>
|
|
11795
|
+
|
|
11796
|
+
|
|
11797
|
+
|
|
11798
|
+
|
|
11799
|
+
|
|
11800
|
+
<td class="description last">The parameters for deleting the forum category.</td>
|
|
11801
|
+
</tr>
|
|
11802
|
+
|
|
11803
|
+
|
|
11804
|
+
</tbody>
|
|
11805
|
+
</table>
|
|
11806
|
+
|
|
11807
|
+
|
|
11808
|
+
|
|
11809
|
+
|
|
11810
|
+
|
|
11811
|
+
|
|
11812
|
+
|
|
11813
|
+
|
|
11814
|
+
|
|
11815
|
+
|
|
11816
|
+
|
|
11817
|
+
|
|
11818
|
+
|
|
11819
|
+
|
|
11820
|
+
<h5 class="h5-throws">Throws:</h5>
|
|
11821
|
+
|
|
11822
|
+
|
|
11823
|
+
|
|
11824
|
+
<dl>
|
|
11825
|
+
<dt>
|
|
11826
|
+
<div class="param-desc usertext">
|
|
11827
|
+
- If the request fails.
|
|
11828
|
+
</div>
|
|
11829
|
+
</dt>
|
|
11830
|
+
<dd></dd>
|
|
11831
|
+
<dt>
|
|
11832
|
+
<dl class="param-type">
|
|
11833
|
+
<dt>
|
|
11834
|
+
Type
|
|
11835
|
+
</dt>
|
|
11836
|
+
<dd>
|
|
11837
|
+
|
|
11838
|
+
<span class="param-type">HttpError</span>
|
|
11839
|
+
|
|
11840
|
+
|
|
11841
|
+
|
|
11842
|
+
</dd>
|
|
11843
|
+
</dl>
|
|
11844
|
+
</dt>
|
|
11845
|
+
<dd></dd>
|
|
11846
|
+
</dl>
|
|
11847
|
+
|
|
11848
|
+
|
|
11849
|
+
|
|
11850
|
+
|
|
11851
|
+
|
|
11852
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
11853
|
+
|
|
11854
|
+
|
|
11855
|
+
<div class="param-desc">
|
|
11856
|
+
- A promise that resolves when the category is deleted.
|
|
11857
|
+
</div>
|
|
11858
|
+
|
|
11859
|
+
|
|
11860
|
+
|
|
11861
|
+
<dl class="param-type">
|
|
11862
|
+
<dt>
|
|
11863
|
+
Type
|
|
11864
|
+
</dt>
|
|
11865
|
+
<dd>
|
|
11866
|
+
|
|
11867
|
+
<span class="param-type">Promise.<void></span>
|
|
11868
|
+
|
|
11869
|
+
|
|
11870
|
+
|
|
11871
|
+
</dd>
|
|
11872
|
+
</dl>
|
|
11873
|
+
|
|
11874
|
+
|
|
11875
|
+
|
|
11876
|
+
|
|
11877
|
+
|
|
11878
|
+
|
|
11879
|
+
|
|
11880
|
+
|
|
11881
|
+
|
|
11882
|
+
|
|
11319
11883
|
<h4 class="name" id="~deletePost"><span class="type-signature type-signature-async, inner">(async, inner) </span>deletePost<span class="signature">(postId, brand)</span><span class="type-signature"> → {Promise.<void>}</span></h4>
|
|
11320
11884
|
|
|
11321
11885
|
|
|
@@ -16022,7 +16586,7 @@ Automatically marks the thread as read when posts are fetched.</li></ul></dd>
|
|
|
16022
16586
|
<br class="clear">
|
|
16023
16587
|
|
|
16024
16588
|
<footer>
|
|
16025
|
-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Fri Nov 21 2025
|
|
16589
|
+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Fri Nov 21 2025 17:22:14 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
|
|
16026
16590
|
</footer>
|
|
16027
16591
|
|
|
16028
16592
|
<script>prettyPrint();</script>
|