musora-content-services 2.40.0 → 2.42.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (63) hide show
  1. package/CHANGELOG.md +19 -0
  2. package/docs/ContentOrganization.html +2 -2
  3. package/docs/Forums.html +4 -4
  4. package/docs/Gamification.html +2 -2
  5. package/docs/UserManagementSystem.html +2 -2
  6. package/docs/api_types.js.html +2 -2
  7. package/docs/config.js.html +2 -2
  8. package/docs/content-org_content-org.js.html +2 -2
  9. package/docs/content-org_guided-courses.ts.html +2 -2
  10. package/docs/content-org_playlists-types.js.html +2 -2
  11. package/docs/content-org_playlists.js.html +2 -2
  12. package/docs/content.js.html +2 -2
  13. package/docs/forums_categories.ts.html +3 -3
  14. package/docs/forums_forums.ts.html +2 -2
  15. package/docs/forums_threads.ts.html +61 -3
  16. package/docs/gamification_awards.ts.html +23 -2
  17. package/docs/gamification_gamification.js.html +2 -2
  18. package/docs/global.html +2 -2
  19. package/docs/index.html +2 -2
  20. package/docs/module-Accounts.html +2 -2
  21. package/docs/module-Awards.html +165 -3
  22. package/docs/module-Categories.html +10 -2
  23. package/docs/module-Config.html +2 -2
  24. package/docs/module-Content-Services-V2.html +2 -2
  25. package/docs/module-Forums.html +2709 -85
  26. package/docs/module-GuidedCourses.html +2 -2
  27. package/docs/module-Interests.html +2 -2
  28. package/docs/module-Payments.html +2 -2
  29. package/docs/module-Permissions.html +2 -2
  30. package/docs/module-Playlists.html +2 -2
  31. package/docs/module-Railcontent-Services.html +2 -2
  32. package/docs/module-Sanity-Services.html +2 -2
  33. package/docs/module-Sessions.html +2 -2
  34. package/docs/module-Threads.html +646 -2
  35. package/docs/module-UserActivity.html +2 -2
  36. package/docs/module-UserChat.html +2 -2
  37. package/docs/module-UserManagement.html +2 -2
  38. package/docs/module-UserMemberships.html +2 -2
  39. package/docs/module-UserNotifications.html +2 -2
  40. package/docs/module-UserProfile.html +2 -2
  41. package/docs/railcontent.js.html +2 -2
  42. package/docs/sanity.js.html +2 -2
  43. package/docs/userActivity.js.html +2 -2
  44. package/docs/user_account.ts.html +2 -2
  45. package/docs/user_chat.js.html +2 -2
  46. package/docs/user_interests.js.html +2 -2
  47. package/docs/user_management.js.html +2 -2
  48. package/docs/user_memberships.js.html +2 -2
  49. package/docs/user_notifications.js.html +2 -2
  50. package/docs/user_payments.ts.html +2 -2
  51. package/docs/user_permissions.js.html +2 -2
  52. package/docs/user_profile.js.html +2 -2
  53. package/docs/user_sessions.js.html +2 -2
  54. package/docs/user_types.js.html +2 -2
  55. package/docs/user_user-management-system.js.html +2 -2
  56. package/package.json +1 -1
  57. package/src/index.d.ts +10 -2
  58. package/src/index.js +10 -2
  59. package/src/services/contentProgress.js +1 -0
  60. package/src/services/forums/categories.ts +1 -1
  61. package/src/services/forums/threads.ts +59 -1
  62. package/src/services/forums/types.ts +1 -0
  63. package/src/services/gamification/awards.ts +21 -0
@@ -1,11 +1,11 @@
1
1
  <!DOCTYPE html>
2
2
  <html lang="en">
3
3
  <head>
4
-
4
+
5
5
  <meta charset="utf-8">
6
6
  <title>Forums - Documentation</title>
7
-
8
-
7
+
8
+
9
9
  <script src="scripts/prettify/prettify.js"></script>
10
10
  <script src="scripts/prettify/lang-css.js"></script>
11
11
  <!--[if lt IE 9]>
@@ -14,7 +14,7 @@
14
14
  <link type="text/css" rel="stylesheet" href="styles/prettify.css">
15
15
  <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
16
16
  <script src="scripts/nav.js" defer></script>
17
-
17
+
18
18
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
19
19
  </head>
20
20
  <body>
@@ -27,84 +27,174 @@
27
27
  <label for="nav-trigger" class="overlay"></label>
28
28
 
29
29
  <nav >
30
+
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#~requestEmailChange">requestEmailChange</a></li><li data-type='method'><a href="module-Accounts.html#~resetPassword">resetPassword</a></li><li data-type='method'><a href="module-Accounts.html#~sendAccountSetupEmail">sendAccountSetupEmail</a></li><li data-type='method'><a href="module-Accounts.html#~sendPasswordResetEmail">sendPasswordResetEmail</a></li><li data-type='method'><a href="module-Accounts.html#~setupAccount">setupAccount</a></li><li data-type='method'><a href="module-Accounts.html#~status">status</a></li></ul></li><li><a href="module-Awards.html">Awards</a><ul class='methods'><li data-type='method'><a href="module-Awards.html#~fetchAwardsForUser">fetchAwardsForUser</a></li><li data-type='method'><a href="module-Awards.html#~fetchCertificate">fetchCertificate</a></li><li data-type='method'><a href="module-Awards.html#~getAwardDataForGuidedContent">getAwardDataForGuidedContent</a></li></ul></li><li><a href="module-Config.html">Config</a><ul class='methods'><li data-type='method'><a href="module-Config.html#.initializeService">initializeService</a></li></ul></li><li><a href="module-Content-Services-V2.html">Content-Services-V2</a><ul class='methods'><li data-type='method'><a href="module-Content-Services-V2.html#.getContentRows">getContentRows</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.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#.getRecentForTab">getRecentForTab</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#~createThread">createThread</a></li><li data-type='method'><a href="module-Forums.html#~fetchForumCategories">fetchForumCategories</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#~unfollowThread">unfollowThread</a></li><li data-type='method'><a href="module-Forums.html#~updateForumCategory">updateForumCategory</a></li></ul></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-Payments.html">Payments</a><ul class='methods'><li data-type='method'><a href="module-Payments.html#~fetchCustomerPayments">fetchCustomerPayments</a></li></ul></li><li><a href="module-Permissions.html">Permissions</a><ul class='methods'><li data-type='method'><a href="module-Permissions.html#.fetchUserPermissions">fetchUserPermissions</a></li><li data-type='method'><a href="module-Permissions.html#.reset">reset</a></li></ul></li><li><a href="module-Playlists.html">Playlists</a><ul class='methods'><li data-type='method'><a href="module-Playlists.html#.addItemToPlaylist">addItemToPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.createPlaylist">createPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.deletePlaylist">deletePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.duplicatePlaylist">duplicatePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.fetchPlaylist">fetchPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.fetchPlaylistItems">fetchPlaylistItems</a></li><li data-type='method'><a href="module-Playlists.html#.fetchUserPlaylists">fetchUserPlaylists</a></li><li data-type='method'><a href="module-Playlists.html#.togglePlaylistPrivate">togglePlaylistPrivate</a></li><li data-type='method'><a href="module-Playlists.html#.undeletePlaylist">undeletePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.updatePlaylist">updatePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~deleteItemsFromPlaylist">deleteItemsFromPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~likePlaylist">likePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~reportPlaylist">reportPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~restoreItemFromPlaylist">restoreItemFromPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~unlikePlaylist">unlikePlaylist</a></li></ul></li><li><a href="module-Railcontent-Services.html">Railcontent-Services</a><ul class='methods'><li data-type='method'><a href="module-Railcontent-Services.html#.assignModeratorToComment">assignModeratorToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.closeComment">closeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.createComment">createComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.deleteComment">deleteComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.editComment">editComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchAllCompletedStates">fetchAllCompletedStates</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCarouselCardData">fetchCarouselCardData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchComment">fetchComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCommentRelies">fetchCommentRelies</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchComments">fetchComments</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedContent">fetchCompletedContent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedState">fetchCompletedState</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentInProgress">fetchContentInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentPageUserData">fetchContentPageUserData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchNextContentDataForParent">fetchNextContentDataForParent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchRecentUserActivities">fetchRecentUserActivities</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchSongsInProgress">fetchSongsInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchTopComment">fetchTopComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserAward">fetchUserAward</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserBadges">fetchUserBadges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserPracticeNotes">fetchUserPracticeNotes</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.likeComment">likeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.openComment">openComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentComplete">postContentComplete</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentReset">postContentReset</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentRestore">postContentRestore</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentStart">postContentStart</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.replyToComment">replyToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.reportComment">reportComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.restoreComment">restoreComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.setStudentViewForUser">setStudentViewForUser</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.unassignModeratorToComment">unassignModeratorToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.unlikeComment">unlikeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#~fetchLastInteractedChild">fetchLastInteractedChild</a></li></ul></li><li><a href="module-Sanity-Services.html">Sanity-Services</a><ul class='methods'><li data-type='method'><a href="module-Sanity-Services.html#.fetchAll">fetchAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllFilterOptions">fetchAllFilterOptions</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchAllPacks">fetchAllPacks</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchArtistLessons">fetchArtistLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchArtists">fetchArtists</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByRailContentId">fetchByRailContentId</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByRailContentIds">fetchByRailContentIds</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchByReference">fetchByReference</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchCoachLessons">fetchCoachLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchComingSoon">fetchComingSoon</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchCommentModContentData">fetchCommentModContentData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchFoundation">fetchFoundation</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchGenreLessons">fetchGenreLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLeaving">fetchLeaving</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLessonContent">fetchLessonContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchLessonsFeaturingThisContent">fetchLessonsFeaturingThisContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMetadata">fetchMetadata</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethod">fetchMethod</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodChildren">fetchMethodChildren</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodChildrenIds">fetchMethodChildrenIds</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchMethodPreviousNextLesson">fetchMethodPreviousNextLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchNewReleases">fetchNewReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchNextPreviousLesson">fetchNextPreviousLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchOtherSongVersions">fetchOtherSongVersions</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackAll">fetchPackAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackData">fetchPackData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchParentForDownload">fetchParentForDownload</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedLessons">fetchRelatedLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedRecommendedContent">fetchRelatedRecommendedContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedSongs">fetchRelatedSongs</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchReturning">fetchReturning</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSanity">fetchSanity</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchScheduledReleases">fetchScheduledReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchShowsData">fetchShowsData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.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#.isDisplayNameAvailable">isDisplayNameAvailable</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#.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><a href="global.html">Global</a></h3>
33
+
34
+ </nav>
30
35
 
