musora-content-services 2.78.0 → 2.79.1

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.
Files changed (68) hide show
  1. package/CHANGELOG.md +19 -0
  2. package/docs/ContentOrganization.html +2 -2
  3. package/docs/Forums.html +2 -2
  4. package/docs/Gamification.html +2 -2
  5. package/docs/TestUser.html +2 -2
  6. package/docs/UserManagementSystem.html +2 -2
  7. package/docs/api_types.js.html +2 -2
  8. package/docs/config.js.html +2 -2
  9. package/docs/content-org_content-org.js.html +2 -2
  10. package/docs/content-org_guided-courses.ts.html +2 -2
  11. package/docs/content-org_learning-paths.ts.html +106 -13
  12. package/docs/content-org_playlists-types.js.html +2 -2
  13. package/docs/content-org_playlists.js.html +2 -2
  14. package/docs/content.js.html +2 -2
  15. package/docs/forums_categories.ts.html +2 -2
  16. package/docs/forums_forums.ts.html +2 -2
  17. package/docs/forums_posts.ts.html +22 -3
  18. package/docs/forums_threads.ts.html +16 -3
  19. package/docs/gamification_awards.ts.html +26 -12
  20. package/docs/gamification_gamification.js.html +2 -2
  21. package/docs/global.html +2 -2
  22. package/docs/index.html +2 -2
  23. package/docs/liveTesting.ts.html +2 -2
  24. package/docs/module-Accounts.html +10 -10
  25. package/docs/module-Awards.html +106 -6
  26. package/docs/module-Config.html +2 -2
  27. package/docs/module-Content-Services-V2.html +2 -2
  28. package/docs/module-Forums.html +731 -89
  29. package/docs/module-GuidedCourses.html +2 -2
  30. package/docs/module-Interests.html +2 -2
  31. package/docs/module-LearningPaths.html +640 -12
  32. package/docs/module-Onboarding.html +2 -2
  33. package/docs/module-Payments.html +2 -2
  34. package/docs/module-Permissions.html +2 -2
  35. package/docs/module-Playlists.html +2 -2
  36. package/docs/module-ProgressRow.html +2 -2
  37. package/docs/module-Railcontent-Services.html +2 -2
  38. package/docs/module-Sanity-Services.html +29 -29
  39. package/docs/module-Sessions.html +2 -2
  40. package/docs/module-UserActivity.html +2 -2
  41. package/docs/module-UserChat.html +2 -2
  42. package/docs/module-UserManagement.html +2 -2
  43. package/docs/module-UserMemberships.html +2 -2
  44. package/docs/module-UserNotifications.html +2 -2
  45. package/docs/module-UserProfile.html +2 -2
  46. package/docs/progress-row_method-card.js.html +8 -7
  47. package/docs/railcontent.js.html +2 -2
  48. package/docs/sanity.js.html +5 -3
  49. package/docs/userActivity.js.html +2 -2
  50. package/docs/user_account.ts.html +5 -11
  51. package/docs/user_chat.js.html +2 -2
  52. package/docs/user_interests.js.html +2 -2
  53. package/docs/user_management.js.html +2 -2
  54. package/docs/user_memberships.ts.html +2 -2
  55. package/docs/user_notifications.js.html +2 -2
  56. package/docs/user_onboarding.ts.html +2 -2
  57. package/docs/user_payments.ts.html +2 -2
  58. package/docs/user_permissions.js.html +2 -2
  59. package/docs/user_profile.js.html +2 -2
  60. package/docs/user_sessions.js.html +2 -2
  61. package/docs/user_types.js.html +2 -2
  62. package/docs/user_user-management-system.js.html +2 -2
  63. package/package.json +1 -1
  64. package/src/services/content-org/learning-paths.ts +35 -21
  65. package/src/services/contentAggregator.js +8 -5
  66. package/src/services/forums/categories.ts +1 -1
  67. package/src/services/gamification/awards.ts +24 -10
  68. package/src/services/user/account.ts +3 -9
@@ -29,7 +29,7 @@
29
29
  <nav >
30
30
 
31
31
 
