musora-content-services 2.39.5 → 2.41.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 (66) hide show
  1. package/CHANGELOG.md +32 -0
  2. package/docs/ContentOrganization.html +2 -2
  3. package/docs/Forums.html +28 -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 +26 -3
  14. package/docs/forums_forums.ts.html +4 -3
  15. package/docs/forums_threads.ts.html +128 -0
  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 +679 -0
  23. package/docs/module-Config.html +2 -2
  24. package/docs/module-Content-Services-V2.html +2 -2
  25. package/docs/module-ForumCategories.html +198 -2
  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 +3 -3
  34. package/docs/module-Threads.html +724 -0
  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 +152 -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 +24 -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 +3 -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 +18 -3
  58. package/src/index.js +18 -3
  59. package/src/services/contentProgress.js +1 -0
  60. package/src/services/forums/categories.ts +24 -1
  61. package/src/services/forums/forums.ts +2 -1
  62. package/src/services/forums/threads.ts +56 -0
  63. package/src/services/forums/types.ts +13 -0
  64. package/src/services/gamification/awards.ts +21 -0
  65. package/src/services/imageSRCVerify.js +0 -0
  66. package/src/services/user/memberships.js +22 -0
package/docs/module-Threads.html ADDED
@@ -0,0 +1,724 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+
5
+ <meta charset="utf-8">
6
+ <title>Threads - Documentation</title>
7
+
8
+
9
+ <script src="scripts/prettify/prettify.js"></script>
10
+ <script src="scripts/prettify/lang-css.js"></script>
11
+ <!--[if lt IE 9]>
12
+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
13
+ <![endif]-->
14
+ <link type="text/css" rel="stylesheet" href="styles/prettify.css">
15
+ <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
16
+ <script src="scripts/nav.js" defer></script>
17
+
18
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
19
+ </head>
20
+ <body>
21
+
22
+ <input type="checkbox" id="nav-trigger" class="nav-trigger" />
23
+ <label for="nav-trigger" class="navicon-button x">
24
+ <div class="navicon"></div>
25
+ </label>
26
+
27
+ <label for="nav-trigger" class="overlay"></label>
28
+
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-Categories.html">Categories</a><ul class='methods'><li data-type='method'><a href="module-Categories.html#~createForumCategory">createForumCategory</a></li><li data-type='method'><a href="module-Categories.html#~fetchForumCategories">fetchForumCategories</a></li><li data-type='method'><a href="module-Categories.html#~updateForumCategory">updateForumCategory</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-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-Threads.html">Threads</a><ul class='methods'><li data-type='method'><a href="module-Threads.html#~createThread">createThread</a></li><li data-type='method'><a href="module-Threads.html#~followThread">followThread</a></li><li data-type='method'><a href="module-Threads.html#~unfollowThread">unfollowThread</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>
35
+
36
+ <div id="main">
37
+
38
+ <h1 class="page-title">Threads</h1>
39
+
40
+
41
+
42
+
43
+
44
+
45
+
46
+ <section>
47
+
48
+ <header>
49
+
50
+
51
+
52
+ </header>
53
+
54
+ <article>
55
+
56
+ <div class="container-overview">
57
+
58
+
59
+
60
+
61
+
62
+ </div>
63
+
64
+
65
+
66
+
67
+
68
+
69
+
70
+
71
+
72
+
73
+
74
+
75
+
76
+
77
+
78
+
79
+
80
+ <h3 class="subsection-title">Methods</h3>
81
+
82
+
83
+
84
+
85
+
86
+
87
+ <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>
88
+
89
+
90
+
91
+
92
+
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 thread under a forum category.</li></ul></dd>
98
+
99
+
100
+
101
+ <dt class="tag-source">Source:</dt>
102
+ <dd class="tag-source"><ul class="dummy"><li>
103
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line17">line 17</a>
104
+ </li></ul></dd>
105
+
106
+
107
+
108
+
109
+
110
+
111
+
112
+
113
+
114
+
115
+
116
+
117
+
118
+
119
+
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+
128
+
129
+
130
+
131
+
132
+
133
+
134
+
135
+
136
+ </dl>
137
+
138
+
139
+
140
+
141
+
142
+
143
+
144
+
145
+
146
+
147
+
148
+
149
+
150
+ <h5 class="h5-parameters">Parameters:</h5>
151
+
152
+
153
+ <table class="params">
154
+ <thead>
155
+ <tr>
156
+
157
+ <th>Name</th>
158
+
159
+
160
+ <th>Type</th>
161
+
162
+
163
+
164
+
165
+
166
+ <th class="last">Description</th>
167
+ </tr>
168
+ </thead>
169
+
170
+ <tbody>
171
+
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">CreateThreadParams</span>
182
+
183
+
184
+
185
+
186
+ </td>
187
+
188
+
189
+
190
+
191
+
192
+ <td class="description last">The parameters for creating the thread.</td>
193
+ </tr>
194
+
195
+
196
+ </tbody>
197
+ </table>
198
+
199
+
200
+
201
+
202
+
203
+
204
+
205
+
206
+
207
+
208
+
209
+
210
+
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>
231
+
232
+
233
+
234
+ </dd>
235
+ </dl>
236
+ </dt>
237
+ <dd></dd>
238
+ </dl>
239
+
240
+
241
+
242
+
243
+
244
+ <h5 class="h5-returns">Returns:</h5>
245
+
246
+
247
+ <div class="param-desc">
248
+ - A promise that resolves to the created thread.
249
+ </div>
250
+
251
+
252
+
253
+ <dl class="param-type">
254
+ <dt>
255
+ Type
256
+ </dt>
257
+ <dd>
258
+
259
+ <span class="param-type">Promise.&lt;ForumThread></span>
260
+
261
+
262
+
263
+ </dd>
264
+ </dl>
265
+
266
+
267
+
268
+
269
+
270
+
271
+
272
+
273
+
274
+
275
+ <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>
276
+
277
+
278
+
279
+
280
+
281
+
282
+ <dl class="details">
283
+
284
+ <dt class="tag-description">Description:</dt>
285
+ <dd class="tag-description"><ul class="dummy"><li>Follow a thread.</li></ul></dd>
286
+
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#line32">line 32</a>
292
+ </li></ul></dd>
293
+
294
+
295
+
296
+
297
+
298
+
299
+
300
+
301
+
302
+
303
+
304
+
305
+
306
+
307
+
308
+
309
+
310
+
311
+
312
+
313
+
314
+
315
+
316
+
317
+
318
+
319
+
320
+
321
+
322
+
323
+
324
+ </dl>
325
+
326
+
327
+
328
+
329
+
330
+
331
+
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
+
354
+ <th class="last">Description</th>
355
+ </tr>
356
+ </thead>
357
+
358
+ <tbody>
359
+
360
+
361
+ <tr>
362
+
363
+ <td class="name"><code>threadId</code></td>
364
+
365
+
366
+ <td class="type">
367
+
368
+
369
+ <span class="param-type">number</span>
370
+
371
+
372
+
373
+
374
+ </td>
375
+
376
+
377
+
378
+
379
+
380
+ <td class="description last">The ID of the thread to lock.</td>
381
+ </tr>
382
+
383
+
384
+
385
+ <tr>
386
+
387
+ <td class="name"><code>brand</code></td>
388
+
389
+
390
+ <td class="type">
391
+
392
+
393
+ <span class="param-type">string</span>
394
+
395
+
396
+
397
+
398
+ </td>
399
+
400
+
401
+
402
+
403
+
404
+ <td class="description last">The brand associated with the follow action.</td>
405
+ </tr>
406
+
407
+
408
+ </tbody>
409
+ </table>
410
+
411
+
412
+
413
+
414
+
415
+
416
+
417
+
418
+
419
+
420
+
421
+
422
+
423
+
424
+ <h5 class="h5-throws">Throws:</h5>
425
+
426
+
427
+
428
+ <dl>
429
+ <dt>
430
+ <div class="param-desc usertext">
431
+ - If the request fails.
432
+ </div>
433
+ </dt>
434
+ <dd></dd>
435
+ <dt>
436
+ <dl class="param-type">
437
+ <dt>
438
+ Type
439
+ </dt>
440
+ <dd>
441
+
442
+ <span class="param-type">HttpError</span>
443
+
444
+
445
+
446
+ </dd>
447
+ </dl>
448
+ </dt>
449
+ <dd></dd>
450
+ </dl>
451
+
452
+
453
+
454
+
455
+
456
+ <h5 class="h5-returns">Returns:</h5>
457
+
458
+
459
+ <div class="param-desc">
460
+ - A promise that resolves when the thread is locked.
461
+ </div>
462
+
463
+
464
+
465
+ <dl class="param-type">
466
+ <dt>
467
+ Type
468
+ </dt>
469
+ <dd>
470
+
471
+ <span class="param-type">Promise.&lt;void></span>
472
+
473
+
474
+
475
+ </dd>
476
+ </dl>
477
+
478
+
479
+
480
+
481
+
482
+
483
+
484
+
485
+
486
+
487
+ <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>
488
+
489
+
490
+
491
+
492
+
493
+
494
+ <dl class="details">
495
+
496
+ <dt class="tag-description">Description:</dt>
497
+ <dd class="tag-description"><ul class="dummy"><li>Unlock a thread to allow further posts.</li></ul></dd>
498
+
499
+
500
+
501
+ <dt class="tag-source">Source:</dt>
502
+ <dd class="tag-source"><ul class="dummy"><li>
503
+ <a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line45">line 45</a>
504
+ </li></ul></dd>
505
+
506
+
507
+
508
+
509
+
510
+
511
+
512
+
513
+
514
+
515
+
516
+
517
+
518
+
519
+
520
+
521
+
522
+
523
+
524
+
525
+
526
+
527
+
528
+
529
+
530
+
531
+
532
+
533
+
534
+
535
+
536
+ </dl>
537
+
538
+
539
+
540
+
541
+
542
+
543
+
544
+
545
+
546
+
547
+
548
+
549
+
550
+ <h5 class="h5-parameters">Parameters:</h5>
551
+
552
+
553
+ <table class="params">
554
+ <thead>
555
+ <tr>
556
+
557
+ <th>Name</th>
558
+
559
+
560
+ <th>Type</th>
561
+
562
+
563
+
564
+
565
+
566
+ <th class="last">Description</th>
567
+ </tr>
568
+ </thead>
569
+
570
+ <tbody>
571
+
572
+
573
+ <tr>
574
+
575
+ <td class="name"><code>threadId</code></td>
576
+
577
+
578
+ <td class="type">
579
+
580
+
581
+ <span class="param-type">number</span>
582
+
583
+
584
+
585
+
586
+ </td>
587
+
588
+
589
+
590
+
591
+
592
+ <td class="description last">The ID of the thread to unlock.</td>
593
+ </tr>
594
+
595
+
596
+
597
+ <tr>
598
+
599
+ <td class="name"><code>brand</code></td>
600
+
601
+
602
+ <td class="type">
603
+
604
+
605
+ <span class="param-type">string</span>
606
+
607
+
608
+
609
+
610
+ </td>
611
+
612
+
613
+
614
+
615
+
616
+ <td class="description last">The brand associated with the unlock action.</td>
617
+ </tr>
618
+
619
+
620
+ </tbody>
621
+ </table>
622
+
623
+
624
+
625
+
626
+
627
+
628
+
629
+
630
+
631
+
632
+
633
+
634
+
635
+
636
+ <h5 class="h5-throws">Throws:</h5>
637
+
638
+
639
+
640
+ <dl>
641
+ <dt>
642
+ <div class="param-desc usertext">
643
+ - If the request fails.
644
+ </div>
645
+ </dt>
646
+ <dd></dd>
647
+ <dt>
648
+ <dl class="param-type">
649
+ <dt>
650
+ Type
651
+ </dt>
652
+ <dd>
653
+
654
+ <span class="param-type">HttpError</span>
655
+
656
+
657
+
658
+ </dd>
659
+ </dl>
660
+ </dt>
661
+ <dd></dd>
662
+ </dl>
663
+
664
+
665
+
666
+
667
+
668
+ <h5 class="h5-returns">Returns:</h5>
669
+
670
+
671
+ <div class="param-desc">
672
+ - A promise that resolves when the thread is unlocked.
673
+ </div>
674
+
675
+
676
+
677
+ <dl class="param-type">
678
+ <dt>
679
+ Type
680
+ </dt>
681
+ <dd>
682
+
683
+ <span class="param-type">Promise.&lt;void></span>
684
+
685
+
686
+
687
+ </dd>
688
+ </dl>
689
+
690
+
691
+
692
+
693
+
694
+
695
+
696
+
697
+
698
+
699
+
700
+ </article>
701
+
702
+ </section>
703
+
704
+
705
+
706
+
707
+
708
+
709
+ </div>
710
+
711
+ <br class="clear">
712
+
713
+ <footer>
714
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Fri Sep 19 2025 17:15:30 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
715
+ </footer>
716
+
717
+ <script>prettyPrint();</script>
718
+ <script src="scripts/polyfill.js"></script>
719
+ <script src="scripts/linenumber.js"></script>
720
+
721
+
722
+
723
+ </body>
724
+ </html>