36
+ <div id="main">
37
+
38
+ <h1 class="page-title">Forums</h1>
39
+
31
40
 
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#~requestEmailChange">requestEmailChange</a></li><li data-type='method'><a href="module-Accounts.html#~resetPassword">resetPassword</a></li><li data-type='method'><a href="module-Accounts.html#~sendAccountSetupEmail">sendAccountSetupEmail</a></li><li data-type='method'><a href="module-Accounts.html#~sendPasswordResetEmail">sendPasswordResetEmail</a></li><li data-type='method'><a href="module-Accounts.html#~setupAccount">setupAccount</a></li><li data-type='method'><a href="module-Accounts.html#~status">status</a></li></ul></li><li><a href="module-Awards.html">Awards</a><ul class='methods'><li data-type='method'><a href="module-Awards.html#~fetchAwardsForUser">fetchAwardsForUser</a></li><li data-type='method'><a href="module-Awards.html#~fetchCertificate">fetchCertificate</a></li></ul></li><li><a href="module-Config.html">Config</a><ul class='methods'><li data-type='method'><a href="module-Config.html#.initializeService">initializeService</a></li></ul></li><li><a href="module-Content-Services-V2.html">Content-Services-V2</a><ul class='methods'><li data-type='method'><a href="module-Content-Services-V2.html#.getContentRows">getContentRows</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getNewAndUpcoming">getNewAndUpcoming</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getRecent">getRecent</a></li><li data-type='method'><a href="module-Content-Services-V2.html#.getRecentForTab">getRecentForTab</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#.fetchForumDiscussions">fetchForumDiscussions</a></li></ul></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-Permissions.html">Permissions</a><ul class='methods'><li data-type='method'><a href="module-Permissions.html#.fetchUserPermissions">fetchUserPermissions</a></li><li data-type='method'><a href="module-Permissions.html#.reset">reset</a></li></ul></li><li><a href="module-Playlists.html">Playlists</a><ul class='methods'><li data-type='method'><a href="module-Playlists.html#.addItemToPlaylist">addItemToPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.createPlaylist">createPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.deletePlaylist">deletePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.duplicatePlaylist">duplicatePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.fetchPlaylist">fetchPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.fetchPlaylistItems">fetchPlaylistItems</a></li><li data-type='method'><a href="module-Playlists.html#.fetchUserPlaylists">fetchUserPlaylists</a></li><li data-type='method'><a href="module-Playlists.html#.togglePlaylistPrivate">togglePlaylistPrivate</a></li><li data-type='method'><a href="module-Playlists.html#.undeletePlaylist">undeletePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#.updatePlaylist">updatePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~deleteItemsFromPlaylist">deleteItemsFromPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~likePlaylist">likePlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~reportPlaylist">reportPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~restoreItemFromPlaylist">restoreItemFromPlaylist</a></li><li data-type='method'><a href="module-Playlists.html#~unlikePlaylist">unlikePlaylist</a></li></ul></li><li><a href="module-Railcontent-Services.html">Railcontent-Services</a><ul class='methods'><li data-type='method'><a href="module-Railcontent-Services.html#.assignModeratorToComment">assignModeratorToComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.closeComment">closeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.createComment">createComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.deleteComment">deleteComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.editComment">editComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchAllCompletedStates">fetchAllCompletedStates</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCarouselCardData">fetchCarouselCardData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchComment">fetchComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCommentRelies">fetchCommentRelies</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchComments">fetchComments</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedContent">fetchCompletedContent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchCompletedState">fetchCompletedState</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentInProgress">fetchContentInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchContentPageUserData">fetchContentPageUserData</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchNextContentDataForParent">fetchNextContentDataForParent</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchRecentUserActivities">fetchRecentUserActivities</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchSongsInProgress">fetchSongsInProgress</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchTopComment">fetchTopComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserAward">fetchUserAward</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserBadges">fetchUserBadges</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.fetchUserPracticeNotes">fetchUserPracticeNotes</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.likeComment">likeComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.openComment">openComment</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentComplete">postContentComplete</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentReset">postContentReset</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.postContentRestore">postContentRestore</a></li><li data-type='method'><a href="module-Railcontent-Services.html#.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#.fetchNewReleases">fetchNewReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchNextPreviousLesson">fetchNextPreviousLesson</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchOtherSongVersions">fetchOtherSongVersions</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackAll">fetchPackAll</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchPackData">fetchPackData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchParentForDownload">fetchParentForDownload</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedLessons">fetchRelatedLessons</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedRecommendedContent">fetchRelatedRecommendedContent</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchRelatedSongs">fetchRelatedSongs</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchReturning">fetchReturning</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchSanity">fetchSanity</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchScheduledReleases">fetchScheduledReleases</a></li><li data-type='method'><a href="module-Sanity-Services.html#.fetchShowsData">fetchShowsData</a></li><li data-type='method'><a href="module-Sanity-Services.html#.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#.isDisplayNameAvailable">isDisplayNameAvailable</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></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="Gamification.html">Gamification</a></li><li><a href="UserManagementSystem.html">UserManagementSystem</a></li></ul><h3><a href="global.html">Global</a></h3>
41
+
33
42
 
34
- </nav>
35
43
 
36
- <div id="main">
37
44
 
38
- <h1 class="page-title">Forums</h1>
39
45
 
46
+ <section>
40
47
 
48
+ <header>
49
+
50
+
51
+
52
+ </header>
41
53
 
54
+ <article>
55
+
56
+ <div class="container-overview">
57
+
58
+
42
59
 
60
+
61
+
62
+ </div>
63
+
43
64
 
65
+
44
66
 
67
+
45
68
 
46
- <section>
69
+
70
+
71
+
47
72
 
48
- <header>
73
+
49
74
 
75
+
50
76
 
77
+
51
78
 
52
- </header>
79
+
80
+ <h3 class="subsection-title">Methods</h3>
53
81
 
54
- <article>
82
+
83
+
55
84
 
56
- <div class="container-overview">
85
+
57
86
 
87
+ <h4 class="name" id="~createForumCategory"><span class="type-signature type-signature-async, inner">(async, inner) </span>createForumCategory<span class="signature">(params)</span><span class="type-signature"> &rarr; {Promise.&lt;ForumCategory>}</span></h4>
58
88
 
89
+
59
90
 
60
91
 
61
92
 
62
- </div>
63
93
 
94
+ <dl class="details">
95
+
96
+ <dt class="tag-description">Description:</dt>
97
+ <dd class="tag-description"><ul class="dummy"><li>Creates a new forum category.</li></ul></dd>
98
+
64
99
 
100
+
101
+ <dt class="tag-source">Source:</dt>
102
+ <dd class="tag-source"><ul class="dummy"><li>
103
+ <a href="forums_categories.ts.html">forums/categories.ts</a>, <a href="forums_categories.ts.html#line30">line 30</a>
104
+ </li></ul></dd>
105
+
65
106
 
107
+
66
108
 
109
+
67
110
 
111
+
68
112
 
113
+
69
114
 
115
+
70
116
 
117
+
71
118
 
119
+
72
120
 
121
+
73
122
 
123
+
74
124
 
125
+
75
126
 
127
+
76
128
 
129
+
77
130
 
131
+
78
132
 
133
+
79
134
 
80
- <h3 class="subsection-title">Methods</h3>
135
+
136
+ </dl>
81
137
 
82
138
 
83
139
 
84
140
 
85
141
 
86
142
 
87
- <h4 class="name" id=".fetchForumDiscussions"><span class="type-signature type-signature-static">(static) </span>fetchForumDiscussions<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise.&lt;Object>}</span></h4>
88
143
 
89
144
 
90
145
 
91
146
 
92
147
 
93
148
 
94
- <dl class="details">
95
149
 
96
- <dt class="tag-description">Description:</dt>
97
- <dd class="tag-description"><ul class="dummy"><li>Fetches forum discussions for the given brand.</li></ul></dd>
150
+ <h5 class="h5-parameters">Parameters:</h5>
151
+
98
152
 
153
+ <table class="params">
154
+ <thead>
155
+ <tr>
156
+
157
+ <th>Name</th>
158
+
99
159
 
160
+ <th>Type</th>
100
161
 
101
- <dt class="tag-source">Source:</dt>
102
- <dd class="tag-source"><ul class="dummy"><li>
103
- <a href="forums_forum.js.html">forums/discussions.js</a>, <a href="forums_forum.js.html#line20">line 20</a>
104
- </li></ul></dd>
162
+
163
+
164
+
165
+
166
+ <th class="last">Description</th>
167
+ </tr>
168
+ </thead>
169
+
170
+ <tbody>
171
+
105
172
 
173
+ <tr>
174
+
175
+ <td class="name"><code>params</code></td>
176
+
177
+
178
+ <td class="type">
179
+
180
+
181
+ <span class="param-type">CreateForumCategoryParams</span>
182
+
183
+
184
+
185
+
186
+ </td>
187
+
188
+
106
189
 
190
+
107
191
 
192
+ <td class="description last">The parameters for creating the forum category.</td>
193
+ </tr>
194
+
195
+
196
+ </tbody>
197
+ </table>
108
198
 
109
199
 