32
- <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Accounts.html">Accounts</a><ul class='methods'><li data-type='method'><a href="module-Accounts.html#~confirmEmailChange">confirmEmailChange</a></li><li data-type='method'><a href="module-Accounts.html#~deleteAccount">deleteAccount</a></li><li data-type='method'><a href="module-Accounts.html#~numberOfActiveUsers">numberOfActiveUsers</a></li><li data-type='method'><a href="module-Accounts.html#~requestEmailChange">requestEmailChange</a></li><li data-type='method'><a href="module-Accounts.html#~resetPassword">resetPassword</a></li><li data-type='method'><a href="module-Accounts.html#~sendAccountSetupEmail">sendAccountSetupEmail</a></li><li data-type='method'><a href="module-Accounts.html#~sendPasswordResetEmail">sendPasswordResetEmail</a></li><li data-type='method'><a href="module-Accounts.html#~setupAccount">setupAccount</a></li><li data-type='method'><a href="module-Accounts.html#~status">status</a></li><li data-type='method'><a href="module-Accounts.html#~toggleStudentView">toggleStudentView</a></li></ul></li><li><a href="module-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#~getLearningPath">getLearningPath</a></li><li data-type='method'><a href="module-LearningPaths.html#~getLearningPathLessonsByIds">getLearningPathLessonsByIds</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-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#~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-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#~completeLearningPathIntroVideo">completeLearningPathIntroVideo</a></li><li data-type='method'><a href="module-LearningPaths.html#~completeMethodIntroVideo">completeMethodIntroVideo</a></li><li data-type='method'><a href="module-LearningPaths.html#~fetchLearningPathLessons">fetchLearningPathLessons</a></li><li data-type='method'><a href="module-LearningPaths.html#~getActivePath">getActivePath</a></li><li data-type='method'><a href="module-LearningPaths.html#~getDailySession">getDailySession</a></li><li data-type='method'><a href="module-LearningPaths.html#~getEnrichedLearningPath">getEnrichedLearningPath</a></li><li data-type='method'><a href="module-LearningPaths.html#~getLearningPathLessonsByIds">getLearningPathLessonsByIds</a></li><li data-type='method'><a href="module-LearningPaths.html#~mapContentToParent">mapContentToParent</a></li><li data-type='method'><a href="module-LearningPaths.html#~resetAllLearningPaths">resetAllLearningPaths</a></li><li data-type='method'><a href="module-LearningPaths.html#~startLearningPath">startLearningPath</a></li><li data-type='method'><a href="module-LearningPaths.html#~updateActivePath">updateActivePath</a></li><li data-type='method'><a href="module-LearningPaths.html#~updateDailySession">updateDailySession</a></li></ul></li><li><a href="module-Onboarding.html">Onboarding</a><ul class='methods'><li data-type='method'><a href="module-Onboarding.html#~getOnboardingRecommendedContent">getOnboardingRecommendedContent</a></li><li data-type='method'><a href="module-Onboarding.html#~startOnboarding">startOnboarding</a></li><li data-type='method'><a href="module-Onboarding.html#~updateOnboarding">updateOnboarding</a></li><li data-type='method'><a href="module-Onboarding.html#~userOnboardingForBrand">userOnboardingForBrand</a></li></ul></li><li><a href="module-Payments.html">Payments</a><ul class='methods'><li data-type='method'><a href="module-Payments.html#~fetchCustomerPayments">fetchCustomerPayments</a></li></ul></li><li><a href="module-Permissions.html">Permissions</a><ul class='methods'><li data-type='method'><a href="module-Permissions.html#.fetchUserPermissions">fetchUserPermissions</a></li><li data-type='method'><a href="module-Permissions.html#.reset">reset</a></li></ul></li><li><a href="module-Playlists.html">Playlists</a><ul class='methods'><li data-type='method'><a href="module-Playlists.html#.addItemToPlaylist">addItemToPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.createPlaylist">createPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.deletePlaylist">deletePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.duplicatePlaylist">duplicatePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.fetchPlaylist">fetchPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.fetchPlaylistItems">fetchPlaylistItems</a></li><li data-type='method'><a href="module-Playlists.html#.fetchUserPlaylists">fetchUserPlaylists</a></li><li data-type='method'><a href="module-Playlists.html#.togglePlaylistPrivate">togglePlaylistPrivate</a></li><li data-type='method'><a href="module-Playlists.html#.undeletePlaylist">undeletePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.updatePlaylist">updatePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~deleteItemsFromPlaylist">deleteItemsFromPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~likePlaylist">likePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~reportPlaylist">reportPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~restoreItemFromPlaylist">restoreItemFromPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~unlikePlaylist">unlikePlaylist</a></li></ul></li><li><a href="module-ProgressRow.html">ProgressRow</a></li><li><a href="module-Railcontent-Services.html">Railcontent-Services</a><ul class='methods'><li data-type='method'><a href="module-Railcontent-Services.html#.assignModeratorToComment">assignModeratorToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.closeComment">closeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.createComment">createComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.deleteComment">deleteComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.editComment">editComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchAllCompletedStates">fetchAllCompletedStates</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCarouselCardData">fetchCarouselCardData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchComment">fetchComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCommentRelies">fetchCommentRelies</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchComments">fetchComments</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedContent">fetchCompletedContent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedState">fetchCompletedState</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentInProgress">fetchContentInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentPageUserData">fetchContentPageUserData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchNextContentDataForParent">fetchNextContentDataForParent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchRecentUserActivities">fetchRecentUserActivities</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchSongsInProgress">fetchSongsInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchTopComment">fetchTopComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserAward">fetchUserAward</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserBadges">fetchUserBadges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserPracticeNotes">fetchUserPracticeNotes</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.likeComment">likeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.openComment">openComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentComplete">postContentComplete</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentReset">postContentReset</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentRestore">postContentRestore</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentStart">postContentStart</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.replyToComment">replyToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.reportComment">reportComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.restoreComment">restoreComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.setStudentViewForUser">setStudentViewForUser</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.unassignModeratorToComment">unassignModeratorToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.unlikeComment">unlikeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#~fetchLastInteractedChild">fetchLastInteractedChild</a></li></ul></li><li><a href="module-Sanity-Services.html">Sanity-Services</a><ul class='methods'><li data-type='method'><a href="module-Sanity-Services.html#.fetchAll">fetchAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllFilterOptions">fetchAllFilterOptions</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllPacks">fetchAllPacks</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchArtistLessons">fetchArtistLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchArtists">fetchArtists</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByRailContentId">fetchByRailContentId</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByRailContentIds">fetchByRailContentIds</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByReference">fetchByReference</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchCoachLessons">fetchCoachLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchComingSoon">fetchComingSoon</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchCommentModContentData">fetchCommentModContentData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchFoundation">fetchFoundation</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchGenreLessons">fetchGenreLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLeaving">fetchLeaving</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLessonContent">fetchLessonContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLessonsFeaturingThisContent">fetchLessonsFeaturingThisContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMetadata">fetchMetadata</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethod">fetchMethod</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodChildren">fetchMethodChildren</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodChildrenIds">fetchMethodChildrenIds</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodPreviousNextLesson">fetchMethodPreviousNextLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodV2IntroVideo">fetchMethodV2IntroVideo</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodV2Structure">fetchMethodV2Structure</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchNewReleases">fetchNewReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchNextPreviousLesson">fetchNextPreviousLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchOtherSongVersions">fetchOtherSongVersions</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackAll">fetchPackAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackData">fetchPackData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedLessons">fetchRelatedLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedRecommendedContent">fetchRelatedRecommendedContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedSongs">fetchRelatedSongs</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchReturning">fetchReturning</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSanity">fetchSanity</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchScheduledReleases">fetchScheduledReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchShowsData">fetchShowsData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSiblingContent">fetchSiblingContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongArtistCount">fetchSongArtistCount</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSongById">fetchSongById</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchUpcomingEvents">fetchUpcomingEvents</a></li><li data-type='method'><a href="module-Sanity-Services.html#.jumpToContinueContent">jumpToContinueContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#~fetchRelatedByLicense">fetchRelatedByLicense</a></li><li data-type='method'><a href="module-Sanity-Services.html#~getQueryFromPage">getQueryFromPage</a></li></ul></li><li><a href="module-Sessions.html">Sessions</a><ul class='methods'><li data-type='method'><a href="module-Sessions.html#.login">login</a></li><li data-type='method'><a href="module-Sessions.html#.logout">logout</a></li></ul></li><li><a href="module-UserActivity.html">UserActivity</a><ul class='methods'><li data-type='method'><a href="module-UserActivity.html#.calculateLongestStreaks">calculateLongestStreaks</a></li><li data-type='method'><a href="module-UserActivity.html#.createPracticeNotes">createPracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.deletePracticeSession">deletePracticeSession</a></li><li data-type='method'><a href="module-UserActivity.html#.deleteUserActivity">deleteUserActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.getPracticeNotes">getPracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.getPracticeSessions">getPracticeSessions</a></li><li data-type='method'><a href="module-UserActivity.html#.getProgressRows">getProgressRows</a></li><li data-type='method'><a href="module-UserActivity.html#.getRecentActivity">getRecentActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.getUserMonthlyStats">getUserMonthlyStats</a></li><li data-type='method'><a href="module-UserActivity.html#.getUserWeeklyStats">getUserWeeklyStats</a></li><li data-type='method'><a href="module-UserActivity.html#.pinProgressRow">pinProgressRow</a></li><li data-type='method'><a href="module-UserActivity.html#.recordUserActivity">recordUserActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.recordUserPractice">recordUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.removeUserPractice">removeUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.restorePracticeSession">restorePracticeSession</a></li><li data-type='method'><a href="module-UserActivity.html#.restoreUserActivity">restoreUserActivity</a></li><li data-type='method'><a href="module-UserActivity.html#.restoreUserPractice">restoreUserPractice</a></li><li data-type='method'><a href="module-UserActivity.html#.unpinProgressRow">unpinProgressRow</a></li><li data-type='method'><a href="module-UserActivity.html#.updatePracticeNotes">updatePracticeNotes</a></li><li data-type='method'><a href="module-UserActivity.html#.updateUserPractice">updateUserPractice</a></li></ul></li><li><a href="module-UserChat.html">UserChat</a><ul class='methods'><li data-type='method'><a href="module-UserChat.html#.fetchChatSettings">fetchChatSettings</a></li></ul></li><li><a href="module-UserManagement.html">UserManagement</a><ul class='methods'><li data-type='method'><a href="module-UserManagement.html#.blockUser">blockUser</a></li><li data-type='method'><a href="module-UserManagement.html#.blockedUsers">blockedUsers</a></li><li data-type='method'><a href="module-UserManagement.html#.deletePicture">deletePicture</a></li><li data-type='method'><a href="module-UserManagement.html#.getUserData">getUserData</a></li><li data-type='method'><a href="module-UserManagement.html#.getUserSignature">getUserSignature</a></li><li data-type='method'><a href="module-UserManagement.html#.isUsernameAvailable">isUsernameAvailable</a></li><li data-type='method'><a href="module-UserManagement.html#.setUserSignature">setUserSignature</a></li><li data-type='method'><a href="module-UserManagement.html#.toggleSignaturePrivate">toggleSignaturePrivate</a></li><li data-type='method'><a href="module-UserManagement.html#.unblockUser">unblockUser</a></li><li data-type='method'><a href="module-UserManagement.html#.updateDisplayName">updateDisplayName</a></li><li data-type='method'><a href="module-UserManagement.html#.uploadPicture">uploadPicture</a></li><li data-type='method'><a href="module-UserManagement.html#.uploadPictureFromS3">uploadPictureFromS3</a></li></ul></li><li><a href="module-UserMemberships.html">UserMemberships</a><ul class='methods'><li data-type='method'><a href="module-UserMemberships.html#~fetchMemberships">fetchMemberships</a></li><li data-type='method'><a href="module-UserMemberships.html#~fetchRechargeTokens">fetchRechargeTokens</a></li><li data-type='method'><a href="module-UserMemberships.html#~restorePurchases">restorePurchases</a></li><li data-type='method'><a href="module-UserMemberships.html#~upgradeSubscription">upgradeSubscription</a></li></ul></li><li><a href="module-UserNotifications.html">UserNotifications</a><ul class='methods'><li data-type='method'><a href="module-UserNotifications.html#.deleteNotification">deleteNotification</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchLiveEventPollingState">fetchLiveEventPollingState</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchNotificationSettings">fetchNotificationSettings</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchNotifications">fetchNotifications</a></li><li data-type='method'><a href="module-UserNotifications.html#.fetchUnreadCount">fetchUnreadCount</a></li><li data-type='method'><a href="module-UserNotifications.html#.markAllNotificationsAsRead">markAllNotificationsAsRead</a></li><li data-type='method'><a href="module-UserNotifications.html#.markNotificationAsRead">markNotificationAsRead</a></li><li data-type='method'><a href="module-UserNotifications.html#.markNotificationAsUnread">markNotificationAsUnread</a></li><li data-type='method'><a href="module-UserNotifications.html#.pauseLiveEventPolling">pauseLiveEventPolling</a></li><li data-type='method'><a href="module-UserNotifications.html#.restoreNotification">restoreNotification</a></li><li data-type='method'><a href="module-UserNotifications.html#.startLiveEventPolling">startLiveEventPolling</a></li><li data-type='method'><a href="module-UserNotifications.html#.updateNotificationSetting">updateNotificationSetting</a></li></ul></li><li><a href="module-UserProfile.html">UserProfile</a><ul class='methods'><li data-type='method'><a href="module-UserProfile.html#.deleteProfilePicture">deleteProfilePicture</a></li><li data-type='method'><a href="module-UserProfile.html#.otherStats">otherStats</a></li></ul></li></ul><h3>Namespaces</h3><ul><li><a href="ContentOrganization.html">ContentOrganization</a></li><li><a href="Forums.html">Forums</a></li><li><a href="Gamification.html">Gamification</a></li><li><a href="UserManagementSystem.html">UserManagementSystem</a></li></ul><h3>Interfaces</h3><ul><li><a href="TestUser.html">TestUser</a></li></ul><h3>Global</h3><ul><li><a href="global.html#createTestUser">createTestUser</a></li></ul>
33
33
 
