musora-content-services 1.7.0 → 1.7.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.claude/settings.local.json +17 -0
- package/.github/workflows/conventional-commits.yaml +0 -0
- package/.github/workflows/node.js.yml +0 -0
- package/.prettierignore +0 -0
- package/.prettierrc +0 -0
- package/CHANGELOG.md +15 -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/jest.config.js +0 -0
- package/link_mcs.sh +0 -0
- package/package.json +1 -1
- package/src/services/imageSRCBuilder.js +1 -1
- package/src/services/imageSRCVerify.js +1 -1
- package/src/services/sanity.js +3 -3
- package/test/dataContext.test.js +0 -0
- package/test/imageSRCBuilder.test.js +1 -1
- package/test/imageSRCVerify.test.js +4 -4
- package/test/localStorageMock.js +0 -0
- package/test/log.js +0 -0
|
@@ -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
|
|
|
@@ -288,7 +288,7 @@
|
|
|
288
288
|
|
|
289
289
|
<dt class="tag-source">Source:</dt>
|
|
290
290
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
291
|
-
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#
|
|
291
|
+
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line17">line 17</a>
|
|
292
292
|
</li></ul></dd>
|
|
293
293
|
|
|
294
294
|
|
|
@@ -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
|
|
|
@@ -682,7 +870,7 @@
|
|
|
682
870
|
|
|
683
871
|
<dt class="tag-source">Source:</dt>
|
|
684
872
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
685
|
-
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#
|
|
873
|
+
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line112">line 112</a>
|
|
686
874
|
</li></ul></dd>
|
|
687
875
|
|
|
688
876
|
|
|
@@ -894,7 +1082,7 @@
|
|
|
894
1082
|
|
|
895
1083
|
<dt class="tag-source">Source:</dt>
|
|
896
1084
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
897
|
-
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#
|
|
1085
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line201">line 201</a>
|
|
898
1086
|
</li></ul></dd>
|
|
899
1087
|
|
|
900
1088
|
|
|
@@ -1106,7 +1294,7 @@
|
|
|
1106
1294
|
|
|
1107
1295
|
<dt class="tag-source">Source:</dt>
|
|
1108
1296
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
1109
|
-
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#
|
|
1297
|
+
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line125">line 125</a>
|
|
1110
1298
|
</li></ul></dd>
|
|
1111
1299
|
|
|
1112
1300
|
|
|
@@ -1294,7 +1482,7 @@
|
|
|
1294
1482
|
|
|
1295
1483
|
<dt class="tag-source">Source:</dt>
|
|
1296
1484
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
1297
|
-
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#
|
|
1485
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line173">line 173</a>
|
|
1298
1486
|
</li></ul></dd>
|
|
1299
1487
|
|
|
1300
1488
|
|
|
@@ -1673,7 +1861,7 @@
|
|
|
1673
1861
|
|
|
1674
1862
|
<dt class="tag-source">Source:</dt>
|
|
1675
1863
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
1676
|
-
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#
|
|
1864
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line187">line 187</a>
|
|
1677
1865
|
</li></ul></dd>
|
|
1678
1866
|
|
|
1679
1867
|
|
|
@@ -1855,13 +2043,14 @@
|
|
|
1855
2043
|
<dl class="details">
|
|
1856
2044
|
|
|
1857
2045
|
<dt class="tag-description">Description:</dt>
|
|
1858
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetches posts for the given thread
|
|
2046
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetches posts for the given thread.
|
|
2047
|
+
Automatically marks the thread as read when posts are fetched.</li></ul></dd>
|
|
1859
2048
|
|
|
1860
2049
|
|
|
1861
2050
|
|
|
1862
2051
|
<dt class="tag-source">Source:</dt>
|
|
1863
2052
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
1864
|
-
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#
|
|
2053
|
+
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line49">line 49</a>
|
|
1865
2054
|
</li></ul></dd>
|
|
1866
2055
|
|
|
1867
2056
|
|
|
@@ -2125,7 +2314,7 @@
|
|
|
2125
2314
|
|
|
2126
2315
|
<dt class="tag-source">Source:</dt>
|
|
2127
2316
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
2128
|
-
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#
|
|
2317
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line97">line 97</a>
|
|
2129
2318
|
</li></ul></dd>
|
|
2130
2319
|
|
|
2131
2320
|
|
|
@@ -2450,7 +2639,7 @@
|
|
|
2450
2639
|
|
|
2451
2640
|
|
|
2452
2641
|
|
|
2453
|
-
<td class="description last">The ID of the thread to
|
|
2642
|
+
<td class="description last">The ID of the thread to follow.</td>
|
|
2454
2643
|
</tr>
|
|
2455
2644
|
|
|
2456
2645
|
|
|
@@ -2530,7 +2719,7 @@
|
|
|
2530
2719
|
|
|
2531
2720
|
|
|
2532
2721
|
<div class="param-desc">
|
|
2533
|
-
- A promise that resolves when the thread is
|
|
2722
|
+
- A promise that resolves when the thread is followed.
|
|
2534
2723
|
</div>
|
|
2535
2724
|
|
|
2536
2725
|
|
|
@@ -2567,13 +2756,14 @@
|
|
|
2567
2756
|
<dl class="details">
|
|
2568
2757
|
|
|
2569
2758
|
<dt class="tag-description">Description:</dt>
|
|
2570
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetches posts for the given post, jumping to the post's location in the thread
|
|
2759
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetches posts for the given post, jumping to the post's location in the thread.
|
|
2760
|
+
Automatically marks the thread as read when posts are fetched.</li></ul></dd>
|
|
2571
2761
|
|
|
2572
2762
|
|
|
2573
2763
|
|
|
2574
2764
|
<dt class="tag-source">Source:</dt>
|
|
2575
2765
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
2576
|
-
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#
|
|
2766
|
+
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line174">line 174</a>
|
|
2577
2767
|
</li></ul></dd>
|
|
2578
2768
|
|
|
2579
2769
|
|
|
@@ -2837,7 +3027,7 @@
|
|
|
2837
3027
|
|
|
2838
3028
|
<dt class="tag-source">Source:</dt>
|
|
2839
3029
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
2840
|
-
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#
|
|
3030
|
+
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line85">line 85</a>
|
|
2841
3031
|
</li></ul></dd>
|
|
2842
3032
|
|
|
2843
3033
|
|
|
@@ -3049,7 +3239,7 @@
|
|
|
3049
3239
|
|
|
3050
3240
|
<dt class="tag-source">Source:</dt>
|
|
3051
3241
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
3052
|
-
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#
|
|
3242
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line147">line 147</a>
|
|
3053
3243
|
</li></ul></dd>
|
|
3054
3244
|
|
|
3055
3245
|
|
|
@@ -3245,7 +3435,7 @@
|
|
|
3245
3435
|
|
|
3246
3436
|
|
|
3247
3437
|
|
|
3248
|
-
<h4 class="name" id="~
|
|
3438
|
+
<h4 class="name" id="~markThreadAsRead"><span class="type-signature type-signature-async, inner">(async, inner) </span>markThreadAsRead<span class="signature">(threadId, brand)</span><span class="type-signature"> → {Promise.<void>}</span></h4>
|
|
3249
3439
|
|
|
3250
3440
|
|
|
3251
3441
|
|
|
@@ -3255,13 +3445,13 @@
|
|
|
3255
3445
|
<dl class="details">
|
|
3256
3446
|
|
|
3257
3447
|
<dt class="tag-description">Description:</dt>
|
|
3258
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
3448
|
+
<dd class="tag-description"><ul class="dummy"><li>Marks a thread as read for the authenticated user.</li></ul></dd>
|
|
3259
3449
|
|
|
3260
3450
|
|
|
3261
3451
|
|
|
3262
3452
|
<dt class="tag-source">Source:</dt>
|
|
3263
3453
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
3264
|
-
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#
|
|
3454
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line78">line 78</a>
|
|
3265
3455
|
</li></ul></dd>
|
|
3266
3456
|
|
|
3267
3457
|
|
|
@@ -3350,7 +3540,7 @@
|
|
|
3350
3540
|
|
|
3351
3541
|
|
|
3352
3542
|
|
|
3353
|
-
<td class="description last">The ID of the thread to
|
|
3543
|
+
<td class="description last">The ID of the thread to mark as read.</td>
|
|
3354
3544
|
</tr>
|
|
3355
3545
|
|
|
3356
3546
|
|
|
@@ -3430,7 +3620,7 @@
|
|
|
3430
3620
|
|
|
3431
3621
|
|
|
3432
3622
|
<div class="param-desc">
|
|
3433
|
-
- A promise that resolves when the thread is
|
|
3623
|
+
- A promise that resolves when the thread is marked as read.
|
|
3434
3624
|
</div>
|
|
3435
3625
|
|
|
3436
3626
|
|
|
@@ -3457,7 +3647,7 @@
|
|
|
3457
3647
|
|
|
3458
3648
|
|
|
3459
3649
|
|
|
3460
|
-
<h4 class="name" id="~
|
|
3650
|
+
<h4 class="name" id="~pinThread"><span class="type-signature type-signature-async, inner">(async, inner) </span>pinThread<span class="signature">(threadId, brand)</span><span class="type-signature"> → {Promise.<void>}</span></h4>
|
|
3461
3651
|
|
|
3462
3652
|
|
|
3463
3653
|
|
|
@@ -3467,13 +3657,13 @@
|
|
|
3467
3657
|
<dl class="details">
|
|
3468
3658
|
|
|
3469
3659
|
<dt class="tag-description">Description:</dt>
|
|
3470
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
3660
|
+
<dd class="tag-description"><ul class="dummy"><li>Pins a thread to the top of its category.</li></ul></dd>
|
|
3471
3661
|
|
|
3472
3662
|
|
|
3473
3663
|
|
|
3474
3664
|
<dt class="tag-source">Source:</dt>
|
|
3475
3665
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
3476
|
-
<a href="
|
|
3666
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line121">line 121</a>
|
|
3477
3667
|
</li></ul></dd>
|
|
3478
3668
|
|
|
3479
3669
|
|
|
@@ -3533,8 +3723,6 @@
|
|
|
3533
3723
|
<th>Type</th>
|
|
3534
3724
|
|
|
3535
3725
|
|
|
3536
|
-
<th>Attributes</th>
|
|
3537
|
-
|
|
3538
3726
|
|
|
3539
3727
|
|
|
3540
3728
|
|
|
@@ -3547,13 +3735,13 @@
|
|
|
3547
3735
|
|
|
3548
3736
|
<tr>
|
|
3549
3737
|
|
|
3550
|
-
<td class="name"><code>
|
|
3738
|
+
<td class="name"><code>threadId</code></td>
|
|
3551
3739
|
|
|
3552
3740
|
|
|
3553
3741
|
<td class="type">
|
|
3554
3742
|
|
|
3555
3743
|
|
|
3556
|
-
<span class="param-type">
|
|
3744
|
+
<span class="param-type">number</span>
|
|
3557
3745
|
|
|
3558
3746
|
|
|
3559
3747
|
|
|
@@ -3561,31 +3749,23 @@
|
|
|
3561
3749
|
</td>
|
|
3562
3750
|
|
|
3563
3751
|
|
|
3564
|
-
<td class="attributes">
|
|
3565
|
-
|
|
3566
|
-
|
|
3567
|
-
|
|
3568
|
-
|
|
3569
|
-
|
|
3570
|
-
</td>
|
|
3571
|
-
|
|
3572
3752
|
|
|
3573
3753
|
|
|
3574
3754
|
|
|
3575
|
-
<td class="description last">The
|
|
3755
|
+
<td class="description last">The ID of the thread to pin.</td>
|
|
3576
3756
|
</tr>
|
|
3577
3757
|
|
|
3578
3758
|
|
|
3579
3759
|
|
|
3580
3760
|
<tr>
|
|
3581
3761
|
|
|
3582
|
-
<td class="name"><code>
|
|
3762
|
+
<td class="name"><code>brand</code></td>
|
|
3583
3763
|
|
|
3584
3764
|
|
|
3585
3765
|
<td class="type">
|
|
3586
3766
|
|
|
3587
3767
|
|
|
3588
|
-
<span class="param-type">
|
|
3768
|
+
<span class="param-type">string</span>
|
|
3589
3769
|
|
|
3590
3770
|
|
|
3591
3771
|
|
|
@@ -3593,20 +3773,10 @@
|
|
|
3593
3773
|
</td>
|
|
3594
3774
|
|
|
3595
3775
|
|
|
3596
|
-
<td class="attributes">
|
|
3597
|
-
|
|
3598
|
-
<optional><br>
|
|
3599
|
-
|
|
3600
|
-
|
|
3601
|
-
|
|
3602
|
-
|
|
3603
|
-
|
|
3604
|
-
</td>
|
|
3605
|
-
|
|
3606
3776
|
|
|
3607
3777
|
|
|
3608
3778
|
|
|
3609
|
-
<td class="description last">
|
|
3779
|
+
<td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
|
|
3610
3780
|
</tr>
|
|
3611
3781
|
|
|
3612
3782
|
|
|
@@ -3662,7 +3832,7 @@
|
|
|
3662
3832
|
|
|
3663
3833
|
|
|
3664
3834
|
<div class="param-desc">
|
|
3665
|
-
-
|
|
3835
|
+
- A promise that resolves when the thread is pinned.
|
|
3666
3836
|
</div>
|
|
3667
3837
|
|
|
3668
3838
|
|
|
@@ -3673,7 +3843,7 @@
|
|
|
3673
3843
|
</dt>
|
|
3674
3844
|
<dd>
|
|
3675
3845
|
|
|
3676
|
-
<span class="param-type">Promise.<
|
|
3846
|
+
<span class="param-type">Promise.<void></span>
|
|
3677
3847
|
|
|
3678
3848
|
|
|
3679
3849
|
|
|
@@ -3689,7 +3859,7 @@
|
|
|
3689
3859
|
|
|
3690
3860
|
|
|
3691
3861
|
|
|
3692
|
-
<h4 class="name" id="~
|
|
3862
|
+
<h4 class="name" id="~search"><span class="type-signature type-signature-async, inner">(async, inner) </span>search<span class="signature">(brand, params<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<<a href="global.html#PaginatedResponse">PaginatedResponse</a>.<ForumPost>>}</span></h4>
|
|
3693
3863
|
|
|
3694
3864
|
|
|
3695
3865
|
|
|
@@ -3699,13 +3869,13 @@
|
|
|
3699
3869
|
<dl class="details">
|
|
3700
3870
|
|
|
3701
3871
|
<dt class="tag-description">Description:</dt>
|
|
3702
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
3872
|
+
<dd class="tag-description"><ul class="dummy"><li>Search forum posts.</li></ul></dd>
|
|
3703
3873
|
|
|
3704
3874
|
|
|
3705
3875
|
|
|
3706
3876
|
<dt class="tag-source">Source:</dt>
|
|
3707
3877
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
3708
|
-
<a href="
|
|
3878
|
+
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line147">line 147</a>
|
|
3709
3879
|
</li></ul></dd>
|
|
3710
3880
|
|
|
3711
3881
|
|
|
@@ -3765,6 +3935,8 @@
|
|
|
3765
3935
|
<th>Type</th>
|
|
3766
3936
|
|
|
3767
3937
|
|
|
3938
|
+
<th>Attributes</th>
|
|
3939
|
+
|
|
3768
3940
|
|
|
3769
3941
|
|
|
3770
3942
|
|
|
@@ -3777,13 +3949,13 @@
|
|
|
3777
3949
|
|
|
3778
3950
|
<tr>
|
|
3779
3951
|
|
|
3780
|
-
<td class="name"><code>
|
|
3952
|
+
<td class="name"><code>brand</code></td>
|
|
3781
3953
|
|
|
3782
3954
|
|
|
3783
3955
|
<td class="type">
|
|
3784
3956
|
|
|
3785
3957
|
|
|
3786
|
-
<span class="param-type">
|
|
3958
|
+
<span class="param-type">string</span>
|
|
3787
3959
|
|
|
3788
3960
|
|
|
3789
3961
|
|
|
@@ -3791,23 +3963,31 @@
|
|
|
3791
3963
|
</td>
|
|
3792
3964
|
|
|
3793
3965
|
|
|
3966
|
+
<td class="attributes">
|
|
3967
|
+
|
|
3968
|
+
|
|
3969
|
+
|
|
3970
|
+
|
|
3971
|
+
|
|
3972
|
+
</td>
|
|
3973
|
+
|
|
3794
3974
|
|
|
3795
3975
|
|
|
3796
3976
|
|
|
3797
|
-
<td class="description last">The
|
|
3977
|
+
<td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
|
|
3798
3978
|
</tr>
|
|
3799
3979
|
|
|
3800
3980
|
|
|
3801
3981
|
|
|
3802
3982
|
<tr>
|
|
3803
3983
|
|
|
3804
|
-
<td class="name"><code>
|
|
3984
|
+
<td class="name"><code>params</code></td>
|
|
3805
3985
|
|
|
3806
3986
|
|
|
3807
3987
|
<td class="type">
|
|
3808
3988
|
|
|
3809
3989
|
|
|
3810
|
-
<span class="param-type">
|
|
3990
|
+
<span class="param-type">SearchParams</span>
|
|
3811
3991
|
|
|
3812
3992
|
|
|
3813
3993
|
|
|
@@ -3815,10 +3995,20 @@
|
|
|
3815
3995
|
</td>
|
|
3816
3996
|
|
|
3817
3997
|
|
|
3998
|
+
<td class="attributes">
|
|
3999
|
+
|
|
4000
|
+
<optional><br>
|
|
4001
|
+
|
|
4002
|
+
|
|
4003
|
+
|
|
4004
|
+
|
|
4005
|
+
|
|
4006
|
+
</td>
|
|
4007
|
+
|
|
3818
4008
|
|
|
3819
4009
|
|
|
3820
4010
|
|
|
3821
|
-
<td class="description last">
|
|
4011
|
+
<td class="description last">Optional search parameters such as `query`, `page`, `limit`, and `sort`.</td>
|
|
3822
4012
|
</tr>
|
|
3823
4013
|
|
|
3824
4014
|
|
|
@@ -3874,7 +4064,219 @@
|
|
|
3874
4064
|
|
|
3875
4065
|
|
|
3876
4066
|
<div class="param-desc">
|
|
3877
|
-
-
|
|
4067
|
+
- Resolves to a paginated list of forum posts.
|
|
4068
|
+
</div>
|
|
4069
|
+
|
|
4070
|
+
|
|
4071
|
+
|
|
4072
|
+
<dl class="param-type">
|
|
4073
|
+
<dt>
|
|
4074
|
+
Type
|
|
4075
|
+
</dt>
|
|
4076
|
+
<dd>
|
|
4077
|
+
|
|
4078
|
+
<span class="param-type">Promise.<<a href="global.html#PaginatedResponse">PaginatedResponse</a>.<ForumPost>></span>
|
|
4079
|
+
|
|
4080
|
+
|
|
4081
|
+
|
|
4082
|
+
</dd>
|
|
4083
|
+
</dl>
|
|
4084
|
+
|
|
4085
|
+
|
|
4086
|
+
|
|
4087
|
+
|
|
4088
|
+
|
|
4089
|
+
|
|
4090
|
+
|
|
4091
|
+
|
|
4092
|
+
|
|
4093
|
+
|
|
4094
|
+
<h4 class="name" id="~unfollowThread"><span class="type-signature type-signature-async, inner">(async, inner) </span>unfollowThread<span class="signature">(threadId, brand)</span><span class="type-signature"> → {Promise.<void>}</span></h4>
|
|
4095
|
+
|
|
4096
|
+
|
|
4097
|
+
|
|
4098
|
+
|
|
4099
|
+
|
|
4100
|
+
|
|
4101
|
+
<dl class="details">
|
|
4102
|
+
|
|
4103
|
+
<dt class="tag-description">Description:</dt>
|
|
4104
|
+
<dd class="tag-description"><ul class="dummy"><li>Unfollow a thread to allow further posts.</li></ul></dd>
|
|
4105
|
+
|
|
4106
|
+
|
|
4107
|
+
|
|
4108
|
+
<dt class="tag-source">Source:</dt>
|
|
4109
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
4110
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line65">line 65</a>
|
|
4111
|
+
</li></ul></dd>
|
|
4112
|
+
|
|
4113
|
+
|
|
4114
|
+
|
|
4115
|
+
|
|
4116
|
+
|
|
4117
|
+
|
|
4118
|
+
|
|
4119
|
+
|
|
4120
|
+
|
|
4121
|
+
|
|
4122
|
+
|
|
4123
|
+
|
|
4124
|
+
|
|
4125
|
+
|
|
4126
|
+
|
|
4127
|
+
|
|
4128
|
+
|
|
4129
|
+
|
|
4130
|
+
|
|
4131
|
+
|
|
4132
|
+
|
|
4133
|
+
|
|
4134
|
+
|
|
4135
|
+
|
|
4136
|
+
|
|
4137
|
+
|
|
4138
|
+
|
|
4139
|
+
|
|
4140
|
+
|
|
4141
|
+
|
|
4142
|
+
|
|
4143
|
+
</dl>
|
|
4144
|
+
|
|
4145
|
+
|
|
4146
|
+
|
|
4147
|
+
|
|
4148
|
+
|
|
4149
|
+
|
|
4150
|
+
|
|
4151
|
+
|
|
4152
|
+
|
|
4153
|
+
|
|
4154
|
+
|
|
4155
|
+
|
|
4156
|
+
|
|
4157
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
4158
|
+
|
|
4159
|
+
|
|
4160
|
+
<table class="params">
|
|
4161
|
+
<thead>
|
|
4162
|
+
<tr>
|
|
4163
|
+
|
|
4164
|
+
<th>Name</th>
|
|
4165
|
+
|
|
4166
|
+
|
|
4167
|
+
<th>Type</th>
|
|
4168
|
+
|
|
4169
|
+
|
|
4170
|
+
|
|
4171
|
+
|
|
4172
|
+
|
|
4173
|
+
<th class="last">Description</th>
|
|
4174
|
+
</tr>
|
|
4175
|
+
</thead>
|
|
4176
|
+
|
|
4177
|
+
<tbody>
|
|
4178
|
+
|
|
4179
|
+
|
|
4180
|
+
<tr>
|
|
4181
|
+
|
|
4182
|
+
<td class="name"><code>threadId</code></td>
|
|
4183
|
+
|
|
4184
|
+
|
|
4185
|
+
<td class="type">
|
|
4186
|
+
|
|
4187
|
+
|
|
4188
|
+
<span class="param-type">number</span>
|
|
4189
|
+
|
|
4190
|
+
|
|
4191
|
+
|
|
4192
|
+
|
|
4193
|
+
</td>
|
|
4194
|
+
|
|
4195
|
+
|
|
4196
|
+
|
|
4197
|
+
|
|
4198
|
+
|
|
4199
|
+
<td class="description last">The ID of the thread to unfollow.</td>
|
|
4200
|
+
</tr>
|
|
4201
|
+
|
|
4202
|
+
|
|
4203
|
+
|
|
4204
|
+
<tr>
|
|
4205
|
+
|
|
4206
|
+
<td class="name"><code>brand</code></td>
|
|
4207
|
+
|
|
4208
|
+
|
|
4209
|
+
<td class="type">
|
|
4210
|
+
|
|
4211
|
+
|
|
4212
|
+
<span class="param-type">string</span>
|
|
4213
|
+
|
|
4214
|
+
|
|
4215
|
+
|
|
4216
|
+
|
|
4217
|
+
</td>
|
|
4218
|
+
|
|
4219
|
+
|
|
4220
|
+
|
|
4221
|
+
|
|
4222
|
+
|
|
4223
|
+
<td class="description last">The brand associated with the unfollow action.</td>
|
|
4224
|
+
</tr>
|
|
4225
|
+
|
|
4226
|
+
|
|
4227
|
+
</tbody>
|
|
4228
|
+
</table>
|
|
4229
|
+
|
|
4230
|
+
|
|
4231
|
+
|
|
4232
|
+
|
|
4233
|
+
|
|
4234
|
+
|
|
4235
|
+
|
|
4236
|
+
|
|
4237
|
+
|
|
4238
|
+
|
|
4239
|
+
|
|
4240
|
+
|
|
4241
|
+
|
|
4242
|
+
|
|
4243
|
+
<h5 class="h5-throws">Throws:</h5>
|
|
4244
|
+
|
|
4245
|
+
|
|
4246
|
+
|
|
4247
|
+
<dl>
|
|
4248
|
+
<dt>
|
|
4249
|
+
<div class="param-desc usertext">
|
|
4250
|
+
- If the request fails.
|
|
4251
|
+
</div>
|
|
4252
|
+
</dt>
|
|
4253
|
+
<dd></dd>
|
|
4254
|
+
<dt>
|
|
4255
|
+
<dl class="param-type">
|
|
4256
|
+
<dt>
|
|
4257
|
+
Type
|
|
4258
|
+
</dt>
|
|
4259
|
+
<dd>
|
|
4260
|
+
|
|
4261
|
+
<span class="param-type">HttpError</span>
|
|
4262
|
+
|
|
4263
|
+
|
|
4264
|
+
|
|
4265
|
+
</dd>
|
|
4266
|
+
</dl>
|
|
4267
|
+
</dt>
|
|
4268
|
+
<dd></dd>
|
|
4269
|
+
</dl>
|
|
4270
|
+
|
|
4271
|
+
|
|
4272
|
+
|
|
4273
|
+
|
|
4274
|
+
|
|
4275
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
4276
|
+
|
|
4277
|
+
|
|
4278
|
+
<div class="param-desc">
|
|
4279
|
+
- A promise that resolves when the thread is unfollowed.
|
|
3878
4280
|
</div>
|
|
3879
4281
|
|
|
3880
4282
|
|
|
@@ -3917,7 +4319,7 @@
|
|
|
3917
4319
|
|
|
3918
4320
|
<dt class="tag-source">Source:</dt>
|
|
3919
4321
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
3920
|
-
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#
|
|
4322
|
+
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line98">line 98</a>
|
|
3921
4323
|
</li></ul></dd>
|
|
3922
4324
|
|
|
3923
4325
|
|
|
@@ -4129,7 +4531,7 @@
|
|
|
4129
4531
|
|
|
4130
4532
|
<dt class="tag-source">Source:</dt>
|
|
4131
4533
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
4132
|
-
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#
|
|
4534
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line160">line 160</a>
|
|
4133
4535
|
</li></ul></dd>
|
|
4134
4536
|
|
|
4135
4537
|
|
|
@@ -4341,7 +4743,7 @@
|
|
|
4341
4743
|
|
|
4342
4744
|
<dt class="tag-source">Source:</dt>
|
|
4343
4745
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
4344
|
-
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#
|
|
4746
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line134">line 134</a>
|
|
4345
4747
|
</li></ul></dd>
|
|
4346
4748
|
|
|
4347
4749
|
|
|
@@ -4741,7 +5143,7 @@
|
|
|
4741
5143
|
|
|
4742
5144
|
<dt class="tag-source">Source:</dt>
|
|
4743
5145
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
4744
|
-
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#
|
|
5146
|
+
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line30">line 30</a>
|
|
4745
5147
|
</li></ul></dd>
|
|
4746
5148
|
|
|
4747
5149
|
|
|
@@ -5399,7 +5801,7 @@
|
|
|
5399
5801
|
|
|
5400
5802
|
<dt class="tag-source">Source:</dt>
|
|
5401
5803
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
5402
|
-
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#
|
|
5804
|
+
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line17">line 17</a>
|
|
5403
5805
|
</li></ul></dd>
|
|
5404
5806
|
|
|
5405
5807
|
|
|
@@ -5474,17 +5876,205 @@
|
|
|
5474
5876
|
<td class="name"><code>threadId</code></td>
|
|
5475
5877
|
|
|
5476
5878
|
|
|
5477
|
-
<td class="type">
|
|
5478
|
-
|
|
5479
|
-
</td>
|
|
5879
|
+
<td class="type">
|
|
5880
|
+
|
|
5881
|
+
</td>
|
|
5882
|
+
|
|
5883
|
+
|
|
5884
|
+
|
|
5885
|
+
|
|
5886
|
+
|
|
5887
|
+
<td class="description last"></td>
|
|
5888
|
+
</tr>
|
|
5889
|
+
|
|
5890
|
+
|
|
5891
|
+
|
|
5892
|
+
<tr>
|
|
5893
|
+
|
|
5894
|
+
<td class="name"><code>params</code></td>
|
|
5895
|
+
|
|
5896
|
+
|
|
5897
|
+
<td class="type">
|
|
5898
|
+
|
|
5899
|
+
|
|
5900
|
+
<span class="param-type">CreatePostParams</span>
|
|
5901
|
+
|
|
5902
|
+
|
|
5903
|
+
|
|
5904
|
+
|
|
5905
|
+
</td>
|
|
5906
|
+
|
|
5907
|
+
|
|
5908
|
+
|
|
5909
|
+
|
|
5910
|
+
|
|
5911
|
+
<td class="description last">The parameters for creating the post.</td>
|
|
5912
|
+
</tr>
|
|
5913
|
+
|
|
5914
|
+
|
|
5915
|
+
</tbody>
|
|
5916
|
+
</table>
|
|
5917
|
+
|
|
5918
|
+
|
|
5919
|
+
|
|
5920
|
+
|
|
5921
|
+
|
|
5922
|
+
|
|
5923
|
+
|
|
5924
|
+
|
|
5925
|
+
|
|
5926
|
+
|
|
5927
|
+
|
|
5928
|
+
|
|
5929
|
+
|
|
5930
|
+
|
|
5931
|
+
<h5 class="h5-throws">Throws:</h5>
|
|
5932
|
+
|
|
5933
|
+
|
|
5934
|
+
|
|
5935
|
+
<dl>
|
|
5936
|
+
<dt>
|
|
5937
|
+
<div class="param-desc usertext">
|
|
5938
|
+
- If the request fails.
|
|
5939
|
+
</div>
|
|
5940
|
+
</dt>
|
|
5941
|
+
<dd></dd>
|
|
5942
|
+
<dt>
|
|
5943
|
+
<dl class="param-type">
|
|
5944
|
+
<dt>
|
|
5945
|
+
Type
|
|
5946
|
+
</dt>
|
|
5947
|
+
<dd>
|
|
5948
|
+
|
|
5949
|
+
<span class="param-type">HttpError</span>
|
|
5950
|
+
|
|
5951
|
+
|
|
5952
|
+
|
|
5953
|
+
</dd>
|
|
5954
|
+
</dl>
|
|
5955
|
+
</dt>
|
|
5956
|
+
<dd></dd>
|
|
5957
|
+
</dl>
|
|
5958
|
+
|
|
5959
|
+
|
|
5960
|
+
|
|
5961
|
+
|
|
5962
|
+
|
|
5963
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
5964
|
+
|
|
5965
|
+
|
|
5966
|
+
<div class="param-desc">
|
|
5967
|
+
- A promise that resolves to the created post.
|
|
5968
|
+
</div>
|
|
5969
|
+
|
|
5970
|
+
|
|
5971
|
+
|
|
5972
|
+
<dl class="param-type">
|
|
5973
|
+
<dt>
|
|
5974
|
+
Type
|
|
5975
|
+
</dt>
|
|
5976
|
+
<dd>
|
|
5977
|
+
|
|
5978
|
+
<span class="param-type">Promise.<ForumPost></span>
|
|
5979
|
+
|
|
5980
|
+
|
|
5981
|
+
|
|
5982
|
+
</dd>
|
|
5983
|
+
</dl>
|
|
5984
|
+
|
|
5985
|
+
|
|
5986
|
+
|
|
5987
|
+
|
|
5988
|
+
|
|
5989
|
+
|
|
5990
|
+
|
|
5991
|
+
|
|
5992
|
+
|
|
5993
|
+
|
|
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>
|
|
5995
|
+
|
|
5996
|
+
|
|
5997
|
+
|
|
5998
|
+
|
|
5999
|
+
|
|
6000
|
+
|
|
6001
|
+
<dl class="details">
|
|
6002
|
+
|
|
6003
|
+
<dt class="tag-description">Description:</dt>
|
|
6004
|
+
<dd class="tag-description"><ul class="dummy"><li>Creates a new thread under a forum category.</li></ul></dd>
|
|
6005
|
+
|
|
6006
|
+
|
|
6007
|
+
|
|
6008
|
+
<dt class="tag-source">Source:</dt>
|
|
6009
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
6010
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line17">line 17</a>
|
|
6011
|
+
</li></ul></dd>
|
|
6012
|
+
|
|
6013
|
+
|
|
6014
|
+
|
|
6015
|
+
|
|
6016
|
+
|
|
6017
|
+
|
|
6018
|
+
|
|
6019
|
+
|
|
6020
|
+
|
|
6021
|
+
|
|
6022
|
+
|
|
6023
|
+
|
|
6024
|
+
|
|
6025
|
+
|
|
6026
|
+
|
|
6027
|
+
|
|
6028
|
+
|
|
6029
|
+
|
|
6030
|
+
|
|
6031
|
+
|
|
6032
|
+
|
|
6033
|
+
|
|
6034
|
+
|
|
6035
|
+
|
|
6036
|
+
|
|
6037
|
+
|
|
6038
|
+
|
|
6039
|
+
|
|
6040
|
+
|
|
6041
|
+
|
|
6042
|
+
|
|
6043
|
+
</dl>
|
|
6044
|
+
|
|
6045
|
+
|
|
6046
|
+
|
|
6047
|
+
|
|
6048
|
+
|
|
6049
|
+
|
|
6050
|
+
|
|
6051
|
+
|
|
6052
|
+
|
|
6053
|
+
|
|
6054
|
+
|
|
6055
|
+
|
|
6056
|
+
|
|
6057
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
6058
|
+
|
|
6059
|
+
|
|
6060
|
+
<table class="params">
|
|
6061
|
+
<thead>
|
|
6062
|
+
<tr>
|
|
6063
|
+
|
|
6064
|
+
<th>Name</th>
|
|
6065
|
+
|
|
6066
|
+
|
|
6067
|
+
<th>Type</th>
|
|
5480
6068
|
|
|
5481
|
-
|
|
6069
|
+
|
|
5482
6070
|
|
|
5483
|
-
|
|
6071
|
+
|
|
5484
6072
|
|
|
5485
|
-
|
|
5486
|
-
|
|
6073
|
+
<th class="last">Description</th>
|
|
6074
|
+
</tr>
|
|
6075
|
+
</thead>
|
|
5487
6076
|
|
|
6077
|
+
<tbody>
|
|
5488
6078
|
|
|
5489
6079
|
|
|
5490
6080
|
<tr>
|
|
@@ -5495,7 +6085,7 @@
|
|
|
5495
6085
|
<td class="type">
|
|
5496
6086
|
|
|
5497
6087
|
|
|
5498
|
-
<span class="param-type">
|
|
6088
|
+
<span class="param-type">CreateThreadParams</span>
|
|
5499
6089
|
|
|
5500
6090
|
|
|
5501
6091
|
|
|
@@ -5506,7 +6096,7 @@
|
|
|
5506
6096
|
|
|
5507
6097
|
|
|
5508
6098
|
|
|
5509
|
-
<td class="description last">The parameters for creating the
|
|
6099
|
+
<td class="description last">The parameters for creating the thread.</td>
|
|
5510
6100
|
</tr>
|
|
5511
6101
|
|
|
5512
6102
|
|
|
@@ -5562,7 +6152,7 @@
|
|
|
5562
6152
|
|
|
5563
6153
|
|
|
5564
6154
|
<div class="param-desc">
|
|
5565
|
-
- A promise that resolves to the created
|
|
6155
|
+
- A promise that resolves to the created thread.
|
|
5566
6156
|
</div>
|
|
5567
6157
|
|
|
5568
6158
|
|
|
@@ -5573,7 +6163,7 @@
|
|
|
5573
6163
|
</dt>
|
|
5574
6164
|
<dd>
|
|
5575
6165
|
|
|
5576
|
-
<span class="param-type">Promise.<
|
|
6166
|
+
<span class="param-type">Promise.<ForumThread></span>
|
|
5577
6167
|
|
|
5578
6168
|
|
|
5579
6169
|
|
|
@@ -5589,7 +6179,7 @@
|
|
|
5589
6179
|
|
|
5590
6180
|
|
|
5591
6181
|
|
|
5592
|
-
<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>
|
|
5593
6183
|
|
|
5594
6184
|
|
|
5595
6185
|
|
|
@@ -5599,13 +6189,13 @@
|
|
|
5599
6189
|
<dl class="details">
|
|
5600
6190
|
|
|
5601
6191
|
<dt class="tag-description">Description:</dt>
|
|
5602
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
6192
|
+
<dd class="tag-description"><ul class="dummy"><li>Deletes a forum category.</li></ul></dd>
|
|
5603
6193
|
|
|
5604
6194
|
|
|
5605
6195
|
|
|
5606
6196
|
<dt class="tag-source">Source:</dt>
|
|
5607
6197
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
5608
|
-
<a href="
|
|
6198
|
+
<a href="forums_categories.ts.html">forums/categories.ts</a>, <a href="forums_categories.ts.html#line72">line 72</a>
|
|
5609
6199
|
</li></ul></dd>
|
|
5610
6200
|
|
|
5611
6201
|
|
|
@@ -5683,7 +6273,7 @@
|
|
|
5683
6273
|
<td class="type">
|
|
5684
6274
|
|
|
5685
6275
|
|
|
5686
|
-
<span class="param-type">
|
|
6276
|
+
<span class="param-type">DeleteForumCategoryParams</span>
|
|
5687
6277
|
|
|
5688
6278
|
|
|
5689
6279
|
|
|
@@ -5694,7 +6284,7 @@
|
|
|
5694
6284
|
|
|
5695
6285
|
|
|
5696
6286
|
|
|
5697
|
-
<td class="description last">The parameters for
|
|
6287
|
+
<td class="description last">The parameters for deleting the forum category.</td>
|
|
5698
6288
|
</tr>
|
|
5699
6289
|
|
|
5700
6290
|
|
|
@@ -5750,7 +6340,7 @@
|
|
|
5750
6340
|
|
|
5751
6341
|
|
|
5752
6342
|
<div class="param-desc">
|
|
5753
|
-
- A promise that resolves
|
|
6343
|
+
- A promise that resolves when the category is deleted.
|
|
5754
6344
|
</div>
|
|
5755
6345
|
|
|
5756
6346
|
|
|
@@ -5761,7 +6351,7 @@
|
|
|
5761
6351
|
</dt>
|
|
5762
6352
|
<dd>
|
|
5763
6353
|
|
|
5764
|
-
<span class="param-type">Promise.<
|
|
6354
|
+
<span class="param-type">Promise.<void></span>
|
|
5765
6355
|
|
|
5766
6356
|
|
|
5767
6357
|
|
|
@@ -5793,7 +6383,7 @@
|
|
|
5793
6383
|
|
|
5794
6384
|
<dt class="tag-source">Source:</dt>
|
|
5795
6385
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
5796
|
-
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#
|
|
6386
|
+
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line112">line 112</a>
|
|
5797
6387
|
</li></ul></dd>
|
|
5798
6388
|
|
|
5799
6389
|
|
|
@@ -6005,7 +6595,7 @@
|
|
|
6005
6595
|
|
|
6006
6596
|
<dt class="tag-source">Source:</dt>
|
|
6007
6597
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
6008
|
-
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#
|
|
6598
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line201">line 201</a>
|
|
6009
6599
|
</li></ul></dd>
|
|
6010
6600
|
|
|
6011
6601
|
|
|
@@ -6217,7 +6807,7 @@
|
|
|
6217
6807
|
|
|
6218
6808
|
<dt class="tag-source">Source:</dt>
|
|
6219
6809
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
6220
|
-
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#
|
|
6810
|
+
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line125">line 125</a>
|
|
6221
6811
|
</li></ul></dd>
|
|
6222
6812
|
|
|
6223
6813
|
|
|
@@ -6405,7 +6995,7 @@
|
|
|
6405
6995
|
|
|
6406
6996
|
<dt class="tag-source">Source:</dt>
|
|
6407
6997
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
6408
|
-
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#
|
|
6998
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line173">line 173</a>
|
|
6409
6999
|
</li></ul></dd>
|
|
6410
7000
|
|
|
6411
7001
|
|
|
@@ -6784,7 +7374,7 @@
|
|
|
6784
7374
|
|
|
6785
7375
|
<dt class="tag-source">Source:</dt>
|
|
6786
7376
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
6787
|
-
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#
|
|
7377
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line187">line 187</a>
|
|
6788
7378
|
</li></ul></dd>
|
|
6789
7379
|
|
|
6790
7380
|
|
|
@@ -6966,13 +7556,14 @@
|
|
|
6966
7556
|
<dl class="details">
|
|
6967
7557
|
|
|
6968
7558
|
<dt class="tag-description">Description:</dt>
|
|
6969
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetches posts for the given thread
|
|
7559
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetches posts for the given thread.
|
|
7560
|
+
Automatically marks the thread as read when posts are fetched.</li></ul></dd>
|
|
6970
7561
|
|
|
6971
7562
|
|
|
6972
7563
|
|
|
6973
7564
|
<dt class="tag-source">Source:</dt>
|
|
6974
7565
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
6975
|
-
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#
|
|
7566
|
+
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line49">line 49</a>
|
|
6976
7567
|
</li></ul></dd>
|
|
6977
7568
|
|
|
6978
7569
|
|
|
@@ -7236,7 +7827,7 @@
|
|
|
7236
7827
|
|
|
7237
7828
|
<dt class="tag-source">Source:</dt>
|
|
7238
7829
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
7239
|
-
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#
|
|
7830
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line97">line 97</a>
|
|
7240
7831
|
</li></ul></dd>
|
|
7241
7832
|
|
|
7242
7833
|
|
|
@@ -7561,7 +8152,7 @@
|
|
|
7561
8152
|
|
|
7562
8153
|
|
|
7563
8154
|
|
|
7564
|
-
<td class="description last">The ID of the thread to
|
|
8155
|
+
<td class="description last">The ID of the thread to follow.</td>
|
|
7565
8156
|
</tr>
|
|
7566
8157
|
|
|
7567
8158
|
|
|
@@ -7641,7 +8232,7 @@
|
|
|
7641
8232
|
|
|
7642
8233
|
|
|
7643
8234
|
<div class="param-desc">
|
|
7644
|
-
- A promise that resolves when the thread is
|
|
8235
|
+
- A promise that resolves when the thread is followed.
|
|
7645
8236
|
</div>
|
|
7646
8237
|
|
|
7647
8238
|
|
|
@@ -7678,13 +8269,14 @@
|
|
|
7678
8269
|
<dl class="details">
|
|
7679
8270
|
|
|
7680
8271
|
<dt class="tag-description">Description:</dt>
|
|
7681
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetches posts for the given post, jumping to the post's location in the thread
|
|
8272
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetches posts for the given post, jumping to the post's location in the thread.
|
|
8273
|
+
Automatically marks the thread as read when posts are fetched.</li></ul></dd>
|
|
7682
8274
|
|
|
7683
8275
|
|
|
7684
8276
|
|
|
7685
8277
|
<dt class="tag-source">Source:</dt>
|
|
7686
8278
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
7687
|
-
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#
|
|
8279
|
+
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line174">line 174</a>
|
|
7688
8280
|
</li></ul></dd>
|
|
7689
8281
|
|
|
7690
8282
|
|
|
@@ -7807,28 +8399,250 @@
|
|
|
7807
8399
|
<td class="attributes">
|
|
7808
8400
|
|
|
7809
8401
|
|
|
7810
|
-
|
|
8402
|
+
|
|
8403
|
+
|
|
8404
|
+
|
|
8405
|
+
</td>
|
|
8406
|
+
|
|
8407
|
+
|
|
8408
|
+
|
|
8409
|
+
|
|
8410
|
+
<td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
|
|
8411
|
+
</tr>
|
|
8412
|
+
|
|
8413
|
+
|
|
8414
|
+
|
|
8415
|
+
<tr>
|
|
8416
|
+
|
|
8417
|
+
<td class="name"><code>params</code></td>
|
|
8418
|
+
|
|
8419
|
+
|
|
8420
|
+
<td class="type">
|
|
8421
|
+
|
|
8422
|
+
|
|
8423
|
+
<span class="param-type">FetchPostParams</span>
|
|
8424
|
+
|
|
8425
|
+
|
|
8426
|
+
|
|
8427
|
+
|
|
8428
|
+
</td>
|
|
8429
|
+
|
|
8430
|
+
|
|
8431
|
+
<td class="attributes">
|
|
8432
|
+
|
|
8433
|
+
<optional><br>
|
|
8434
|
+
|
|
8435
|
+
|
|
8436
|
+
|
|
8437
|
+
|
|
8438
|
+
|
|
8439
|
+
</td>
|
|
8440
|
+
|
|
8441
|
+
|
|
8442
|
+
|
|
8443
|
+
|
|
8444
|
+
<td class="description last">Optional parameters such as `page`, `limit`, and `sort`.</td>
|
|
8445
|
+
</tr>
|
|
8446
|
+
|
|
8447
|
+
|
|
8448
|
+
</tbody>
|
|
8449
|
+
</table>
|
|
8450
|
+
|
|
8451
|
+
|
|
8452
|
+
|
|
8453
|
+
|
|
8454
|
+
|
|
8455
|
+
|
|
8456
|
+
|
|
8457
|
+
|
|
8458
|
+
|
|
8459
|
+
|
|
8460
|
+
|
|
8461
|
+
|
|
8462
|
+
|
|
8463
|
+
|
|
8464
|
+
<h5 class="h5-throws">Throws:</h5>
|
|
8465
|
+
|
|
8466
|
+
|
|
8467
|
+
|
|
8468
|
+
<dl>
|
|
8469
|
+
<dt>
|
|
8470
|
+
<div class="param-desc usertext">
|
|
8471
|
+
- If the request fails.
|
|
8472
|
+
</div>
|
|
8473
|
+
</dt>
|
|
8474
|
+
<dd></dd>
|
|
8475
|
+
<dt>
|
|
8476
|
+
<dl class="param-type">
|
|
8477
|
+
<dt>
|
|
8478
|
+
Type
|
|
8479
|
+
</dt>
|
|
8480
|
+
<dd>
|
|
8481
|
+
|
|
8482
|
+
<span class="param-type">HttpError</span>
|
|
8483
|
+
|
|
8484
|
+
|
|
8485
|
+
|
|
8486
|
+
</dd>
|
|
8487
|
+
</dl>
|
|
8488
|
+
</dt>
|
|
8489
|
+
<dd></dd>
|
|
8490
|
+
</dl>
|
|
8491
|
+
|
|
8492
|
+
|
|
8493
|
+
|
|
8494
|
+
|
|
8495
|
+
|
|
8496
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
8497
|
+
|
|
8498
|
+
|
|
8499
|
+
<div class="param-desc">
|
|
8500
|
+
- Resolves to a paginated list of forum posts.
|
|
8501
|
+
</div>
|
|
8502
|
+
|
|
8503
|
+
|
|
8504
|
+
|
|
8505
|
+
<dl class="param-type">
|
|
8506
|
+
<dt>
|
|
8507
|
+
Type
|
|
8508
|
+
</dt>
|
|
8509
|
+
<dd>
|
|
8510
|
+
|
|
8511
|
+
<span class="param-type">Promise.<<a href="global.html#PaginatedResponse">PaginatedResponse</a>.<ForumPost>></span>
|
|
8512
|
+
|
|
8513
|
+
|
|
8514
|
+
|
|
8515
|
+
</dd>
|
|
8516
|
+
</dl>
|
|
8517
|
+
|
|
8518
|
+
|
|
8519
|
+
|
|
8520
|
+
|
|
8521
|
+
|
|
8522
|
+
|
|
8523
|
+
|
|
8524
|
+
|
|
8525
|
+
|
|
8526
|
+
|
|
8527
|
+
<h4 class="name" id="~likePost"><span class="type-signature type-signature-async, inner">(async, inner) </span>likePost<span class="signature">(postId, brand)</span><span class="type-signature"> → {Promise.<void>}</span></h4>
|
|
8528
|
+
|
|
8529
|
+
|
|
8530
|
+
|
|
8531
|
+
|
|
8532
|
+
|
|
8533
|
+
|
|
8534
|
+
<dl class="details">
|
|
8535
|
+
|
|
8536
|
+
<dt class="tag-description">Description:</dt>
|
|
8537
|
+
<dd class="tag-description"><ul class="dummy"><li>Like a forum post.</li></ul></dd>
|
|
8538
|
+
|
|
8539
|
+
|
|
8540
|
+
|
|
8541
|
+
<dt class="tag-source">Source:</dt>
|
|
8542
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
8543
|
+
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line85">line 85</a>
|
|
8544
|
+
</li></ul></dd>
|
|
8545
|
+
|
|
8546
|
+
|
|
8547
|
+
|
|
8548
|
+
|
|
8549
|
+
|
|
8550
|
+
|
|
8551
|
+
|
|
8552
|
+
|
|
8553
|
+
|
|
8554
|
+
|
|
8555
|
+
|
|
8556
|
+
|
|
8557
|
+
|
|
8558
|
+
|
|
8559
|
+
|
|
8560
|
+
|
|
8561
|
+
|
|
8562
|
+
|
|
8563
|
+
|
|
8564
|
+
|
|
8565
|
+
|
|
8566
|
+
|
|
8567
|
+
|
|
8568
|
+
|
|
8569
|
+
|
|
8570
|
+
|
|
8571
|
+
|
|
8572
|
+
|
|
8573
|
+
|
|
8574
|
+
|
|
8575
|
+
|
|
8576
|
+
</dl>
|
|
8577
|
+
|
|
8578
|
+
|
|
8579
|
+
|
|
8580
|
+
|
|
8581
|
+
|
|
8582
|
+
|
|
8583
|
+
|
|
8584
|
+
|
|
8585
|
+
|
|
8586
|
+
|
|
8587
|
+
|
|
8588
|
+
|
|
8589
|
+
|
|
8590
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
8591
|
+
|
|
8592
|
+
|
|
8593
|
+
<table class="params">
|
|
8594
|
+
<thead>
|
|
8595
|
+
<tr>
|
|
8596
|
+
|
|
8597
|
+
<th>Name</th>
|
|
8598
|
+
|
|
8599
|
+
|
|
8600
|
+
<th>Type</th>
|
|
8601
|
+
|
|
8602
|
+
|
|
8603
|
+
|
|
8604
|
+
|
|
8605
|
+
|
|
8606
|
+
<th class="last">Description</th>
|
|
8607
|
+
</tr>
|
|
8608
|
+
</thead>
|
|
8609
|
+
|
|
8610
|
+
<tbody>
|
|
8611
|
+
|
|
8612
|
+
|
|
8613
|
+
<tr>
|
|
8614
|
+
|
|
8615
|
+
<td class="name"><code>postId</code></td>
|
|
8616
|
+
|
|
8617
|
+
|
|
8618
|
+
<td class="type">
|
|
8619
|
+
|
|
8620
|
+
|
|
8621
|
+
<span class="param-type">number</span>
|
|
8622
|
+
|
|
8623
|
+
|
|
8624
|
+
|
|
8625
|
+
|
|
8626
|
+
</td>
|
|
7811
8627
|
|
|
7812
|
-
|
|
7813
|
-
</td>
|
|
7814
8628
|
|
|
7815
8629
|
|
|
7816
8630
|
|
|
7817
8631
|
|
|
7818
|
-
<td class="description last">The
|
|
8632
|
+
<td class="description last">The ID of the post to like.</td>
|
|
7819
8633
|
</tr>
|
|
7820
8634
|
|
|
7821
8635
|
|
|
7822
8636
|
|
|
7823
8637
|
<tr>
|
|
7824
8638
|
|
|
7825
|
-
<td class="name"><code>
|
|
8639
|
+
<td class="name"><code>brand</code></td>
|
|
7826
8640
|
|
|
7827
8641
|
|
|
7828
8642
|
<td class="type">
|
|
7829
8643
|
|
|
7830
8644
|
|
|
7831
|
-
<span class="param-type">
|
|
8645
|
+
<span class="param-type">string</span>
|
|
7832
8646
|
|
|
7833
8647
|
|
|
7834
8648
|
|
|
@@ -7836,20 +8650,10 @@
|
|
|
7836
8650
|
</td>
|
|
7837
8651
|
|
|
7838
8652
|
|
|
7839
|
-
<td class="attributes">
|
|
7840
|
-
|
|
7841
|
-
<optional><br>
|
|
7842
|
-
|
|
7843
|
-
|
|
7844
|
-
|
|
7845
|
-
|
|
7846
|
-
|
|
7847
|
-
</td>
|
|
7848
|
-
|
|
7849
8653
|
|
|
7850
8654
|
|
|
7851
8655
|
|
|
7852
|
-
<td class="description last">
|
|
8656
|
+
<td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
|
|
7853
8657
|
</tr>
|
|
7854
8658
|
|
|
7855
8659
|
|
|
@@ -7905,7 +8709,7 @@
|
|
|
7905
8709
|
|
|
7906
8710
|
|
|
7907
8711
|
<div class="param-desc">
|
|
7908
|
-
-
|
|
8712
|
+
- A promise that resolves when the post is liked.
|
|
7909
8713
|
</div>
|
|
7910
8714
|
|
|
7911
8715
|
|
|
@@ -7916,7 +8720,7 @@
|
|
|
7916
8720
|
</dt>
|
|
7917
8721
|
<dd>
|
|
7918
8722
|
|
|
7919
|
-
<span class="param-type">Promise.<
|
|
8723
|
+
<span class="param-type">Promise.<void></span>
|
|
7920
8724
|
|
|
7921
8725
|
|
|
7922
8726
|
|
|
@@ -7932,7 +8736,7 @@
|
|
|
7932
8736
|
|
|
7933
8737
|
|
|
7934
8738
|
|
|
7935
|
-
<h4 class="name" id="~
|
|
8739
|
+
<h4 class="name" id="~lockThread"><span class="type-signature type-signature-async, inner">(async, inner) </span>lockThread<span class="signature">(threadId, brand)</span><span class="type-signature"> → {Promise.<void>}</span></h4>
|
|
7936
8740
|
|
|
7937
8741
|
|
|
7938
8742
|
|
|
@@ -7942,13 +8746,13 @@
|
|
|
7942
8746
|
<dl class="details">
|
|
7943
8747
|
|
|
7944
8748
|
<dt class="tag-description">Description:</dt>
|
|
7945
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
8749
|
+
<dd class="tag-description"><ul class="dummy"><li>Locks a thread to prevent further posts.</li></ul></dd>
|
|
7946
8750
|
|
|
7947
8751
|
|
|
7948
8752
|
|
|
7949
8753
|
<dt class="tag-source">Source:</dt>
|
|
7950
8754
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
7951
|
-
<a href="
|
|
8755
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line147">line 147</a>
|
|
7952
8756
|
</li></ul></dd>
|
|
7953
8757
|
|
|
7954
8758
|
|
|
@@ -8020,7 +8824,7 @@
|
|
|
8020
8824
|
|
|
8021
8825
|
<tr>
|
|
8022
8826
|
|
|
8023
|
-
<td class="name"><code>
|
|
8827
|
+
<td class="name"><code>threadId</code></td>
|
|
8024
8828
|
|
|
8025
8829
|
|
|
8026
8830
|
<td class="type">
|
|
@@ -8037,7 +8841,7 @@
|
|
|
8037
8841
|
|
|
8038
8842
|
|
|
8039
8843
|
|
|
8040
|
-
<td class="description last">The ID of the
|
|
8844
|
+
<td class="description last">The ID of the thread to lock.</td>
|
|
8041
8845
|
</tr>
|
|
8042
8846
|
|
|
8043
8847
|
|
|
@@ -8117,7 +8921,7 @@
|
|
|
8117
8921
|
|
|
8118
8922
|
|
|
8119
8923
|
<div class="param-desc">
|
|
8120
|
-
- A promise that resolves when the
|
|
8924
|
+
- A promise that resolves when the thread is locked.
|
|
8121
8925
|
</div>
|
|
8122
8926
|
|
|
8123
8927
|
|
|
@@ -8144,7 +8948,7 @@
|
|
|
8144
8948
|
|
|
8145
8949
|
|
|
8146
8950
|
|
|
8147
|
-
<h4 class="name" id="~
|
|
8951
|
+
<h4 class="name" id="~markThreadAsRead"><span class="type-signature type-signature-async, inner">(async, inner) </span>markThreadAsRead<span class="signature">(threadId, brand)</span><span class="type-signature"> → {Promise.<void>}</span></h4>
|
|
8148
8952
|
|
|
8149
8953
|
|
|
8150
8954
|
|
|
@@ -8154,13 +8958,13 @@
|
|
|
8154
8958
|
<dl class="details">
|
|
8155
8959
|
|
|
8156
8960
|
<dt class="tag-description">Description:</dt>
|
|
8157
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
8961
|
+
<dd class="tag-description"><ul class="dummy"><li>Marks a thread as read for the authenticated user.</li></ul></dd>
|
|
8158
8962
|
|
|
8159
8963
|
|
|
8160
8964
|
|
|
8161
8965
|
<dt class="tag-source">Source:</dt>
|
|
8162
8966
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
8163
|
-
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#
|
|
8967
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line78">line 78</a>
|
|
8164
8968
|
</li></ul></dd>
|
|
8165
8969
|
|
|
8166
8970
|
|
|
@@ -8249,7 +9053,7 @@
|
|
|
8249
9053
|
|
|
8250
9054
|
|
|
8251
9055
|
|
|
8252
|
-
<td class="description last">The ID of the thread to
|
|
9056
|
+
<td class="description last">The ID of the thread to mark as read.</td>
|
|
8253
9057
|
</tr>
|
|
8254
9058
|
|
|
8255
9059
|
|
|
@@ -8329,7 +9133,7 @@
|
|
|
8329
9133
|
|
|
8330
9134
|
|
|
8331
9135
|
<div class="param-desc">
|
|
8332
|
-
- A promise that resolves when the thread is
|
|
9136
|
+
- A promise that resolves when the thread is marked as read.
|
|
8333
9137
|
</div>
|
|
8334
9138
|
|
|
8335
9139
|
|
|
@@ -8372,7 +9176,7 @@
|
|
|
8372
9176
|
|
|
8373
9177
|
<dt class="tag-source">Source:</dt>
|
|
8374
9178
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
8375
|
-
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#
|
|
9179
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line121">line 121</a>
|
|
8376
9180
|
</li></ul></dd>
|
|
8377
9181
|
|
|
8378
9182
|
|
|
@@ -8584,7 +9388,7 @@
|
|
|
8584
9388
|
|
|
8585
9389
|
<dt class="tag-source">Source:</dt>
|
|
8586
9390
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
8587
|
-
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#
|
|
9391
|
+
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line147">line 147</a>
|
|
8588
9392
|
</li></ul></dd>
|
|
8589
9393
|
|
|
8590
9394
|
|
|
@@ -8810,7 +9614,7 @@
|
|
|
8810
9614
|
<dl class="details">
|
|
8811
9615
|
|
|
8812
9616
|
<dt class="tag-description">Description:</dt>
|
|
8813
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
9617
|
+
<dd class="tag-description"><ul class="dummy"><li>Unfollow a thread to allow further posts.</li></ul></dd>
|
|
8814
9618
|
|
|
8815
9619
|
|
|
8816
9620
|
|
|
@@ -8905,7 +9709,7 @@
|
|
|
8905
9709
|
|
|
8906
9710
|
|
|
8907
9711
|
|
|
8908
|
-
<td class="description last">The ID of the thread to
|
|
9712
|
+
<td class="description last">The ID of the thread to unfollow.</td>
|
|
8909
9713
|
</tr>
|
|
8910
9714
|
|
|
8911
9715
|
|
|
@@ -8929,7 +9733,7 @@
|
|
|
8929
9733
|
|
|
8930
9734
|
|
|
8931
9735
|
|
|
8932
|
-
<td class="description last">The brand associated with the
|
|
9736
|
+
<td class="description last">The brand associated with the unfollow action.</td>
|
|
8933
9737
|
</tr>
|
|
8934
9738
|
|
|
8935
9739
|
|
|
@@ -8985,7 +9789,7 @@
|
|
|
8985
9789
|
|
|
8986
9790
|
|
|
8987
9791
|
<div class="param-desc">
|
|
8988
|
-
- A promise that resolves when the thread is
|
|
9792
|
+
- A promise that resolves when the thread is unfollowed.
|
|
8989
9793
|
</div>
|
|
8990
9794
|
|
|
8991
9795
|
|
|
@@ -9028,7 +9832,7 @@
|
|
|
9028
9832
|
|
|
9029
9833
|
<dt class="tag-source">Source:</dt>
|
|
9030
9834
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
9031
|
-
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#
|
|
9835
|
+
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line98">line 98</a>
|
|
9032
9836
|
</li></ul></dd>
|
|
9033
9837
|
|
|
9034
9838
|
|
|
@@ -9240,7 +10044,7 @@
|
|
|
9240
10044
|
|
|
9241
10045
|
<dt class="tag-source">Source:</dt>
|
|
9242
10046
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
9243
|
-
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#
|
|
10047
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line160">line 160</a>
|
|
9244
10048
|
</li></ul></dd>
|
|
9245
10049
|
|
|
9246
10050
|
|
|
@@ -9452,7 +10256,7 @@
|
|
|
9452
10256
|
|
|
9453
10257
|
<dt class="tag-source">Source:</dt>
|
|
9454
10258
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
9455
|
-
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#
|
|
10259
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line134">line 134</a>
|
|
9456
10260
|
</li></ul></dd>
|
|
9457
10261
|
|
|
9458
10262
|
|
|
@@ -9852,7 +10656,7 @@
|
|
|
9852
10656
|
|
|
9853
10657
|
<dt class="tag-source">Source:</dt>
|
|
9854
10658
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
9855
|
-
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#
|
|
10659
|
+
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line30">line 30</a>
|
|
9856
10660
|
</li></ul></dd>
|
|
9857
10661
|
|
|
9858
10662
|
|
|
@@ -10510,7 +11314,213 @@
|
|
|
10510
11314
|
|
|
10511
11315
|
<dt class="tag-source">Source:</dt>
|
|
10512
11316
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
10513
|
-
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#
|
|
11317
|
+
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line17">line 17</a>
|
|
11318
|
+
</li></ul></dd>
|
|
11319
|
+
|
|
11320
|
+
|
|
11321
|
+
|
|
11322
|
+
|
|
11323
|
+
|
|
11324
|
+
|
|
11325
|
+
|
|
11326
|
+
|
|
11327
|
+
|
|
11328
|
+
|
|
11329
|
+
|
|
11330
|
+
|
|
11331
|
+
|
|
11332
|
+
|
|
11333
|
+
|
|
11334
|
+
|
|
11335
|
+
|
|
11336
|
+
|
|
11337
|
+
|
|
11338
|
+
|
|
11339
|
+
|
|
11340
|
+
|
|
11341
|
+
|
|
11342
|
+
|
|
11343
|
+
|
|
11344
|
+
|
|
11345
|
+
|
|
11346
|
+
|
|
11347
|
+
|
|
11348
|
+
|
|
11349
|
+
|
|
11350
|
+
</dl>
|
|
11351
|
+
|
|
11352
|
+
|
|
11353
|
+
|
|
11354
|
+
|
|
11355
|
+
|
|
11356
|
+
|
|
11357
|
+
|
|
11358
|
+
|
|
11359
|
+
|
|
11360
|
+
|
|
11361
|
+
|
|
11362
|
+
|
|
11363
|
+
|
|
11364
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
11365
|
+
|
|
11366
|
+
|
|
11367
|
+
<table class="params">
|
|
11368
|
+
<thead>
|
|
11369
|
+
<tr>
|
|
11370
|
+
|
|
11371
|
+
<th>Name</th>
|
|
11372
|
+
|
|
11373
|
+
|
|
11374
|
+
<th>Type</th>
|
|
11375
|
+
|
|
11376
|
+
|
|
11377
|
+
|
|
11378
|
+
|
|
11379
|
+
|
|
11380
|
+
<th class="last">Description</th>
|
|
11381
|
+
</tr>
|
|
11382
|
+
</thead>
|
|
11383
|
+
|
|
11384
|
+
<tbody>
|
|
11385
|
+
|
|
11386
|
+
|
|
11387
|
+
<tr>
|
|
11388
|
+
|
|
11389
|
+
<td class="name"><code>threadId</code></td>
|
|
11390
|
+
|
|
11391
|
+
|
|
11392
|
+
<td class="type">
|
|
11393
|
+
|
|
11394
|
+
</td>
|
|
11395
|
+
|
|
11396
|
+
|
|
11397
|
+
|
|
11398
|
+
|
|
11399
|
+
|
|
11400
|
+
<td class="description last"></td>
|
|
11401
|
+
</tr>
|
|
11402
|
+
|
|
11403
|
+
|
|
11404
|
+
|
|
11405
|
+
<tr>
|
|
11406
|
+
|
|
11407
|
+
<td class="name"><code>params</code></td>
|
|
11408
|
+
|
|
11409
|
+
|
|
11410
|
+
<td class="type">
|
|
11411
|
+
|
|
11412
|
+
|
|
11413
|
+
<span class="param-type">CreatePostParams</span>
|
|
11414
|
+
|
|
11415
|
+
|
|
11416
|
+
|
|
11417
|
+
|
|
11418
|
+
</td>
|
|
11419
|
+
|
|
11420
|
+
|
|
11421
|
+
|
|
11422
|
+
|
|
11423
|
+
|
|
11424
|
+
<td class="description last">The parameters for creating the post.</td>
|
|
11425
|
+
</tr>
|
|
11426
|
+
|
|
11427
|
+
|
|
11428
|
+
</tbody>
|
|
11429
|
+
</table>
|
|
11430
|
+
|
|
11431
|
+
|
|
11432
|
+
|
|
11433
|
+
|
|
11434
|
+
|
|
11435
|
+
|
|
11436
|
+
|
|
11437
|
+
|
|
11438
|
+
|
|
11439
|
+
|
|
11440
|
+
|
|
11441
|
+
|
|
11442
|
+
|
|
11443
|
+
|
|
11444
|
+
<h5 class="h5-throws">Throws:</h5>
|
|
11445
|
+
|
|
11446
|
+
|
|
11447
|
+
|
|
11448
|
+
<dl>
|
|
11449
|
+
<dt>
|
|
11450
|
+
<div class="param-desc usertext">
|
|
11451
|
+
- If the request fails.
|
|
11452
|
+
</div>
|
|
11453
|
+
</dt>
|
|
11454
|
+
<dd></dd>
|
|
11455
|
+
<dt>
|
|
11456
|
+
<dl class="param-type">
|
|
11457
|
+
<dt>
|
|
11458
|
+
Type
|
|
11459
|
+
</dt>
|
|
11460
|
+
<dd>
|
|
11461
|
+
|
|
11462
|
+
<span class="param-type">HttpError</span>
|
|
11463
|
+
|
|
11464
|
+
|
|
11465
|
+
|
|
11466
|
+
</dd>
|
|
11467
|
+
</dl>
|
|
11468
|
+
</dt>
|
|
11469
|
+
<dd></dd>
|
|
11470
|
+
</dl>
|
|
11471
|
+
|
|
11472
|
+
|
|
11473
|
+
|
|
11474
|
+
|
|
11475
|
+
|
|
11476
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
11477
|
+
|
|
11478
|
+
|
|
11479
|
+
<div class="param-desc">
|
|
11480
|
+
- A promise that resolves to the created post.
|
|
11481
|
+
</div>
|
|
11482
|
+
|
|
11483
|
+
|
|
11484
|
+
|
|
11485
|
+
<dl class="param-type">
|
|
11486
|
+
<dt>
|
|
11487
|
+
Type
|
|
11488
|
+
</dt>
|
|
11489
|
+
<dd>
|
|
11490
|
+
|
|
11491
|
+
<span class="param-type">Promise.<ForumPost></span>
|
|
11492
|
+
|
|
11493
|
+
|
|
11494
|
+
|
|
11495
|
+
</dd>
|
|
11496
|
+
</dl>
|
|
11497
|
+
|
|
11498
|
+
|
|
11499
|
+
|
|
11500
|
+
|
|
11501
|
+
|
|
11502
|
+
|
|
11503
|
+
|
|
11504
|
+
|
|
11505
|
+
|
|
11506
|
+
|
|
11507
|
+
<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>
|
|
11508
|
+
|
|
11509
|
+
|
|
11510
|
+
|
|
11511
|
+
|
|
11512
|
+
|
|
11513
|
+
|
|
11514
|
+
<dl class="details">
|
|
11515
|
+
|
|
11516
|
+
<dt class="tag-description">Description:</dt>
|
|
11517
|
+
<dd class="tag-description"><ul class="dummy"><li>Creates a new thread under a forum category.</li></ul></dd>
|
|
11518
|
+
|
|
11519
|
+
|
|
11520
|
+
|
|
11521
|
+
<dt class="tag-source">Source:</dt>
|
|
11522
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
11523
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line17">line 17</a>
|
|
10514
11524
|
</li></ul></dd>
|
|
10515
11525
|
|
|
10516
11526
|
|
|
@@ -10580,24 +11590,6 @@
|
|
|
10580
11590
|
<tbody>
|
|
10581
11591
|
|
|
10582
11592
|
|
|
10583
|
-
<tr>
|
|
10584
|
-
|
|
10585
|
-
<td class="name"><code>threadId</code></td>
|
|
10586
|
-
|
|
10587
|
-
|
|
10588
|
-
<td class="type">
|
|
10589
|
-
|
|
10590
|
-
</td>
|
|
10591
|
-
|
|
10592
|
-
|
|
10593
|
-
|
|
10594
|
-
|
|
10595
|
-
|
|
10596
|
-
<td class="description last"></td>
|
|
10597
|
-
</tr>
|
|
10598
|
-
|
|
10599
|
-
|
|
10600
|
-
|
|
10601
11593
|
<tr>
|
|
10602
11594
|
|
|
10603
11595
|
<td class="name"><code>params</code></td>
|
|
@@ -10606,7 +11598,7 @@
|
|
|
10606
11598
|
<td class="type">
|
|
10607
11599
|
|
|
10608
11600
|
|
|
10609
|
-
<span class="param-type">
|
|
11601
|
+
<span class="param-type">CreateThreadParams</span>
|
|
10610
11602
|
|
|
10611
11603
|
|
|
10612
11604
|
|
|
@@ -10617,7 +11609,7 @@
|
|
|
10617
11609
|
|
|
10618
11610
|
|
|
10619
11611
|
|
|
10620
|
-
<td class="description last">The parameters for creating the
|
|
11612
|
+
<td class="description last">The parameters for creating the thread.</td>
|
|
10621
11613
|
</tr>
|
|
10622
11614
|
|
|
10623
11615
|
|
|
@@ -10673,7 +11665,7 @@
|
|
|
10673
11665
|
|
|
10674
11666
|
|
|
10675
11667
|
<div class="param-desc">
|
|
10676
|
-
- A promise that resolves to the created
|
|
11668
|
+
- A promise that resolves to the created thread.
|
|
10677
11669
|
</div>
|
|
10678
11670
|
|
|
10679
11671
|
|
|
@@ -10684,7 +11676,7 @@
|
|
|
10684
11676
|
</dt>
|
|
10685
11677
|
<dd>
|
|
10686
11678
|
|
|
10687
|
-
<span class="param-type">Promise.<
|
|
11679
|
+
<span class="param-type">Promise.<ForumThread></span>
|
|
10688
11680
|
|
|
10689
11681
|
|
|
10690
11682
|
|
|
@@ -10700,7 +11692,7 @@
|
|
|
10700
11692
|
|
|
10701
11693
|
|
|
10702
11694
|
|
|
10703
|
-
<h4 class="name" id="~
|
|
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>
|
|
10704
11696
|
|
|
10705
11697
|
|
|
10706
11698
|
|
|
@@ -10710,13 +11702,13 @@
|
|
|
10710
11702
|
<dl class="details">
|
|
10711
11703
|
|
|
10712
11704
|
<dt class="tag-description">Description:</dt>
|
|
10713
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
11705
|
+
<dd class="tag-description"><ul class="dummy"><li>Deletes a forum category.</li></ul></dd>
|
|
10714
11706
|
|
|
10715
11707
|
|
|
10716
11708
|
|
|
10717
11709
|
<dt class="tag-source">Source:</dt>
|
|
10718
11710
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
10719
|
-
<a href="
|
|
11711
|
+
<a href="forums_categories.ts.html">forums/categories.ts</a>, <a href="forums_categories.ts.html#line72">line 72</a>
|
|
10720
11712
|
</li></ul></dd>
|
|
10721
11713
|
|
|
10722
11714
|
|
|
@@ -10794,7 +11786,7 @@
|
|
|
10794
11786
|
<td class="type">
|
|
10795
11787
|
|
|
10796
11788
|
|
|
10797
|
-
<span class="param-type">
|
|
11789
|
+
<span class="param-type">DeleteForumCategoryParams</span>
|
|
10798
11790
|
|
|
10799
11791
|
|
|
10800
11792
|
|
|
@@ -10805,7 +11797,7 @@
|
|
|
10805
11797
|
|
|
10806
11798
|
|
|
10807
11799
|
|
|
10808
|
-
<td class="description last">The parameters for
|
|
11800
|
+
<td class="description last">The parameters for deleting the forum category.</td>
|
|
10809
11801
|
</tr>
|
|
10810
11802
|
|
|
10811
11803
|
|
|
@@ -10861,7 +11853,7 @@
|
|
|
10861
11853
|
|
|
10862
11854
|
|
|
10863
11855
|
<div class="param-desc">
|
|
10864
|
-
- A promise that resolves
|
|
11856
|
+
- A promise that resolves when the category is deleted.
|
|
10865
11857
|
</div>
|
|
10866
11858
|
|
|
10867
11859
|
|
|
@@ -10872,7 +11864,7 @@
|
|
|
10872
11864
|
</dt>
|
|
10873
11865
|
<dd>
|
|
10874
11866
|
|
|
10875
|
-
<span class="param-type">Promise.<
|
|
11867
|
+
<span class="param-type">Promise.<void></span>
|
|
10876
11868
|
|
|
10877
11869
|
|
|
10878
11870
|
|
|
@@ -10904,7 +11896,7 @@
|
|
|
10904
11896
|
|
|
10905
11897
|
<dt class="tag-source">Source:</dt>
|
|
10906
11898
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
10907
|
-
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#
|
|
11899
|
+
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line112">line 112</a>
|
|
10908
11900
|
</li></ul></dd>
|
|
10909
11901
|
|
|
10910
11902
|
|
|
@@ -11116,7 +12108,7 @@
|
|
|
11116
12108
|
|
|
11117
12109
|
<dt class="tag-source">Source:</dt>
|
|
11118
12110
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
11119
|
-
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#
|
|
12111
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line201">line 201</a>
|
|
11120
12112
|
</li></ul></dd>
|
|
11121
12113
|
|
|
11122
12114
|
|
|
@@ -11328,7 +12320,7 @@
|
|
|
11328
12320
|
|
|
11329
12321
|
<dt class="tag-source">Source:</dt>
|
|
11330
12322
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
11331
|
-
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#
|
|
12323
|
+
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line125">line 125</a>
|
|
11332
12324
|
</li></ul></dd>
|
|
11333
12325
|
|
|
11334
12326
|
|
|
@@ -11516,7 +12508,7 @@
|
|
|
11516
12508
|
|
|
11517
12509
|
<dt class="tag-source">Source:</dt>
|
|
11518
12510
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
11519
|
-
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#
|
|
12511
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line173">line 173</a>
|
|
11520
12512
|
</li></ul></dd>
|
|
11521
12513
|
|
|
11522
12514
|
|
|
@@ -11895,7 +12887,7 @@
|
|
|
11895
12887
|
|
|
11896
12888
|
<dt class="tag-source">Source:</dt>
|
|
11897
12889
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
11898
|
-
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#
|
|
12890
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line187">line 187</a>
|
|
11899
12891
|
</li></ul></dd>
|
|
11900
12892
|
|
|
11901
12893
|
|
|
@@ -12077,13 +13069,14 @@
|
|
|
12077
13069
|
<dl class="details">
|
|
12078
13070
|
|
|
12079
13071
|
<dt class="tag-description">Description:</dt>
|
|
12080
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetches posts for the given thread
|
|
13072
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetches posts for the given thread.
|
|
13073
|
+
Automatically marks the thread as read when posts are fetched.</li></ul></dd>
|
|
12081
13074
|
|
|
12082
13075
|
|
|
12083
13076
|
|
|
12084
13077
|
<dt class="tag-source">Source:</dt>
|
|
12085
13078
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
12086
|
-
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#
|
|
13079
|
+
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line49">line 49</a>
|
|
12087
13080
|
</li></ul></dd>
|
|
12088
13081
|
|
|
12089
13082
|
|
|
@@ -12347,7 +13340,7 @@
|
|
|
12347
13340
|
|
|
12348
13341
|
<dt class="tag-source">Source:</dt>
|
|
12349
13342
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
12350
|
-
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#
|
|
13343
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line97">line 97</a>
|
|
12351
13344
|
</li></ul></dd>
|
|
12352
13345
|
|
|
12353
13346
|
|
|
@@ -12672,7 +13665,7 @@
|
|
|
12672
13665
|
|
|
12673
13666
|
|
|
12674
13667
|
|
|
12675
|
-
<td class="description last">The ID of the thread to
|
|
13668
|
+
<td class="description last">The ID of the thread to follow.</td>
|
|
12676
13669
|
</tr>
|
|
12677
13670
|
|
|
12678
13671
|
|
|
@@ -12752,7 +13745,7 @@
|
|
|
12752
13745
|
|
|
12753
13746
|
|
|
12754
13747
|
<div class="param-desc">
|
|
12755
|
-
- A promise that resolves when the thread is
|
|
13748
|
+
- A promise that resolves when the thread is followed.
|
|
12756
13749
|
</div>
|
|
12757
13750
|
|
|
12758
13751
|
|
|
@@ -12789,13 +13782,14 @@
|
|
|
12789
13782
|
<dl class="details">
|
|
12790
13783
|
|
|
12791
13784
|
<dt class="tag-description">Description:</dt>
|
|
12792
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetches posts for the given post, jumping to the post's location in the thread
|
|
13785
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetches posts for the given post, jumping to the post's location in the thread.
|
|
13786
|
+
Automatically marks the thread as read when posts are fetched.</li></ul></dd>
|
|
12793
13787
|
|
|
12794
13788
|
|
|
12795
13789
|
|
|
12796
13790
|
<dt class="tag-source">Source:</dt>
|
|
12797
13791
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
12798
|
-
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#
|
|
13792
|
+
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line174">line 174</a>
|
|
12799
13793
|
</li></ul></dd>
|
|
12800
13794
|
|
|
12801
13795
|
|
|
@@ -13059,7 +14053,7 @@
|
|
|
13059
14053
|
|
|
13060
14054
|
<dt class="tag-source">Source:</dt>
|
|
13061
14055
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
13062
|
-
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#
|
|
14056
|
+
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line85">line 85</a>
|
|
13063
14057
|
</li></ul></dd>
|
|
13064
14058
|
|
|
13065
14059
|
|
|
@@ -13271,7 +14265,7 @@
|
|
|
13271
14265
|
|
|
13272
14266
|
<dt class="tag-source">Source:</dt>
|
|
13273
14267
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
13274
|
-
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#
|
|
14268
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line147">line 147</a>
|
|
13275
14269
|
</li></ul></dd>
|
|
13276
14270
|
|
|
13277
14271
|
|
|
@@ -13467,6 +14461,218 @@
|
|
|
13467
14461
|
|
|
13468
14462
|
|
|
13469
14463
|
|
|
14464
|
+
<h4 class="name" id="~markThreadAsRead"><span class="type-signature type-signature-async, inner">(async, inner) </span>markThreadAsRead<span class="signature">(threadId, brand)</span><span class="type-signature"> → {Promise.<void>}</span></h4>
|
|
14465
|
+
|
|
14466
|
+
|
|
14467
|
+
|
|
14468
|
+
|
|
14469
|
+
|
|
14470
|
+
|
|
14471
|
+
<dl class="details">
|
|
14472
|
+
|
|
14473
|
+
<dt class="tag-description">Description:</dt>
|
|
14474
|
+
<dd class="tag-description"><ul class="dummy"><li>Marks a thread as read for the authenticated user.</li></ul></dd>
|
|
14475
|
+
|
|
14476
|
+
|
|
14477
|
+
|
|
14478
|
+
<dt class="tag-source">Source:</dt>
|
|
14479
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
14480
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line78">line 78</a>
|
|
14481
|
+
</li></ul></dd>
|
|
14482
|
+
|
|
14483
|
+
|
|
14484
|
+
|
|
14485
|
+
|
|
14486
|
+
|
|
14487
|
+
|
|
14488
|
+
|
|
14489
|
+
|
|
14490
|
+
|
|
14491
|
+
|
|
14492
|
+
|
|
14493
|
+
|
|
14494
|
+
|
|
14495
|
+
|
|
14496
|
+
|
|
14497
|
+
|
|
14498
|
+
|
|
14499
|
+
|
|
14500
|
+
|
|
14501
|
+
|
|
14502
|
+
|
|
14503
|
+
|
|
14504
|
+
|
|
14505
|
+
|
|
14506
|
+
|
|
14507
|
+
|
|
14508
|
+
|
|
14509
|
+
|
|
14510
|
+
|
|
14511
|
+
|
|
14512
|
+
|
|
14513
|
+
</dl>
|
|
14514
|
+
|
|
14515
|
+
|
|
14516
|
+
|
|
14517
|
+
|
|
14518
|
+
|
|
14519
|
+
|
|
14520
|
+
|
|
14521
|
+
|
|
14522
|
+
|
|
14523
|
+
|
|
14524
|
+
|
|
14525
|
+
|
|
14526
|
+
|
|
14527
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
14528
|
+
|
|
14529
|
+
|
|
14530
|
+
<table class="params">
|
|
14531
|
+
<thead>
|
|
14532
|
+
<tr>
|
|
14533
|
+
|
|
14534
|
+
<th>Name</th>
|
|
14535
|
+
|
|
14536
|
+
|
|
14537
|
+
<th>Type</th>
|
|
14538
|
+
|
|
14539
|
+
|
|
14540
|
+
|
|
14541
|
+
|
|
14542
|
+
|
|
14543
|
+
<th class="last">Description</th>
|
|
14544
|
+
</tr>
|
|
14545
|
+
</thead>
|
|
14546
|
+
|
|
14547
|
+
<tbody>
|
|
14548
|
+
|
|
14549
|
+
|
|
14550
|
+
<tr>
|
|
14551
|
+
|
|
14552
|
+
<td class="name"><code>threadId</code></td>
|
|
14553
|
+
|
|
14554
|
+
|
|
14555
|
+
<td class="type">
|
|
14556
|
+
|
|
14557
|
+
|
|
14558
|
+
<span class="param-type">number</span>
|
|
14559
|
+
|
|
14560
|
+
|
|
14561
|
+
|
|
14562
|
+
|
|
14563
|
+
</td>
|
|
14564
|
+
|
|
14565
|
+
|
|
14566
|
+
|
|
14567
|
+
|
|
14568
|
+
|
|
14569
|
+
<td class="description last">The ID of the thread to mark as read.</td>
|
|
14570
|
+
</tr>
|
|
14571
|
+
|
|
14572
|
+
|
|
14573
|
+
|
|
14574
|
+
<tr>
|
|
14575
|
+
|
|
14576
|
+
<td class="name"><code>brand</code></td>
|
|
14577
|
+
|
|
14578
|
+
|
|
14579
|
+
<td class="type">
|
|
14580
|
+
|
|
14581
|
+
|
|
14582
|
+
<span class="param-type">string</span>
|
|
14583
|
+
|
|
14584
|
+
|
|
14585
|
+
|
|
14586
|
+
|
|
14587
|
+
</td>
|
|
14588
|
+
|
|
14589
|
+
|
|
14590
|
+
|
|
14591
|
+
|
|
14592
|
+
|
|
14593
|
+
<td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
|
|
14594
|
+
</tr>
|
|
14595
|
+
|
|
14596
|
+
|
|
14597
|
+
</tbody>
|
|
14598
|
+
</table>
|
|
14599
|
+
|
|
14600
|
+
|
|
14601
|
+
|
|
14602
|
+
|
|
14603
|
+
|
|
14604
|
+
|
|
14605
|
+
|
|
14606
|
+
|
|
14607
|
+
|
|
14608
|
+
|
|
14609
|
+
|
|
14610
|
+
|
|
14611
|
+
|
|
14612
|
+
|
|
14613
|
+
<h5 class="h5-throws">Throws:</h5>
|
|
14614
|
+
|
|
14615
|
+
|
|
14616
|
+
|
|
14617
|
+
<dl>
|
|
14618
|
+
<dt>
|
|
14619
|
+
<div class="param-desc usertext">
|
|
14620
|
+
- If the request fails.
|
|
14621
|
+
</div>
|
|
14622
|
+
</dt>
|
|
14623
|
+
<dd></dd>
|
|
14624
|
+
<dt>
|
|
14625
|
+
<dl class="param-type">
|
|
14626
|
+
<dt>
|
|
14627
|
+
Type
|
|
14628
|
+
</dt>
|
|
14629
|
+
<dd>
|
|
14630
|
+
|
|
14631
|
+
<span class="param-type">HttpError</span>
|
|
14632
|
+
|
|
14633
|
+
|
|
14634
|
+
|
|
14635
|
+
</dd>
|
|
14636
|
+
</dl>
|
|
14637
|
+
</dt>
|
|
14638
|
+
<dd></dd>
|
|
14639
|
+
</dl>
|
|
14640
|
+
|
|
14641
|
+
|
|
14642
|
+
|
|
14643
|
+
|
|
14644
|
+
|
|
14645
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
14646
|
+
|
|
14647
|
+
|
|
14648
|
+
<div class="param-desc">
|
|
14649
|
+
- A promise that resolves when the thread is marked as read.
|
|
14650
|
+
</div>
|
|
14651
|
+
|
|
14652
|
+
|
|
14653
|
+
|
|
14654
|
+
<dl class="param-type">
|
|
14655
|
+
<dt>
|
|
14656
|
+
Type
|
|
14657
|
+
</dt>
|
|
14658
|
+
<dd>
|
|
14659
|
+
|
|
14660
|
+
<span class="param-type">Promise.<void></span>
|
|
14661
|
+
|
|
14662
|
+
|
|
14663
|
+
|
|
14664
|
+
</dd>
|
|
14665
|
+
</dl>
|
|
14666
|
+
|
|
14667
|
+
|
|
14668
|
+
|
|
14669
|
+
|
|
14670
|
+
|
|
14671
|
+
|
|
14672
|
+
|
|
14673
|
+
|
|
14674
|
+
|
|
14675
|
+
|
|
13470
14676
|
<h4 class="name" id="~pinThread"><span class="type-signature type-signature-async, inner">(async, inner) </span>pinThread<span class="signature">(threadId, brand)</span><span class="type-signature"> → {Promise.<void>}</span></h4>
|
|
13471
14677
|
|
|
13472
14678
|
|
|
@@ -13483,7 +14689,7 @@
|
|
|
13483
14689
|
|
|
13484
14690
|
<dt class="tag-source">Source:</dt>
|
|
13485
14691
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
13486
|
-
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#
|
|
14692
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line121">line 121</a>
|
|
13487
14693
|
</li></ul></dd>
|
|
13488
14694
|
|
|
13489
14695
|
|
|
@@ -13695,7 +14901,7 @@
|
|
|
13695
14901
|
|
|
13696
14902
|
<dt class="tag-source">Source:</dt>
|
|
13697
14903
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
13698
|
-
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#
|
|
14904
|
+
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line147">line 147</a>
|
|
13699
14905
|
</li></ul></dd>
|
|
13700
14906
|
|
|
13701
14907
|
|
|
@@ -13921,7 +15127,7 @@
|
|
|
13921
15127
|
<dl class="details">
|
|
13922
15128
|
|
|
13923
15129
|
<dt class="tag-description">Description:</dt>
|
|
13924
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
15130
|
+
<dd class="tag-description"><ul class="dummy"><li>Unfollow a thread to allow further posts.</li></ul></dd>
|
|
13925
15131
|
|
|
13926
15132
|
|
|
13927
15133
|
|
|
@@ -14016,7 +15222,7 @@
|
|
|
14016
15222
|
|
|
14017
15223
|
|
|
14018
15224
|
|
|
14019
|
-
<td class="description last">The ID of the thread to
|
|
15225
|
+
<td class="description last">The ID of the thread to unfollow.</td>
|
|
14020
15226
|
</tr>
|
|
14021
15227
|
|
|
14022
15228
|
|
|
@@ -14040,7 +15246,7 @@
|
|
|
14040
15246
|
|
|
14041
15247
|
|
|
14042
15248
|
|
|
14043
|
-
<td class="description last">The brand associated with the
|
|
15249
|
+
<td class="description last">The brand associated with the unfollow action.</td>
|
|
14044
15250
|
</tr>
|
|
14045
15251
|
|
|
14046
15252
|
|
|
@@ -14096,7 +15302,7 @@
|
|
|
14096
15302
|
|
|
14097
15303
|
|
|
14098
15304
|
<div class="param-desc">
|
|
14099
|
-
- A promise that resolves when the thread is
|
|
15305
|
+
- A promise that resolves when the thread is unfollowed.
|
|
14100
15306
|
</div>
|
|
14101
15307
|
|
|
14102
15308
|
|
|
@@ -14139,7 +15345,7 @@
|
|
|
14139
15345
|
|
|
14140
15346
|
<dt class="tag-source">Source:</dt>
|
|
14141
15347
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
14142
|
-
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#
|
|
15348
|
+
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line98">line 98</a>
|
|
14143
15349
|
</li></ul></dd>
|
|
14144
15350
|
|
|
14145
15351
|
|
|
@@ -14351,7 +15557,7 @@
|
|
|
14351
15557
|
|
|
14352
15558
|
<dt class="tag-source">Source:</dt>
|
|
14353
15559
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
14354
|
-
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#
|
|
15560
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line160">line 160</a>
|
|
14355
15561
|
</li></ul></dd>
|
|
14356
15562
|
|
|
14357
15563
|
|
|
@@ -14563,7 +15769,7 @@
|
|
|
14563
15769
|
|
|
14564
15770
|
<dt class="tag-source">Source:</dt>
|
|
14565
15771
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
14566
|
-
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#
|
|
15772
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line134">line 134</a>
|
|
14567
15773
|
</li></ul></dd>
|
|
14568
15774
|
|
|
14569
15775
|
|
|
@@ -14963,7 +16169,7 @@
|
|
|
14963
16169
|
|
|
14964
16170
|
<dt class="tag-source">Source:</dt>
|
|
14965
16171
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
14966
|
-
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#
|
|
16172
|
+
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line30">line 30</a>
|
|
14967
16173
|
</li></ul></dd>
|
|
14968
16174
|
|
|
14969
16175
|
|
|
@@ -15380,7 +16586,7 @@
|
|
|
15380
16586
|
<br class="clear">
|
|
15381
16587
|
|
|
15382
16588
|
<footer>
|
|
15383
|
-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on
|
|
16589
|
+
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.
|
|
15384
16590
|
</footer>
|
|
15385
16591
|
|
|
15386
16592
|
<script>prettyPrint();</script>
|