110
200
 
@@ -119,180 +209,369 @@
119
209
 
120
210
 
121
211
 
212
+ <h5 class="h5-throws">Throws:</h5>
213
+
214
+
215
+
216
+ <dl>
217
+ <dt>
218
+ <div class="param-desc usertext">
219
+ - If the request fails.
220
+ </div>
221
+ </dt>
222
+ <dd></dd>
223
+ <dt>
224
+ <dl class="param-type">
225
+ <dt>
226
+ Type
227
+ </dt>
228
+ <dd>
229
+
230
+ <span class="param-type">HttpError</span>
122
231
 
123
232
 
124
233
 
234
+ </dd>
235
+ </dl>
236
+ </dt>
237
+ <dd></dd>
238
+ </dl>
125
239
 
126
240
 
241
+
127
242
 
128
243
 
244
+ <h5 class="h5-returns">Returns:</h5>
129
245
 
246
+
247
+ <div class="param-desc">
248
+ - A promise that resolves to the created forum category.
249
+ </div>
130
250
 
131
251
 
132
252
 
253
+ <dl class="param-type">
254
+ <dt>
255
+ Type
256
+ </dt>
257
+ <dd>
258
+
259
+ <span class="param-type">Promise.&lt;ForumCategory></span>
133
260
 
134
261
 
135
262
 
263
+ </dd>
136
264
  </dl>
137
265
 
266
+
267
+
268
+
269
+
270
+
271
+
138
272
 
273
+
139
274
 
275
+ <h4 class="name" id="~createThread"><span class="type-signature type-signature-async, inner">(async, inner) </span>createThread<span class="signature">(params)</span><span class="type-signature"> &rarr; {Promise.&lt;ForumThread>}</span></h4>
140
276
 
277
+
141
278
 
142
279
 
143
280
 
144
281
 
282
+ <dl class="details">
283
+
284
+ <dt class="tag-description">Description:</dt>
285
+ <dd class="tag-description"><ul class="dummy"><li>Creates a new thread under a forum category.</li></ul></dd>
286
+
145
287
 
288
+
289
+ <dt class="tag-source">Source:</dt>
290
+ <dd class="tag-source"><ul class="dummy"><li>
291
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line18">line 18</a>
292
+ </li></ul></dd>
293
+
146
294
 
295
+
147
296
 
148
- <h5 class="h5-examples">Example</h5>
297
+
149
298
 
150
- <pre class="prettyprint"><code>fetchForumDiscussions({ brand: 'singeo' })
151
- .then(data => console.log(data))
152
- .catch(error => console.error(error));</code></pre>
299
+
153
300
 
301
+
154
302
 
303
+
155
304
 
305
+
156
306
 
157
- <h5 class="h5-parameters">Parameters:</h5>
307
+
158
308
 
309
+
159
310
 
160
- <table class="params">
161
- <thead>
162
- <tr>
311
+
163
312
 
164
- <th>Name</th>
313
+
165
314
 
315
+
316
+
317
+
318
+
319
+
320
+
321
+
322
+
323
+
324
+ </dl>
166
325
 
167
- <th>Type</th>
168
326
 
169
327
 
170
- <th>Attributes</th>
171
328
 
172
329
 
173
330
 
174
- <th>Default</th>
175
331
 
176
332
 
333
+
334
+
335
+
336
+
337
+
338
+ <h5 class="h5-parameters">Parameters:</h5>
339
+
340
+
341
+ <table class="params">
342
+ <thead>
343
+ <tr>
344
+
345
+ <th>Name</th>
346
+
347
+
348
+ <th>Type</th>
349
+
350
+
351
+
352
+
353
+
177
354
  <th class="last">Description</th>
178
355
  </tr>
179
356
  </thead>
180
357
 
181
358
  <tbody>
182
-
359
+
183
360
 
184
361
  <tr>
362
+
363
+ <td class="name"><code>params</code></td>
364
+
185
365
 
186
- <td class="name"><code>options</code></td>
366
+ <td class="type">
367
+
368
+
369
+ <span class="param-type">CreateThreadParams</span>
187
370
 
188
371
 
189
- <td class="type">
190
372
 
373
+
374
+ </td>
191
375
 
192
- <span class="param-type">Object</span>
376
+
193
377
 
378
+
194
379
 
380
+ <td class="description last">The parameters for creating the thread.</td>
381
+ </tr>
195
382
 
383
+
384
+ </tbody>
385
+ </table>
196
386
 
197
- </td>
198
387
 
199
388
 
200
- <td class="attributes">
201
389
 
202
- &lt;optional><br>
203
390
 
204
391
 
205
392
 
206
393
 
207
394
 
208
- </td>
209
395
 
210
396
 
211
397
 
212
- <td class="default">
213
398
 
214
- <code>{}</code>
215
399
 
216
- </td>
400
+ <h5 class="h5-throws">Throws:</h5>
217
401
 
402
+
218
403
 
219
- <td class="description last">Options for fetching discussions.
220
- <h6>Properties</h6>
404
+ <dl>
405
+ <dt>
406
+ <div class="param-desc usertext">
407
+ - If the request fails.
408
+ </div>
409
+ </dt>
410
+ <dd></dd>
411
+ <dt>
412
+ <dl class="param-type">
413
+ <dt>
414
+ Type
415
+ </dt>
416
+ <dd>
417
+
418
+ <span class="param-type">HttpError</span>
221
419
 
222
420
 
223
- <table class="params">
224
- <thead>
225
- <tr>
226
421
 
227
- <th>Name</th>
422
+ </dd>
423
+ </dl>
424
+ </dt>
425
+ <dd></dd>
426
+ </dl>
228
427
 
229
428
 
230
- <th>Type</th>
429
+
430
+
231
431
 
432
+ <h5 class="h5-returns">Returns:</h5>
232
433
 
233
- <th>Attributes</th>
434
+
435
+ <div class="param-desc">
436
+ - A promise that resolves to the created thread.
437
+ </div>
234
438
 
235
439
 
236
440
 
237
- <th>Default</th>
441
+ <dl class="param-type">
442
+ <dt>
443
+ Type
444
+ </dt>
445
+ <dd>
446
+
447
+ <span class="param-type">Promise.&lt;ForumThread></span>
238
448
 
239
449
 
240
- <th class="last">Description</th>
241
- </tr>
242
- </thead>
243
450
 
244
- <tbody>
451
+ </dd>
452
+ </dl>
245
453
 
454
+
246
455
 
247
- <tr>
248
456
 
249
- <td class="name"><code>brand</code></td>
250
457
 
458
+
459
+
251
460
 
252
- <td class="type">
461
+
253
462
 
463
+ <h4 class="name" id="~fetchForumCategories"><span class="type-signature type-signature-async, inner">(async, inner) </span>fetchForumCategories<span class="signature">(brand)</span><span class="type-signature"> &rarr; {Promise.&lt;ForumCategory>}</span></h4>
254
464
 
255
- <span class="param-type">string</span>
256
- |
465
+
257
466
 
258
- <span class="param-type">null</span>
259
467
 
260
468
 
261
469
 
470
+ <dl class="details">
471
+
472
+ <dt class="tag-description">Description:</dt>
473
+ <dd class="tag-description"><ul class="dummy"><li>Fetches forum categories for the given brand.</li></ul></dd>
474
+
262
475
 
263
- </td>
476
+
477
+ <dt class="tag-source">Source:</dt>
478
+ <dd class="tag-source"><ul class="dummy"><li>
479
+ <a href="forums_categories.ts.html">forums/categories.ts</a>, <a href="forums_categories.ts.html#line10">line 10</a>
480
+ </li></ul></dd>
481
+
264
482
 
483
+
265
484
 
266
- <td class="attributes">
485
+
267
486
 
268
- &lt;optional><br>
487
+
269
488
 
489
+
270
490
 
491
+
271
492
 
493
+
272
494
 
495
+
273
496
 
274
- </td>
497
+
275
498
 
499
+
276
500
 
501
+
277
502
 
278
- <td class="default">
503
+
279
504
 
280
- <code>null</code>
505
+
281
506
 
282
- </td>
507
+
283
508
 
509
+
284
510
 
285
- <td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
286
- </tr>
511
+
512
+ </dl>
287
513
 
288
514
 
289
- </tbody>
290
- </table>
291
515
 
516
+
517
+
518
+
519
+
520
+
521
+
522
+
523
+
524
+
525
+
526
+ <h5 class="h5-parameters">Parameters:</h5>
527
+
528
+
529
+ <table class="params">
530
+ <thead>
531
+ <tr>
532
+
533
+ <th>Name</th>
534
+
535
+
536
+ <th>Type</th>
537
+
538
+
539
+
540
+
541
+
542
+ <th class="last">Description</th>
543
+ </tr>
544
+ </thead>
545
+
546
+ <tbody>
547
+
548
+
549
+ <tr>
550
+
551
+ <td class="name"><code>brand</code></td>
552
+
553
+
554
+ <td class="type">
555
+
556
+
557
+ <span class="param-type">string</span>
558
+ |
559
+
560
+ <span class="param-type">null</span>
561
+
562
+
563
+
564
+
292
565
  </td>
293
- </tr>
294
566
 
567
+
568
+
569
+
570
+
571
+ <td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
572
+ </tr>
295
573
 
574
+
296
575
  </tbody>
297
576
  </table>
298
577
 
@@ -309,13 +588,43 @@
309
588
 
310
589
 
311
590
 
591
+ <h5 class="h5-throws">Throws:</h5>
312
592
 
593
+
313
594
 
314
- <h5 class="h5-returns">Returns:</h5>
595
+ <dl>
596
+ <dt>
597
+ <div class="param-desc usertext">
598
+ - If the request fails.
599
+ </div>
600
+ </dt>
601
+ <dd></dd>
602
+ <dt>
603
+ <dl class="param-type">
604
+ <dt>
605
+ Type
606
+ </dt>
607
+ <dd>
608
+
609
+ <span class="param-type">HttpError</span>
610
+
611
+
612
+
613
+ </dd>
614
+ </dl>
615
+ </dt>
616
+ <dd></dd>
617
+ </dl>
315
618
 