34
34
  </nav>
35
35
 
@@ -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#line16">line 16</a>
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
 
@@ -682,7 +682,7 @@
682
682
 
683
683
  <dt class="tag-source">Source:</dt>
684
684
  <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#line104">line 104</a>
685
+ <a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line112">line 112</a>
686
686
  </li></ul></dd>
687
687
 
688
688
 
@@ -894,7 +894,7 @@
894
894
 
895
895
  <dt class="tag-source">Source:</dt>
896
896
  <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#line188">line 188</a>
897
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line201">line 201</a>
898
898
  </li></ul></dd>
899
899
 
900
900
 
@@ -1106,7 +1106,7 @@
1106
1106
 
1107
1107
  <dt class="tag-source">Source:</dt>
1108
1108
  <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#line117">line 117</a>
1109
+ <a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line125">line 125</a>
1110
1110
  </li></ul></dd>
1111
1111
 
1112
1112
 
@@ -1294,7 +1294,7 @@
1294
1294
 
1295
1295
  <dt class="tag-source">Source:</dt>
1296
1296
  <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#line160">line 160</a>
1297
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line173">line 173</a>
1298
1298
  </li></ul></dd>
1299
1299
 
1300
1300
 
@@ -1673,7 +1673,7 @@
1673
1673
 
1674
1674
  <dt class="tag-source">Source:</dt>
1675
1675
  <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#line174">line 174</a>
1676
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line187">line 187</a>
1677
1677
  </li></ul></dd>
1678
1678
 
1679
1679
 
@@ -1855,13 +1855,14 @@
1855
1855
  <dl class="details">
1856
1856
 
1857
1857
  <dt class="tag-description">Description:</dt>
1858
- <dd class="tag-description"><ul class="dummy"><li>Fetches posts for the given thread.</li></ul></dd>
1858
+ <dd class="tag-description"><ul class="dummy"><li>Fetches posts for the given thread.
1859
+ Automatically marks the thread as read when posts are fetched.</li></ul></dd>
1859
1860
 
1860
1861
 
1861
1862
 
1862
1863
  <dt class="tag-source">Source:</dt>
1863
1864
  <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#line48">line 48</a>
1865
+ <a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line49">line 49</a>
1865
1866
  </li></ul></dd>
1866
1867
 
1867
1868
 
@@ -2125,7 +2126,7 @@
2125
2126
 
2126
2127
  <dt class="tag-source">Source:</dt>
2127
2128
  <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#line84">line 84</a>
2129
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line97">line 97</a>
2129
2130
  </li></ul></dd>
2130
2131
 
2131
2132
 
@@ -2567,13 +2568,14 @@
2567
2568
  <dl class="details">
2568
2569
 
2569
2570
  <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.</li></ul></dd>
2571
+ <dd class="tag-description"><ul class="dummy"><li>Fetches posts for the given post, jumping to the post's location in the thread.
2572
+ Automatically marks the thread as read when posts are fetched.</li></ul></dd>
2571
2573
 
2572
2574
 
2573
2575
 
2574
2576
  <dt class="tag-source">Source:</dt>
2575
2577
  <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#line166">line 166</a>
2578
+ <a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line174">line 174</a>
2577
2579
  </li></ul></dd>
2578
2580
 
2579
2581
 
@@ -2837,7 +2839,7 @@
2837
2839
 
2838
2840
  <dt class="tag-source">Source:</dt>
2839
2841
  <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#line77">line 77</a>
2842
+ <a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line85">line 85</a>
2841
2843
  </li></ul></dd>
2842
2844
 
2843
2845
 
@@ -3049,7 +3051,7 @@
3049
3051
 
3050
3052
  <dt class="tag-source">Source:</dt>
3051
3053
  <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#line134">line 134</a>
3054
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line147">line 147</a>
3053
3055
  </li></ul></dd>
3054
3056
 
3055
3057
 
@@ -3245,6 +3247,218 @@
3245
3247
 
3246
3248
 
3247
3249
 
3250
+ <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"> &rarr; {Promise.&lt;void>}</span></h4>
3251
+
3252
+
3253
+
3254
+
3255
+
3256
+
3257
+ <dl class="details">
3258
+
3259
+ <dt class="tag-description">Description:</dt>
3260
+ <dd class="tag-description"><ul class="dummy"><li>Marks a thread as read for the authenticated user.</li></ul></dd>
3261
+
3262
+
3263
+
3264
+ <dt class="tag-source">Source:</dt>
3265
+ <dd class="tag-source"><ul class="dummy"><li>
3266
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line78">line 78</a>
3267
+ </li></ul></dd>
3268
+
3269
+
3270
+
3271
+
3272
+
3273
+
3274
+
3275
+
3276
+
3277
+
3278
+
3279
+
3280
+
3281
+
3282
+
3283
+
3284
+
3285
+
3286
+
3287
+
3288
+
3289
+
3290
+
3291
+
3292
+
3293
+
3294
+
3295
+
3296
+
3297
+
3298
+
3299
+ </dl>
3300
+
3301
+
3302
+
3303
+
3304
+
3305
+
3306
+
3307
+
3308
+
3309
+
3310
+
3311
+
3312
+
3313
+ <h5 class="h5-parameters">Parameters:</h5>
3314
+
3315
+
3316
+ <table class="params">
3317
+ <thead>
3318
+ <tr>
3319
+
3320
+ <th>Name</th>
3321
+
3322
+
3323
+ <th>Type</th>
3324
+
3325
+
3326
+
3327
+
3328
+
3329
+ <th class="last">Description</th>
3330
+ </tr>
3331
+ </thead>
3332
+
3333
+ <tbody>
3334
+
3335
+
3336
+ <tr>
3337
+
3338
+ <td class="name"><code>threadId</code></td>
3339
+
3340
+
3341
+ <td class="type">
3342
+
3343
+
3344
+ <span class="param-type">number</span>
3345
+
3346
+
3347
+
3348
+
3349
+ </td>
3350
+
3351
+
3352
+
3353
+
3354
+
3355
+ <td class="description last">The ID of the thread to mark as read.</td>
3356
+ </tr>
3357
+
3358
+
3359
+
3360
+ <tr>
3361
+
3362
+ <td class="name"><code>brand</code></td>
3363
+
3364
+
3365
+ <td class="type">
3366
+
3367
+
3368
+ <span class="param-type">string</span>
3369
+
3370
+
3371
+
3372
+
3373
+ </td>
3374
+
3375
+
3376
+
3377
+
3378
+
3379
+ <td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
3380
+ </tr>
3381
+
3382
+
3383
+ </tbody>
3384
+ </table>
3385
+
3386
+
3387
+
3388
+
3389
+
3390
+
3391
+
3392
+
3393
+
3394
+
3395
+
3396
+
3397
+
3398
+
3399
+ <h5 class="h5-throws">Throws:</h5>
3400
+
3401
+
3402
+
3403
+ <dl>
3404
+ <dt>
3405
+ <div class="param-desc usertext">
3406
+ - If the request fails.
3407
+ </div>
3408
+ </dt>
3409
+ <dd></dd>
3410
+ <dt>
3411
+ <dl class="param-type">
3412
+ <dt>
3413
+ Type
3414
+ </dt>
3415
+ <dd>
3416
+
3417
+ <span class="param-type">HttpError</span>
3418
+
3419
+
3420
+
3421
+ </dd>
3422
+ </dl>
3423
+ </dt>
3424
+ <dd></dd>
3425
+ </dl>
3426
+
3427
+
3428
+
3429
+
3430
+
3431
+ <h5 class="h5-returns">Returns:</h5>
3432
+
3433
+
3434
+ <div class="param-desc">
3435
+ - A promise that resolves when the thread is marked as read.
3436
+ </div>
3437
+
3438
+
3439
+
3440
+ <dl class="param-type">
3441
+ <dt>
3442
+ Type
3443
+ </dt>
3444
+ <dd>
3445
+
3446
+ <span class="param-type">Promise.&lt;void></span>
3447
+
3448
+
3449
+
3450
+ </dd>
3451
+ </dl>
3452
+
3453
+
3454
+
3455
+
3456
+
3457
+
3458
+
3459
+
3460
+
3461
+
3248
3462
  <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"> &rarr; {Promise.&lt;void>}</span></h4>
3249
3463
 
3250
3464
 
@@ -3261,7 +3475,7 @@
3261
3475
 
3262
3476
  <dt class="tag-source">Source:</dt>
3263
3477
  <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#line108">line 108</a>
3478
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line121">line 121</a>
3265
3479
  </li></ul></dd>
3266
3480
 
3267
3481
 
@@ -3473,7 +3687,7 @@
3473
3687
 