316
619
 
620
+
621
+
622
+
623
+ <h5 class="h5-returns">Returns:</h5>
624
+
625
+
317
626
  <div class="param-desc">
318
- - A promise that resolves to the list of discussions.
627
+ - A promise that resolves to the list of forum categories.
319
628
  </div>
320
629
 
321
630
 
@@ -325,39 +634,2354 @@
325
634
  Type
326
635
  </dt>
327
636
  <dd>
328
-
329
- <span class="param-type">Promise.&lt;Object></span>
637
+
638
+ <span class="param-type">Promise.&lt;ForumCategory></span>
330
639
 
331
640
 
332
641
 
333
642
  </dd>
334
643
  </dl>
335
644
 
645
+
336
646
 
337
647
 
338
648
 
649
+
650
+
339
651
 
652
+
340
653
 
654
+ <h4 class="name" id="~fetchThreads"><span class="type-signature type-signature-async, inner">(async, inner) </span>fetchThreads<span class="signature">(categoryId, brand, params)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="global.html#PaginatedResponse">PaginatedResponse</a>.&lt;ForumThread>>}</span></h4>
341
655
 
656
+
342
657
 
343
658
 
344
659
 
345
660
 
346
- </article>
661
+ <dl class="details">
662
+
663
+ <dt class="tag-description">Description:</dt>
664
+ <dd class="tag-description"><ul class="dummy"><li>Fetches forum threads for the given category.</li></ul></dd>
665
+
347
666
 
348
- </section>
667
+
668
+ <dt class="tag-source">Source:</dt>
669
+ <dd class="tag-source"><ul class="dummy"><li>
670
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line65">line 65</a>
671
+ </li></ul></dd>
672
+
673
+
674
+
675
+
676
+
677
+
678
+
679
+
680
+
681
+
682
+
683
+
684
+
685
+
686
+
687
+
688
+
689
+
690
+
691
+
692
+
693
+
694
+
695
+
696
+
349
697
 
698
+
350
699
 