3474
3688
  <dt class="tag-source">Source:</dt>
3475
3689
  <dd class="tag-source"><ul class="dummy"><li>
3476
- <a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line139">line 139</a>
3690
+ <a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line147">line 147</a>
3477
3691
  </li></ul></dd>
3478
3692
 
3479
3693
 
@@ -3917,7 +4131,7 @@
3917
4131
 
3918
4132
  <dt class="tag-source">Source:</dt>
3919
4133
  <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#line90">line 90</a>
4134
+ <a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line98">line 98</a>
3921
4135
  </li></ul></dd>
3922
4136
 
3923
4137
 
@@ -4129,7 +4343,7 @@
4129
4343
 
4130
4344
  <dt class="tag-source">Source:</dt>
4131
4345
  <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#line147">line 147</a>
4346
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line160">line 160</a>
4133
4347
  </li></ul></dd>
4134
4348
 
4135
4349
 
@@ -4341,7 +4555,7 @@
4341
4555
 
4342
4556
  <dt class="tag-source">Source:</dt>
4343
4557
  <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#line121">line 121</a>
4558
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line134">line 134</a>
4345
4559
  </li></ul></dd>
4346
4560
 
4347
4561
 
@@ -4741,7 +4955,7 @@
4741
4955
 
4742
4956
  <dt class="tag-source">Source:</dt>
4743
4957
  <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#line29">line 29</a>
4958
+ <a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line30">line 30</a>
4745
4959
  </li></ul></dd>
4746
4960
 
4747
4961
 
@@ -5399,7 +5613,7 @@
5399
5613
 
5400
5614
  <dt class="tag-source">Source:</dt>
5401
5615
  <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#line16">line 16</a>
5616
+ <a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line17">line 17</a>
5403
5617
  </li></ul></dd>
5404
5618
 
5405
5619
 
@@ -5793,7 +6007,7 @@
5793
6007
 
5794
6008
  <dt class="tag-source">Source:</dt>
5795
6009
  <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#line104">line 104</a>
6010
+ <a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line112">line 112</a>
5797
6011
  </li></ul></dd>
5798
6012
 
5799
6013
 
@@ -6005,7 +6219,7 @@
6005
6219
 
6006
6220
  <dt class="tag-source">Source:</dt>
6007
6221
  <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#line188">line 188</a>
6222
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line201">line 201</a>
6009
6223
  </li></ul></dd>
6010
6224
 
6011
6225
 
@@ -6217,7 +6431,7 @@
6217
6431
 
6218
6432
  <dt class="tag-source">Source:</dt>
6219
6433
  <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#line117">line 117</a>
6434
+ <a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line125">line 125</a>
6221
6435
  </li></ul></dd>
6222
6436
 
6223
6437
 
@@ -6405,7 +6619,7 @@
6405
6619
 
6406
6620
  <dt class="tag-source">Source:</dt>
6407
6621
  <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#line160">line 160</a>
6622
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line173">line 173</a>
6409
6623
  </li></ul></dd>
6410
6624
 
6411
6625
 
@@ -6784,7 +6998,7 @@
6784
6998
 
6785
6999
  <dt class="tag-source">Source:</dt>
6786
7000
  <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#line174">line 174</a>
7001
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line187">line 187</a>
6788
7002
  </li></ul></dd>
6789
7003
 
6790
7004
 
@@ -6966,13 +7180,14 @@
6966
7180
  <dl class="details">
6967
7181
 
6968
7182
  <dt class="tag-description">Description:</dt>
6969
- <dd class="tag-description"><ul class="dummy"><li>Fetches posts for the given thread.</li></ul></dd>
7183
+ <dd class="tag-description"><ul class="dummy"><li>Fetches posts for the given thread.
7184
+ Automatically marks the thread as read when posts are fetched.</li></ul></dd>
6970
7185
 
6971
7186
 
6972
7187
 
6973
7188
  <dt class="tag-source">Source:</dt>
6974
7189
  <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#line48">line 48</a>
7190
+ <a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line49">line 49</a>
6976
7191
  </li></ul></dd>
6977
7192
 
6978
7193
 
@@ -7236,7 +7451,7 @@
7236
7451
 
7237
7452
  <dt class="tag-source">Source:</dt>
7238
7453
  <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#line84">line 84</a>
7454
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line97">line 97</a>
7240
7455
  </li></ul></dd>
7241
7456
 
7242
7457
 
@@ -7678,13 +7893,14 @@
7678
7893
  <dl class="details">
7679
7894
 
7680
7895
  <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.</li></ul></dd>
7896
+ <dd class="tag-description"><ul class="dummy"><li>Fetches posts for the given post, jumping to the post's location in the thread.
7897
+ Automatically marks the thread as read when posts are fetched.</li></ul></dd>
7682
7898
 
7683
7899
 
7684
7900
 
7685
7901
  <dt class="tag-source">Source:</dt>
7686
7902
  <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#line166">line 166</a>
7903
+ <a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line174">line 174</a>
7688
7904
  </li></ul></dd>
7689
7905
 
7690
7906
 
@@ -7948,7 +8164,7 @@
7948
8164
 
7949
8165
  <dt class="tag-source">Source:</dt>
7950
8166
  <dd class="tag-source"><ul class="dummy"><li>
7951
- <a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line77">line 77</a>
8167
+ <a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line85">line 85</a>
7952
8168
  </li></ul></dd>
7953
8169
 
7954
8170
 
@@ -8160,7 +8376,7 @@
8160
8376
 
8161
8377
  <dt class="tag-source">Source:</dt>
8162
8378
  <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#line134">line 134</a>
8379
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line147">line 147</a>
8164
8380
  </li></ul></dd>
8165
8381
 
8166
8382
 
@@ -8356,7 +8572,7 @@
8356
8572
 
8357
8573
 
8358
8574
 
8359
- <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"> &rarr; {Promise.&lt;void>}</span></h4>
8575
+ <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"> &rarr; {Promise.&lt;void>}</span></h4>
8360
8576
 
8361
8577
 
8362
8578
 
@@ -8366,13 +8582,13 @@
8366
8582
  <dl class="details">
8367
8583
 
8368
8584
  <dt class="tag-description">Description:</dt>
8369
- <dd class="tag-description"><ul class="dummy"><li>Pins a thread to the top of its category.</li></ul></dd>
8585
+ <dd class="tag-description"><ul class="dummy"><li>Marks a thread as read for the authenticated user.</li></ul></dd>
8370
8586
 
8371
8587
 
8372
8588
 
8373
8589
  <dt class="tag-source">Source:</dt>
8374
8590
  <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#line108">line 108</a>
8591
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line78">line 78</a>
8376
8592
  </li></ul></dd>
8377
8593
 
8378
8594
 
@@ -8461,7 +8677,7 @@
8461
8677
 
8462
8678
 
8463
8679
 
8464
- <td class="description last">The ID of the thread to pin.</td>
8680
+ <td class="description last">The ID of the thread to mark as read.</td>
8465
8681
  </tr>
8466
8682
 
8467
8683
 
@@ -8541,7 +8757,7 @@
8541
8757
 
8542
8758
 
8543
8759
  <div class="param-desc">
8544
- - A promise that resolves when the thread is pinned.
8760
+ - A promise that resolves when the thread is marked as read.
8545
8761
  </div>
8546
8762
 
8547
8763
 
@@ -8568,7 +8784,7 @@
8568
8784
 
8569
8785
 
8570
8786
 
8571
- <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"> &rarr; {Promise.&lt;<a href="global.html#PaginatedResponse">PaginatedResponse</a>.&lt;ForumPost>>}</span></h4>
8787
+ <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"> &rarr; {Promise.&lt;void>}</span></h4>
8572
8788
 
8573
8789
 
8574
8790
 
@@ -8578,13 +8794,13 @@
8578
8794
  <dl class="details">
8579
8795
 
8580
8796
  <dt class="tag-description">Description:</dt>
8581
- <dd class="tag-description"><ul class="dummy"><li>Search forum posts.</li></ul></dd>
8797
+ <dd class="tag-description"><ul class="dummy"><li>Pins a thread to the top of its category.</li></ul></dd>
8582
8798
 
8583
8799
 
8584
8800
 
8585
8801
  <dt class="tag-source">Source:</dt>
8586
8802
  <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#line139">line 139</a>
8803
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line121">line 121</a>
8588
8804
  </li></ul></dd>
8589
8805
 
8590
8806
 
@@ -8644,8 +8860,6 @@
8644
8860
  <th>Type</th>
8645
8861
 
8646
8862
 
8647
- <th>Attributes</th>
8648
-
8649
8863
 
8650
8864
 
8651
8865
 
@@ -8658,13 +8872,13 @@
8658
8872
 
8659
8873
  <tr>
8660
8874
 
8661
- <td class="name"><code>brand</code></td>
8875
+ <td class="name"><code>threadId</code></td>
8662
8876
 
8663
8877
 
8664
8878
  <td class="type">
8665
8879
 
8666
8880
 
8667
- <span class="param-type">string</span>
8881
+ <span class="param-type">number</span>
8668
8882
 
8669
8883
 
8670
8884
 
@@ -8672,31 +8886,23 @@
8672
8886
  </td>
8673
8887
 
8674
8888
 
8675
- <td class="attributes">
8676
-
8677
-
8678
-
8679
-
8680
-
8681
- </td>
8682
-
8683
8889
 
8684
8890
 
8685
8891
 
8686
- <td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
8892
+ <td class="description last">The ID of the thread to pin.</td>
8687
8893
  </tr>
8688
8894
 
8689
8895
 
8690
8896
 
8691
8897
  <tr>
8692
8898
 
8693
- <td class="name"><code>params</code></td>
8899
+ <td class="name"><code>brand</code></td>
8694
8900
 
8695
8901
 
8696
8902
  <td class="type">
8697
8903
 
8698
8904
 
8699
- <span class="param-type">SearchParams</span>
8905
+ <span class="param-type">string</span>
8700
8906
 
8701
8907
 
8702
8908
 
@@ -8704,18 +8910,240 @@
8704
8910
  </td>
8705
8911
 
8706
8912
 
8707
- <td class="attributes">
8708
-
8709
- &lt;optional><br>
8710
-
8711
-
8712
-
8713
8913
 
8714
-
8715
- </td>
8716
8914
 
8717
8915
 
8718
-
8916
+ <td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
8917
+ </tr>
8918
+
8919
+
8920
+ </tbody>
8921
+ </table>
8922
+
8923
+
8924
+
8925
+
8926
+
8927
+
8928
+
8929
+
8930
+
8931
+
8932
+
8933
+
8934
+
8935
+
8936
+ <h5 class="h5-throws">Throws:</h5>
8937
+
8938
+
8939
+
8940
+ <dl>
8941
+ <dt>
8942
+ <div class="param-desc usertext">
8943
+ - If the request fails.
8944
+ </div>
8945
+ </dt>
8946
+ <dd></dd>
8947
+ <dt>
8948
+ <dl class="param-type">
8949
+ <dt>
8950
+ Type
8951
+ </dt>
8952
+ <dd>
8953
+
8954
+ <span class="param-type">HttpError</span>
8955
+
8956
+
8957
+
8958
+ </dd>
8959
+ </dl>
8960
+ </dt>
8961
+ <dd></dd>
8962
+ </dl>
8963
+
8964
+
8965
+
8966
+
8967
+
8968
+ <h5 class="h5-returns">Returns:</h5>
8969
+
8970
+
8971
+ <div class="param-desc">
8972
+ - A promise that resolves when the thread is pinned.
8973
+ </div>
8974
+
8975
+
8976
+
8977
+ <dl class="param-type">
8978
+ <dt>
8979
+ Type
8980
+ </dt>
8981
+ <dd>
8982
+
8983
+ <span class="param-type">Promise.&lt;void></span>
8984
+
8985
+
8986
+
8987
+ </dd>
8988
+ </dl>
8989
+
8990
+
8991
+
8992
+
8993
+
8994
+
8995
+
8996
+
8997
+
8998
+
8999
+ <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"> &rarr; {Promise.&lt;<a href="global.html#PaginatedResponse">PaginatedResponse</a>.&lt;ForumPost>>}</span></h4>
9000
+
9001
+
9002
+
9003
+
9004
+
9005
+
9006
+ <dl class="details">
9007
+
9008
+ <dt class="tag-description">Description:</dt>
9009
+ <dd class="tag-description"><ul class="dummy"><li>Search forum posts.</li></ul></dd>
9010
+
9011
+
9012
+
9013
+ <dt class="tag-source">Source:</dt>
9014
+ <dd class="tag-source"><ul class="dummy"><li>
9015
+ <a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line147">line 147</a>
9016
+ </li></ul></dd>
9017
+
9018
+
9019
+
9020
+
9021
+
9022
+
9023
+
9024
+
9025
+
9026
+
9027
+
9028
+
9029
+
9030
+
9031
+
9032
+
9033
+
9034
+
9035
+
9036
+
9037
+
9038
+
9039
+
9040
+
9041
+
9042
+
9043
+
9044
+
9045
+
9046
+
9047
+
9048
+ </dl>
9049
+
9050
+
9051
+
9052
+
9053
+
9054
+
9055
+
9056
+
9057
+
9058
+
9059
+
9060
+
9061
+
9062
+ <h5 class="h5-parameters">Parameters:</h5>
9063
+
9064
+
9065
+ <table class="params">
9066
+ <thead>
9067
+ <tr>
9068
+
9069
+ <th>Name</th>
9070
+
9071
+
9072
+ <th>Type</th>
9073
+
9074
+
9075
+ <th>Attributes</th>
9076
+
9077
+
9078
+
9079
+
9080
+ <th class="last">Description</th>
9081
+ </tr>
9082
+ </thead>
9083
+
9084
+ <tbody>
9085
+
9086
+
9087
+ <tr>
9088
+
9089
+ <td class="name"><code>brand</code></td>
9090
+
9091
+
9092
+ <td class="type">
9093
+
9094
+
9095
+ <span class="param-type">string</span>
9096
+
9097
+
9098
+
9099
+
9100
+ </td>
9101
+
9102
+
9103
+ <td class="attributes">
9104
+
9105
+
9106
+
9107
+
9108
+
9109
+ </td>
9110
+
9111
+
9112
+
9113
+
9114
+ <td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
9115
+ </tr>
9116
+
9117
+
9118
+
9119
+ <tr>
9120
+
9121
+ <td class="name"><code>params</code></td>
9122
+
9123
+
9124
+ <td class="type">
9125
+
9126
+
9127
+ <span class="param-type">SearchParams</span>
9128
+
9129
+
9130
+
9131
+
9132
+ </td>
9133
+
9134
+
9135
+ <td class="attributes">
9136
+
9137
+ &lt;optional><br>
9138
+
9139
+
9140
+
9141
+
9142
+
9143
+ </td>
9144
+
9145
+
9146
+
8719
9147
 