700
+
701
+
702
+
703
+ </dl>
704
+
705
+
706
+
707
+
708
+
709
+
710
+
711
+
712
+
713
+
714
+
715
+
716
+
717
+ <h5 class="h5-parameters">Parameters:</h5>
718
+
719
+
720
+ <table class="params">
721
+ <thead>
722
+ <tr>
723
+
724
+ <th>Name</th>
725
+
726
+
727
+ <th>Type</th>
728
+
729
+
730
+
731
+
732
+
733
+ <th class="last">Description</th>
734
+ </tr>
735
+ </thead>
736
+
737
+ <tbody>
738
+
739
+
740
+ <tr>
741
+
742
+ <td class="name"><code>categoryId</code></td>
743
+
744
+
745
+ <td class="type">
746
+
747
+
748
+ <span class="param-type">number</span>
749
+
750
+
751
+
752
+
753
+ </td>
754
+
755
+
756
+
757
+
758
+
759
+ <td class="description last">The ID of the forum category.</td>
760
+ </tr>
761
+
762
+
763
+
764
+ <tr>
765
+
766
+ <td class="name"><code>brand</code></td>
767
+
768
+
769
+ <td class="type">
770
+
771
+
772
+ <span class="param-type">string</span>
773
+
774
+
775
+
776
+
777
+ </td>
778
+
779
+
780
+
781
+
782
+
783
+ <td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
784
+ </tr>
785
+
786
+
787
+
788
+ <tr>
789
+
790
+ <td class="name"><code>params</code></td>
791
+
792
+
793
+ <td class="type">
794
+
795
+
796
+ <span class="param-type">FetchThreadParams</span>
797
+
798
+
799
+
800
+
801
+ </td>
802
+
803
+
804
+
805
+
806
+
807
+ <td class="description last">Optional additional parameters (e.g., is_followed, sort("last_post_published_on","-last_post_published_on","mine")).</td>
808
+ </tr>
809
+
810
+
811
+ </tbody>
812
+ </table>
813
+
814
+
815
+
816
+
817
+
818
+
819
+
820
+
821
+
822
+
823
+
824
+
825
+
826
+
827
+ <h5 class="h5-throws">Throws:</h5>
828
+
829
+
830
+
831
+ <dl>
832
+ <dt>
833
+ <div class="param-desc usertext">
834
+ - If the HTTP request fails.
835
+ </div>
836
+ </dt>
837
+ <dd></dd>
838
+ <dt>
839
+ <dl class="param-type">
840
+ <dt>
841
+ Type
842
+ </dt>
843
+ <dd>
844
+
845
+ <span class="param-type">HttpError</span>
846
+
847
+
848
+
849
+ </dd>
850
+ </dl>
851
+ </dt>
852
+ <dd></dd>
853
+ </dl>
854
+
855
+
856
+
857
+
858
+
859
+ <h5 class="h5-returns">Returns:</h5>
860
+
861
+
862
+ <div class="param-desc">
863
+ - A promise that resolves to a paginated list of forum threads.
864
+ </div>
865
+
866
+
867
+
868
+ <dl class="param-type">
869
+ <dt>
870
+ Type
871
+ </dt>
872
+ <dd>
873
+
874
+ <span class="param-type">Promise.&lt;<a href="global.html#PaginatedResponse">PaginatedResponse</a>.&lt;ForumThread>></span>
875
+
876
+
877
+
878
+ </dd>
879
+ </dl>
880
+
881
+
882
+
883
+
884
+
885
+
886
+
887
+
888
+
889
+
890
+ <h4 class="name" id="~followThread"><span class="type-signature type-signature-async, inner">(async, inner) </span>followThread<span class="signature">(threadId, brand)</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
891
+
892
+
893
+
894
+
895
+
896
+
897
+ <dl class="details">
898
+
899
+ <dt class="tag-description">Description:</dt>
900
+ <dd class="tag-description"><ul class="dummy"><li>Follow a thread.</li></ul></dd>
901
+
902
+
903
+
904
+ <dt class="tag-source">Source:</dt>
905
+ <dd class="tag-source"><ul class="dummy"><li>
906
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line33">line 33</a>
907
+ </li></ul></dd>
908
+
909
+
910
+
911
+
912
+
913
+
914
+
915
+
916
+
917
+
918
+
919
+
920
+
921
+
922
+
923
+
924
+
925
+
926
+
927
+
928
+
929
+
930
+
931
+
932
+
933
+
934
+
935
+
936
+
937
+
938
+
939
+ </dl>
940
+
941
+
942
+
943
+
944
+
945
+
946
+
947
+
948
+
949
+
950
+
951
+
952
+
953
+ <h5 class="h5-parameters">Parameters:</h5>
954
+
955
+
956
+ <table class="params">
957
+ <thead>
958
+ <tr>
959
+
960
+ <th>Name</th>
961
+
962
+
963
+ <th>Type</th>
964
+
965
+
966
+
967
+
968
+
969
+ <th class="last">Description</th>
970
+ </tr>
971
+ </thead>
972
+
973
+ <tbody>
974
+
975
+
976
+ <tr>
977
+
978
+ <td class="name"><code>threadId</code></td>
979
+
980
+
981
+ <td class="type">
982
+
983
+
984
+ <span class="param-type">number</span>
985
+
986
+
987
+
988
+
989
+ </td>
990
+
991
+
992
+
993
+
994
+
995
+ <td class="description last">The ID of the thread to lock.</td>
996
+ </tr>
997
+
998
+
999
+
1000
+ <tr>
1001
+
1002
+ <td class="name"><code>brand</code></td>
1003
+
1004
+
1005
+ <td class="type">
1006
+
1007
+
1008
+ <span class="param-type">string</span>
1009
+
1010
+
1011
+
1012
+
1013
+ </td>
1014
+
1015
+
1016
+
1017
+
1018
+
1019
+ <td class="description last">The brand associated with the follow action.</td>
1020
+ </tr>
1021
+
1022
+
1023
+ </tbody>
1024
+ </table>
1025
+
1026
+
1027
+
1028
+
1029
+
1030
+
1031
+
1032
+
1033
+
1034
+
1035
+
1036
+
1037
+
1038
+
1039
+ <h5 class="h5-throws">Throws:</h5>
1040
+
1041
+
1042
+
1043
+ <dl>
1044
+ <dt>
1045
+ <div class="param-desc usertext">
1046
+ - If the request fails.
1047
+ </div>
1048
+ </dt>
1049
+ <dd></dd>
1050
+ <dt>
1051
+ <dl class="param-type">
1052
+ <dt>
1053
+ Type
1054
+ </dt>
1055
+ <dd>
1056
+
1057
+ <span class="param-type">HttpError</span>
1058
+
1059
+
1060
+
1061
+ </dd>
1062
+ </dl>
1063
+ </dt>
1064
+ <dd></dd>
1065
+ </dl>
1066
+
1067
+
1068
+
1069
+
1070
+
1071
+ <h5 class="h5-returns">Returns:</h5>
1072
+
1073
+
1074
+ <div class="param-desc">
1075
+ - A promise that resolves when the thread is locked.
1076
+ </div>
1077
+
1078
+
1079
+
1080
+ <dl class="param-type">
1081
+ <dt>
1082
+ Type
1083
+ </dt>
1084
+ <dd>
1085
+
1086
+ <span class="param-type">Promise.&lt;void></span>
1087
+
1088
+
1089
+
1090
+ </dd>
1091
+ </dl>
1092
+
1093
+
1094
+
1095
+
1096
+
1097
+
1098
+
1099
+
1100
+
1101
+
1102
+ <h4 class="name" id="~unfollowThread"><span class="type-signature type-signature-async, inner">(async, inner) </span>unfollowThread<span class="signature">(threadId, brand)</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
1103
+
1104
+
1105
+
1106
+
1107
+
1108
+
1109
+ <dl class="details">
1110
+
1111
+ <dt class="tag-description">Description:</dt>
1112
+ <dd class="tag-description"><ul class="dummy"><li>Unlock a thread to allow further posts.</li></ul></dd>
1113
+
1114
+
1115
+
1116
+ <dt class="tag-source">Source:</dt>
1117
+ <dd class="tag-source"><ul class="dummy"><li>
1118
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line46">line 46</a>
1119
+ </li></ul></dd>
1120
+
1121
+
1122
+
1123
+
1124
+
1125
+
1126
+
1127
+
1128
+
1129
+
1130
+
1131
+
1132
+
1133
+
1134
+
1135
+
1136
+
1137
+
1138
+
1139
+
1140
+
1141
+
1142
+
1143
+
1144
+
1145
+
1146
+
1147
+
1148
+
1149
+
1150
+
1151
+ </dl>
1152
+
1153
+
1154
+
1155
+
1156
+
1157
+
1158
+
1159
+
1160
+
1161
+
1162
+
1163
+
1164
+
1165
+ <h5 class="h5-parameters">Parameters:</h5>
1166
+
1167
+
1168
+ <table class="params">
1169
+ <thead>
1170
+ <tr>
1171
+
1172
+ <th>Name</th>
1173
+
1174
+
1175
+ <th>Type</th>
1176
+
1177
+
1178
+
1179
+
1180
+
1181
+ <th class="last">Description</th>
1182
+ </tr>
1183
+ </thead>
1184
+
1185
+ <tbody>
1186
+
1187
+
1188
+ <tr>
1189
+
1190
+ <td class="name"><code>threadId</code></td>
1191
+
1192
+
1193
+ <td class="type">
1194
+
1195
+
1196
+ <span class="param-type">number</span>
1197
+
1198
+
1199
+
1200
+
1201
+ </td>
1202
+
1203
+
1204
+
1205
+
1206
+
1207
+ <td class="description last">The ID of the thread to unlock.</td>
1208
+ </tr>
1209
+
1210
+
1211
+
1212
+ <tr>
1213
+
1214
+ <td class="name"><code>brand</code></td>
1215
+
1216
+
1217
+ <td class="type">
1218
+
1219
+
1220
+ <span class="param-type">string</span>
1221
+
1222
+
1223
+
1224
+
1225
+ </td>
1226
+
1227
+
1228
+
1229
+
1230
+
1231
+ <td class="description last">The brand associated with the unlock action.</td>
1232
+ </tr>
1233
+
1234
+
1235
+ </tbody>
1236
+ </table>
1237
+
1238
+
1239
+
1240
+
1241
+
1242
+
1243
+
1244
+
1245
+
1246
+
1247
+
1248
+
1249
+
1250
+
1251
+ <h5 class="h5-throws">Throws:</h5>
1252
+
1253
+
1254
+
1255
+ <dl>
1256
+ <dt>
1257
+ <div class="param-desc usertext">
1258
+ - If the request fails.
1259
+ </div>
1260
+ </dt>
1261
+ <dd></dd>
1262
+ <dt>
1263
+ <dl class="param-type">
1264
+ <dt>
1265
+ Type
1266
+ </dt>
1267
+ <dd>
1268
+
1269
+ <span class="param-type">HttpError</span>
1270
+
1271
+
1272
+
1273
+ </dd>
1274
+ </dl>
1275
+ </dt>
1276
+ <dd></dd>
1277
+ </dl>
1278
+
1279
+
1280
+
1281
+
1282
+
1283
+ <h5 class="h5-returns">Returns:</h5>
1284
+
1285
+
1286
+ <div class="param-desc">
1287
+ - A promise that resolves when the thread is unlocked.
1288
+ </div>
1289
+
1290
+
1291
+
1292
+ <dl class="param-type">
1293
+ <dt>
1294
+ Type
1295
+ </dt>
1296
+ <dd>
1297
+
1298
+ <span class="param-type">Promise.&lt;void></span>
1299
+
1300
+
1301
+
1302
+ </dd>
1303
+ </dl>
1304
+
1305
+
1306
+
1307
+
1308
+
1309
+
1310
+
1311
+
1312
+
1313
+
1314
+ <h4 class="name" id="~updateForumCategory"><span class="type-signature type-signature-async, inner">(async, inner) </span>updateForumCategory<span class="signature">(params)</span><span class="type-signature"> &rarr; {Promise.&lt;ForumCategory>}</span></h4>
1315
+
1316
+
1317
+
1318
+
1319
+
1320
+
1321
+ <dl class="details">
1322
+
1323
+ <dt class="tag-description">Description:</dt>
1324
+ <dd class="tag-description"><ul class="dummy"><li>Creates a new forum category.</li></ul></dd>
1325
+
1326
+
1327
+
1328
+ <dt class="tag-source">Source:</dt>
1329
+ <dd class="tag-source"><ul class="dummy"><li>
1330
+ <a href="forums_categories.ts.html">forums/categories.ts</a>, <a href="forums_categories.ts.html#line53">line 53</a>
1331
+ </li></ul></dd>
1332
+
1333
+
1334
+
1335
+
1336
+
1337
+
1338
+
1339
+
1340
+
1341
+
1342
+
1343
+
1344
+
1345
+
1346
+
1347
+
1348
+
1349
+
1350
+
1351
+
1352
+
1353
+
1354
+
1355
+
1356
+
1357
+
1358
+
1359
+
1360
+
1361
+
1362
+
1363
+ </dl>
1364
+
1365
+
1366
+
1367
+
1368
+
1369
+
1370
+
1371
+
1372
+
1373
+
1374
+
1375
+
1376
+
1377
+ <h5 class="h5-parameters">Parameters:</h5>
1378
+
1379
+
1380
+ <table class="params">
1381
+ <thead>
1382
+ <tr>
1383
+
1384
+ <th>Name</th>
1385
+
1386
+
1387
+ <th>Type</th>
1388
+
1389
+
1390
+
1391
+
1392
+
1393
+ <th class="last">Description</th>
1394
+ </tr>
1395
+ </thead>
1396
+
1397
+ <tbody>
1398
+
1399
+
1400
+ <tr>
1401
+
1402
+ <td class="name"><code>params</code></td>
1403
+
1404
+
1405
+ <td class="type">
1406
+
1407
+
1408
+ <span class="param-type">UpdateForumCategoryParams</span>
1409
+
1410
+
1411
+
1412
+
1413
+ </td>
1414
+
1415
+
1416
+
1417
+
1418
+
1419
+ <td class="description last">The parameters for creating the forum category.</td>
1420
+ </tr>
1421
+
1422
+
1423
+ </tbody>
1424
+ </table>
1425
+
1426
+
1427
+
1428
+
1429
+
1430
+
1431
+
1432
+
1433
+
1434
+
1435
+
1436
+
1437
+
1438
+
1439
+ <h5 class="h5-throws">Throws:</h5>
1440
+
1441
+
1442
+
1443
+ <dl>
1444
+ <dt>
1445
+ <div class="param-desc usertext">
1446
+ - If the request fails.
1447
+ </div>
1448
+ </dt>
1449
+ <dd></dd>
1450
+ <dt>
1451
+ <dl class="param-type">
1452
+ <dt>
1453
+ Type
1454
+ </dt>
1455
+ <dd>
1456
+
1457
+ <span class="param-type">HttpError</span>
1458
+
1459
+
1460
+
1461
+ </dd>
1462
+ </dl>
1463
+ </dt>
1464
+ <dd></dd>
1465
+ </dl>
1466
+
1467
+
1468
+
1469
+
1470
+
1471
+ <h5 class="h5-returns">Returns:</h5>
1472
+
1473
+
1474
+ <div class="param-desc">
1475
+ - A promise that resolves to the created forum category.
1476
+ </div>
1477
+
1478
+
1479
+
1480
+ <dl class="param-type">
1481
+ <dt>
1482
+ Type
1483
+ </dt>
1484
+ <dd>
1485
+
1486
+ <span class="param-type">Promise.&lt;ForumCategory></span>
1487
+
1488
+
1489
+
1490
+ </dd>
1491
+ </dl>
1492
+
1493
+
1494
+
1495
+
1496
+
1497
+
1498
+
1499
+
1500
+
1501
+
1502
+
1503
+ </article>
1504
+
1505
+ </section>
1506
+
1507
+
1508
+
1509
+
1510
+
1511
+
1512
+
1513
+ <section>
1514
+
1515
+ <header>
1516
+
1517
+
1518
+
1519
+ </header>
1520
+
1521
+ <article>
1522
+
1523
+ <div class="container-overview">
1524
+
1525
+
1526
+
1527
+
1528
+
1529
+ </div>
1530
+
1531
+
1532
+
1533
+
1534
+
1535
+
1536
+
1537
+
1538
+
1539
+
1540
+
1541
+
1542
+
1543
+
1544
+
1545
+
1546
+
1547
+ <h3 class="subsection-title">Methods</h3>
1548
+
1549
+
1550
+
1551
+
1552
+
1553
+
1554
+ <h4 class="name" id="~createForumCategory"><span class="type-signature type-signature-async, inner">(async, inner) </span>createForumCategory<span class="signature">(params)</span><span class="type-signature"> &rarr; {Promise.&lt;ForumCategory>}</span></h4>
1555
+
1556
+
1557
+
1558
+
1559
+
1560
+
1561
+ <dl class="details">
1562
+
1563
+ <dt class="tag-description">Description:</dt>
1564
+ <dd class="tag-description"><ul class="dummy"><li>Creates a new forum category.</li></ul></dd>
1565
+
1566
+
1567
+
1568
+ <dt class="tag-source">Source:</dt>
1569
+ <dd class="tag-source"><ul class="dummy"><li>
1570
+ <a href="forums_categories.ts.html">forums/categories.ts</a>, <a href="forums_categories.ts.html#line30">line 30</a>
1571
+ </li></ul></dd>
1572
+
1573
+
1574
+
1575
+
1576
+
1577
+
1578
+
1579
+
1580
+
1581
+
1582
+
1583
+
1584
+
1585
+
1586
+
1587
+
1588
+
1589
+
1590
+
1591
+
1592
+
1593
+
1594
+
1595
+
1596
+
1597
+
1598
+
1599
+
1600
+
1601
+
1602
+
1603
+ </dl>
1604
+
1605
+
1606
+
1607
+
1608
+
1609
+
1610
+
1611
+
1612
+
1613
+
1614
+
1615
+
1616
+
1617
+ <h5 class="h5-parameters">Parameters:</h5>
1618
+
1619
+
1620
+ <table class="params">
1621
+ <thead>
1622
+ <tr>
1623
+
1624
+ <th>Name</th>
1625
+
1626
+
1627
+ <th>Type</th>
1628
+
1629
+
1630
+
1631
+
1632
+
1633
+ <th class="last">Description</th>
1634
+ </tr>
1635
+ </thead>
1636
+
1637
+ <tbody>
1638
+
1639
+
1640
+ <tr>
1641
+
1642
+ <td class="name"><code>params</code></td>
1643
+
1644
+
1645
+ <td class="type">
1646
+
1647
+
1648
+ <span class="param-type">CreateForumCategoryParams</span>
1649
+
1650
+
1651
+
1652
+
1653
+ </td>
1654
+
1655
+
1656
+
1657
+
1658
+
1659
+ <td class="description last">The parameters for creating the forum category.</td>
1660
+ </tr>
1661
+
1662
+
1663
+ </tbody>
1664
+ </table>
1665
+
1666
+
1667
+
1668
+
1669
+
1670
+
1671
+
1672
+
1673
+
1674
+
1675
+
1676
+
1677
+
1678
+
1679
+ <h5 class="h5-throws">Throws:</h5>
1680
+
1681
+
1682
+
1683
+ <dl>
1684
+ <dt>
1685
+ <div class="param-desc usertext">
1686
+ - If the request fails.
1687
+ </div>
1688
+ </dt>
1689
+ <dd></dd>
1690
+ <dt>
1691
+ <dl class="param-type">
1692
+ <dt>
1693
+ Type
1694
+ </dt>
1695
+ <dd>
1696
+
1697
+ <span class="param-type">HttpError</span>
1698
+
1699
+
1700
+
1701
+ </dd>
1702
+ </dl>
1703
+ </dt>
1704
+ <dd></dd>
1705
+ </dl>
1706
+
1707
+
1708
+
1709
+
1710
+
1711
+ <h5 class="h5-returns">Returns:</h5>
1712
+
1713
+
1714
+ <div class="param-desc">
1715
+ - A promise that resolves to the created forum category.
1716
+ </div>
1717
+
1718
+
1719
+
1720
+ <dl class="param-type">
1721
+ <dt>
1722
+ Type
1723
+ </dt>
1724
+ <dd>
1725
+
1726
+ <span class="param-type">Promise.&lt;ForumCategory></span>
1727
+
1728
+
1729
+
1730
+ </dd>
1731
+ </dl>
1732
+
1733
+
1734
+
1735
+
1736
+
1737
+
1738
+
1739
+
1740
+
1741
+
1742
+ <h4 class="name" id="~createThread"><span class="type-signature type-signature-async, inner">(async, inner) </span>createThread<span class="signature">(params)</span><span class="type-signature"> &rarr; {Promise.&lt;ForumThread>}</span></h4>
1743
+
1744
+
1745
+
1746
+
1747
+
1748
+
1749
+ <dl class="details">
1750
+
1751
+ <dt class="tag-description">Description:</dt>
1752
+ <dd class="tag-description"><ul class="dummy"><li>Creates a new thread under a forum category.</li></ul></dd>
1753
+
1754
+
1755
+
1756
+ <dt class="tag-source">Source:</dt>
1757
+ <dd class="tag-source"><ul class="dummy"><li>
1758
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line18">line 18</a>
1759
+ </li></ul></dd>
1760
+
1761
+
1762
+
1763
+
1764
+
1765
+
1766
+
1767
+
1768
+
1769
+
1770
+
1771
+
1772
+
1773
+
1774
+
1775
+
1776
+
1777
+
1778
+
1779
+
1780
+
1781
+
1782
+
1783
+
1784
+
1785
+
1786
+
1787
+
1788
+
1789
+
1790
+
1791
+ </dl>
1792
+
1793
+
1794
+
1795
+
1796
+
1797
+
1798
+
1799
+
1800
+
1801
+
1802
+
1803
+
1804
+
1805
+ <h5 class="h5-parameters">Parameters:</h5>
1806
+
1807
+
1808
+ <table class="params">
1809
+ <thead>
1810
+ <tr>
1811
+
1812
+ <th>Name</th>
1813
+
1814
+
1815
+ <th>Type</th>
1816
+
1817
+
1818
+
1819
+
1820
+
1821
+ <th class="last">Description</th>
1822
+ </tr>
1823
+ </thead>
1824
+
1825
+ <tbody>
1826
+
1827
+
1828
+ <tr>
1829
+
1830
+ <td class="name"><code>params</code></td>
1831
+
1832
+
1833
+ <td class="type">
1834
+
1835
+
1836
+ <span class="param-type">CreateThreadParams</span>
1837
+
1838
+
1839
+
1840
+
1841
+ </td>
1842
+
1843
+
1844
+
1845
+
1846
+
1847
+ <td class="description last">The parameters for creating the thread.</td>
1848
+ </tr>
1849
+
1850
+
1851
+ </tbody>
1852
+ </table>
1853
+
1854
+
1855
+
1856
+
1857
+
1858
+
1859
+
1860
+
1861
+
1862
+
1863
+
1864
+
1865
+
1866
+
1867
+ <h5 class="h5-throws">Throws:</h5>
1868
+
1869
+
1870
+
1871
+ <dl>
1872
+ <dt>
1873
+ <div class="param-desc usertext">
1874
+ - If the request fails.
1875
+ </div>
1876
+ </dt>
1877
+ <dd></dd>
1878
+ <dt>
1879
+ <dl class="param-type">
1880
+ <dt>
1881
+ Type
1882
+ </dt>
1883
+ <dd>
1884
+
1885
+ <span class="param-type">HttpError</span>
1886
+
1887
+
1888
+
1889
+ </dd>
1890
+ </dl>
1891
+ </dt>
1892
+ <dd></dd>
1893
+ </dl>
1894
+
1895
+
1896
+
1897
+
1898
+
1899
+ <h5 class="h5-returns">Returns:</h5>
1900
+
1901
+
1902
+ <div class="param-desc">
1903
+ - A promise that resolves to the created thread.
1904
+ </div>
1905
+
1906
+
1907
+
1908
+ <dl class="param-type">
1909
+ <dt>
1910
+ Type
1911
+ </dt>
1912
+ <dd>
1913
+
1914
+ <span class="param-type">Promise.&lt;ForumThread></span>
1915
+
1916
+
1917
+
1918
+ </dd>
1919
+ </dl>
1920
+
1921
+
1922
+
1923
+
1924
+
1925
+
1926
+
1927
+
1928
+
1929
+
1930
+ <h4 class="name" id="~fetchForumCategories"><span class="type-signature type-signature-async, inner">(async, inner) </span>fetchForumCategories<span class="signature">(brand)</span><span class="type-signature"> &rarr; {Promise.&lt;ForumCategory>}</span></h4>
1931
+
1932
+
1933
+
1934
+
1935
+
1936
+
1937
+ <dl class="details">
1938
+
1939
+ <dt class="tag-description">Description:</dt>
1940
+ <dd class="tag-description"><ul class="dummy"><li>Fetches forum categories for the given brand.</li></ul></dd>
1941
+
1942
+
1943
+
1944
+ <dt class="tag-source">Source:</dt>
1945
+ <dd class="tag-source"><ul class="dummy"><li>
1946
+ <a href="forums_categories.ts.html">forums/categories.ts</a>, <a href="forums_categories.ts.html#line10">line 10</a>
1947
+ </li></ul></dd>
1948
+
1949
+
1950
+
1951
+
1952
+
1953
+
1954
+
1955
+
1956
+
1957
+
1958
+
1959
+
1960
+
1961
+
1962
+
1963
+
1964
+
1965
+
1966
+
1967
+
1968
+
1969
+
1970
+
1971
+
1972
+
1973
+
1974
+
1975
+
1976
+
1977
+
1978
+
1979
+ </dl>
1980
+
1981
+
1982
+
1983
+
1984
+
1985
+
1986
+
1987
+
1988
+
1989
+
1990
+
1991
+
1992
+
1993
+ <h5 class="h5-parameters">Parameters:</h5>
1994
+
1995
+
1996
+ <table class="params">
1997
+ <thead>
1998
+ <tr>
1999
+
2000
+ <th>Name</th>
2001
+
2002
+
2003
+ <th>Type</th>
2004
+
2005
+
2006
+
2007
+
2008
+
2009
+ <th class="last">Description</th>
2010
+ </tr>
2011
+ </thead>
2012
+
2013
+ <tbody>
2014
+
2015
+
2016
+ <tr>
2017
+
2018
+ <td class="name"><code>brand</code></td>
2019
+
2020
+
2021
+ <td class="type">
2022
+
2023
+
2024
+ <span class="param-type">string</span>
2025
+ |
2026
+
2027
+ <span class="param-type">null</span>
2028
+
2029
+
2030
+
2031
+
2032
+ </td>
2033
+
2034
+
2035
+
2036
+
2037
+
2038
+ <td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
2039
+ </tr>
2040
+
2041
+
2042
+ </tbody>
2043
+ </table>
2044
+
2045
+
2046
+
2047
+
2048
+
2049
+
2050
+
2051
+
2052
+
2053
+
2054
+
2055
+
2056
+
2057
+
2058
+ <h5 class="h5-throws">Throws:</h5>
2059
+
2060
+
2061
+
2062
+ <dl>
2063
+ <dt>
2064
+ <div class="param-desc usertext">
2065
+ - If the request fails.
2066
+ </div>
2067
+ </dt>
2068
+ <dd></dd>
2069
+ <dt>
2070
+ <dl class="param-type">
2071
+ <dt>
2072
+ Type
2073
+ </dt>
2074
+ <dd>
2075
+
2076
+ <span class="param-type">HttpError</span>
2077
+
2078
+
2079
+
2080
+ </dd>
2081
+ </dl>
2082
+ </dt>
2083
+ <dd></dd>
2084
+ </dl>
2085
+
2086
+
2087
+
2088
+
2089
+
2090
+ <h5 class="h5-returns">Returns:</h5>
2091
+
2092
+
2093
+ <div class="param-desc">
2094
+ - A promise that resolves to the list of forum categories.
2095
+ </div>
2096
+
2097
+
2098
+
2099
+ <dl class="param-type">
2100
+ <dt>
2101
+ Type
2102
+ </dt>
2103
+ <dd>
2104
+
2105
+ <span class="param-type">Promise.&lt;ForumCategory></span>
2106
+
2107
+
2108
+
2109
+ </dd>
2110
+ </dl>
2111
+
2112
+
2113
+
2114
+
2115
+
2116
+
2117
+
2118
+
2119
+
2120
+
2121
+ <h4 class="name" id="~fetchThreads"><span class="type-signature type-signature-async, inner">(async, inner) </span>fetchThreads<span class="signature">(categoryId, brand, params)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="global.html#PaginatedResponse">PaginatedResponse</a>.&lt;ForumThread>>}</span></h4>
2122
+
2123
+
2124
+
2125
+
2126
+
2127
+
2128
+ <dl class="details">
2129
+
2130
+ <dt class="tag-description">Description:</dt>
2131
+ <dd class="tag-description"><ul class="dummy"><li>Fetches forum threads for the given category.</li></ul></dd>
2132
+
2133
+
2134
+
2135
+ <dt class="tag-source">Source:</dt>
2136
+ <dd class="tag-source"><ul class="dummy"><li>
2137
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line65">line 65</a>
2138
+ </li></ul></dd>
2139
+
2140
+
2141
+
2142
+
2143
+
2144
+
2145
+
2146
+
2147
+
2148
+
2149
+
2150
+
2151
+
2152
+
2153
+
2154
+
2155
+
2156
+
2157
+
2158
+
2159
+
2160
+
2161
+
2162
+
2163
+
2164
+
2165
+
2166
+
2167
+
2168
+
2169
+
2170
+ </dl>
2171
+
2172
+
2173
+
2174
+
2175
+
2176
+
2177
+
2178
+
2179
+
2180
+
2181
+
2182
+
2183
+
2184
+ <h5 class="h5-parameters">Parameters:</h5>
2185
+
2186
+
2187
+ <table class="params">
2188
+ <thead>
2189
+ <tr>
2190
+
2191
+ <th>Name</th>
2192
+
2193
+
2194
+ <th>Type</th>
2195
+
2196
+
2197
+
2198
+
2199
+
2200
+ <th class="last">Description</th>
2201
+ </tr>
2202
+ </thead>
2203
+
2204
+ <tbody>
2205
+
2206
+
2207
+ <tr>
2208
+
2209
+ <td class="name"><code>categoryId</code></td>
2210
+
2211
+
2212
+ <td class="type">
2213
+
2214
+
2215
+ <span class="param-type">number</span>
2216
+
2217
+
2218
+
2219
+
2220
+ </td>
2221
+
2222
+
2223
+
2224
+
2225
+
2226
+ <td class="description last">The ID of the forum category.</td>
2227
+ </tr>
2228
+
2229
+
2230
+
2231
+ <tr>
2232
+
2233
+ <td class="name"><code>brand</code></td>
2234
+
2235
+
2236
+ <td class="type">
2237
+
2238
+
2239
+ <span class="param-type">string</span>
2240
+
2241
+
2242
+
2243
+
2244
+ </td>
2245
+
2246
+
2247
+
2248
+
2249
+
2250
+ <td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
2251
+ </tr>
2252
+
2253
+
2254
+
2255
+ <tr>
2256
+
2257
+ <td class="name"><code>params</code></td>
2258
+
2259
+
2260
+ <td class="type">
2261
+
2262
+
2263
+ <span class="param-type">FetchThreadParams</span>
2264
+
2265
+
2266
+
2267
+
2268
+ </td>
2269
+
2270
+
2271
+
2272
+
2273
+
2274
+ <td class="description last">Optional additional parameters (e.g., is_followed, sort("last_post_published_on","-last_post_published_on","mine")).</td>
2275
+ </tr>
2276
+
2277
+
2278
+ </tbody>
2279
+ </table>
2280
+
2281
+
2282
+
2283
+
2284
+
2285
+
2286
+
2287
+
2288
+
2289
+
2290
+
2291
+
2292
+
2293
+
2294
+ <h5 class="h5-throws">Throws:</h5>
2295
+
2296
+
2297
+
2298
+ <dl>
2299
+ <dt>
2300
+ <div class="param-desc usertext">
2301
+ - If the HTTP request fails.
2302
+ </div>
2303
+ </dt>
2304
+ <dd></dd>
2305
+ <dt>
2306
+ <dl class="param-type">
2307
+ <dt>
2308
+ Type
2309
+ </dt>
2310
+ <dd>
2311
+
2312
+ <span class="param-type">HttpError</span>
2313
+
2314
+
2315
+
2316
+ </dd>
2317
+ </dl>
2318
+ </dt>
2319
+ <dd></dd>
2320
+ </dl>
2321
+
2322
+
2323
+
2324
+
2325
+
2326
+ <h5 class="h5-returns">Returns:</h5>
2327
+
2328
+
2329
+ <div class="param-desc">
2330
+ - A promise that resolves to a paginated list of forum threads.
2331
+ </div>
2332
+
2333
+
2334
+
2335
+ <dl class="param-type">
2336
+ <dt>
2337
+ Type
2338
+ </dt>
2339
+ <dd>
2340
+
2341
+ <span class="param-type">Promise.&lt;<a href="global.html#PaginatedResponse">PaginatedResponse</a>.&lt;ForumThread>></span>
2342
+
2343
+
2344
+
2345
+ </dd>
2346
+ </dl>
2347
+
2348
+
2349
+
2350
+
2351
+
2352
+
2353
+
2354
+
2355
+
2356
+
2357
+ <h4 class="name" id="~followThread"><span class="type-signature type-signature-async, inner">(async, inner) </span>followThread<span class="signature">(threadId, brand)</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
2358
+
2359
+
2360
+
2361
+
2362
+
2363
+
2364
+ <dl class="details">
2365
+
2366
+ <dt class="tag-description">Description:</dt>
2367
+ <dd class="tag-description"><ul class="dummy"><li>Follow a thread.</li></ul></dd>
2368
+
2369
+
2370
+
2371
+ <dt class="tag-source">Source:</dt>
2372
+ <dd class="tag-source"><ul class="dummy"><li>
2373
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line33">line 33</a>
2374
+ </li></ul></dd>
2375
+
2376
+
2377
+
2378
+
2379
+
2380
+
2381
+
2382
+
2383
+
2384
+
2385
+
2386
+
2387
+
2388
+
2389
+
2390
+
2391
+
2392
+
2393
+
2394
+
2395
+
2396
+
2397
+
2398
+
2399
+
2400
+
2401
+
2402
+
2403
+
2404
+
2405
+
2406
+ </dl>
2407
+
2408
+
2409
+
2410
+
2411
+
2412
+
2413
+
2414
+
2415
+
2416
+
2417
+
2418
+
2419
+
2420
+ <h5 class="h5-parameters">Parameters:</h5>
2421
+
2422
+
2423
+ <table class="params">
2424
+ <thead>
2425
+ <tr>
2426
+
2427
+ <th>Name</th>
2428
+
2429
+
2430
+ <th>Type</th>
2431
+
2432
+
2433
+
2434
+
2435
+
2436
+ <th class="last">Description</th>
2437
+ </tr>
2438
+ </thead>
2439
+
2440
+ <tbody>
2441
+
2442
+
2443
+ <tr>
2444
+
2445
+ <td class="name"><code>threadId</code></td>
2446
+
2447
+
2448
+ <td class="type">
2449
+
2450
+
2451
+ <span class="param-type">number</span>
2452
+
2453
+
2454
+
2455
+
2456
+ </td>
2457
+
2458
+
2459
+
2460
+
2461
+
2462
+ <td class="description last">The ID of the thread to lock.</td>
2463
+ </tr>
2464
+
2465
+
2466
+
2467
+ <tr>
2468
+
2469
+ <td class="name"><code>brand</code></td>
2470
+
2471
+
2472
+ <td class="type">
2473
+
2474
+
2475
+ <span class="param-type">string</span>
2476
+
2477
+
2478
+
2479
+
2480
+ </td>
2481
+
2482
+
2483
+
2484
+
2485
+
2486
+ <td class="description last">The brand associated with the follow action.</td>
2487
+ </tr>
2488
+
2489
+
2490
+ </tbody>
2491
+ </table>
2492
+
2493
+
2494
+
2495
+
2496
+
2497
+
2498
+
2499
+
2500
+
2501
+
2502
+
2503
+
2504
+
2505
+
2506
+ <h5 class="h5-throws">Throws:</h5>
2507
+
2508
+
2509
+
2510
+ <dl>
2511
+ <dt>
2512
+ <div class="param-desc usertext">
2513
+ - If the request fails.
2514
+ </div>
2515
+ </dt>
2516
+ <dd></dd>
2517
+ <dt>
2518
+ <dl class="param-type">
2519
+ <dt>
2520
+ Type
2521
+ </dt>
2522
+ <dd>
2523
+
2524
+ <span class="param-type">HttpError</span>
2525
+
2526
+
2527
+
2528
+ </dd>
2529
+ </dl>
2530
+ </dt>
2531
+ <dd></dd>
2532
+ </dl>
2533
+
2534
+
2535
+
2536
+
2537
+
2538
+ <h5 class="h5-returns">Returns:</h5>
2539
+
2540
+
2541
+ <div class="param-desc">
2542
+ - A promise that resolves when the thread is locked.
2543
+ </div>
2544
+
2545
+
2546
+
2547
+ <dl class="param-type">
2548
+ <dt>
2549
+ Type
2550
+ </dt>
2551
+ <dd>
2552
+
2553
+ <span class="param-type">Promise.&lt;void></span>
2554
+
2555
+
2556
+
2557
+ </dd>
2558
+ </dl>
2559
+
2560
+
2561
+
2562
+
2563
+
2564
+
2565
+
2566
+
2567
+
2568
+
2569
+ <h4 class="name" id="~unfollowThread"><span class="type-signature type-signature-async, inner">(async, inner) </span>unfollowThread<span class="signature">(threadId, brand)</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
2570
+
2571
+
2572
+
2573
+
2574
+
2575
+
2576
+ <dl class="details">
2577
+
2578
+ <dt class="tag-description">Description:</dt>
2579
+ <dd class="tag-description"><ul class="dummy"><li>Unlock a thread to allow further posts.</li></ul></dd>
2580
+
2581
+
2582
+
2583
+ <dt class="tag-source">Source:</dt>
2584
+ <dd class="tag-source"><ul class="dummy"><li>
2585
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line46">line 46</a>
2586
+ </li></ul></dd>
2587
+
2588
+
2589
+
2590
+
2591
+
2592
+
2593
+
2594
+
2595
+
2596
+
2597
+
2598
+
2599
+
2600
+
2601
+
2602
+
2603
+
2604
+
2605
+
2606
+
2607
+
2608
+
2609
+
2610
+
2611
+
2612
+
2613
+
2614
+
2615
+
2616
+
2617
+
2618
+ </dl>
2619
+
2620
+
2621
+
2622
+
2623
+
2624
+
2625
+
2626
+
2627
+
2628
+
2629
+
2630
+
2631
+
2632
+ <h5 class="h5-parameters">Parameters:</h5>
2633
+
2634
+
2635
+ <table class="params">
2636
+ <thead>
2637
+ <tr>
2638
+
2639
+ <th>Name</th>
2640
+
2641
+
2642
+ <th>Type</th>
2643
+
2644
+
2645
+
2646
+
2647
+
2648
+ <th class="last">Description</th>
2649
+ </tr>
2650
+ </thead>
2651
+
2652
+ <tbody>
2653
+
2654
+
2655
+ <tr>
2656
+
2657
+ <td class="name"><code>threadId</code></td>
2658
+
2659
+
2660
+ <td class="type">
2661
+
2662
+
2663
+ <span class="param-type">number</span>
2664
+
2665
+
2666
+
2667
+
2668
+ </td>
2669
+
2670
+
2671
+
2672
+
2673
+
2674
+ <td class="description last">The ID of the thread to unlock.</td>
2675
+ </tr>
2676
+
2677
+
2678
+
2679
+ <tr>
2680
+
2681
+ <td class="name"><code>brand</code></td>
2682
+
2683
+
2684
+ <td class="type">
2685
+
2686
+
2687
+ <span class="param-type">string</span>
2688
+
2689
+
2690
+
2691
+
2692
+ </td>
2693
+
2694
+
2695
+
2696
+
2697
+
2698
+ <td class="description last">The brand associated with the unlock action.</td>
2699
+ </tr>
2700
+
2701
+
2702
+ </tbody>
2703
+ </table>
2704
+
2705
+
2706
+
2707
+
2708
+
2709
+
2710
+
2711
+
2712
+
2713
+
2714
+
2715
+
2716
+
2717
+
2718
+ <h5 class="h5-throws">Throws:</h5>
2719
+
2720
+
2721
+
2722
+ <dl>
2723
+ <dt>
2724
+ <div class="param-desc usertext">
2725
+ - If the request fails.
2726
+ </div>
2727
+ </dt>
2728
+ <dd></dd>
2729
+ <dt>
2730
+ <dl class="param-type">
2731
+ <dt>
2732
+ Type
2733
+ </dt>
2734
+ <dd>
2735
+
2736
+ <span class="param-type">HttpError</span>
2737
+
2738
+
2739
+
2740
+ </dd>
2741
+ </dl>
2742
+ </dt>
2743
+ <dd></dd>
2744
+ </dl>
2745
+
2746
+
2747
+
2748
+
2749
+
2750
+ <h5 class="h5-returns">Returns:</h5>
2751
+
2752
+
2753
+ <div class="param-desc">
2754
+ - A promise that resolves when the thread is unlocked.
2755
+ </div>
2756
+
2757
+
2758
+
2759
+ <dl class="param-type">
2760
+ <dt>
2761
+ Type
2762
+ </dt>
2763
+ <dd>
2764
+
2765
+ <span class="param-type">Promise.&lt;void></span>
2766
+
2767
+
2768
+
2769
+ </dd>
2770
+ </dl>
2771
+
2772
+
2773
+
2774
+
2775
+
2776
+
2777
+
2778
+
2779
+
2780
+
2781
+ <h4 class="name" id="~updateForumCategory"><span class="type-signature type-signature-async, inner">(async, inner) </span>updateForumCategory<span class="signature">(params)</span><span class="type-signature"> &rarr; {Promise.&lt;ForumCategory>}</span></h4>
2782
+
2783
+
2784
+
2785
+
2786
+
2787
+
2788
+ <dl class="details">
2789
+
2790
+ <dt class="tag-description">Description:</dt>
2791
+ <dd class="tag-description"><ul class="dummy"><li>Creates a new forum category.</li></ul></dd>
2792
+
2793
+
2794
+
2795
+ <dt class="tag-source">Source:</dt>
2796
+ <dd class="tag-source"><ul class="dummy"><li>
2797
+ <a href="forums_categories.ts.html">forums/categories.ts</a>, <a href="forums_categories.ts.html#line53">line 53</a>
2798
+ </li></ul></dd>
2799
+
2800
+
2801
+
2802
+
2803
+
2804
+
2805
+
2806
+
2807
+
2808
+
2809
+
2810
+
2811
+
2812
+
2813
+
2814
+
2815
+
2816
+
2817
+
2818
+
2819
+
2820
+
2821
+
2822
+
2823
+
2824
+
2825
+
2826
+
2827
+
2828
+
2829
+
2830
+ </dl>
2831
+
2832
+
2833
+
2834
+
2835
+
2836
+
2837
+
2838
+
2839
+
2840
+
2841
+
2842
+
2843
+
2844
+ <h5 class="h5-parameters">Parameters:</h5>
2845
+
2846
+
2847
+ <table class="params">
2848
+ <thead>
2849
+ <tr>
2850
+
2851
+ <th>Name</th>
2852
+
2853
+
2854
+ <th>Type</th>
2855
+
2856
+
2857
+
2858
+
2859
+
2860
+ <th class="last">Description</th>
2861
+ </tr>
2862
+ </thead>
2863
+
2864
+ <tbody>
2865
+
2866
+
2867
+ <tr>
2868
+
2869
+ <td class="name"><code>params</code></td>
2870
+
2871
+
2872
+ <td class="type">
2873
+
2874
+
2875
+ <span class="param-type">UpdateForumCategoryParams</span>
2876
+
2877
+
2878
+
2879
+
2880
+ </td>
2881
+
2882
+
2883
+
2884
+
2885
+
2886
+ <td class="description last">The parameters for creating the forum category.</td>
2887
+ </tr>
2888
+
2889
+
2890
+ </tbody>
2891
+ </table>
2892
+
2893
+
2894
+
2895
+
2896
+
2897
+
2898
+
2899
+
2900
+
2901
+
2902
+
2903
+
2904
+
2905
+
2906
+ <h5 class="h5-throws">Throws:</h5>
2907
+
2908
+
2909
+
2910
+ <dl>
2911
+ <dt>
2912
+ <div class="param-desc usertext">
2913
+ - If the request fails.
2914
+ </div>
2915
+ </dt>
2916
+ <dd></dd>
2917
+ <dt>
2918
+ <dl class="param-type">
2919
+ <dt>
2920
+ Type
2921
+ </dt>
2922
+ <dd>
2923
+
2924
+ <span class="param-type">HttpError</span>
2925
+
2926
+
2927
+
2928
+ </dd>
2929
+ </dl>
2930
+ </dt>
2931
+ <dd></dd>
2932
+ </dl>
2933
+
2934
+
2935
+
2936
+
2937
+
2938
+ <h5 class="h5-returns">Returns:</h5>
2939
+
2940
+
2941
+ <div class="param-desc">
2942
+ - A promise that resolves to the created forum category.
2943
+ </div>
2944
+
2945
+
2946
+
2947
+ <dl class="param-type">
2948
+ <dt>
2949
+ Type
2950
+ </dt>
2951
+ <dd>
2952
+
2953
+ <span class="param-type">Promise.&lt;ForumCategory></span>
2954
+
2955
+
2956
+
2957
+ </dd>
2958
+ </dl>
2959
+
2960
+
2961
+
2962
+
2963
+
2964
+
2965
+
2966
+
2967
+
2968
+
2969
+
2970
+ </article>
2971
+
2972
+ </section>
351
2973
 
352
2974
 
353
2975
 
354
2976
 
2977
+
2978
+
355
2979
  </div>
356
2980
 
357
2981
  <br class="clear">
358
2982
 
359
2983
  <footer>
360
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Tue Sep 09 2025 13:27:24 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
2984
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Mon Sep 22 2025 12:44:47 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
361
2985
  </footer>
362
2986
 
363
2987
  <script>prettyPrint();</script>
@@ -367,4 +2991,4 @@
367
2991
 
368
2992
 
369
2993
  </body>
370
- </html>
2994
+ </html>