8720
9148
  <td class="description last">Optional search parameters such as `query`, `page`, `limit`, and `sort`.</td>
8721
9149
  </tr>
@@ -9028,7 +9456,7 @@
9028
9456
 
9029
9457
  <dt class="tag-source">Source:</dt>
9030
9458
  <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#line90">line 90</a>
9459
+ <a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line98">line 98</a>
9032
9460
  </li></ul></dd>
9033
9461
 
9034
9462
 
@@ -9240,7 +9668,7 @@
9240
9668
 
9241
9669
  <dt class="tag-source">Source:</dt>
9242
9670
  <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#line147">line 147</a>
9671
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line160">line 160</a>
9244
9672
  </li></ul></dd>
9245
9673
 
9246
9674
 
@@ -9452,7 +9880,7 @@
9452
9880
 
9453
9881
  <dt class="tag-source">Source:</dt>
9454
9882
  <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#line121">line 121</a>
9883
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line134">line 134</a>
9456
9884
  </li></ul></dd>
9457
9885
 
9458
9886
 
@@ -9852,7 +10280,7 @@
9852
10280
 
9853
10281
  <dt class="tag-source">Source:</dt>
9854
10282
  <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#line29">line 29</a>
10283
+ <a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line30">line 30</a>
9856
10284
  </li></ul></dd>
9857
10285
 
9858
10286
 
@@ -10510,7 +10938,7 @@
10510
10938
 
10511
10939
  <dt class="tag-source">Source:</dt>
10512
10940
  <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#line16">line 16</a>
10941
+ <a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line17">line 17</a>
10514
10942
  </li></ul></dd>
10515
10943
 
10516
10944
 
@@ -10904,7 +11332,7 @@
10904
11332
 
10905
11333
  <dt class="tag-source">Source:</dt>
10906
11334
  <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#line104">line 104</a>
11335
+ <a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line112">line 112</a>
10908
11336
  </li></ul></dd>
10909
11337
 
10910
11338
 
@@ -11116,7 +11544,7 @@
11116
11544
 
11117
11545
  <dt class="tag-source">Source:</dt>
11118
11546
  <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#line188">line 188</a>
11547
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line201">line 201</a>
11120
11548
  </li></ul></dd>
11121
11549
 
11122
11550
 
@@ -11328,7 +11756,7 @@
11328
11756
 
11329
11757
  <dt class="tag-source">Source:</dt>
11330
11758
  <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#line117">line 117</a>
11759
+ <a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line125">line 125</a>
11332
11760
  </li></ul></dd>
11333
11761
 
11334
11762
 
@@ -11516,7 +11944,7 @@
11516
11944
 
11517
11945
  <dt class="tag-source">Source:</dt>
11518
11946
  <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#line160">line 160</a>
11947
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line173">line 173</a>
11520
11948
  </li></ul></dd>
11521
11949
 
11522
11950
 
@@ -11895,7 +12323,7 @@
11895
12323
 
11896
12324
  <dt class="tag-source">Source:</dt>
11897
12325
  <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#line174">line 174</a>
12326
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line187">line 187</a>
11899
12327
  </li></ul></dd>
11900
12328
 
11901
12329
 
@@ -12077,13 +12505,14 @@
12077
12505
  <dl class="details">
12078
12506
 
12079
12507
  <dt class="tag-description">Description:</dt>
12080
- <dd class="tag-description"><ul class="dummy"><li>Fetches posts for the given thread.</li></ul></dd>
12508
+ <dd class="tag-description"><ul class="dummy"><li>Fetches posts for the given thread.
12509
+ Automatically marks the thread as read when posts are fetched.</li></ul></dd>
12081
12510
 
12082
12511
 
12083
12512
 
12084
12513
  <dt class="tag-source">Source:</dt>
12085
12514
  <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#line48">line 48</a>
12515
+ <a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line49">line 49</a>
12087
12516
  </li></ul></dd>
12088
12517
 
12089
12518
 
@@ -12347,7 +12776,7 @@
12347
12776
 
12348
12777
  <dt class="tag-source">Source:</dt>
12349
12778
  <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#line84">line 84</a>
12779
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line97">line 97</a>
12351
12780
  </li></ul></dd>
12352
12781
 
12353
12782
 
@@ -12789,13 +13218,14 @@
12789
13218
  <dl class="details">
12790
13219
 
12791
13220
  <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.</li></ul></dd>
13221
+ <dd class="tag-description"><ul class="dummy"><li>Fetches posts for the given post, jumping to the post's location in the thread.
13222
+ Automatically marks the thread as read when posts are fetched.</li></ul></dd>
12793
13223
 
12794
13224
 
12795
13225
 
12796
13226
  <dt class="tag-source">Source:</dt>
12797
13227
  <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#line166">line 166</a>
13228
+ <a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line174">line 174</a>
12799
13229
  </li></ul></dd>
12800
13230
 
12801
13231
 
@@ -13059,7 +13489,7 @@
13059
13489
 
13060
13490
  <dt class="tag-source">Source:</dt>
13061
13491
  <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#line77">line 77</a>
13492
+ <a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line85">line 85</a>
13063
13493
  </li></ul></dd>
13064
13494
 
13065
13495
 
@@ -13271,7 +13701,7 @@
13271
13701
 
13272
13702
  <dt class="tag-source">Source:</dt>
13273
13703
  <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#line134">line 134</a>
13704
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line147">line 147</a>
13275
13705
  </li></ul></dd>
13276
13706
 
13277
13707
 
@@ -13467,6 +13897,218 @@
13467
13897
 
13468
13898
 
13469
13899
 
13900
+ <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"> &rarr; {Promise.&lt;void>}</span></h4>
13901
+
13902
+
13903
+
13904
+
13905
+
13906
+
13907
+ <dl class="details">
13908
+
13909
+ <dt class="tag-description">Description:</dt>
13910
+ <dd class="tag-description"><ul class="dummy"><li>Marks a thread as read for the authenticated user.</li></ul></dd>
13911
+
13912
+
13913
+
13914
+ <dt class="tag-source">Source:</dt>
13915
+ <dd class="tag-source"><ul class="dummy"><li>
13916
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line78">line 78</a>
13917
+ </li></ul></dd>
13918
+
13919
+
13920
+
13921
+
13922
+
13923
+
13924
+
13925
+
13926
+
13927
+
13928
+
13929
+
13930
+
13931
+
13932
+
13933
+
13934
+
13935
+
13936
+
13937
+
13938
+
13939
+
13940
+
13941
+
13942
+
13943
+
13944
+
13945
+
13946
+
13947
+
13948
+
13949
+ </dl>
13950
+
13951
+
13952
+
13953
+
13954
+
13955
+
13956
+
13957
+
13958
+
13959
+
13960
+
13961
+
13962
+
13963
+ <h5 class="h5-parameters">Parameters:</h5>
13964
+
13965
+
13966
+ <table class="params">
13967
+ <thead>
13968
+ <tr>
13969
+
13970
+ <th>Name</th>
13971
+
13972
+
13973
+ <th>Type</th>
13974
+
13975
+
13976
+
13977
+
13978
+
13979
+ <th class="last">Description</th>
13980
+ </tr>
13981
+ </thead>
13982
+
13983
+ <tbody>
13984
+
13985
+
13986
+ <tr>
13987
+
13988
+ <td class="name"><code>threadId</code></td>
13989
+
13990
+
13991
+ <td class="type">
13992
+
13993
+
13994
+ <span class="param-type">number</span>
13995
+
13996
+
13997
+
13998
+
13999
+ </td>
14000
+
14001
+
14002
+
14003
+
14004
+
14005
+ <td class="description last">The ID of the thread to mark as read.</td>
14006
+ </tr>
14007
+
14008
+
14009
+
14010
+ <tr>
14011
+
14012
+ <td class="name"><code>brand</code></td>
14013
+
14014
+
14015
+ <td class="type">
14016
+
14017
+
14018
+ <span class="param-type">string</span>
14019
+
14020
+
14021
+
14022
+
14023
+ </td>
14024
+
14025
+
14026
+
14027
+
14028
+
14029
+ <td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
14030
+ </tr>
14031
+
14032
+
14033
+ </tbody>
14034
+ </table>
14035
+
14036
+
14037
+
14038
+
14039
+
14040
+
14041
+
14042
+
14043
+
14044
+
14045
+
14046
+
14047
+
14048
+
14049
+ <h5 class="h5-throws">Throws:</h5>
14050
+
14051
+
14052
+
14053
+ <dl>
14054
+ <dt>
14055
+ <div class="param-desc usertext">
14056
+ - If the request fails.
14057
+ </div>
14058
+ </dt>
14059
+ <dd></dd>
14060
+ <dt>
14061
+ <dl class="param-type">
14062
+ <dt>
14063
+ Type
14064
+ </dt>
14065
+ <dd>
14066
+
14067
+ <span class="param-type">HttpError</span>
14068
+
14069
+
14070
+
14071
+ </dd>
14072
+ </dl>
14073
+ </dt>
14074
+ <dd></dd>
14075
+ </dl>
14076
+
14077
+
14078
+
14079
+
14080
+
14081
+ <h5 class="h5-returns">Returns:</h5>
14082
+
14083
+
14084
+ <div class="param-desc">
14085
+ - A promise that resolves when the thread is marked as read.
14086
+ </div>
14087
+
14088
+
14089
+
14090
+ <dl class="param-type">
14091
+ <dt>
14092
+ Type
14093
+ </dt>
14094
+ <dd>
14095
+
14096
+ <span class="param-type">Promise.&lt;void></span>
14097
+
14098
+
14099
+
14100
+ </dd>
14101
+ </dl>
14102
+
14103
+
14104
+
14105
+
14106
+
14107
+
14108
+
14109
+
14110
+
14111
+
13470
14112
  <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"> &rarr; {Promise.&lt;void>}</span></h4>
13471
14113
 
13472
14114
 
@@ -13483,7 +14125,7 @@
13483
14125
 
13484
14126
  <dt class="tag-source">Source:</dt>
13485
14127
  <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#line108">line 108</a>
14128
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line121">line 121</a>
13487
14129
  </li></ul></dd>
13488
14130
 
13489
14131
 
@@ -13695,7 +14337,7 @@
13695
14337
 
13696
14338
  <dt class="tag-source">Source:</dt>
13697
14339
  <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#line139">line 139</a>
14340
+ <a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line147">line 147</a>
13699
14341
  </li></ul></dd>
13700
14342
 
13701
14343
 
@@ -14139,7 +14781,7 @@
14139
14781
 
14140
14782
  <dt class="tag-source">Source:</dt>
14141
14783
  <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#line90">line 90</a>
14784
+ <a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line98">line 98</a>
14143
14785
  </li></ul></dd>
14144
14786
 
14145
14787
 
@@ -14351,7 +14993,7 @@
14351
14993
 
14352
14994
  <dt class="tag-source">Source:</dt>
14353
14995
  <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#line147">line 147</a>
14996
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line160">line 160</a>
14355
14997
  </li></ul></dd>
14356
14998
 
14357
14999
 
@@ -14563,7 +15205,7 @@
14563
15205
 
14564
15206
  <dt class="tag-source">Source:</dt>
14565
15207
  <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#line121">line 121</a>
15208
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line134">line 134</a>
14567
15209
  </li></ul></dd>
14568
15210
 
14569
15211
 
@@ -14963,7 +15605,7 @@
14963
15605
 
14964
15606
  <dt class="tag-source">Source:</dt>
14965
15607
  <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#line29">line 29</a>
15608
+ <a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line30">line 30</a>
14967
15609
  </li></ul></dd>
14968
15610
 
14969
15611
 
@@ -15380,7 +16022,7 @@
15380
16022
  <br class="clear">
15381
16023
 
15382
16024
  <footer>
15383
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Wed Nov 12 2025 23:37:50 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
16025
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Mon Nov 17 2025 22:03:50 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
15384
16026
  </footer>
15385
16027
 
15386
16028
  <script>prettyPrint();</script>