musora-content-services 2.45.0 → 2.47.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +22 -0
- package/docs/ContentOrganization.html +2 -2
- package/docs/Forums.html +2 -2
- package/docs/Gamification.html +2 -2
- package/docs/UserManagementSystem.html +2 -2
- package/docs/api_types.js.html +2 -2
- package/docs/config.js.html +2 -2
- package/docs/content-org_content-org.js.html +2 -2
- package/docs/content-org_guided-courses.ts.html +2 -2
- package/docs/content-org_playlists-types.js.html +2 -2
- package/docs/content-org_playlists.js.html +2 -2
- package/docs/content.js.html +2 -2
- package/docs/forums_categories.ts.html +2 -2
- package/docs/forums_forums.ts.html +2 -2
- package/docs/forums_posts.ts.html +2 -2
- package/docs/forums_threads.ts.html +30 -3
- package/docs/gamification_awards.ts.html +2 -2
- package/docs/gamification_gamification.js.html +2 -2
- package/docs/global.html +2 -2
- package/docs/index.html +2 -2
- package/docs/module-Accounts.html +2 -2
- package/docs/module-Awards.html +2 -2
- package/docs/module-Categories.html +0 -0
- package/docs/module-Config.html +2 -2
- package/docs/module-Content-Services-V2.html +2 -2
- package/docs/module-ForumCategories.html +0 -0
- package/docs/module-Forums.html +1726 -598
- package/docs/module-GuidedCourses.html +2 -2
- package/docs/module-Interests.html +2 -2
- package/docs/module-Payments.html +2 -2
- package/docs/module-Permissions.html +2 -2
- package/docs/module-Playlists.html +2 -2
- package/docs/module-Railcontent-Services.html +2 -2
- package/docs/module-Sanity-Services.html +2 -2
- package/docs/module-Sessions.html +2 -2
- package/docs/module-Threads.html +0 -0
- package/docs/module-UserActivity.html +2 -2
- package/docs/module-UserChat.html +2 -2
- package/docs/module-UserManagement.html +2 -2
- package/docs/module-UserMemberships.html +2 -2
- package/docs/module-UserNotifications.html +2 -2
- package/docs/module-UserProfile.html +2 -2
- package/docs/railcontent.js.html +2 -2
- package/docs/sanity.js.html +2 -2
- package/docs/userActivity.js.html +3 -3
- package/docs/user_account.ts.html +2 -2
- package/docs/user_chat.js.html +2 -2
- package/docs/user_interests.js.html +2 -2
- package/docs/user_management.js.html +2 -2
- package/docs/user_memberships.js.html +2 -2
- package/docs/user_notifications.js.html +2 -2
- package/docs/user_payments.ts.html +2 -2
- package/docs/user_permissions.js.html +2 -2
- package/docs/user_profile.js.html +2 -2
- package/docs/user_sessions.js.html +2 -2
- package/docs/user_types.js.html +2 -2
- package/docs/user_user-management-system.js.html +2 -2
- package/package.json +1 -1
- package/src/contentMetaData.js +31 -362
- package/src/contentTypeConfig.js +3 -2
- package/src/index.d.ts +4 -2
- package/src/index.js +4 -2
- package/src/services/contentProgress.js +0 -0
- package/src/services/forums/categories.ts +0 -0
- package/src/services/forums/threads.ts +28 -1
- package/src/services/gamification/awards.ts +0 -0
- package/src/services/user/memberships.js +0 -0
- package/src/services/userActivity.js +1 -1
package/docs/module-Forums.html
CHANGED
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
<nav >
|
|
30
30
|
|
|
31
31
|
|
|
32
|
-
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Accounts.html">Accounts</a><ul class='methods'><li data-type='method'><a href="module-Accounts.html#~confirmEmailChange">confirmEmailChange</a></li><li data-type='method'><a href="module-Accounts.html#~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#~createPost">createPost</a></li><li data-type='method'><a href="module-Forums.html#~createThread">createThread</a></li><li data-type='method'><a href="module-Forums.html#~fetchForumCategories">fetchForumCategories</a></li><li data-type='method'><a href="module-Forums.html#~fetchPosts">fetchPosts</a></li><li data-type='method'><a href="module-Forums.html#~fetchThreads">fetchThreads</a></li><li data-type='method'><a href="module-Forums.html#~followThread">followThread</a></li><li data-type='method'><a href="module-Forums.html#~lockThread">lockThread</a></li><li data-type='method'><a href="module-Forums.html#~pinThread">pinThread</a></li><li data-type='method'><a href="module-Forums.html#~unfollowThread">unfollowThread</a></li><li data-type='method'><a href="module-Forums.html#~unlockThread">unlockThread</a></li><li data-type='method'><a href="module-Forums.html#~unpinThread">unpinThread</a></li><li data-type='method'><a href="module-Forums.html#~updateForumCategory">updateForumCategory</a></li><li data-type='method'><a href="module-Forums.html#~updateThread">updateThread</a></li></ul></li><li></li><li></li><li><a href="module-GuidedCourses.html">GuidedCourses</a></li><li><a href="module-Interests.html">Interests</a><ul class='methods'><li data-type='method'><a href="module-Interests.html#.fetchInterests">fetchInterests</a></li><li data-type='method'><a href="module-Interests.html#.fetchUninterests">fetchUninterests</a></li><li data-type='method'><a href="module-Interests.html#.markContentAsInterested">markContentAsInterested</a></li><li data-type='method'><a href="module-Interests.html#.markContentAsNotInterested">markContentAsNotInterested</a></li><li data-type='method'><a href="module-Interests.html#.removeContentAsInterested">removeContentAsInterested</a></li><li data-type='method'><a href="module-Interests.html#.removeContentAsNotInterested">removeContentAsNotInterested</a></li></ul></li><li><a href="module-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#.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>
|
|
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#~createPost">createPost</a></li><li data-type='method'><a href="module-Forums.html#~createThread">createThread</a></li><li data-type='method'><a href="module-Forums.html#~fetchFollowedThreads">fetchFollowedThreads</a></li><li data-type='method'><a href="module-Forums.html#~fetchForumCategories">fetchForumCategories</a></li><li data-type='method'><a href="module-Forums.html#~fetchLatestThreads">fetchLatestThreads</a></li><li data-type='method'><a href="module-Forums.html#~fetchPosts">fetchPosts</a></li><li data-type='method'><a href="module-Forums.html#~fetchThreads">fetchThreads</a></li><li data-type='method'><a href="module-Forums.html#~followThread">followThread</a></li><li data-type='method'><a href="module-Forums.html#~lockThread">lockThread</a></li><li data-type='method'><a href="module-Forums.html#~pinThread">pinThread</a></li><li data-type='method'><a href="module-Forums.html#~unfollowThread">unfollowThread</a></li><li data-type='method'><a href="module-Forums.html#~unlockThread">unlockThread</a></li><li data-type='method'><a href="module-Forums.html#~unpinThread">unpinThread</a></li><li data-type='method'><a href="module-Forums.html#~updateForumCategory">updateForumCategory</a></li><li data-type='method'><a href="module-Forums.html#~updateThread">updateThread</a></li></ul></li><li></li><li></li><li><a href="module-GuidedCourses.html">GuidedCourses</a></li><li><a href="module-Interests.html">Interests</a><ul class='methods'><li data-type='method'><a href="module-Interests.html#.fetchInterests">fetchInterests</a></li><li data-type='method'><a href="module-Interests.html#.fetchUninterests">fetchUninterests</a></li><li data-type='method'><a href="module-Interests.html#.markContentAsInterested">markContentAsInterested</a></li><li data-type='method'><a href="module-Interests.html#.markContentAsNotInterested">markContentAsNotInterested</a></li><li data-type='method'><a href="module-Interests.html#.removeContentAsInterested">removeContentAsInterested</a></li><li data-type='method'><a href="module-Interests.html#.removeContentAsNotInterested">removeContentAsNotInterested</a></li></ul></li><li><a href="module-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#.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
33
|
|
|
34
34
|
</nav>
|
|
35
35
|
|
|
@@ -648,6 +648,194 @@
|
|
|
648
648
|
|
|
649
649
|
|
|
650
650
|
|
|
651
|
+
<h4 class="name" id="~fetchFollowedThreads"><span class="type-signature type-signature-async, inner">(async, inner) </span>fetchFollowedThreads<span class="signature">(brand)</span><span class="type-signature"> → {Promise.<<a href="global.html#PaginatedResponse">PaginatedResponse</a>.<ForumThread>>}</span></h4>
|
|
652
|
+
|
|
653
|
+
|
|
654
|
+
|
|
655
|
+
|
|
656
|
+
|
|
657
|
+
|
|
658
|
+
<dl class="details">
|
|
659
|
+
|
|
660
|
+
<dt class="tag-description">Description:</dt>
|
|
661
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetches followed forum Threads for the given brand and current user.</li></ul></dd>
|
|
662
|
+
|
|
663
|
+
|
|
664
|
+
|
|
665
|
+
<dt class="tag-source">Source:</dt>
|
|
666
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
667
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line160">line 160</a>
|
|
668
|
+
</li></ul></dd>
|
|
669
|
+
|
|
670
|
+
|
|
671
|
+
|
|
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
|
+
|
|
697
|
+
|
|
698
|
+
|
|
699
|
+
|
|
700
|
+
</dl>
|
|
701
|
+
|
|
702
|
+
|
|
703
|
+
|
|
704
|
+
|
|
705
|
+
|
|
706
|
+
|
|
707
|
+
|
|
708
|
+
|
|
709
|
+
|
|
710
|
+
|
|
711
|
+
|
|
712
|
+
|
|
713
|
+
|
|
714
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
715
|
+
|
|
716
|
+
|
|
717
|
+
<table class="params">
|
|
718
|
+
<thead>
|
|
719
|
+
<tr>
|
|
720
|
+
|
|
721
|
+
<th>Name</th>
|
|
722
|
+
|
|
723
|
+
|
|
724
|
+
<th>Type</th>
|
|
725
|
+
|
|
726
|
+
|
|
727
|
+
|
|
728
|
+
|
|
729
|
+
|
|
730
|
+
<th class="last">Description</th>
|
|
731
|
+
</tr>
|
|
732
|
+
</thead>
|
|
733
|
+
|
|
734
|
+
<tbody>
|
|
735
|
+
|
|
736
|
+
|
|
737
|
+
<tr>
|
|
738
|
+
|
|
739
|
+
<td class="name"><code>brand</code></td>
|
|
740
|
+
|
|
741
|
+
|
|
742
|
+
<td class="type">
|
|
743
|
+
|
|
744
|
+
|
|
745
|
+
<span class="param-type">string</span>
|
|
746
|
+
|
|
747
|
+
|
|
748
|
+
|
|
749
|
+
|
|
750
|
+
</td>
|
|
751
|
+
|
|
752
|
+
|
|
753
|
+
|
|
754
|
+
|
|
755
|
+
|
|
756
|
+
<td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
|
|
757
|
+
</tr>
|
|
758
|
+
|
|
759
|
+
|
|
760
|
+
</tbody>
|
|
761
|
+
</table>
|
|
762
|
+
|
|
763
|
+
|
|
764
|
+
|
|
765
|
+
|
|
766
|
+
|
|
767
|
+
|
|
768
|
+
|
|
769
|
+
|
|
770
|
+
|
|
771
|
+
|
|
772
|
+
|
|
773
|
+
|
|
774
|
+
|
|
775
|
+
|
|
776
|
+
<h5 class="h5-throws">Throws:</h5>
|
|
777
|
+
|
|
778
|
+
|
|
779
|
+
|
|
780
|
+
<dl>
|
|
781
|
+
<dt>
|
|
782
|
+
<div class="param-desc usertext">
|
|
783
|
+
- If the request fails.
|
|
784
|
+
</div>
|
|
785
|
+
</dt>
|
|
786
|
+
<dd></dd>
|
|
787
|
+
<dt>
|
|
788
|
+
<dl class="param-type">
|
|
789
|
+
<dt>
|
|
790
|
+
Type
|
|
791
|
+
</dt>
|
|
792
|
+
<dd>
|
|
793
|
+
|
|
794
|
+
<span class="param-type">HttpError</span>
|
|
795
|
+
|
|
796
|
+
|
|
797
|
+
|
|
798
|
+
</dd>
|
|
799
|
+
</dl>
|
|
800
|
+
</dt>
|
|
801
|
+
<dd></dd>
|
|
802
|
+
</dl>
|
|
803
|
+
|
|
804
|
+
|
|
805
|
+
|
|
806
|
+
|
|
807
|
+
|
|
808
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
809
|
+
|
|
810
|
+
|
|
811
|
+
<div class="param-desc">
|
|
812
|
+
- A promise that resolves to the list of forum threads.
|
|
813
|
+
</div>
|
|
814
|
+
|
|
815
|
+
|
|
816
|
+
|
|
817
|
+
<dl class="param-type">
|
|
818
|
+
<dt>
|
|
819
|
+
Type
|
|
820
|
+
</dt>
|
|
821
|
+
<dd>
|
|
822
|
+
|
|
823
|
+
<span class="param-type">Promise.<<a href="global.html#PaginatedResponse">PaginatedResponse</a>.<ForumThread>></span>
|
|
824
|
+
|
|
825
|
+
|
|
826
|
+
|
|
827
|
+
</dd>
|
|
828
|
+
</dl>
|
|
829
|
+
|
|
830
|
+
|
|
831
|
+
|
|
832
|
+
|
|
833
|
+
|
|
834
|
+
|
|
835
|
+
|
|
836
|
+
|
|
837
|
+
|
|
838
|
+
|
|
651
839
|
<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"> → {Promise.<ForumCategory>}</span></h4>
|
|
652
840
|
|
|
653
841
|
|
|
@@ -839,7 +1027,7 @@
|
|
|
839
1027
|
|
|
840
1028
|
|
|
841
1029
|
|
|
842
|
-
<h4 class="name" id="~
|
|
1030
|
+
<h4 class="name" id="~fetchLatestThreads"><span class="type-signature type-signature-async, inner">(async, inner) </span>fetchLatestThreads<span class="signature">(brand)</span><span class="type-signature"> → {Promise.<<a href="global.html#PaginatedResponse">PaginatedResponse</a>.<ForumThread>>}</span></h4>
|
|
843
1031
|
|
|
844
1032
|
|
|
845
1033
|
|
|
@@ -849,13 +1037,13 @@
|
|
|
849
1037
|
<dl class="details">
|
|
850
1038
|
|
|
851
1039
|
<dt class="tag-description">Description:</dt>
|
|
852
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetches
|
|
1040
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetches latest forum Threads for the given brand and not blocked to current user.</li></ul></dd>
|
|
853
1041
|
|
|
854
1042
|
|
|
855
1043
|
|
|
856
1044
|
<dt class="tag-source">Source:</dt>
|
|
857
1045
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
858
|
-
<a href="
|
|
1046
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line174">line 174</a>
|
|
859
1047
|
</li></ul></dd>
|
|
860
1048
|
|
|
861
1049
|
|
|
@@ -915,8 +1103,6 @@
|
|
|
915
1103
|
<th>Type</th>
|
|
916
1104
|
|
|
917
1105
|
|
|
918
|
-
<th>Attributes</th>
|
|
919
|
-
|
|
920
1106
|
|
|
921
1107
|
|
|
922
1108
|
|
|
@@ -929,13 +1115,13 @@
|
|
|
929
1115
|
|
|
930
1116
|
<tr>
|
|
931
1117
|
|
|
932
|
-
<td class="name"><code>
|
|
1118
|
+
<td class="name"><code>brand</code></td>
|
|
933
1119
|
|
|
934
1120
|
|
|
935
1121
|
<td class="type">
|
|
936
1122
|
|
|
937
1123
|
|
|
938
|
-
<span class="param-type">
|
|
1124
|
+
<span class="param-type">string</span>
|
|
939
1125
|
|
|
940
1126
|
|
|
941
1127
|
|
|
@@ -943,31 +1129,1111 @@
|
|
|
943
1129
|
</td>
|
|
944
1130
|
|
|
945
1131
|
|
|
946
|
-
|
|
1132
|
+
|
|
1133
|
+
|
|
1134
|
+
|
|
1135
|
+
<td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
|
|
1136
|
+
</tr>
|
|
1137
|
+
|
|
1138
|
+
|
|
1139
|
+
</tbody>
|
|
1140
|
+
</table>
|
|
1141
|
+
|
|
1142
|
+
|
|
1143
|
+
|
|
1144
|
+
|
|
1145
|
+
|
|
1146
|
+
|
|
1147
|
+
|
|
1148
|
+
|
|
1149
|
+
|
|
1150
|
+
|
|
1151
|
+
|
|
1152
|
+
|
|
1153
|
+
|
|
1154
|
+
|
|
1155
|
+
<h5 class="h5-throws">Throws:</h5>
|
|
1156
|
+
|
|
1157
|
+
|
|
1158
|
+
|
|
1159
|
+
<dl>
|
|
1160
|
+
<dt>
|
|
1161
|
+
<div class="param-desc usertext">
|
|
1162
|
+
- If the request fails.
|
|
1163
|
+
</div>
|
|
1164
|
+
</dt>
|
|
1165
|
+
<dd></dd>
|
|
1166
|
+
<dt>
|
|
1167
|
+
<dl class="param-type">
|
|
1168
|
+
<dt>
|
|
1169
|
+
Type
|
|
1170
|
+
</dt>
|
|
1171
|
+
<dd>
|
|
947
1172
|
|
|
1173
|
+
<span class="param-type">HttpError</span>
|
|
1174
|
+
|
|
1175
|
+
|
|
1176
|
+
|
|
1177
|
+
</dd>
|
|
1178
|
+
</dl>
|
|
1179
|
+
</dt>
|
|
1180
|
+
<dd></dd>
|
|
1181
|
+
</dl>
|
|
1182
|
+
|
|
1183
|
+
|
|
1184
|
+
|
|
1185
|
+
|
|
1186
|
+
|
|
1187
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
1188
|
+
|
|
1189
|
+
|
|
1190
|
+
<div class="param-desc">
|
|
1191
|
+
- A promise that resolves to the list of forum threads.
|
|
1192
|
+
</div>
|
|
1193
|
+
|
|
1194
|
+
|
|
1195
|
+
|
|
1196
|
+
<dl class="param-type">
|
|
1197
|
+
<dt>
|
|
1198
|
+
Type
|
|
1199
|
+
</dt>
|
|
1200
|
+
<dd>
|
|
1201
|
+
|
|
1202
|
+
<span class="param-type">Promise.<<a href="global.html#PaginatedResponse">PaginatedResponse</a>.<ForumThread>></span>
|
|
1203
|
+
|
|
1204
|
+
|
|
1205
|
+
|
|
1206
|
+
</dd>
|
|
1207
|
+
</dl>
|
|
1208
|
+
|
|
1209
|
+
|
|
1210
|
+
|
|
1211
|
+
|
|
1212
|
+
|
|
1213
|
+
|
|
1214
|
+
|
|
1215
|
+
|
|
1216
|
+
|
|
1217
|
+
|
|
1218
|
+
<h4 class="name" id="~fetchPosts"><span class="type-signature type-signature-async, inner">(async, inner) </span>fetchPosts<span class="signature">(threadId, brand, params<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<<a href="global.html#PaginatedResponse">PaginatedResponse</a>.<ForumPost>>}</span></h4>
|
|
1219
|
+
|
|
1220
|
+
|
|
1221
|
+
|
|
1222
|
+
|
|
1223
|
+
|
|
1224
|
+
|
|
1225
|
+
<dl class="details">
|
|
1226
|
+
|
|
1227
|
+
<dt class="tag-description">Description:</dt>
|
|
1228
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetches posts for the given thread.</li></ul></dd>
|
|
1229
|
+
|
|
1230
|
+
|
|
1231
|
+
|
|
1232
|
+
<dt class="tag-source">Source:</dt>
|
|
1233
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
1234
|
+
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line37">line 37</a>
|
|
1235
|
+
</li></ul></dd>
|
|
1236
|
+
|
|
1237
|
+
|
|
1238
|
+
|
|
1239
|
+
|
|
1240
|
+
|
|
1241
|
+
|
|
1242
|
+
|
|
1243
|
+
|
|
1244
|
+
|
|
1245
|
+
|
|
1246
|
+
|
|
1247
|
+
|
|
1248
|
+
|
|
1249
|
+
|
|
1250
|
+
|
|
1251
|
+
|
|
1252
|
+
|
|
1253
|
+
|
|
1254
|
+
|
|
1255
|
+
|
|
1256
|
+
|
|
1257
|
+
|
|
1258
|
+
|
|
1259
|
+
|
|
1260
|
+
|
|
1261
|
+
|
|
1262
|
+
|
|
1263
|
+
|
|
1264
|
+
|
|
1265
|
+
|
|
1266
|
+
|
|
1267
|
+
</dl>
|
|
1268
|
+
|
|
1269
|
+
|
|
1270
|
+
|
|
1271
|
+
|
|
1272
|
+
|
|
1273
|
+
|
|
1274
|
+
|
|
1275
|
+
|
|
1276
|
+
|
|
1277
|
+
|
|
1278
|
+
|
|
1279
|
+
|
|
1280
|
+
|
|
1281
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
1282
|
+
|
|
1283
|
+
|
|
1284
|
+
<table class="params">
|
|
1285
|
+
<thead>
|
|
1286
|
+
<tr>
|
|
1287
|
+
|
|
1288
|
+
<th>Name</th>
|
|
1289
|
+
|
|
1290
|
+
|
|
1291
|
+
<th>Type</th>
|
|
1292
|
+
|
|
1293
|
+
|
|
1294
|
+
<th>Attributes</th>
|
|
1295
|
+
|
|
1296
|
+
|
|
1297
|
+
|
|
1298
|
+
|
|
1299
|
+
<th class="last">Description</th>
|
|
1300
|
+
</tr>
|
|
1301
|
+
</thead>
|
|
1302
|
+
|
|
1303
|
+
<tbody>
|
|
1304
|
+
|
|
1305
|
+
|
|
1306
|
+
<tr>
|
|
1307
|
+
|
|
1308
|
+
<td class="name"><code>threadId</code></td>
|
|
1309
|
+
|
|
1310
|
+
|
|
1311
|
+
<td class="type">
|
|
1312
|
+
|
|
1313
|
+
|
|
1314
|
+
<span class="param-type">number</span>
|
|
1315
|
+
|
|
1316
|
+
|
|
1317
|
+
|
|
1318
|
+
|
|
1319
|
+
</td>
|
|
1320
|
+
|
|
1321
|
+
|
|
1322
|
+
<td class="attributes">
|
|
1323
|
+
|
|
1324
|
+
|
|
1325
|
+
|
|
1326
|
+
|
|
1327
|
+
|
|
1328
|
+
</td>
|
|
1329
|
+
|
|
1330
|
+
|
|
1331
|
+
|
|
1332
|
+
|
|
1333
|
+
<td class="description last">The ID of the forum thread.</td>
|
|
1334
|
+
</tr>
|
|
1335
|
+
|
|
1336
|
+
|
|
1337
|
+
|
|
1338
|
+
<tr>
|
|
1339
|
+
|
|
1340
|
+
<td class="name"><code>brand</code></td>
|
|
1341
|
+
|
|
1342
|
+
|
|
1343
|
+
<td class="type">
|
|
1344
|
+
|
|
1345
|
+
|
|
1346
|
+
<span class="param-type">string</span>
|
|
1347
|
+
|
|
1348
|
+
|
|
1349
|
+
|
|
1350
|
+
|
|
1351
|
+
</td>
|
|
1352
|
+
|
|
1353
|
+
|
|
1354
|
+
<td class="attributes">
|
|
1355
|
+
|
|
1356
|
+
|
|
1357
|
+
|
|
1358
|
+
|
|
1359
|
+
|
|
1360
|
+
</td>
|
|
1361
|
+
|
|
1362
|
+
|
|
1363
|
+
|
|
1364
|
+
|
|
1365
|
+
<td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
|
|
1366
|
+
</tr>
|
|
1367
|
+
|
|
1368
|
+
|
|
1369
|
+
|
|
1370
|
+
<tr>
|
|
1371
|
+
|
|
1372
|
+
<td class="name"><code>params</code></td>
|
|
1373
|
+
|
|
1374
|
+
|
|
1375
|
+
<td class="type">
|
|
1376
|
+
|
|
1377
|
+
|
|
1378
|
+
<span class="param-type">FetchPostParams</span>
|
|
1379
|
+
|
|
1380
|
+
|
|
1381
|
+
|
|
1382
|
+
|
|
1383
|
+
</td>
|
|
1384
|
+
|
|
1385
|
+
|
|
1386
|
+
<td class="attributes">
|
|
1387
|
+
|
|
1388
|
+
<optional><br>
|
|
1389
|
+
|
|
1390
|
+
|
|
1391
|
+
|
|
1392
|
+
|
|
1393
|
+
|
|
1394
|
+
</td>
|
|
1395
|
+
|
|
1396
|
+
|
|
1397
|
+
|
|
1398
|
+
|
|
1399
|
+
<td class="description last">Optional parameters such as `page`, `limit`, and `sort`.</td>
|
|
1400
|
+
</tr>
|
|
1401
|
+
|
|
1402
|
+
|
|
1403
|
+
</tbody>
|
|
1404
|
+
</table>
|
|
1405
|
+
|
|
1406
|
+
|
|
1407
|
+
|
|
1408
|
+
|
|
1409
|
+
|
|
1410
|
+
|
|
1411
|
+
|
|
1412
|
+
|
|
1413
|
+
|
|
1414
|
+
|
|
1415
|
+
|
|
1416
|
+
|
|
1417
|
+
|
|
1418
|
+
|
|
1419
|
+
<h5 class="h5-throws">Throws:</h5>
|
|
1420
|
+
|
|
1421
|
+
|
|
1422
|
+
|
|
1423
|
+
<dl>
|
|
1424
|
+
<dt>
|
|
1425
|
+
<div class="param-desc usertext">
|
|
1426
|
+
- If the request fails.
|
|
1427
|
+
</div>
|
|
1428
|
+
</dt>
|
|
1429
|
+
<dd></dd>
|
|
1430
|
+
<dt>
|
|
1431
|
+
<dl class="param-type">
|
|
1432
|
+
<dt>
|
|
1433
|
+
Type
|
|
1434
|
+
</dt>
|
|
1435
|
+
<dd>
|
|
1436
|
+
|
|
1437
|
+
<span class="param-type">HttpError</span>
|
|
1438
|
+
|
|
1439
|
+
|
|
1440
|
+
|
|
1441
|
+
</dd>
|
|
1442
|
+
</dl>
|
|
1443
|
+
</dt>
|
|
1444
|
+
<dd></dd>
|
|
1445
|
+
</dl>
|
|
1446
|
+
|
|
1447
|
+
|
|
1448
|
+
|
|
1449
|
+
|
|
1450
|
+
|
|
1451
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
1452
|
+
|
|
1453
|
+
|
|
1454
|
+
<div class="param-desc">
|
|
1455
|
+
- Resolves to a paginated list of forum posts.
|
|
1456
|
+
</div>
|
|
1457
|
+
|
|
1458
|
+
|
|
1459
|
+
|
|
1460
|
+
<dl class="param-type">
|
|
1461
|
+
<dt>
|
|
1462
|
+
Type
|
|
1463
|
+
</dt>
|
|
1464
|
+
<dd>
|
|
1465
|
+
|
|
1466
|
+
<span class="param-type">Promise.<<a href="global.html#PaginatedResponse">PaginatedResponse</a>.<ForumPost>></span>
|
|
1467
|
+
|
|
1468
|
+
|
|
1469
|
+
|
|
1470
|
+
</dd>
|
|
1471
|
+
</dl>
|
|
1472
|
+
|
|
1473
|
+
|
|
1474
|
+
|
|
1475
|
+
|
|
1476
|
+
|
|
1477
|
+
|
|
1478
|
+
|
|
1479
|
+
|
|
1480
|
+
|
|
1481
|
+
|
|
1482
|
+
<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"> → {Promise.<<a href="global.html#PaginatedResponse">PaginatedResponse</a>.<ForumThread>>}</span></h4>
|
|
1483
|
+
|
|
1484
|
+
|
|
1485
|
+
|
|
1486
|
+
|
|
1487
|
+
|
|
1488
|
+
|
|
1489
|
+
<dl class="details">
|
|
1490
|
+
|
|
1491
|
+
<dt class="tag-description">Description:</dt>
|
|
1492
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetches forum threads for the given category.</li></ul></dd>
|
|
1493
|
+
|
|
1494
|
+
|
|
1495
|
+
|
|
1496
|
+
<dt class="tag-source">Source:</dt>
|
|
1497
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
1498
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line84">line 84</a>
|
|
1499
|
+
</li></ul></dd>
|
|
1500
|
+
|
|
1501
|
+
|
|
1502
|
+
|
|
1503
|
+
|
|
1504
|
+
|
|
1505
|
+
|
|
1506
|
+
|
|
1507
|
+
|
|
1508
|
+
|
|
1509
|
+
|
|
1510
|
+
|
|
1511
|
+
|
|
1512
|
+
|
|
1513
|
+
|
|
1514
|
+
|
|
1515
|
+
|
|
1516
|
+
|
|
1517
|
+
|
|
1518
|
+
|
|
1519
|
+
|
|
1520
|
+
|
|
1521
|
+
|
|
1522
|
+
|
|
1523
|
+
|
|
1524
|
+
|
|
1525
|
+
|
|
1526
|
+
|
|
1527
|
+
|
|
1528
|
+
|
|
1529
|
+
|
|
1530
|
+
|
|
1531
|
+
</dl>
|
|
1532
|
+
|
|
1533
|
+
|
|
1534
|
+
|
|
1535
|
+
|
|
1536
|
+
|
|
1537
|
+
|
|
1538
|
+
|
|
1539
|
+
|
|
1540
|
+
|
|
1541
|
+
|
|
1542
|
+
|
|
1543
|
+
|
|
1544
|
+
|
|
1545
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
1546
|
+
|
|
1547
|
+
|
|
1548
|
+
<table class="params">
|
|
1549
|
+
<thead>
|
|
1550
|
+
<tr>
|
|
1551
|
+
|
|
1552
|
+
<th>Name</th>
|
|
1553
|
+
|
|
1554
|
+
|
|
1555
|
+
<th>Type</th>
|
|
1556
|
+
|
|
1557
|
+
|
|
1558
|
+
|
|
1559
|
+
|
|
1560
|
+
|
|
1561
|
+
<th class="last">Description</th>
|
|
1562
|
+
</tr>
|
|
1563
|
+
</thead>
|
|
1564
|
+
|
|
1565
|
+
<tbody>
|
|
1566
|
+
|
|
1567
|
+
|
|
1568
|
+
<tr>
|
|
1569
|
+
|
|
1570
|
+
<td class="name"><code>categoryId</code></td>
|
|
1571
|
+
|
|
1572
|
+
|
|
1573
|
+
<td class="type">
|
|
1574
|
+
|
|
1575
|
+
|
|
1576
|
+
<span class="param-type">number</span>
|
|
1577
|
+
|
|
1578
|
+
|
|
1579
|
+
|
|
1580
|
+
|
|
1581
|
+
</td>
|
|
1582
|
+
|
|
1583
|
+
|
|
1584
|
+
|
|
1585
|
+
|
|
1586
|
+
|
|
1587
|
+
<td class="description last">The ID of the forum category.</td>
|
|
1588
|
+
</tr>
|
|
1589
|
+
|
|
1590
|
+
|
|
1591
|
+
|
|
1592
|
+
<tr>
|
|
1593
|
+
|
|
1594
|
+
<td class="name"><code>brand</code></td>
|
|
1595
|
+
|
|
1596
|
+
|
|
1597
|
+
<td class="type">
|
|
1598
|
+
|
|
1599
|
+
|
|
1600
|
+
<span class="param-type">string</span>
|
|
1601
|
+
|
|
1602
|
+
|
|
1603
|
+
|
|
1604
|
+
|
|
1605
|
+
</td>
|
|
1606
|
+
|
|
1607
|
+
|
|
1608
|
+
|
|
1609
|
+
|
|
1610
|
+
|
|
1611
|
+
<td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
|
|
1612
|
+
</tr>
|
|
1613
|
+
|
|
1614
|
+
|
|
1615
|
+
|
|
1616
|
+
<tr>
|
|
1617
|
+
|
|
1618
|
+
<td class="name"><code>params</code></td>
|
|
1619
|
+
|
|
1620
|
+
|
|
1621
|
+
<td class="type">
|
|
1622
|
+
|
|
1623
|
+
|
|
1624
|
+
<span class="param-type">FetchThreadParams</span>
|
|
1625
|
+
|
|
1626
|
+
|
|
1627
|
+
|
|
1628
|
+
|
|
1629
|
+
</td>
|
|
1630
|
+
|
|
1631
|
+
|
|
1632
|
+
|
|
1633
|
+
|
|
1634
|
+
|
|
1635
|
+
<td class="description last">Optional additional parameters (e.g., is_followed, sort("last_post_published_on","-last_post_published_on","mine")).</td>
|
|
1636
|
+
</tr>
|
|
1637
|
+
|
|
1638
|
+
|
|
1639
|
+
</tbody>
|
|
1640
|
+
</table>
|
|
1641
|
+
|
|
1642
|
+
|
|
1643
|
+
|
|
1644
|
+
|
|
1645
|
+
|
|
1646
|
+
|
|
1647
|
+
|
|
1648
|
+
|
|
1649
|
+
|
|
1650
|
+
|
|
1651
|
+
|
|
1652
|
+
|
|
1653
|
+
|
|
1654
|
+
|
|
1655
|
+
<h5 class="h5-throws">Throws:</h5>
|
|
1656
|
+
|
|
1657
|
+
|
|
1658
|
+
|
|
1659
|
+
<dl>
|
|
1660
|
+
<dt>
|
|
1661
|
+
<div class="param-desc usertext">
|
|
1662
|
+
- If the HTTP request fails.
|
|
1663
|
+
</div>
|
|
1664
|
+
</dt>
|
|
1665
|
+
<dd></dd>
|
|
1666
|
+
<dt>
|
|
1667
|
+
<dl class="param-type">
|
|
1668
|
+
<dt>
|
|
1669
|
+
Type
|
|
1670
|
+
</dt>
|
|
1671
|
+
<dd>
|
|
1672
|
+
|
|
1673
|
+
<span class="param-type">HttpError</span>
|
|
1674
|
+
|
|
1675
|
+
|
|
1676
|
+
|
|
1677
|
+
</dd>
|
|
1678
|
+
</dl>
|
|
1679
|
+
</dt>
|
|
1680
|
+
<dd></dd>
|
|
1681
|
+
</dl>
|
|
1682
|
+
|
|
1683
|
+
|
|
1684
|
+
|
|
1685
|
+
|
|
1686
|
+
|
|
1687
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
1688
|
+
|
|
1689
|
+
|
|
1690
|
+
<div class="param-desc">
|
|
1691
|
+
- A promise that resolves to a paginated list of forum threads.
|
|
1692
|
+
</div>
|
|
1693
|
+
|
|
1694
|
+
|
|
1695
|
+
|
|
1696
|
+
<dl class="param-type">
|
|
1697
|
+
<dt>
|
|
1698
|
+
Type
|
|
1699
|
+
</dt>
|
|
1700
|
+
<dd>
|
|
1701
|
+
|
|
1702
|
+
<span class="param-type">Promise.<<a href="global.html#PaginatedResponse">PaginatedResponse</a>.<ForumThread>></span>
|
|
1703
|
+
|
|
1704
|
+
|
|
1705
|
+
|
|
1706
|
+
</dd>
|
|
1707
|
+
</dl>
|
|
1708
|
+
|
|
1709
|
+
|
|
1710
|
+
|
|
1711
|
+
|
|
1712
|
+
|
|
1713
|
+
|
|
1714
|
+
|
|
1715
|
+
|
|
1716
|
+
|
|
1717
|
+
|
|
1718
|
+
<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"> → {Promise.<void>}</span></h4>
|
|
1719
|
+
|
|
1720
|
+
|
|
1721
|
+
|
|
1722
|
+
|
|
1723
|
+
|
|
1724
|
+
|
|
1725
|
+
<dl class="details">
|
|
1726
|
+
|
|
1727
|
+
<dt class="tag-description">Description:</dt>
|
|
1728
|
+
<dd class="tag-description"><ul class="dummy"><li>Follow a thread.</li></ul></dd>
|
|
1729
|
+
|
|
1730
|
+
|
|
1731
|
+
|
|
1732
|
+
<dt class="tag-source">Source:</dt>
|
|
1733
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
1734
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line52">line 52</a>
|
|
1735
|
+
</li></ul></dd>
|
|
1736
|
+
|
|
1737
|
+
|
|
1738
|
+
|
|
1739
|
+
|
|
1740
|
+
|
|
1741
|
+
|
|
1742
|
+
|
|
1743
|
+
|
|
1744
|
+
|
|
1745
|
+
|
|
1746
|
+
|
|
1747
|
+
|
|
1748
|
+
|
|
1749
|
+
|
|
1750
|
+
|
|
1751
|
+
|
|
1752
|
+
|
|
1753
|
+
|
|
1754
|
+
|
|
1755
|
+
|
|
1756
|
+
|
|
1757
|
+
|
|
1758
|
+
|
|
1759
|
+
|
|
1760
|
+
|
|
1761
|
+
|
|
1762
|
+
|
|
1763
|
+
|
|
1764
|
+
|
|
1765
|
+
|
|
1766
|
+
|
|
1767
|
+
</dl>
|
|
1768
|
+
|
|
1769
|
+
|
|
1770
|
+
|
|
1771
|
+
|
|
1772
|
+
|
|
1773
|
+
|
|
1774
|
+
|
|
1775
|
+
|
|
1776
|
+
|
|
1777
|
+
|
|
1778
|
+
|
|
1779
|
+
|
|
1780
|
+
|
|
1781
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
1782
|
+
|
|
1783
|
+
|
|
1784
|
+
<table class="params">
|
|
1785
|
+
<thead>
|
|
1786
|
+
<tr>
|
|
1787
|
+
|
|
1788
|
+
<th>Name</th>
|
|
1789
|
+
|
|
1790
|
+
|
|
1791
|
+
<th>Type</th>
|
|
1792
|
+
|
|
1793
|
+
|
|
1794
|
+
|
|
1795
|
+
|
|
1796
|
+
|
|
1797
|
+
<th class="last">Description</th>
|
|
1798
|
+
</tr>
|
|
1799
|
+
</thead>
|
|
1800
|
+
|
|
1801
|
+
<tbody>
|
|
1802
|
+
|
|
1803
|
+
|
|
1804
|
+
<tr>
|
|
1805
|
+
|
|
1806
|
+
<td class="name"><code>threadId</code></td>
|
|
1807
|
+
|
|
1808
|
+
|
|
1809
|
+
<td class="type">
|
|
1810
|
+
|
|
1811
|
+
|
|
1812
|
+
<span class="param-type">number</span>
|
|
1813
|
+
|
|
1814
|
+
|
|
1815
|
+
|
|
1816
|
+
|
|
1817
|
+
</td>
|
|
1818
|
+
|
|
1819
|
+
|
|
1820
|
+
|
|
1821
|
+
|
|
1822
|
+
|
|
1823
|
+
<td class="description last">The ID of the thread to lock.</td>
|
|
1824
|
+
</tr>
|
|
1825
|
+
|
|
1826
|
+
|
|
1827
|
+
|
|
1828
|
+
<tr>
|
|
1829
|
+
|
|
1830
|
+
<td class="name"><code>brand</code></td>
|
|
1831
|
+
|
|
1832
|
+
|
|
1833
|
+
<td class="type">
|
|
1834
|
+
|
|
1835
|
+
|
|
1836
|
+
<span class="param-type">string</span>
|
|
1837
|
+
|
|
1838
|
+
|
|
1839
|
+
|
|
1840
|
+
|
|
1841
|
+
</td>
|
|
1842
|
+
|
|
1843
|
+
|
|
1844
|
+
|
|
1845
|
+
|
|
1846
|
+
|
|
1847
|
+
<td class="description last">The brand associated with the follow action.</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 when the thread is locked.
|
|
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.<void></span>
|
|
1915
|
+
|
|
1916
|
+
|
|
1917
|
+
|
|
1918
|
+
</dd>
|
|
1919
|
+
</dl>
|
|
1920
|
+
|
|
1921
|
+
|
|
1922
|
+
|
|
1923
|
+
|
|
1924
|
+
|
|
1925
|
+
|
|
1926
|
+
|
|
1927
|
+
|
|
1928
|
+
|
|
1929
|
+
|
|
1930
|
+
<h4 class="name" id="~lockThread"><span class="type-signature type-signature-async, inner">(async, inner) </span>lockThread<span class="signature">(threadId, brand)</span><span class="type-signature"> → {Promise.<void>}</span></h4>
|
|
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>Locks a thread to prevent further posts.</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_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line134">line 134</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>threadId</code></td>
|
|
2019
|
+
|
|
2020
|
+
|
|
2021
|
+
<td class="type">
|
|
2022
|
+
|
|
2023
|
+
|
|
2024
|
+
<span class="param-type">number</span>
|
|
2025
|
+
|
|
2026
|
+
|
|
2027
|
+
|
|
2028
|
+
|
|
2029
|
+
</td>
|
|
2030
|
+
|
|
2031
|
+
|
|
2032
|
+
|
|
2033
|
+
|
|
2034
|
+
|
|
2035
|
+
<td class="description last">The ID of the thread to lock.</td>
|
|
2036
|
+
</tr>
|
|
2037
|
+
|
|
2038
|
+
|
|
2039
|
+
|
|
2040
|
+
<tr>
|
|
2041
|
+
|
|
2042
|
+
<td class="name"><code>brand</code></td>
|
|
2043
|
+
|
|
2044
|
+
|
|
2045
|
+
<td class="type">
|
|
2046
|
+
|
|
2047
|
+
|
|
2048
|
+
<span class="param-type">string</span>
|
|
2049
|
+
|
|
2050
|
+
|
|
2051
|
+
|
|
2052
|
+
|
|
2053
|
+
</td>
|
|
2054
|
+
|
|
2055
|
+
|
|
2056
|
+
|
|
2057
|
+
|
|
2058
|
+
|
|
2059
|
+
<td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
|
|
2060
|
+
</tr>
|
|
2061
|
+
|
|
2062
|
+
|
|
2063
|
+
</tbody>
|
|
2064
|
+
</table>
|
|
2065
|
+
|
|
2066
|
+
|
|
2067
|
+
|
|
2068
|
+
|
|
2069
|
+
|
|
2070
|
+
|
|
2071
|
+
|
|
2072
|
+
|
|
2073
|
+
|
|
2074
|
+
|
|
2075
|
+
|
|
2076
|
+
|
|
2077
|
+
|
|
2078
|
+
|
|
2079
|
+
<h5 class="h5-throws">Throws:</h5>
|
|
2080
|
+
|
|
2081
|
+
|
|
2082
|
+
|
|
2083
|
+
<dl>
|
|
2084
|
+
<dt>
|
|
2085
|
+
<div class="param-desc usertext">
|
|
2086
|
+
- If the request fails.
|
|
2087
|
+
</div>
|
|
2088
|
+
</dt>
|
|
2089
|
+
<dd></dd>
|
|
2090
|
+
<dt>
|
|
2091
|
+
<dl class="param-type">
|
|
2092
|
+
<dt>
|
|
2093
|
+
Type
|
|
2094
|
+
</dt>
|
|
2095
|
+
<dd>
|
|
2096
|
+
|
|
2097
|
+
<span class="param-type">HttpError</span>
|
|
2098
|
+
|
|
2099
|
+
|
|
2100
|
+
|
|
2101
|
+
</dd>
|
|
2102
|
+
</dl>
|
|
2103
|
+
</dt>
|
|
2104
|
+
<dd></dd>
|
|
2105
|
+
</dl>
|
|
2106
|
+
|
|
2107
|
+
|
|
2108
|
+
|
|
2109
|
+
|
|
2110
|
+
|
|
2111
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
2112
|
+
|
|
2113
|
+
|
|
2114
|
+
<div class="param-desc">
|
|
2115
|
+
- A promise that resolves when the thread is locked.
|
|
2116
|
+
</div>
|
|
2117
|
+
|
|
2118
|
+
|
|
2119
|
+
|
|
2120
|
+
<dl class="param-type">
|
|
2121
|
+
<dt>
|
|
2122
|
+
Type
|
|
2123
|
+
</dt>
|
|
2124
|
+
<dd>
|
|
2125
|
+
|
|
2126
|
+
<span class="param-type">Promise.<void></span>
|
|
2127
|
+
|
|
2128
|
+
|
|
2129
|
+
|
|
2130
|
+
</dd>
|
|
2131
|
+
</dl>
|
|
2132
|
+
|
|
2133
|
+
|
|
2134
|
+
|
|
2135
|
+
|
|
2136
|
+
|
|
2137
|
+
|
|
2138
|
+
|
|
2139
|
+
|
|
2140
|
+
|
|
2141
|
+
|
|
2142
|
+
<h4 class="name" id="~pinThread"><span class="type-signature type-signature-async, inner">(async, inner) </span>pinThread<span class="signature">(threadId, brand)</span><span class="type-signature"> → {Promise.<void>}</span></h4>
|
|
2143
|
+
|
|
2144
|
+
|
|
2145
|
+
|
|
2146
|
+
|
|
2147
|
+
|
|
2148
|
+
|
|
2149
|
+
<dl class="details">
|
|
2150
|
+
|
|
2151
|
+
<dt class="tag-description">Description:</dt>
|
|
2152
|
+
<dd class="tag-description"><ul class="dummy"><li>Pins a thread to the top of its category.</li></ul></dd>
|
|
2153
|
+
|
|
2154
|
+
|
|
2155
|
+
|
|
2156
|
+
<dt class="tag-source">Source:</dt>
|
|
2157
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
2158
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line108">line 108</a>
|
|
2159
|
+
</li></ul></dd>
|
|
2160
|
+
|
|
2161
|
+
|
|
2162
|
+
|
|
2163
|
+
|
|
2164
|
+
|
|
2165
|
+
|
|
2166
|
+
|
|
2167
|
+
|
|
2168
|
+
|
|
2169
|
+
|
|
2170
|
+
|
|
2171
|
+
|
|
2172
|
+
|
|
2173
|
+
|
|
2174
|
+
|
|
2175
|
+
|
|
2176
|
+
|
|
2177
|
+
|
|
2178
|
+
|
|
2179
|
+
|
|
2180
|
+
|
|
2181
|
+
|
|
2182
|
+
|
|
2183
|
+
|
|
2184
|
+
|
|
2185
|
+
|
|
2186
|
+
|
|
2187
|
+
|
|
2188
|
+
|
|
2189
|
+
|
|
2190
|
+
|
|
2191
|
+
</dl>
|
|
2192
|
+
|
|
2193
|
+
|
|
2194
|
+
|
|
2195
|
+
|
|
2196
|
+
|
|
2197
|
+
|
|
2198
|
+
|
|
2199
|
+
|
|
2200
|
+
|
|
2201
|
+
|
|
2202
|
+
|
|
2203
|
+
|
|
2204
|
+
|
|
2205
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
2206
|
+
|
|
2207
|
+
|
|
2208
|
+
<table class="params">
|
|
2209
|
+
<thead>
|
|
2210
|
+
<tr>
|
|
2211
|
+
|
|
2212
|
+
<th>Name</th>
|
|
2213
|
+
|
|
948
2214
|
|
|
949
|
-
|
|
2215
|
+
<th>Type</th>
|
|
950
2216
|
|
|
951
|
-
|
|
952
|
-
</td>
|
|
953
|
-
|
|
2217
|
+
|
|
954
2218
|
|
|
955
|
-
|
|
2219
|
+
|
|
956
2220
|
|
|
957
|
-
|
|
958
|
-
|
|
2221
|
+
<th class="last">Description</th>
|
|
2222
|
+
</tr>
|
|
2223
|
+
</thead>
|
|
959
2224
|
|
|
2225
|
+
<tbody>
|
|
960
2226
|
|
|
961
2227
|
|
|
962
2228
|
<tr>
|
|
963
2229
|
|
|
964
|
-
<td class="name"><code>
|
|
2230
|
+
<td class="name"><code>threadId</code></td>
|
|
965
2231
|
|
|
966
2232
|
|
|
967
2233
|
<td class="type">
|
|
968
2234
|
|
|
969
2235
|
|
|
970
|
-
<span class="param-type">
|
|
2236
|
+
<span class="param-type">number</span>
|
|
971
2237
|
|
|
972
2238
|
|
|
973
2239
|
|
|
@@ -975,31 +2241,23 @@
|
|
|
975
2241
|
</td>
|
|
976
2242
|
|
|
977
2243
|
|
|
978
|
-
<td class="attributes">
|
|
979
|
-
|
|
980
|
-
|
|
981
|
-
|
|
982
|
-
|
|
983
|
-
|
|
984
|
-
</td>
|
|
985
|
-
|
|
986
2244
|
|
|
987
2245
|
|
|
988
2246
|
|
|
989
|
-
<td class="description last">The
|
|
2247
|
+
<td class="description last">The ID of the thread to pin.</td>
|
|
990
2248
|
</tr>
|
|
991
2249
|
|
|
992
2250
|
|
|
993
2251
|
|
|
994
2252
|
<tr>
|
|
995
2253
|
|
|
996
|
-
<td class="name"><code>
|
|
2254
|
+
<td class="name"><code>brand</code></td>
|
|
997
2255
|
|
|
998
2256
|
|
|
999
2257
|
<td class="type">
|
|
1000
2258
|
|
|
1001
2259
|
|
|
1002
|
-
<span class="param-type">
|
|
2260
|
+
<span class="param-type">string</span>
|
|
1003
2261
|
|
|
1004
2262
|
|
|
1005
2263
|
|
|
@@ -1007,20 +2265,10 @@
|
|
|
1007
2265
|
</td>
|
|
1008
2266
|
|
|
1009
2267
|
|
|
1010
|
-
<td class="attributes">
|
|
1011
|
-
|
|
1012
|
-
<optional><br>
|
|
1013
|
-
|
|
1014
|
-
|
|
1015
|
-
|
|
1016
|
-
|
|
1017
|
-
|
|
1018
|
-
</td>
|
|
1019
|
-
|
|
1020
2268
|
|
|
1021
2269
|
|
|
1022
2270
|
|
|
1023
|
-
<td class="description last">
|
|
2271
|
+
<td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
|
|
1024
2272
|
</tr>
|
|
1025
2273
|
|
|
1026
2274
|
|
|
@@ -1076,7 +2324,7 @@
|
|
|
1076
2324
|
|
|
1077
2325
|
|
|
1078
2326
|
<div class="param-desc">
|
|
1079
|
-
-
|
|
2327
|
+
- A promise that resolves when the thread is pinned.
|
|
1080
2328
|
</div>
|
|
1081
2329
|
|
|
1082
2330
|
|
|
@@ -1087,7 +2335,7 @@
|
|
|
1087
2335
|
</dt>
|
|
1088
2336
|
<dd>
|
|
1089
2337
|
|
|
1090
|
-
<span class="param-type">Promise.<
|
|
2338
|
+
<span class="param-type">Promise.<void></span>
|
|
1091
2339
|
|
|
1092
2340
|
|
|
1093
2341
|
|
|
@@ -1103,7 +2351,7 @@
|
|
|
1103
2351
|
|
|
1104
2352
|
|
|
1105
2353
|
|
|
1106
|
-
<h4 class="name" id="~
|
|
2354
|
+
<h4 class="name" id="~unfollowThread"><span class="type-signature type-signature-async, inner">(async, inner) </span>unfollowThread<span class="signature">(threadId, brand)</span><span class="type-signature"> → {Promise.<void>}</span></h4>
|
|
1107
2355
|
|
|
1108
2356
|
|
|
1109
2357
|
|
|
@@ -1113,13 +2361,13 @@
|
|
|
1113
2361
|
<dl class="details">
|
|
1114
2362
|
|
|
1115
2363
|
<dt class="tag-description">Description:</dt>
|
|
1116
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
2364
|
+
<dd class="tag-description"><ul class="dummy"><li>Unlock a thread to allow further posts.</li></ul></dd>
|
|
1117
2365
|
|
|
1118
2366
|
|
|
1119
2367
|
|
|
1120
2368
|
<dt class="tag-source">Source:</dt>
|
|
1121
2369
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
1122
|
-
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#
|
|
2370
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line65">line 65</a>
|
|
1123
2371
|
</li></ul></dd>
|
|
1124
2372
|
|
|
1125
2373
|
|
|
@@ -1191,7 +2439,7 @@
|
|
|
1191
2439
|
|
|
1192
2440
|
<tr>
|
|
1193
2441
|
|
|
1194
|
-
<td class="name"><code>
|
|
2442
|
+
<td class="name"><code>threadId</code></td>
|
|
1195
2443
|
|
|
1196
2444
|
|
|
1197
2445
|
<td class="type">
|
|
@@ -1208,7 +2456,7 @@
|
|
|
1208
2456
|
|
|
1209
2457
|
|
|
1210
2458
|
|
|
1211
|
-
<td class="description last">The ID of the
|
|
2459
|
+
<td class="description last">The ID of the thread to unlock.</td>
|
|
1212
2460
|
</tr>
|
|
1213
2461
|
|
|
1214
2462
|
|
|
@@ -1232,31 +2480,7 @@
|
|
|
1232
2480
|
|
|
1233
2481
|
|
|
1234
2482
|
|
|
1235
|
-
<td class="description last">The brand
|
|
1236
|
-
</tr>
|
|
1237
|
-
|
|
1238
|
-
|
|
1239
|
-
|
|
1240
|
-
<tr>
|
|
1241
|
-
|
|
1242
|
-
<td class="name"><code>params</code></td>
|
|
1243
|
-
|
|
1244
|
-
|
|
1245
|
-
<td class="type">
|
|
1246
|
-
|
|
1247
|
-
|
|
1248
|
-
<span class="param-type">FetchThreadParams</span>
|
|
1249
|
-
|
|
1250
|
-
|
|
1251
|
-
|
|
1252
|
-
|
|
1253
|
-
</td>
|
|
1254
|
-
|
|
1255
|
-
|
|
1256
|
-
|
|
1257
|
-
|
|
1258
|
-
|
|
1259
|
-
<td class="description last">Optional additional parameters (e.g., is_followed, sort("last_post_published_on","-last_post_published_on","mine")).</td>
|
|
2483
|
+
<td class="description last">The brand associated with the unlock action.</td>
|
|
1260
2484
|
</tr>
|
|
1261
2485
|
|
|
1262
2486
|
|
|
@@ -1283,7 +2507,7 @@
|
|
|
1283
2507
|
<dl>
|
|
1284
2508
|
<dt>
|
|
1285
2509
|
<div class="param-desc usertext">
|
|
1286
|
-
- If the
|
|
2510
|
+
- If the request fails.
|
|
1287
2511
|
</div>
|
|
1288
2512
|
</dt>
|
|
1289
2513
|
<dd></dd>
|
|
@@ -1312,7 +2536,7 @@
|
|
|
1312
2536
|
|
|
1313
2537
|
|
|
1314
2538
|
<div class="param-desc">
|
|
1315
|
-
- A promise that resolves
|
|
2539
|
+
- A promise that resolves when the thread is unlocked.
|
|
1316
2540
|
</div>
|
|
1317
2541
|
|
|
1318
2542
|
|
|
@@ -1323,7 +2547,7 @@
|
|
|
1323
2547
|
</dt>
|
|
1324
2548
|
<dd>
|
|
1325
2549
|
|
|
1326
|
-
<span class="param-type">Promise.<
|
|
2550
|
+
<span class="param-type">Promise.<void></span>
|
|
1327
2551
|
|
|
1328
2552
|
|
|
1329
2553
|
|
|
@@ -1339,7 +2563,7 @@
|
|
|
1339
2563
|
|
|
1340
2564
|
|
|
1341
2565
|
|
|
1342
|
-
<h4 class="name" id="~
|
|
2566
|
+
<h4 class="name" id="~unlockThread"><span class="type-signature type-signature-async, inner">(async, inner) </span>unlockThread<span class="signature">(threadId, brand)</span><span class="type-signature"> → {Promise.<void>}</span></h4>
|
|
1343
2567
|
|
|
1344
2568
|
|
|
1345
2569
|
|
|
@@ -1349,13 +2573,13 @@
|
|
|
1349
2573
|
<dl class="details">
|
|
1350
2574
|
|
|
1351
2575
|
<dt class="tag-description">Description:</dt>
|
|
1352
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
2576
|
+
<dd class="tag-description"><ul class="dummy"><li>Unlock a thread to allow further posts.</li></ul></dd>
|
|
1353
2577
|
|
|
1354
2578
|
|
|
1355
2579
|
|
|
1356
2580
|
<dt class="tag-source">Source:</dt>
|
|
1357
2581
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
1358
|
-
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#
|
|
2582
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line147">line 147</a>
|
|
1359
2583
|
</li></ul></dd>
|
|
1360
2584
|
|
|
1361
2585
|
|
|
@@ -1444,7 +2668,7 @@
|
|
|
1444
2668
|
|
|
1445
2669
|
|
|
1446
2670
|
|
|
1447
|
-
<td class="description last">The ID of the thread to
|
|
2671
|
+
<td class="description last">The ID of the thread to unlock.</td>
|
|
1448
2672
|
</tr>
|
|
1449
2673
|
|
|
1450
2674
|
|
|
@@ -1468,7 +2692,7 @@
|
|
|
1468
2692
|
|
|
1469
2693
|
|
|
1470
2694
|
|
|
1471
|
-
<td class="description last">The brand
|
|
2695
|
+
<td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
|
|
1472
2696
|
</tr>
|
|
1473
2697
|
|
|
1474
2698
|
|
|
@@ -1524,7 +2748,7 @@
|
|
|
1524
2748
|
|
|
1525
2749
|
|
|
1526
2750
|
<div class="param-desc">
|
|
1527
|
-
- A promise that resolves when the thread is
|
|
2751
|
+
- A promise that resolves when the thread is unlocked.
|
|
1528
2752
|
</div>
|
|
1529
2753
|
|
|
1530
2754
|
|
|
@@ -1551,7 +2775,7 @@
|
|
|
1551
2775
|
|
|
1552
2776
|
|
|
1553
2777
|
|
|
1554
|
-
<h4 class="name" id="~
|
|
2778
|
+
<h4 class="name" id="~unpinThread"><span class="type-signature type-signature-async, inner">(async, inner) </span>unpinThread<span class="signature">(threadId, brand)</span><span class="type-signature"> → {Promise.<void>}</span></h4>
|
|
1555
2779
|
|
|
1556
2780
|
|
|
1557
2781
|
|
|
@@ -1561,13 +2785,13 @@
|
|
|
1561
2785
|
<dl class="details">
|
|
1562
2786
|
|
|
1563
2787
|
<dt class="tag-description">Description:</dt>
|
|
1564
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
2788
|
+
<dd class="tag-description"><ul class="dummy"><li>Unpins a thread from the top of its category.</li></ul></dd>
|
|
1565
2789
|
|
|
1566
2790
|
|
|
1567
2791
|
|
|
1568
2792
|
<dt class="tag-source">Source:</dt>
|
|
1569
2793
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
1570
|
-
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#
|
|
2794
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line121">line 121</a>
|
|
1571
2795
|
</li></ul></dd>
|
|
1572
2796
|
|
|
1573
2797
|
|
|
@@ -1656,7 +2880,7 @@
|
|
|
1656
2880
|
|
|
1657
2881
|
|
|
1658
2882
|
|
|
1659
|
-
<td class="description last">The ID of the thread to
|
|
2883
|
+
<td class="description last">The ID of the thread to unpin.</td>
|
|
1660
2884
|
</tr>
|
|
1661
2885
|
|
|
1662
2886
|
|
|
@@ -1736,7 +2960,7 @@
|
|
|
1736
2960
|
|
|
1737
2961
|
|
|
1738
2962
|
<div class="param-desc">
|
|
1739
|
-
- A promise that resolves when the thread is
|
|
2963
|
+
- A promise that resolves when the thread is unpinned.
|
|
1740
2964
|
</div>
|
|
1741
2965
|
|
|
1742
2966
|
|
|
@@ -1763,7 +2987,7 @@
|
|
|
1763
2987
|
|
|
1764
2988
|
|
|
1765
2989
|
|
|
1766
|
-
<h4 class="name" id="~
|
|
2990
|
+
<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"> → {Promise.<ForumCategory>}</span></h4>
|
|
1767
2991
|
|
|
1768
2992
|
|
|
1769
2993
|
|
|
@@ -1773,13 +2997,13 @@
|
|
|
1773
2997
|
<dl class="details">
|
|
1774
2998
|
|
|
1775
2999
|
<dt class="tag-description">Description:</dt>
|
|
1776
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
3000
|
+
<dd class="tag-description"><ul class="dummy"><li>Creates a new forum category.</li></ul></dd>
|
|
1777
3001
|
|
|
1778
3002
|
|
|
1779
3003
|
|
|
1780
3004
|
<dt class="tag-source">Source:</dt>
|
|
1781
3005
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
1782
|
-
<a href="
|
|
3006
|
+
<a href="forums_categories.ts.html">forums/categories.ts</a>, <a href="forums_categories.ts.html#line53">line 53</a>
|
|
1783
3007
|
</li></ul></dd>
|
|
1784
3008
|
|
|
1785
3009
|
|
|
@@ -1851,37 +3075,13 @@
|
|
|
1851
3075
|
|
|
1852
3076
|
<tr>
|
|
1853
3077
|
|
|
1854
|
-
<td class="name"><code>
|
|
1855
|
-
|
|
1856
|
-
|
|
1857
|
-
<td class="type">
|
|
1858
|
-
|
|
1859
|
-
|
|
1860
|
-
<span class="param-type">number</span>
|
|
1861
|
-
|
|
1862
|
-
|
|
1863
|
-
|
|
1864
|
-
|
|
1865
|
-
</td>
|
|
1866
|
-
|
|
1867
|
-
|
|
1868
|
-
|
|
1869
|
-
|
|
1870
|
-
|
|
1871
|
-
<td class="description last">The ID of the thread to pin.</td>
|
|
1872
|
-
</tr>
|
|
1873
|
-
|
|
1874
|
-
|
|
1875
|
-
|
|
1876
|
-
<tr>
|
|
1877
|
-
|
|
1878
|
-
<td class="name"><code>brand</code></td>
|
|
3078
|
+
<td class="name"><code>params</code></td>
|
|
1879
3079
|
|
|
1880
3080
|
|
|
1881
3081
|
<td class="type">
|
|
1882
3082
|
|
|
1883
3083
|
|
|
1884
|
-
<span class="param-type">
|
|
3084
|
+
<span class="param-type">UpdateForumCategoryParams</span>
|
|
1885
3085
|
|
|
1886
3086
|
|
|
1887
3087
|
|
|
@@ -1892,7 +3092,7 @@
|
|
|
1892
3092
|
|
|
1893
3093
|
|
|
1894
3094
|
|
|
1895
|
-
<td class="description last">The
|
|
3095
|
+
<td class="description last">The parameters for creating the forum category.</td>
|
|
1896
3096
|
</tr>
|
|
1897
3097
|
|
|
1898
3098
|
|
|
@@ -1948,7 +3148,7 @@
|
|
|
1948
3148
|
|
|
1949
3149
|
|
|
1950
3150
|
<div class="param-desc">
|
|
1951
|
-
- A promise that resolves
|
|
3151
|
+
- A promise that resolves to the created forum category.
|
|
1952
3152
|
</div>
|
|
1953
3153
|
|
|
1954
3154
|
|
|
@@ -1959,7 +3159,7 @@
|
|
|
1959
3159
|
</dt>
|
|
1960
3160
|
<dd>
|
|
1961
3161
|
|
|
1962
|
-
<span class="param-type">Promise.<
|
|
3162
|
+
<span class="param-type">Promise.<ForumCategory></span>
|
|
1963
3163
|
|
|
1964
3164
|
|
|
1965
3165
|
|
|
@@ -1975,7 +3175,7 @@
|
|
|
1975
3175
|
|
|
1976
3176
|
|
|
1977
3177
|
|
|
1978
|
-
<h4 class="name" id="~
|
|
3178
|
+
<h4 class="name" id="~updateThread"><span class="type-signature type-signature-async, inner">(async, inner) </span>updateThread<span class="signature">(threadId, params)</span><span class="type-signature"> → {Promise.<ForumThread>}</span></h4>
|
|
1979
3179
|
|
|
1980
3180
|
|
|
1981
3181
|
|
|
@@ -1985,13 +3185,13 @@
|
|
|
1985
3185
|
<dl class="details">
|
|
1986
3186
|
|
|
1987
3187
|
<dt class="tag-description">Description:</dt>
|
|
1988
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
3188
|
+
<dd class="tag-description"><ul class="dummy"><li>Updates an existing thread under a forum category.</li></ul></dd>
|
|
1989
3189
|
|
|
1990
3190
|
|
|
1991
3191
|
|
|
1992
3192
|
<dt class="tag-source">Source:</dt>
|
|
1993
3193
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
1994
|
-
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#
|
|
3194
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line36">line 36</a>
|
|
1995
3195
|
</li></ul></dd>
|
|
1996
3196
|
|
|
1997
3197
|
|
|
@@ -2080,20 +3280,20 @@
|
|
|
2080
3280
|
|
|
2081
3281
|
|
|
2082
3282
|
|
|
2083
|
-
<td class="description last">The ID of the thread to
|
|
3283
|
+
<td class="description last">The ID of the thread to update.</td>
|
|
2084
3284
|
</tr>
|
|
2085
3285
|
|
|
2086
3286
|
|
|
2087
3287
|
|
|
2088
3288
|
<tr>
|
|
2089
3289
|
|
|
2090
|
-
<td class="name"><code>
|
|
3290
|
+
<td class="name"><code>params</code></td>
|
|
2091
3291
|
|
|
2092
3292
|
|
|
2093
3293
|
<td class="type">
|
|
2094
3294
|
|
|
2095
3295
|
|
|
2096
|
-
<span class="param-type">
|
|
3296
|
+
<span class="param-type">UpdateThreadParams</span>
|
|
2097
3297
|
|
|
2098
3298
|
|
|
2099
3299
|
|
|
@@ -2104,7 +3304,7 @@
|
|
|
2104
3304
|
|
|
2105
3305
|
|
|
2106
3306
|
|
|
2107
|
-
<td class="description last">The
|
|
3307
|
+
<td class="description last">The parameters for updating the thread.</td>
|
|
2108
3308
|
</tr>
|
|
2109
3309
|
|
|
2110
3310
|
|
|
@@ -2160,7 +3360,7 @@
|
|
|
2160
3360
|
|
|
2161
3361
|
|
|
2162
3362
|
<div class="param-desc">
|
|
2163
|
-
- A promise that resolves
|
|
3363
|
+
- A promise that resolves to the updated thread.
|
|
2164
3364
|
</div>
|
|
2165
3365
|
|
|
2166
3366
|
|
|
@@ -2171,7 +3371,7 @@
|
|
|
2171
3371
|
</dt>
|
|
2172
3372
|
<dd>
|
|
2173
3373
|
|
|
2174
|
-
<span class="param-type">Promise.<
|
|
3374
|
+
<span class="param-type">Promise.<ForumThread></span>
|
|
2175
3375
|
|
|
2176
3376
|
|
|
2177
3377
|
|
|
@@ -2183,11 +3383,63 @@
|
|
|
2183
3383
|
|
|
2184
3384
|
|
|
2185
3385
|
|
|
3386
|
+
|
|
3387
|
+
|
|
3388
|
+
|
|
3389
|
+
|
|
3390
|
+
|
|
3391
|
+
</article>
|
|
3392
|
+
|
|
3393
|
+
</section>
|
|
3394
|
+
|
|
3395
|
+
|
|
3396
|
+
|
|
3397
|
+
|
|
3398
|
+
|
|
3399
|
+
|
|
3400
|
+
|
|
3401
|
+
<section>
|
|
3402
|
+
|
|
3403
|
+
<header>
|
|
3404
|
+
|
|
3405
|
+
|
|
3406
|
+
|
|
3407
|
+
</header>
|
|
3408
|
+
|
|
3409
|
+
<article>
|
|
3410
|
+
|
|
3411
|
+
<div class="container-overview">
|
|
3412
|
+
|
|
3413
|
+
|
|
3414
|
+
|
|
3415
|
+
|
|
3416
|
+
|
|
3417
|
+
</div>
|
|
3418
|
+
|
|
3419
|
+
|
|
3420
|
+
|
|
3421
|
+
|
|
3422
|
+
|
|
3423
|
+
|
|
3424
|
+
|
|
3425
|
+
|
|
3426
|
+
|
|
3427
|
+
|
|
3428
|
+
|
|
3429
|
+
|
|
3430
|
+
|
|
3431
|
+
|
|
3432
|
+
|
|
3433
|
+
|
|
3434
|
+
|
|
3435
|
+
<h3 class="subsection-title">Methods</h3>
|
|
3436
|
+
|
|
3437
|
+
|
|
2186
3438
|
|
|
2187
3439
|
|
|
2188
3440
|
|
|
2189
3441
|
|
|
2190
|
-
<h4 class="name" id="~
|
|
3442
|
+
<h4 class="name" id="~createForumCategory"><span class="type-signature type-signature-async, inner">(async, inner) </span>createForumCategory<span class="signature">(params)</span><span class="type-signature"> → {Promise.<ForumCategory>}</span></h4>
|
|
2191
3443
|
|
|
2192
3444
|
|
|
2193
3445
|
|
|
@@ -2197,13 +3449,13 @@
|
|
|
2197
3449
|
<dl class="details">
|
|
2198
3450
|
|
|
2199
3451
|
<dt class="tag-description">Description:</dt>
|
|
2200
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
3452
|
+
<dd class="tag-description"><ul class="dummy"><li>Creates a new forum category.</li></ul></dd>
|
|
2201
3453
|
|
|
2202
3454
|
|
|
2203
3455
|
|
|
2204
3456
|
<dt class="tag-source">Source:</dt>
|
|
2205
3457
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
2206
|
-
<a href="
|
|
3458
|
+
<a href="forums_categories.ts.html">forums/categories.ts</a>, <a href="forums_categories.ts.html#line30">line 30</a>
|
|
2207
3459
|
</li></ul></dd>
|
|
2208
3460
|
|
|
2209
3461
|
|
|
@@ -2264,48 +3516,24 @@
|
|
|
2264
3516
|
|
|
2265
3517
|
|
|
2266
3518
|
|
|
2267
|
-
|
|
2268
|
-
|
|
2269
|
-
<th class="last">Description</th>
|
|
2270
|
-
</tr>
|
|
2271
|
-
</thead>
|
|
2272
|
-
|
|
2273
|
-
<tbody>
|
|
2274
|
-
|
|
2275
|
-
|
|
2276
|
-
<tr>
|
|
2277
|
-
|
|
2278
|
-
<td class="name"><code>threadId</code></td>
|
|
2279
|
-
|
|
2280
|
-
|
|
2281
|
-
<td class="type">
|
|
2282
|
-
|
|
2283
|
-
|
|
2284
|
-
<span class="param-type">number</span>
|
|
2285
|
-
|
|
2286
|
-
|
|
2287
|
-
|
|
2288
|
-
|
|
2289
|
-
</td>
|
|
2290
|
-
|
|
2291
|
-
|
|
2292
|
-
|
|
2293
|
-
|
|
3519
|
+
|
|
2294
3520
|
|
|
2295
|
-
|
|
2296
|
-
|
|
3521
|
+
<th class="last">Description</th>
|
|
3522
|
+
</tr>
|
|
3523
|
+
</thead>
|
|
2297
3524
|
|
|
3525
|
+
<tbody>
|
|
2298
3526
|
|
|
2299
3527
|
|
|
2300
3528
|
<tr>
|
|
2301
3529
|
|
|
2302
|
-
<td class="name"><code>
|
|
3530
|
+
<td class="name"><code>params</code></td>
|
|
2303
3531
|
|
|
2304
3532
|
|
|
2305
3533
|
<td class="type">
|
|
2306
3534
|
|
|
2307
3535
|
|
|
2308
|
-
<span class="param-type">
|
|
3536
|
+
<span class="param-type">CreateForumCategoryParams</span>
|
|
2309
3537
|
|
|
2310
3538
|
|
|
2311
3539
|
|
|
@@ -2316,7 +3544,7 @@
|
|
|
2316
3544
|
|
|
2317
3545
|
|
|
2318
3546
|
|
|
2319
|
-
<td class="description last">The
|
|
3547
|
+
<td class="description last">The parameters for creating the forum category.</td>
|
|
2320
3548
|
</tr>
|
|
2321
3549
|
|
|
2322
3550
|
|
|
@@ -2372,7 +3600,7 @@
|
|
|
2372
3600
|
|
|
2373
3601
|
|
|
2374
3602
|
<div class="param-desc">
|
|
2375
|
-
- A promise that resolves
|
|
3603
|
+
- A promise that resolves to the created forum category.
|
|
2376
3604
|
</div>
|
|
2377
3605
|
|
|
2378
3606
|
|
|
@@ -2383,7 +3611,7 @@
|
|
|
2383
3611
|
</dt>
|
|
2384
3612
|
<dd>
|
|
2385
3613
|
|
|
2386
|
-
<span class="param-type">Promise.<
|
|
3614
|
+
<span class="param-type">Promise.<ForumCategory></span>
|
|
2387
3615
|
|
|
2388
3616
|
|
|
2389
3617
|
|
|
@@ -2399,7 +3627,7 @@
|
|
|
2399
3627
|
|
|
2400
3628
|
|
|
2401
3629
|
|
|
2402
|
-
<h4 class="name" id="~
|
|
3630
|
+
<h4 class="name" id="~createPost"><span class="type-signature type-signature-async, inner">(async, inner) </span>createPost<span class="signature">(params)</span><span class="type-signature"> → {Promise.<ForumPost>}</span></h4>
|
|
2403
3631
|
|
|
2404
3632
|
|
|
2405
3633
|
|
|
@@ -2409,13 +3637,13 @@
|
|
|
2409
3637
|
<dl class="details">
|
|
2410
3638
|
|
|
2411
3639
|
<dt class="tag-description">Description:</dt>
|
|
2412
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
3640
|
+
<dd class="tag-description"><ul class="dummy"><li>Creates a new post under a forum thread.</li></ul></dd>
|
|
2413
3641
|
|
|
2414
3642
|
|
|
2415
3643
|
|
|
2416
3644
|
<dt class="tag-source">Source:</dt>
|
|
2417
3645
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
2418
|
-
<a href="
|
|
3646
|
+
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line16">line 16</a>
|
|
2419
3647
|
</li></ul></dd>
|
|
2420
3648
|
|
|
2421
3649
|
|
|
@@ -2487,37 +3715,13 @@
|
|
|
2487
3715
|
|
|
2488
3716
|
<tr>
|
|
2489
3717
|
|
|
2490
|
-
<td class="name"><code>
|
|
2491
|
-
|
|
2492
|
-
|
|
2493
|
-
<td class="type">
|
|
2494
|
-
|
|
2495
|
-
|
|
2496
|
-
<span class="param-type">number</span>
|
|
2497
|
-
|
|
2498
|
-
|
|
2499
|
-
|
|
2500
|
-
|
|
2501
|
-
</td>
|
|
2502
|
-
|
|
2503
|
-
|
|
2504
|
-
|
|
2505
|
-
|
|
2506
|
-
|
|
2507
|
-
<td class="description last">The ID of the thread to unpin.</td>
|
|
2508
|
-
</tr>
|
|
2509
|
-
|
|
2510
|
-
|
|
2511
|
-
|
|
2512
|
-
<tr>
|
|
2513
|
-
|
|
2514
|
-
<td class="name"><code>brand</code></td>
|
|
3718
|
+
<td class="name"><code>params</code></td>
|
|
2515
3719
|
|
|
2516
3720
|
|
|
2517
3721
|
<td class="type">
|
|
2518
3722
|
|
|
2519
3723
|
|
|
2520
|
-
<span class="param-type">
|
|
3724
|
+
<span class="param-type">CreatePostParams</span>
|
|
2521
3725
|
|
|
2522
3726
|
|
|
2523
3727
|
|
|
@@ -2528,7 +3732,7 @@
|
|
|
2528
3732
|
|
|
2529
3733
|
|
|
2530
3734
|
|
|
2531
|
-
<td class="description last">The
|
|
3735
|
+
<td class="description last">The parameters for creating the post.</td>
|
|
2532
3736
|
</tr>
|
|
2533
3737
|
|
|
2534
3738
|
|
|
@@ -2584,7 +3788,7 @@
|
|
|
2584
3788
|
|
|
2585
3789
|
|
|
2586
3790
|
<div class="param-desc">
|
|
2587
|
-
- A promise that resolves
|
|
3791
|
+
- A promise that resolves to the created post.
|
|
2588
3792
|
</div>
|
|
2589
3793
|
|
|
2590
3794
|
|
|
@@ -2595,7 +3799,7 @@
|
|
|
2595
3799
|
</dt>
|
|
2596
3800
|
<dd>
|
|
2597
3801
|
|
|
2598
|
-
<span class="param-type">Promise.<
|
|
3802
|
+
<span class="param-type">Promise.<ForumPost></span>
|
|
2599
3803
|
|
|
2600
3804
|
|
|
2601
3805
|
|
|
@@ -2611,7 +3815,7 @@
|
|
|
2611
3815
|
|
|
2612
3816
|
|
|
2613
3817
|
|
|
2614
|
-
<h4 class="name" id="~
|
|
3818
|
+
<h4 class="name" id="~createThread"><span class="type-signature type-signature-async, inner">(async, inner) </span>createThread<span class="signature">(params)</span><span class="type-signature"> → {Promise.<ForumThread>}</span></h4>
|
|
2615
3819
|
|
|
2616
3820
|
|
|
2617
3821
|
|
|
@@ -2621,13 +3825,13 @@
|
|
|
2621
3825
|
<dl class="details">
|
|
2622
3826
|
|
|
2623
3827
|
<dt class="tag-description">Description:</dt>
|
|
2624
|
-
<dd class="tag-description"><ul class="dummy"><li>Creates a new forum category.</li></ul></dd>
|
|
3828
|
+
<dd class="tag-description"><ul class="dummy"><li>Creates a new thread under a forum category.</li></ul></dd>
|
|
2625
3829
|
|
|
2626
3830
|
|
|
2627
3831
|
|
|
2628
3832
|
<dt class="tag-source">Source:</dt>
|
|
2629
3833
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
2630
|
-
<a href="
|
|
3834
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line17">line 17</a>
|
|
2631
3835
|
</li></ul></dd>
|
|
2632
3836
|
|
|
2633
3837
|
|
|
@@ -2705,7 +3909,7 @@
|
|
|
2705
3909
|
<td class="type">
|
|
2706
3910
|
|
|
2707
3911
|
|
|
2708
|
-
<span class="param-type">
|
|
3912
|
+
<span class="param-type">CreateThreadParams</span>
|
|
2709
3913
|
|
|
2710
3914
|
|
|
2711
3915
|
|
|
@@ -2716,7 +3920,7 @@
|
|
|
2716
3920
|
|
|
2717
3921
|
|
|
2718
3922
|
|
|
2719
|
-
<td class="description last">The parameters for creating the
|
|
3923
|
+
<td class="description last">The parameters for creating the thread.</td>
|
|
2720
3924
|
</tr>
|
|
2721
3925
|
|
|
2722
3926
|
|
|
@@ -2772,7 +3976,7 @@
|
|
|
2772
3976
|
|
|
2773
3977
|
|
|
2774
3978
|
<div class="param-desc">
|
|
2775
|
-
- A promise that resolves to the created
|
|
3979
|
+
- A promise that resolves to the created thread.
|
|
2776
3980
|
</div>
|
|
2777
3981
|
|
|
2778
3982
|
|
|
@@ -2783,7 +3987,7 @@
|
|
|
2783
3987
|
</dt>
|
|
2784
3988
|
<dd>
|
|
2785
3989
|
|
|
2786
|
-
<span class="param-type">Promise.<
|
|
3990
|
+
<span class="param-type">Promise.<ForumThread></span>
|
|
2787
3991
|
|
|
2788
3992
|
|
|
2789
3993
|
|
|
@@ -2799,7 +4003,7 @@
|
|
|
2799
4003
|
|
|
2800
4004
|
|
|
2801
4005
|
|
|
2802
|
-
<h4 class="name" id="~
|
|
4006
|
+
<h4 class="name" id="~fetchFollowedThreads"><span class="type-signature type-signature-async, inner">(async, inner) </span>fetchFollowedThreads<span class="signature">(brand)</span><span class="type-signature"> → {Promise.<<a href="global.html#PaginatedResponse">PaginatedResponse</a>.<ForumThread>>}</span></h4>
|
|
2803
4007
|
|
|
2804
4008
|
|
|
2805
4009
|
|
|
@@ -2809,13 +4013,13 @@
|
|
|
2809
4013
|
<dl class="details">
|
|
2810
4014
|
|
|
2811
4015
|
<dt class="tag-description">Description:</dt>
|
|
2812
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
4016
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetches followed forum Threads for the given brand and current user.</li></ul></dd>
|
|
2813
4017
|
|
|
2814
4018
|
|
|
2815
4019
|
|
|
2816
4020
|
<dt class="tag-source">Source:</dt>
|
|
2817
4021
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
2818
|
-
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#
|
|
4022
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line160">line 160</a>
|
|
2819
4023
|
</li></ul></dd>
|
|
2820
4024
|
|
|
2821
4025
|
|
|
@@ -2887,37 +4091,13 @@
|
|
|
2887
4091
|
|
|
2888
4092
|
<tr>
|
|
2889
4093
|
|
|
2890
|
-
<td class="name"><code>
|
|
2891
|
-
|
|
2892
|
-
|
|
2893
|
-
<td class="type">
|
|
2894
|
-
|
|
2895
|
-
|
|
2896
|
-
<span class="param-type">number</span>
|
|
2897
|
-
|
|
2898
|
-
|
|
2899
|
-
|
|
2900
|
-
|
|
2901
|
-
</td>
|
|
2902
|
-
|
|
2903
|
-
|
|
2904
|
-
|
|
2905
|
-
|
|
2906
|
-
|
|
2907
|
-
<td class="description last">The ID of the thread to update.</td>
|
|
2908
|
-
</tr>
|
|
2909
|
-
|
|
2910
|
-
|
|
2911
|
-
|
|
2912
|
-
<tr>
|
|
2913
|
-
|
|
2914
|
-
<td class="name"><code>params</code></td>
|
|
4094
|
+
<td class="name"><code>brand</code></td>
|
|
2915
4095
|
|
|
2916
4096
|
|
|
2917
4097
|
<td class="type">
|
|
2918
4098
|
|
|
2919
4099
|
|
|
2920
|
-
<span class="param-type">
|
|
4100
|
+
<span class="param-type">string</span>
|
|
2921
4101
|
|
|
2922
4102
|
|
|
2923
4103
|
|
|
@@ -2928,7 +4108,7 @@
|
|
|
2928
4108
|
|
|
2929
4109
|
|
|
2930
4110
|
|
|
2931
|
-
<td class="description last">The
|
|
4111
|
+
<td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
|
|
2932
4112
|
</tr>
|
|
2933
4113
|
|
|
2934
4114
|
|
|
@@ -2984,7 +4164,7 @@
|
|
|
2984
4164
|
|
|
2985
4165
|
|
|
2986
4166
|
<div class="param-desc">
|
|
2987
|
-
- A promise that resolves to the
|
|
4167
|
+
- A promise that resolves to the list of forum threads.
|
|
2988
4168
|
</div>
|
|
2989
4169
|
|
|
2990
4170
|
|
|
@@ -2995,7 +4175,7 @@
|
|
|
2995
4175
|
</dt>
|
|
2996
4176
|
<dd>
|
|
2997
4177
|
|
|
2998
|
-
<span class="param-type">Promise.<ForumThread
|
|
4178
|
+
<span class="param-type">Promise.<<a href="global.html#PaginatedResponse">PaginatedResponse</a>.<ForumThread>></span>
|
|
2999
4179
|
|
|
3000
4180
|
|
|
3001
4181
|
|
|
@@ -3007,63 +4187,11 @@
|
|
|
3007
4187
|
|
|
3008
4188
|
|
|
3009
4189
|
|
|
3010
|
-
|
|
3011
|
-
|
|
3012
|
-
|
|
3013
|
-
|
|
3014
|
-
|
|
3015
|
-
</article>
|
|
3016
|
-
|
|
3017
|
-
</section>
|
|
3018
|
-
|
|
3019
|
-
|
|
3020
|
-
|
|
3021
|
-
|
|
3022
|
-
|
|
3023
|
-
|
|
3024
|
-
|
|
3025
|
-
<section>
|
|
3026
|
-
|
|
3027
|
-
<header>
|
|
3028
|
-
|
|
3029
|
-
|
|
3030
|
-
|
|
3031
|
-
</header>
|
|
3032
|
-
|
|
3033
|
-
<article>
|
|
3034
|
-
|
|
3035
|
-
<div class="container-overview">
|
|
3036
|
-
|
|
3037
|
-
|
|
3038
|
-
|
|
3039
|
-
|
|
3040
|
-
|
|
3041
|
-
</div>
|
|
3042
|
-
|
|
3043
|
-
|
|
3044
|
-
|
|
3045
|
-
|
|
3046
|
-
|
|
3047
|
-
|
|
3048
|
-
|
|
3049
|
-
|
|
3050
|
-
|
|
3051
|
-
|
|
3052
|
-
|
|
3053
|
-
|
|
3054
|
-
|
|
3055
|
-
|
|
3056
|
-
|
|
3057
|
-
|
|
3058
|
-
|
|
3059
|
-
<h3 class="subsection-title">Methods</h3>
|
|
3060
|
-
|
|
3061
|
-
|
|
3062
4190
|
|
|
3063
4191
|
|
|
3064
4192
|
|
|
3065
4193
|
|
|
3066
|
-
<h4 class="name" id="~
|
|
4194
|
+
<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"> → {Promise.<ForumCategory>}</span></h4>
|
|
3067
4195
|
|
|
3068
4196
|
|
|
3069
4197
|
|
|
@@ -3073,13 +4201,13 @@
|
|
|
3073
4201
|
<dl class="details">
|
|
3074
4202
|
|
|
3075
4203
|
<dt class="tag-description">Description:</dt>
|
|
3076
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
4204
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetches forum categories for the given brand.</li></ul></dd>
|
|
3077
4205
|
|
|
3078
4206
|
|
|
3079
4207
|
|
|
3080
4208
|
<dt class="tag-source">Source:</dt>
|
|
3081
4209
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
3082
|
-
<a href="forums_categories.ts.html">forums/categories.ts</a>, <a href="forums_categories.ts.html#
|
|
4210
|
+
<a href="forums_categories.ts.html">forums/categories.ts</a>, <a href="forums_categories.ts.html#line10">line 10</a>
|
|
3083
4211
|
</li></ul></dd>
|
|
3084
4212
|
|
|
3085
4213
|
|
|
@@ -3151,13 +4279,16 @@
|
|
|
3151
4279
|
|
|
3152
4280
|
<tr>
|
|
3153
4281
|
|
|
3154
|
-
<td class="name"><code>
|
|
4282
|
+
<td class="name"><code>brand</code></td>
|
|
3155
4283
|
|
|
3156
4284
|
|
|
3157
4285
|
<td class="type">
|
|
3158
4286
|
|
|
3159
4287
|
|
|
3160
|
-
<span class="param-type">
|
|
4288
|
+
<span class="param-type">string</span>
|
|
4289
|
+
|
|
|
4290
|
+
|
|
4291
|
+
<span class="param-type">null</span>
|
|
3161
4292
|
|
|
3162
4293
|
|
|
3163
4294
|
|
|
@@ -3168,7 +4299,7 @@
|
|
|
3168
4299
|
|
|
3169
4300
|
|
|
3170
4301
|
|
|
3171
|
-
<td class="description last">The
|
|
4302
|
+
<td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
|
|
3172
4303
|
</tr>
|
|
3173
4304
|
|
|
3174
4305
|
|
|
@@ -3224,7 +4355,7 @@
|
|
|
3224
4355
|
|
|
3225
4356
|
|
|
3226
4357
|
<div class="param-desc">
|
|
3227
|
-
- A promise that resolves to the
|
|
4358
|
+
- A promise that resolves to the list of forum categories.
|
|
3228
4359
|
</div>
|
|
3229
4360
|
|
|
3230
4361
|
|
|
@@ -3251,7 +4382,7 @@
|
|
|
3251
4382
|
|
|
3252
4383
|
|
|
3253
4384
|
|
|
3254
|
-
<h4 class="name" id="~
|
|
4385
|
+
<h4 class="name" id="~fetchLatestThreads"><span class="type-signature type-signature-async, inner">(async, inner) </span>fetchLatestThreads<span class="signature">(brand)</span><span class="type-signature"> → {Promise.<<a href="global.html#PaginatedResponse">PaginatedResponse</a>.<ForumThread>>}</span></h4>
|
|
3255
4386
|
|
|
3256
4387
|
|
|
3257
4388
|
|
|
@@ -3261,13 +4392,13 @@
|
|
|
3261
4392
|
<dl class="details">
|
|
3262
4393
|
|
|
3263
4394
|
<dt class="tag-description">Description:</dt>
|
|
3264
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
4395
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetches latest forum Threads for the given brand and not blocked to current user.</li></ul></dd>
|
|
3265
4396
|
|
|
3266
4397
|
|
|
3267
4398
|
|
|
3268
4399
|
<dt class="tag-source">Source:</dt>
|
|
3269
4400
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
3270
|
-
<a href="
|
|
4401
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line174">line 174</a>
|
|
3271
4402
|
</li></ul></dd>
|
|
3272
4403
|
|
|
3273
4404
|
|
|
@@ -3339,13 +4470,13 @@
|
|
|
3339
4470
|
|
|
3340
4471
|
<tr>
|
|
3341
4472
|
|
|
3342
|
-
<td class="name"><code>
|
|
4473
|
+
<td class="name"><code>brand</code></td>
|
|
3343
4474
|
|
|
3344
4475
|
|
|
3345
4476
|
<td class="type">
|
|
3346
4477
|
|
|
3347
4478
|
|
|
3348
|
-
<span class="param-type">
|
|
4479
|
+
<span class="param-type">string</span>
|
|
3349
4480
|
|
|
3350
4481
|
|
|
3351
4482
|
|
|
@@ -3356,7 +4487,7 @@
|
|
|
3356
4487
|
|
|
3357
4488
|
|
|
3358
4489
|
|
|
3359
|
-
<td class="description last">The
|
|
4490
|
+
<td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
|
|
3360
4491
|
</tr>
|
|
3361
4492
|
|
|
3362
4493
|
|
|
@@ -3412,7 +4543,7 @@
|
|
|
3412
4543
|
|
|
3413
4544
|
|
|
3414
4545
|
<div class="param-desc">
|
|
3415
|
-
- A promise that resolves to the
|
|
4546
|
+
- A promise that resolves to the list of forum threads.
|
|
3416
4547
|
</div>
|
|
3417
4548
|
|
|
3418
4549
|
|
|
@@ -3423,7 +4554,7 @@
|
|
|
3423
4554
|
</dt>
|
|
3424
4555
|
<dd>
|
|
3425
4556
|
|
|
3426
|
-
<span class="param-type">Promise.<
|
|
4557
|
+
<span class="param-type">Promise.<<a href="global.html#PaginatedResponse">PaginatedResponse</a>.<ForumThread>></span>
|
|
3427
4558
|
|
|
3428
4559
|
|
|
3429
4560
|
|
|
@@ -3439,7 +4570,7 @@
|
|
|
3439
4570
|
|
|
3440
4571
|
|
|
3441
4572
|
|
|
3442
|
-
<h4 class="name" id="~
|
|
4573
|
+
<h4 class="name" id="~fetchPosts"><span class="type-signature type-signature-async, inner">(async, inner) </span>fetchPosts<span class="signature">(threadId, brand, params<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<<a href="global.html#PaginatedResponse">PaginatedResponse</a>.<ForumPost>>}</span></h4>
|
|
3443
4574
|
|
|
3444
4575
|
|
|
3445
4576
|
|
|
@@ -3449,13 +4580,13 @@
|
|
|
3449
4580
|
<dl class="details">
|
|
3450
4581
|
|
|
3451
4582
|
<dt class="tag-description">Description:</dt>
|
|
3452
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
4583
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetches posts for the given thread.</li></ul></dd>
|
|
3453
4584
|
|
|
3454
4585
|
|
|
3455
4586
|
|
|
3456
4587
|
<dt class="tag-source">Source:</dt>
|
|
3457
4588
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
3458
|
-
<a href="
|
|
4589
|
+
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line37">line 37</a>
|
|
3459
4590
|
</li></ul></dd>
|
|
3460
4591
|
|
|
3461
4592
|
|
|
@@ -3512,17 +4643,83 @@
|
|
|
3512
4643
|
<th>Name</th>
|
|
3513
4644
|
|
|
3514
4645
|
|
|
3515
|
-
<th>Type</th>
|
|
4646
|
+
<th>Type</th>
|
|
4647
|
+
|
|
4648
|
+
|
|
4649
|
+
<th>Attributes</th>
|
|
4650
|
+
|
|
4651
|
+
|
|
4652
|
+
|
|
4653
|
+
|
|
4654
|
+
<th class="last">Description</th>
|
|
4655
|
+
</tr>
|
|
4656
|
+
</thead>
|
|
4657
|
+
|
|
4658
|
+
<tbody>
|
|
4659
|
+
|
|
4660
|
+
|
|
4661
|
+
<tr>
|
|
4662
|
+
|
|
4663
|
+
<td class="name"><code>threadId</code></td>
|
|
4664
|
+
|
|
4665
|
+
|
|
4666
|
+
<td class="type">
|
|
4667
|
+
|
|
4668
|
+
|
|
4669
|
+
<span class="param-type">number</span>
|
|
4670
|
+
|
|
4671
|
+
|
|
4672
|
+
|
|
4673
|
+
|
|
4674
|
+
</td>
|
|
4675
|
+
|
|
4676
|
+
|
|
4677
|
+
<td class="attributes">
|
|
4678
|
+
|
|
4679
|
+
|
|
4680
|
+
|
|
4681
|
+
|
|
4682
|
+
|
|
4683
|
+
</td>
|
|
4684
|
+
|
|
4685
|
+
|
|
4686
|
+
|
|
4687
|
+
|
|
4688
|
+
<td class="description last">The ID of the forum thread.</td>
|
|
4689
|
+
</tr>
|
|
4690
|
+
|
|
4691
|
+
|
|
4692
|
+
|
|
4693
|
+
<tr>
|
|
4694
|
+
|
|
4695
|
+
<td class="name"><code>brand</code></td>
|
|
4696
|
+
|
|
4697
|
+
|
|
4698
|
+
<td class="type">
|
|
4699
|
+
|
|
4700
|
+
|
|
4701
|
+
<span class="param-type">string</span>
|
|
4702
|
+
|
|
4703
|
+
|
|
4704
|
+
|
|
4705
|
+
|
|
4706
|
+
</td>
|
|
4707
|
+
|
|
4708
|
+
|
|
4709
|
+
<td class="attributes">
|
|
4710
|
+
|
|
3516
4711
|
|
|
3517
|
-
|
|
4712
|
+
|
|
3518
4713
|
|
|
3519
|
-
|
|
4714
|
+
|
|
4715
|
+
</td>
|
|
4716
|
+
|
|
3520
4717
|
|
|
3521
|
-
|
|
3522
|
-
|
|
3523
|
-
|
|
4718
|
+
|
|
4719
|
+
|
|
4720
|
+
<td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
|
|
4721
|
+
</tr>
|
|
3524
4722
|
|
|
3525
|
-
<tbody>
|
|
3526
4723
|
|
|
3527
4724
|
|
|
3528
4725
|
<tr>
|
|
@@ -3533,7 +4730,7 @@
|
|
|
3533
4730
|
<td class="type">
|
|
3534
4731
|
|
|
3535
4732
|
|
|
3536
|
-
<span class="param-type">
|
|
4733
|
+
<span class="param-type">FetchPostParams</span>
|
|
3537
4734
|
|
|
3538
4735
|
|
|
3539
4736
|
|
|
@@ -3541,10 +4738,20 @@
|
|
|
3541
4738
|
</td>
|
|
3542
4739
|
|
|
3543
4740
|
|
|
4741
|
+
<td class="attributes">
|
|
4742
|
+
|
|
4743
|
+
<optional><br>
|
|
4744
|
+
|
|
4745
|
+
|
|
4746
|
+
|
|
4747
|
+
|
|
4748
|
+
|
|
4749
|
+
</td>
|
|
4750
|
+
|
|
3544
4751
|
|
|
3545
4752
|
|
|
3546
4753
|
|
|
3547
|
-
<td class="description last">
|
|
4754
|
+
<td class="description last">Optional parameters such as `page`, `limit`, and `sort`.</td>
|
|
3548
4755
|
</tr>
|
|
3549
4756
|
|
|
3550
4757
|
|
|
@@ -3600,7 +4807,7 @@
|
|
|
3600
4807
|
|
|
3601
4808
|
|
|
3602
4809
|
<div class="param-desc">
|
|
3603
|
-
-
|
|
4810
|
+
- Resolves to a paginated list of forum posts.
|
|
3604
4811
|
</div>
|
|
3605
4812
|
|
|
3606
4813
|
|
|
@@ -3611,7 +4818,7 @@
|
|
|
3611
4818
|
</dt>
|
|
3612
4819
|
<dd>
|
|
3613
4820
|
|
|
3614
|
-
<span class="param-type">Promise.<
|
|
4821
|
+
<span class="param-type">Promise.<<a href="global.html#PaginatedResponse">PaginatedResponse</a>.<ForumPost>></span>
|
|
3615
4822
|
|
|
3616
4823
|
|
|
3617
4824
|
|
|
@@ -3627,7 +4834,7 @@
|
|
|
3627
4834
|
|
|
3628
4835
|
|
|
3629
4836
|
|
|
3630
|
-
<h4 class="name" id="~
|
|
4837
|
+
<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"> → {Promise.<<a href="global.html#PaginatedResponse">PaginatedResponse</a>.<ForumThread>>}</span></h4>
|
|
3631
4838
|
|
|
3632
4839
|
|
|
3633
4840
|
|
|
@@ -3637,13 +4844,13 @@
|
|
|
3637
4844
|
<dl class="details">
|
|
3638
4845
|
|
|
3639
4846
|
<dt class="tag-description">Description:</dt>
|
|
3640
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetches forum
|
|
4847
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetches forum threads for the given category.</li></ul></dd>
|
|
3641
4848
|
|
|
3642
4849
|
|
|
3643
4850
|
|
|
3644
4851
|
<dt class="tag-source">Source:</dt>
|
|
3645
4852
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
3646
|
-
<a href="
|
|
4853
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line84">line 84</a>
|
|
3647
4854
|
</li></ul></dd>
|
|
3648
4855
|
|
|
3649
4856
|
|
|
@@ -3713,6 +4920,30 @@
|
|
|
3713
4920
|
<tbody>
|
|
3714
4921
|
|
|
3715
4922
|
|
|
4923
|
+
<tr>
|
|
4924
|
+
|
|
4925
|
+
<td class="name"><code>categoryId</code></td>
|
|
4926
|
+
|
|
4927
|
+
|
|
4928
|
+
<td class="type">
|
|
4929
|
+
|
|
4930
|
+
|
|
4931
|
+
<span class="param-type">number</span>
|
|
4932
|
+
|
|
4933
|
+
|
|
4934
|
+
|
|
4935
|
+
|
|
4936
|
+
</td>
|
|
4937
|
+
|
|
4938
|
+
|
|
4939
|
+
|
|
4940
|
+
|
|
4941
|
+
|
|
4942
|
+
<td class="description last">The ID of the forum category.</td>
|
|
4943
|
+
</tr>
|
|
4944
|
+
|
|
4945
|
+
|
|
4946
|
+
|
|
3716
4947
|
<tr>
|
|
3717
4948
|
|
|
3718
4949
|
<td class="name"><code>brand</code></td>
|
|
@@ -3722,9 +4953,6 @@
|
|
|
3722
4953
|
|
|
3723
4954
|
|
|
3724
4955
|
<span class="param-type">string</span>
|
|
3725
|
-
|
|
|
3726
|
-
|
|
3727
|
-
<span class="param-type">null</span>
|
|
3728
4956
|
|
|
3729
4957
|
|
|
3730
4958
|
|
|
@@ -3739,6 +4967,30 @@
|
|
|
3739
4967
|
</tr>
|
|
3740
4968
|
|
|
3741
4969
|
|
|
4970
|
+
|
|
4971
|
+
<tr>
|
|
4972
|
+
|
|
4973
|
+
<td class="name"><code>params</code></td>
|
|
4974
|
+
|
|
4975
|
+
|
|
4976
|
+
<td class="type">
|
|
4977
|
+
|
|
4978
|
+
|
|
4979
|
+
<span class="param-type">FetchThreadParams</span>
|
|
4980
|
+
|
|
4981
|
+
|
|
4982
|
+
|
|
4983
|
+
|
|
4984
|
+
</td>
|
|
4985
|
+
|
|
4986
|
+
|
|
4987
|
+
|
|
4988
|
+
|
|
4989
|
+
|
|
4990
|
+
<td class="description last">Optional additional parameters (e.g., is_followed, sort("last_post_published_on","-last_post_published_on","mine")).</td>
|
|
4991
|
+
</tr>
|
|
4992
|
+
|
|
4993
|
+
|
|
3742
4994
|
</tbody>
|
|
3743
4995
|
</table>
|
|
3744
4996
|
|
|
@@ -3762,7 +5014,7 @@
|
|
|
3762
5014
|
<dl>
|
|
3763
5015
|
<dt>
|
|
3764
5016
|
<div class="param-desc usertext">
|
|
3765
|
-
- If the request fails.
|
|
5017
|
+
- If the HTTP request fails.
|
|
3766
5018
|
</div>
|
|
3767
5019
|
</dt>
|
|
3768
5020
|
<dd></dd>
|
|
@@ -3791,7 +5043,7 @@
|
|
|
3791
5043
|
|
|
3792
5044
|
|
|
3793
5045
|
<div class="param-desc">
|
|
3794
|
-
- A promise that resolves to
|
|
5046
|
+
- A promise that resolves to a paginated list of forum threads.
|
|
3795
5047
|
</div>
|
|
3796
5048
|
|
|
3797
5049
|
|
|
@@ -3802,7 +5054,7 @@
|
|
|
3802
5054
|
</dt>
|
|
3803
5055
|
<dd>
|
|
3804
5056
|
|
|
3805
|
-
<span class="param-type">Promise.<
|
|
5057
|
+
<span class="param-type">Promise.<<a href="global.html#PaginatedResponse">PaginatedResponse</a>.<ForumThread>></span>
|
|
3806
5058
|
|
|
3807
5059
|
|
|
3808
5060
|
|
|
@@ -3818,7 +5070,7 @@
|
|
|
3818
5070
|
|
|
3819
5071
|
|
|
3820
5072
|
|
|
3821
|
-
<h4 class="name" id="~
|
|
5073
|
+
<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"> → {Promise.<void>}</span></h4>
|
|
3822
5074
|
|
|
3823
5075
|
|
|
3824
5076
|
|
|
@@ -3828,13 +5080,13 @@
|
|
|
3828
5080
|
<dl class="details">
|
|
3829
5081
|
|
|
3830
5082
|
<dt class="tag-description">Description:</dt>
|
|
3831
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
5083
|
+
<dd class="tag-description"><ul class="dummy"><li>Follow a thread.</li></ul></dd>
|
|
3832
5084
|
|
|
3833
5085
|
|
|
3834
5086
|
|
|
3835
5087
|
<dt class="tag-source">Source:</dt>
|
|
3836
5088
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
3837
|
-
<a href="
|
|
5089
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line52">line 52</a>
|
|
3838
5090
|
</li></ul></dd>
|
|
3839
5091
|
|
|
3840
5092
|
|
|
@@ -3894,8 +5146,6 @@
|
|
|
3894
5146
|
<th>Type</th>
|
|
3895
5147
|
|
|
3896
5148
|
|
|
3897
|
-
<th>Attributes</th>
|
|
3898
|
-
|
|
3899
5149
|
|
|
3900
5150
|
|
|
3901
5151
|
|
|
@@ -3922,18 +5172,10 @@
|
|
|
3922
5172
|
</td>
|
|
3923
5173
|
|
|
3924
5174
|
|
|
3925
|
-
<td class="attributes">
|
|
3926
|
-
|
|
3927
|
-
|
|
3928
|
-
|
|
3929
|
-
|
|
3930
|
-
|
|
3931
|
-
</td>
|
|
3932
|
-
|
|
3933
5175
|
|
|
3934
5176
|
|
|
3935
5177
|
|
|
3936
|
-
<td class="description last">The ID of the
|
|
5178
|
+
<td class="description last">The ID of the thread to lock.</td>
|
|
3937
5179
|
</tr>
|
|
3938
5180
|
|
|
3939
5181
|
|
|
@@ -3954,52 +5196,10 @@
|
|
|
3954
5196
|
</td>
|
|
3955
5197
|
|
|
3956
5198
|
|
|
3957
|
-
<td class="attributes">
|
|
3958
|
-
|
|
3959
|
-
|
|
3960
|
-
|
|
3961
|
-
|
|
3962
|
-
|
|
3963
|
-
</td>
|
|
3964
|
-
|
|
3965
|
-
|
|
3966
|
-
|
|
3967
|
-
|
|
3968
|
-
<td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
|
|
3969
|
-
</tr>
|
|
3970
|
-
|
|
3971
|
-
|
|
3972
|
-
|
|
3973
|
-
<tr>
|
|
3974
|
-
|
|
3975
|
-
<td class="name"><code>params</code></td>
|
|
3976
|
-
|
|
3977
|
-
|
|
3978
|
-
<td class="type">
|
|
3979
|
-
|
|
3980
|
-
|
|
3981
|
-
<span class="param-type">FetchPostParams</span>
|
|
3982
|
-
|
|
3983
|
-
|
|
3984
|
-
|
|
3985
|
-
|
|
3986
|
-
</td>
|
|
3987
|
-
|
|
3988
|
-
|
|
3989
|
-
<td class="attributes">
|
|
3990
|
-
|
|
3991
|
-
<optional><br>
|
|
3992
|
-
|
|
3993
|
-
|
|
3994
|
-
|
|
3995
|
-
|
|
3996
|
-
|
|
3997
|
-
</td>
|
|
3998
|
-
|
|
3999
5199
|
|
|
4000
5200
|
|
|
4001
5201
|
|
|
4002
|
-
<td class="description last">
|
|
5202
|
+
<td class="description last">The brand associated with the follow action.</td>
|
|
4003
5203
|
</tr>
|
|
4004
5204
|
|
|
4005
5205
|
|
|
@@ -4055,7 +5255,7 @@
|
|
|
4055
5255
|
|
|
4056
5256
|
|
|
4057
5257
|
<div class="param-desc">
|
|
4058
|
-
-
|
|
5258
|
+
- A promise that resolves when the thread is locked.
|
|
4059
5259
|
</div>
|
|
4060
5260
|
|
|
4061
5261
|
|
|
@@ -4066,7 +5266,7 @@
|
|
|
4066
5266
|
</dt>
|
|
4067
5267
|
<dd>
|
|
4068
5268
|
|
|
4069
|
-
<span class="param-type">Promise.<
|
|
5269
|
+
<span class="param-type">Promise.<void></span>
|
|
4070
5270
|
|
|
4071
5271
|
|
|
4072
5272
|
|
|
@@ -4082,7 +5282,7 @@
|
|
|
4082
5282
|
|
|
4083
5283
|
|
|
4084
5284
|
|
|
4085
|
-
<h4 class="name" id="~
|
|
5285
|
+
<h4 class="name" id="~lockThread"><span class="type-signature type-signature-async, inner">(async, inner) </span>lockThread<span class="signature">(threadId, brand)</span><span class="type-signature"> → {Promise.<void>}</span></h4>
|
|
4086
5286
|
|
|
4087
5287
|
|
|
4088
5288
|
|
|
@@ -4092,13 +5292,13 @@
|
|
|
4092
5292
|
<dl class="details">
|
|
4093
5293
|
|
|
4094
5294
|
<dt class="tag-description">Description:</dt>
|
|
4095
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
5295
|
+
<dd class="tag-description"><ul class="dummy"><li>Locks a thread to prevent further posts.</li></ul></dd>
|
|
4096
5296
|
|
|
4097
5297
|
|
|
4098
5298
|
|
|
4099
5299
|
<dt class="tag-source">Source:</dt>
|
|
4100
5300
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
4101
|
-
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#
|
|
5301
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line134">line 134</a>
|
|
4102
5302
|
</li></ul></dd>
|
|
4103
5303
|
|
|
4104
5304
|
|
|
@@ -4170,7 +5370,7 @@
|
|
|
4170
5370
|
|
|
4171
5371
|
<tr>
|
|
4172
5372
|
|
|
4173
|
-
<td class="name"><code>
|
|
5373
|
+
<td class="name"><code>threadId</code></td>
|
|
4174
5374
|
|
|
4175
5375
|
|
|
4176
5376
|
<td class="type">
|
|
@@ -4187,7 +5387,7 @@
|
|
|
4187
5387
|
|
|
4188
5388
|
|
|
4189
5389
|
|
|
4190
|
-
<td class="description last">The ID of the
|
|
5390
|
+
<td class="description last">The ID of the thread to lock.</td>
|
|
4191
5391
|
</tr>
|
|
4192
5392
|
|
|
4193
5393
|
|
|
@@ -4215,30 +5415,6 @@
|
|
|
4215
5415
|
</tr>
|
|
4216
5416
|
|
|
4217
5417
|
|
|
4218
|
-
|
|
4219
|
-
<tr>
|
|
4220
|
-
|
|
4221
|
-
<td class="name"><code>params</code></td>
|
|
4222
|
-
|
|
4223
|
-
|
|
4224
|
-
<td class="type">
|
|
4225
|
-
|
|
4226
|
-
|
|
4227
|
-
<span class="param-type">FetchThreadParams</span>
|
|
4228
|
-
|
|
4229
|
-
|
|
4230
|
-
|
|
4231
|
-
|
|
4232
|
-
</td>
|
|
4233
|
-
|
|
4234
|
-
|
|
4235
|
-
|
|
4236
|
-
|
|
4237
|
-
|
|
4238
|
-
<td class="description last">Optional additional parameters (e.g., is_followed, sort("last_post_published_on","-last_post_published_on","mine")).</td>
|
|
4239
|
-
</tr>
|
|
4240
|
-
|
|
4241
|
-
|
|
4242
5418
|
</tbody>
|
|
4243
5419
|
</table>
|
|
4244
5420
|
|
|
@@ -4262,7 +5438,7 @@
|
|
|
4262
5438
|
<dl>
|
|
4263
5439
|
<dt>
|
|
4264
5440
|
<div class="param-desc usertext">
|
|
4265
|
-
- If the
|
|
5441
|
+
- If the request fails.
|
|
4266
5442
|
</div>
|
|
4267
5443
|
</dt>
|
|
4268
5444
|
<dd></dd>
|
|
@@ -4291,7 +5467,7 @@
|
|
|
4291
5467
|
|
|
4292
5468
|
|
|
4293
5469
|
<div class="param-desc">
|
|
4294
|
-
- A promise that resolves
|
|
5470
|
+
- A promise that resolves when the thread is locked.
|
|
4295
5471
|
</div>
|
|
4296
5472
|
|
|
4297
5473
|
|
|
@@ -4302,7 +5478,7 @@
|
|
|
4302
5478
|
</dt>
|
|
4303
5479
|
<dd>
|
|
4304
5480
|
|
|
4305
|
-
<span class="param-type">Promise.<
|
|
5481
|
+
<span class="param-type">Promise.<void></span>
|
|
4306
5482
|
|
|
4307
5483
|
|
|
4308
5484
|
|
|
@@ -4318,7 +5494,7 @@
|
|
|
4318
5494
|
|
|
4319
5495
|
|
|
4320
5496
|
|
|
4321
|
-
<h4 class="name" id="~
|
|
5497
|
+
<h4 class="name" id="~pinThread"><span class="type-signature type-signature-async, inner">(async, inner) </span>pinThread<span class="signature">(threadId, brand)</span><span class="type-signature"> → {Promise.<void>}</span></h4>
|
|
4322
5498
|
|
|
4323
5499
|
|
|
4324
5500
|
|
|
@@ -4328,13 +5504,13 @@
|
|
|
4328
5504
|
<dl class="details">
|
|
4329
5505
|
|
|
4330
5506
|
<dt class="tag-description">Description:</dt>
|
|
4331
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
5507
|
+
<dd class="tag-description"><ul class="dummy"><li>Pins a thread to the top of its category.</li></ul></dd>
|
|
4332
5508
|
|
|
4333
5509
|
|
|
4334
5510
|
|
|
4335
5511
|
<dt class="tag-source">Source:</dt>
|
|
4336
5512
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
4337
|
-
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#
|
|
5513
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line108">line 108</a>
|
|
4338
5514
|
</li></ul></dd>
|
|
4339
5515
|
|
|
4340
5516
|
|
|
@@ -4423,7 +5599,7 @@
|
|
|
4423
5599
|
|
|
4424
5600
|
|
|
4425
5601
|
|
|
4426
|
-
<td class="description last">The ID of the thread to
|
|
5602
|
+
<td class="description last">The ID of the thread to pin.</td>
|
|
4427
5603
|
</tr>
|
|
4428
5604
|
|
|
4429
5605
|
|
|
@@ -4447,7 +5623,7 @@
|
|
|
4447
5623
|
|
|
4448
5624
|
|
|
4449
5625
|
|
|
4450
|
-
<td class="description last">The brand
|
|
5626
|
+
<td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
|
|
4451
5627
|
</tr>
|
|
4452
5628
|
|
|
4453
5629
|
|
|
@@ -4503,7 +5679,7 @@
|
|
|
4503
5679
|
|
|
4504
5680
|
|
|
4505
5681
|
<div class="param-desc">
|
|
4506
|
-
- A promise that resolves when the thread is
|
|
5682
|
+
- A promise that resolves when the thread is pinned.
|
|
4507
5683
|
</div>
|
|
4508
5684
|
|
|
4509
5685
|
|
|
@@ -4530,7 +5706,7 @@
|
|
|
4530
5706
|
|
|
4531
5707
|
|
|
4532
5708
|
|
|
4533
|
-
<h4 class="name" id="~
|
|
5709
|
+
<h4 class="name" id="~unfollowThread"><span class="type-signature type-signature-async, inner">(async, inner) </span>unfollowThread<span class="signature">(threadId, brand)</span><span class="type-signature"> → {Promise.<void>}</span></h4>
|
|
4534
5710
|
|
|
4535
5711
|
|
|
4536
5712
|
|
|
@@ -4540,13 +5716,13 @@
|
|
|
4540
5716
|
<dl class="details">
|
|
4541
5717
|
|
|
4542
5718
|
<dt class="tag-description">Description:</dt>
|
|
4543
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
5719
|
+
<dd class="tag-description"><ul class="dummy"><li>Unlock a thread to allow further posts.</li></ul></dd>
|
|
4544
5720
|
|
|
4545
5721
|
|
|
4546
5722
|
|
|
4547
5723
|
<dt class="tag-source">Source:</dt>
|
|
4548
5724
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
4549
|
-
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#
|
|
5725
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line65">line 65</a>
|
|
4550
5726
|
</li></ul></dd>
|
|
4551
5727
|
|
|
4552
5728
|
|
|
@@ -4635,7 +5811,7 @@
|
|
|
4635
5811
|
|
|
4636
5812
|
|
|
4637
5813
|
|
|
4638
|
-
<td class="description last">The ID of the thread to
|
|
5814
|
+
<td class="description last">The ID of the thread to unlock.</td>
|
|
4639
5815
|
</tr>
|
|
4640
5816
|
|
|
4641
5817
|
|
|
@@ -4659,7 +5835,7 @@
|
|
|
4659
5835
|
|
|
4660
5836
|
|
|
4661
5837
|
|
|
4662
|
-
<td class="description last">The brand
|
|
5838
|
+
<td class="description last">The brand associated with the unlock action.</td>
|
|
4663
5839
|
</tr>
|
|
4664
5840
|
|
|
4665
5841
|
|
|
@@ -4715,7 +5891,7 @@
|
|
|
4715
5891
|
|
|
4716
5892
|
|
|
4717
5893
|
<div class="param-desc">
|
|
4718
|
-
- A promise that resolves when the thread is
|
|
5894
|
+
- A promise that resolves when the thread is unlocked.
|
|
4719
5895
|
</div>
|
|
4720
5896
|
|
|
4721
5897
|
|
|
@@ -4742,7 +5918,7 @@
|
|
|
4742
5918
|
|
|
4743
5919
|
|
|
4744
5920
|
|
|
4745
|
-
<h4 class="name" id="~
|
|
5921
|
+
<h4 class="name" id="~unlockThread"><span class="type-signature type-signature-async, inner">(async, inner) </span>unlockThread<span class="signature">(threadId, brand)</span><span class="type-signature"> → {Promise.<void>}</span></h4>
|
|
4746
5922
|
|
|
4747
5923
|
|
|
4748
5924
|
|
|
@@ -4752,13 +5928,13 @@
|
|
|
4752
5928
|
<dl class="details">
|
|
4753
5929
|
|
|
4754
5930
|
<dt class="tag-description">Description:</dt>
|
|
4755
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
5931
|
+
<dd class="tag-description"><ul class="dummy"><li>Unlock a thread to allow further posts.</li></ul></dd>
|
|
4756
5932
|
|
|
4757
5933
|
|
|
4758
5934
|
|
|
4759
5935
|
<dt class="tag-source">Source:</dt>
|
|
4760
5936
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
4761
|
-
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#
|
|
5937
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line147">line 147</a>
|
|
4762
5938
|
</li></ul></dd>
|
|
4763
5939
|
|
|
4764
5940
|
|
|
@@ -4847,7 +6023,7 @@
|
|
|
4847
6023
|
|
|
4848
6024
|
|
|
4849
6025
|
|
|
4850
|
-
<td class="description last">The ID of the thread to
|
|
6026
|
+
<td class="description last">The ID of the thread to unlock.</td>
|
|
4851
6027
|
</tr>
|
|
4852
6028
|
|
|
4853
6029
|
|
|
@@ -4927,7 +6103,7 @@
|
|
|
4927
6103
|
|
|
4928
6104
|
|
|
4929
6105
|
<div class="param-desc">
|
|
4930
|
-
- A promise that resolves when the thread is
|
|
6106
|
+
- A promise that resolves when the thread is unlocked.
|
|
4931
6107
|
</div>
|
|
4932
6108
|
|
|
4933
6109
|
|
|
@@ -4954,7 +6130,7 @@
|
|
|
4954
6130
|
|
|
4955
6131
|
|
|
4956
6132
|
|
|
4957
|
-
<h4 class="name" id="~
|
|
6133
|
+
<h4 class="name" id="~unpinThread"><span class="type-signature type-signature-async, inner">(async, inner) </span>unpinThread<span class="signature">(threadId, brand)</span><span class="type-signature"> → {Promise.<void>}</span></h4>
|
|
4958
6134
|
|
|
4959
6135
|
|
|
4960
6136
|
|
|
@@ -4964,13 +6140,13 @@
|
|
|
4964
6140
|
<dl class="details">
|
|
4965
6141
|
|
|
4966
6142
|
<dt class="tag-description">Description:</dt>
|
|
4967
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
6143
|
+
<dd class="tag-description"><ul class="dummy"><li>Unpins a thread from the top of its category.</li></ul></dd>
|
|
4968
6144
|
|
|
4969
6145
|
|
|
4970
6146
|
|
|
4971
6147
|
<dt class="tag-source">Source:</dt>
|
|
4972
6148
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
4973
|
-
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#
|
|
6149
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line121">line 121</a>
|
|
4974
6150
|
</li></ul></dd>
|
|
4975
6151
|
|
|
4976
6152
|
|
|
@@ -5059,7 +6235,7 @@
|
|
|
5059
6235
|
|
|
5060
6236
|
|
|
5061
6237
|
|
|
5062
|
-
<td class="description last">The ID of the thread to
|
|
6238
|
+
<td class="description last">The ID of the thread to unpin.</td>
|
|
5063
6239
|
</tr>
|
|
5064
6240
|
|
|
5065
6241
|
|
|
@@ -5083,7 +6259,7 @@
|
|
|
5083
6259
|
|
|
5084
6260
|
|
|
5085
6261
|
|
|
5086
|
-
<td class="description last">The brand
|
|
6262
|
+
<td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
|
|
5087
6263
|
</tr>
|
|
5088
6264
|
|
|
5089
6265
|
|
|
@@ -5139,7 +6315,7 @@
|
|
|
5139
6315
|
|
|
5140
6316
|
|
|
5141
6317
|
<div class="param-desc">
|
|
5142
|
-
- A promise that resolves when the thread is
|
|
6318
|
+
- A promise that resolves when the thread is unpinned.
|
|
5143
6319
|
</div>
|
|
5144
6320
|
|
|
5145
6321
|
|
|
@@ -5166,7 +6342,7 @@
|
|
|
5166
6342
|
|
|
5167
6343
|
|
|
5168
6344
|
|
|
5169
|
-
<h4 class="name" id="~
|
|
6345
|
+
<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"> → {Promise.<ForumCategory>}</span></h4>
|
|
5170
6346
|
|
|
5171
6347
|
|
|
5172
6348
|
|
|
@@ -5176,13 +6352,13 @@
|
|
|
5176
6352
|
<dl class="details">
|
|
5177
6353
|
|
|
5178
6354
|
<dt class="tag-description">Description:</dt>
|
|
5179
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
6355
|
+
<dd class="tag-description"><ul class="dummy"><li>Creates a new forum category.</li></ul></dd>
|
|
5180
6356
|
|
|
5181
6357
|
|
|
5182
6358
|
|
|
5183
6359
|
<dt class="tag-source">Source:</dt>
|
|
5184
6360
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
5185
|
-
<a href="
|
|
6361
|
+
<a href="forums_categories.ts.html">forums/categories.ts</a>, <a href="forums_categories.ts.html#line53">line 53</a>
|
|
5186
6362
|
</li></ul></dd>
|
|
5187
6363
|
|
|
5188
6364
|
|
|
@@ -5254,37 +6430,13 @@
|
|
|
5254
6430
|
|
|
5255
6431
|
<tr>
|
|
5256
6432
|
|
|
5257
|
-
<td class="name"><code>
|
|
5258
|
-
|
|
5259
|
-
|
|
5260
|
-
<td class="type">
|
|
5261
|
-
|
|
5262
|
-
|
|
5263
|
-
<span class="param-type">number</span>
|
|
5264
|
-
|
|
5265
|
-
|
|
5266
|
-
|
|
5267
|
-
|
|
5268
|
-
</td>
|
|
5269
|
-
|
|
5270
|
-
|
|
5271
|
-
|
|
5272
|
-
|
|
5273
|
-
|
|
5274
|
-
<td class="description last">The ID of the thread to unlock.</td>
|
|
5275
|
-
</tr>
|
|
5276
|
-
|
|
5277
|
-
|
|
5278
|
-
|
|
5279
|
-
<tr>
|
|
5280
|
-
|
|
5281
|
-
<td class="name"><code>brand</code></td>
|
|
6433
|
+
<td class="name"><code>params</code></td>
|
|
5282
6434
|
|
|
5283
6435
|
|
|
5284
6436
|
<td class="type">
|
|
5285
6437
|
|
|
5286
6438
|
|
|
5287
|
-
<span class="param-type">
|
|
6439
|
+
<span class="param-type">UpdateForumCategoryParams</span>
|
|
5288
6440
|
|
|
5289
6441
|
|
|
5290
6442
|
|
|
@@ -5295,7 +6447,7 @@
|
|
|
5295
6447
|
|
|
5296
6448
|
|
|
5297
6449
|
|
|
5298
|
-
<td class="description last">The
|
|
6450
|
+
<td class="description last">The parameters for creating the forum category.</td>
|
|
5299
6451
|
</tr>
|
|
5300
6452
|
|
|
5301
6453
|
|
|
@@ -5351,7 +6503,7 @@
|
|
|
5351
6503
|
|
|
5352
6504
|
|
|
5353
6505
|
<div class="param-desc">
|
|
5354
|
-
- A promise that resolves
|
|
6506
|
+
- A promise that resolves to the created forum category.
|
|
5355
6507
|
</div>
|
|
5356
6508
|
|
|
5357
6509
|
|
|
@@ -5362,7 +6514,7 @@
|
|
|
5362
6514
|
</dt>
|
|
5363
6515
|
<dd>
|
|
5364
6516
|
|
|
5365
|
-
<span class="param-type">Promise.<
|
|
6517
|
+
<span class="param-type">Promise.<ForumCategory></span>
|
|
5366
6518
|
|
|
5367
6519
|
|
|
5368
6520
|
|
|
@@ -5378,7 +6530,7 @@
|
|
|
5378
6530
|
|
|
5379
6531
|
|
|
5380
6532
|
|
|
5381
|
-
<h4 class="name" id="~
|
|
6533
|
+
<h4 class="name" id="~updateThread"><span class="type-signature type-signature-async, inner">(async, inner) </span>updateThread<span class="signature">(threadId, params)</span><span class="type-signature"> → {Promise.<ForumThread>}</span></h4>
|
|
5382
6534
|
|
|
5383
6535
|
|
|
5384
6536
|
|
|
@@ -5388,13 +6540,13 @@
|
|
|
5388
6540
|
<dl class="details">
|
|
5389
6541
|
|
|
5390
6542
|
<dt class="tag-description">Description:</dt>
|
|
5391
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
6543
|
+
<dd class="tag-description"><ul class="dummy"><li>Updates an existing thread under a forum category.</li></ul></dd>
|
|
5392
6544
|
|
|
5393
6545
|
|
|
5394
6546
|
|
|
5395
6547
|
<dt class="tag-source">Source:</dt>
|
|
5396
6548
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
5397
|
-
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#
|
|
6549
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line36">line 36</a>
|
|
5398
6550
|
</li></ul></dd>
|
|
5399
6551
|
|
|
5400
6552
|
|
|
@@ -5483,20 +6635,20 @@
|
|
|
5483
6635
|
|
|
5484
6636
|
|
|
5485
6637
|
|
|
5486
|
-
<td class="description last">The ID of the thread to
|
|
6638
|
+
<td class="description last">The ID of the thread to update.</td>
|
|
5487
6639
|
</tr>
|
|
5488
6640
|
|
|
5489
6641
|
|
|
5490
6642
|
|
|
5491
6643
|
<tr>
|
|
5492
6644
|
|
|
5493
|
-
<td class="name"><code>
|
|
6645
|
+
<td class="name"><code>params</code></td>
|
|
5494
6646
|
|
|
5495
6647
|
|
|
5496
6648
|
<td class="type">
|
|
5497
6649
|
|
|
5498
6650
|
|
|
5499
|
-
<span class="param-type">
|
|
6651
|
+
<span class="param-type">UpdateThreadParams</span>
|
|
5500
6652
|
|
|
5501
6653
|
|
|
5502
6654
|
|
|
@@ -5507,7 +6659,7 @@
|
|
|
5507
6659
|
|
|
5508
6660
|
|
|
5509
6661
|
|
|
5510
|
-
<td class="description last">The
|
|
6662
|
+
<td class="description last">The parameters for updating the thread.</td>
|
|
5511
6663
|
</tr>
|
|
5512
6664
|
|
|
5513
6665
|
|
|
@@ -5563,7 +6715,7 @@
|
|
|
5563
6715
|
|
|
5564
6716
|
|
|
5565
6717
|
<div class="param-desc">
|
|
5566
|
-
- A promise that resolves
|
|
6718
|
+
- A promise that resolves to the updated thread.
|
|
5567
6719
|
</div>
|
|
5568
6720
|
|
|
5569
6721
|
|
|
@@ -5574,7 +6726,7 @@
|
|
|
5574
6726
|
</dt>
|
|
5575
6727
|
<dd>
|
|
5576
6728
|
|
|
5577
|
-
<span class="param-type">Promise.<
|
|
6729
|
+
<span class="param-type">Promise.<ForumThread></span>
|
|
5578
6730
|
|
|
5579
6731
|
|
|
5580
6732
|
|
|
@@ -5586,11 +6738,63 @@
|
|
|
5586
6738
|
|
|
5587
6739
|
|
|
5588
6740
|
|
|
6741
|
+
|
|
6742
|
+
|
|
6743
|
+
|
|
6744
|
+
|
|
6745
|
+
|
|
6746
|
+
</article>
|
|
6747
|
+
|
|
6748
|
+
</section>
|
|
6749
|
+
|
|
6750
|
+
|
|
6751
|
+
|
|
6752
|
+
|
|
6753
|
+
|
|
6754
|
+
|
|
6755
|
+
|
|
6756
|
+
<section>
|
|
6757
|
+
|
|
6758
|
+
<header>
|
|
6759
|
+
|
|
6760
|
+
|
|
6761
|
+
|
|
6762
|
+
</header>
|
|
6763
|
+
|
|
6764
|
+
<article>
|
|
6765
|
+
|
|
6766
|
+
<div class="container-overview">
|
|
6767
|
+
|
|
6768
|
+
|
|
6769
|
+
|
|
6770
|
+
|
|
6771
|
+
|
|
6772
|
+
</div>
|
|
6773
|
+
|
|
6774
|
+
|
|
6775
|
+
|
|
6776
|
+
|
|
6777
|
+
|
|
6778
|
+
|
|
6779
|
+
|
|
6780
|
+
|
|
6781
|
+
|
|
6782
|
+
|
|
6783
|
+
|
|
6784
|
+
|
|
6785
|
+
|
|
6786
|
+
|
|
6787
|
+
|
|
6788
|
+
|
|
6789
|
+
|
|
6790
|
+
<h3 class="subsection-title">Methods</h3>
|
|
6791
|
+
|
|
6792
|
+
|
|
5589
6793
|
|
|
5590
6794
|
|
|
5591
6795
|
|
|
5592
6796
|
|
|
5593
|
-
<h4 class="name" id="~
|
|
6797
|
+
<h4 class="name" id="~createForumCategory"><span class="type-signature type-signature-async, inner">(async, inner) </span>createForumCategory<span class="signature">(params)</span><span class="type-signature"> → {Promise.<ForumCategory>}</span></h4>
|
|
5594
6798
|
|
|
5595
6799
|
|
|
5596
6800
|
|
|
@@ -5606,7 +6810,7 @@
|
|
|
5606
6810
|
|
|
5607
6811
|
<dt class="tag-source">Source:</dt>
|
|
5608
6812
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
5609
|
-
<a href="forums_categories.ts.html">forums/categories.ts</a>, <a href="forums_categories.ts.html#
|
|
6813
|
+
<a href="forums_categories.ts.html">forums/categories.ts</a>, <a href="forums_categories.ts.html#line30">line 30</a>
|
|
5610
6814
|
</li></ul></dd>
|
|
5611
6815
|
|
|
5612
6816
|
|
|
@@ -5684,7 +6888,7 @@
|
|
|
5684
6888
|
<td class="type">
|
|
5685
6889
|
|
|
5686
6890
|
|
|
5687
|
-
<span class="param-type">
|
|
6891
|
+
<span class="param-type">CreateForumCategoryParams</span>
|
|
5688
6892
|
|
|
5689
6893
|
|
|
5690
6894
|
|
|
@@ -5778,7 +6982,7 @@
|
|
|
5778
6982
|
|
|
5779
6983
|
|
|
5780
6984
|
|
|
5781
|
-
<h4 class="name" id="~
|
|
6985
|
+
<h4 class="name" id="~createPost"><span class="type-signature type-signature-async, inner">(async, inner) </span>createPost<span class="signature">(params)</span><span class="type-signature"> → {Promise.<ForumPost>}</span></h4>
|
|
5782
6986
|
|
|
5783
6987
|
|
|
5784
6988
|
|
|
@@ -5788,13 +6992,13 @@
|
|
|
5788
6992
|
<dl class="details">
|
|
5789
6993
|
|
|
5790
6994
|
<dt class="tag-description">Description:</dt>
|
|
5791
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
6995
|
+
<dd class="tag-description"><ul class="dummy"><li>Creates a new post under a forum thread.</li></ul></dd>
|
|
5792
6996
|
|
|
5793
6997
|
|
|
5794
6998
|
|
|
5795
6999
|
<dt class="tag-source">Source:</dt>
|
|
5796
7000
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
5797
|
-
<a href="
|
|
7001
|
+
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line16">line 16</a>
|
|
5798
7002
|
</li></ul></dd>
|
|
5799
7003
|
|
|
5800
7004
|
|
|
@@ -5864,30 +7068,6 @@
|
|
|
5864
7068
|
<tbody>
|
|
5865
7069
|
|
|
5866
7070
|
|
|
5867
|
-
<tr>
|
|
5868
|
-
|
|
5869
|
-
<td class="name"><code>threadId</code></td>
|
|
5870
|
-
|
|
5871
|
-
|
|
5872
|
-
<td class="type">
|
|
5873
|
-
|
|
5874
|
-
|
|
5875
|
-
<span class="param-type">number</span>
|
|
5876
|
-
|
|
5877
|
-
|
|
5878
|
-
|
|
5879
|
-
|
|
5880
|
-
</td>
|
|
5881
|
-
|
|
5882
|
-
|
|
5883
|
-
|
|
5884
|
-
|
|
5885
|
-
|
|
5886
|
-
<td class="description last">The ID of the thread to update.</td>
|
|
5887
|
-
</tr>
|
|
5888
|
-
|
|
5889
|
-
|
|
5890
|
-
|
|
5891
7071
|
<tr>
|
|
5892
7072
|
|
|
5893
7073
|
<td class="name"><code>params</code></td>
|
|
@@ -5896,7 +7076,7 @@
|
|
|
5896
7076
|
<td class="type">
|
|
5897
7077
|
|
|
5898
7078
|
|
|
5899
|
-
<span class="param-type">
|
|
7079
|
+
<span class="param-type">CreatePostParams</span>
|
|
5900
7080
|
|
|
5901
7081
|
|
|
5902
7082
|
|
|
@@ -5907,7 +7087,7 @@
|
|
|
5907
7087
|
|
|
5908
7088
|
|
|
5909
7089
|
|
|
5910
|
-
<td class="description last">The parameters for
|
|
7090
|
+
<td class="description last">The parameters for creating the post.</td>
|
|
5911
7091
|
</tr>
|
|
5912
7092
|
|
|
5913
7093
|
|
|
@@ -5963,7 +7143,7 @@
|
|
|
5963
7143
|
|
|
5964
7144
|
|
|
5965
7145
|
<div class="param-desc">
|
|
5966
|
-
- A promise that resolves to the
|
|
7146
|
+
- A promise that resolves to the created post.
|
|
5967
7147
|
</div>
|
|
5968
7148
|
|
|
5969
7149
|
|
|
@@ -5974,7 +7154,7 @@
|
|
|
5974
7154
|
</dt>
|
|
5975
7155
|
<dd>
|
|
5976
7156
|
|
|
5977
|
-
<span class="param-type">Promise.<
|
|
7157
|
+
<span class="param-type">Promise.<ForumPost></span>
|
|
5978
7158
|
|
|
5979
7159
|
|
|
5980
7160
|
|
|
@@ -5986,63 +7166,11 @@
|
|
|
5986
7166
|
|
|
5987
7167
|
|
|
5988
7168
|
|
|
5989
|
-
|
|
5990
|
-
|
|
5991
|
-
|
|
5992
|
-
|
|
5993
|
-
|
|
5994
|
-
</article>
|
|
5995
|
-
|
|
5996
|
-
</section>
|
|
5997
|
-
|
|
5998
|
-
|
|
5999
|
-
|
|
6000
|
-
|
|
6001
|
-
|
|
6002
|
-
|
|
6003
|
-
|
|
6004
|
-
<section>
|
|
6005
|
-
|
|
6006
|
-
<header>
|
|
6007
|
-
|
|
6008
|
-
|
|
6009
|
-
|
|
6010
|
-
</header>
|
|
6011
|
-
|
|
6012
|
-
<article>
|
|
6013
|
-
|
|
6014
|
-
<div class="container-overview">
|
|
6015
|
-
|
|
6016
|
-
|
|
6017
|
-
|
|
6018
|
-
|
|
6019
|
-
|
|
6020
|
-
</div>
|
|
6021
|
-
|
|
6022
|
-
|
|
6023
|
-
|
|
6024
|
-
|
|
6025
|
-
|
|
6026
|
-
|
|
6027
|
-
|
|
6028
|
-
|
|
6029
|
-
|
|
6030
|
-
|
|
6031
|
-
|
|
6032
|
-
|
|
6033
|
-
|
|
6034
|
-
|
|
6035
|
-
|
|
6036
|
-
|
|
6037
|
-
|
|
6038
|
-
<h3 class="subsection-title">Methods</h3>
|
|
6039
|
-
|
|
6040
|
-
|
|
6041
7169
|
|
|
6042
7170
|
|
|
6043
7171
|
|
|
6044
7172
|
|
|
6045
|
-
<h4 class="name" id="~
|
|
7173
|
+
<h4 class="name" id="~createThread"><span class="type-signature type-signature-async, inner">(async, inner) </span>createThread<span class="signature">(params)</span><span class="type-signature"> → {Promise.<ForumThread>}</span></h4>
|
|
6046
7174
|
|
|
6047
7175
|
|
|
6048
7176
|
|
|
@@ -6052,13 +7180,13 @@
|
|
|
6052
7180
|
<dl class="details">
|
|
6053
7181
|
|
|
6054
7182
|
<dt class="tag-description">Description:</dt>
|
|
6055
|
-
<dd class="tag-description"><ul class="dummy"><li>Creates a new forum category.</li></ul></dd>
|
|
7183
|
+
<dd class="tag-description"><ul class="dummy"><li>Creates a new thread under a forum category.</li></ul></dd>
|
|
6056
7184
|
|
|
6057
7185
|
|
|
6058
7186
|
|
|
6059
7187
|
<dt class="tag-source">Source:</dt>
|
|
6060
7188
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
6061
|
-
<a href="
|
|
7189
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line17">line 17</a>
|
|
6062
7190
|
</li></ul></dd>
|
|
6063
7191
|
|
|
6064
7192
|
|
|
@@ -6136,7 +7264,7 @@
|
|
|
6136
7264
|
<td class="type">
|
|
6137
7265
|
|
|
6138
7266
|
|
|
6139
|
-
<span class="param-type">
|
|
7267
|
+
<span class="param-type">CreateThreadParams</span>
|
|
6140
7268
|
|
|
6141
7269
|
|
|
6142
7270
|
|
|
@@ -6147,7 +7275,7 @@
|
|
|
6147
7275
|
|
|
6148
7276
|
|
|
6149
7277
|
|
|
6150
|
-
<td class="description last">The parameters for creating the
|
|
7278
|
+
<td class="description last">The parameters for creating the thread.</td>
|
|
6151
7279
|
</tr>
|
|
6152
7280
|
|
|
6153
7281
|
|
|
@@ -6203,7 +7331,7 @@
|
|
|
6203
7331
|
|
|
6204
7332
|
|
|
6205
7333
|
<div class="param-desc">
|
|
6206
|
-
- A promise that resolves to the created
|
|
7334
|
+
- A promise that resolves to the created thread.
|
|
6207
7335
|
</div>
|
|
6208
7336
|
|
|
6209
7337
|
|
|
@@ -6214,7 +7342,7 @@
|
|
|
6214
7342
|
</dt>
|
|
6215
7343
|
<dd>
|
|
6216
7344
|
|
|
6217
|
-
<span class="param-type">Promise.<
|
|
7345
|
+
<span class="param-type">Promise.<ForumThread></span>
|
|
6218
7346
|
|
|
6219
7347
|
|
|
6220
7348
|
|
|
@@ -6230,7 +7358,7 @@
|
|
|
6230
7358
|
|
|
6231
7359
|
|
|
6232
7360
|
|
|
6233
|
-
<h4 class="name" id="~
|
|
7361
|
+
<h4 class="name" id="~fetchFollowedThreads"><span class="type-signature type-signature-async, inner">(async, inner) </span>fetchFollowedThreads<span class="signature">(brand)</span><span class="type-signature"> → {Promise.<<a href="global.html#PaginatedResponse">PaginatedResponse</a>.<ForumThread>>}</span></h4>
|
|
6234
7362
|
|
|
6235
7363
|
|
|
6236
7364
|
|
|
@@ -6240,13 +7368,13 @@
|
|
|
6240
7368
|
<dl class="details">
|
|
6241
7369
|
|
|
6242
7370
|
<dt class="tag-description">Description:</dt>
|
|
6243
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
7371
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetches followed forum Threads for the given brand and current user.</li></ul></dd>
|
|
6244
7372
|
|
|
6245
7373
|
|
|
6246
7374
|
|
|
6247
7375
|
<dt class="tag-source">Source:</dt>
|
|
6248
7376
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
6249
|
-
<a href="
|
|
7377
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line160">line 160</a>
|
|
6250
7378
|
</li></ul></dd>
|
|
6251
7379
|
|
|
6252
7380
|
|
|
@@ -6318,13 +7446,13 @@
|
|
|
6318
7446
|
|
|
6319
7447
|
<tr>
|
|
6320
7448
|
|
|
6321
|
-
<td class="name"><code>
|
|
7449
|
+
<td class="name"><code>brand</code></td>
|
|
6322
7450
|
|
|
6323
7451
|
|
|
6324
7452
|
<td class="type">
|
|
6325
7453
|
|
|
6326
7454
|
|
|
6327
|
-
<span class="param-type">
|
|
7455
|
+
<span class="param-type">string</span>
|
|
6328
7456
|
|
|
6329
7457
|
|
|
6330
7458
|
|
|
@@ -6335,7 +7463,7 @@
|
|
|
6335
7463
|
|
|
6336
7464
|
|
|
6337
7465
|
|
|
6338
|
-
<td class="description last">The
|
|
7466
|
+
<td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
|
|
6339
7467
|
</tr>
|
|
6340
7468
|
|
|
6341
7469
|
|
|
@@ -6391,7 +7519,7 @@
|
|
|
6391
7519
|
|
|
6392
7520
|
|
|
6393
7521
|
<div class="param-desc">
|
|
6394
|
-
- A promise that resolves to the
|
|
7522
|
+
- A promise that resolves to the list of forum threads.
|
|
6395
7523
|
</div>
|
|
6396
7524
|
|
|
6397
7525
|
|
|
@@ -6402,7 +7530,7 @@
|
|
|
6402
7530
|
</dt>
|
|
6403
7531
|
<dd>
|
|
6404
7532
|
|
|
6405
|
-
<span class="param-type">Promise.<
|
|
7533
|
+
<span class="param-type">Promise.<<a href="global.html#PaginatedResponse">PaginatedResponse</a>.<ForumThread>></span>
|
|
6406
7534
|
|
|
6407
7535
|
|
|
6408
7536
|
|
|
@@ -6418,7 +7546,7 @@
|
|
|
6418
7546
|
|
|
6419
7547
|
|
|
6420
7548
|
|
|
6421
|
-
<h4 class="name" id="~
|
|
7549
|
+
<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"> → {Promise.<ForumCategory>}</span></h4>
|
|
6422
7550
|
|
|
6423
7551
|
|
|
6424
7552
|
|
|
@@ -6428,13 +7556,13 @@
|
|
|
6428
7556
|
<dl class="details">
|
|
6429
7557
|
|
|
6430
7558
|
<dt class="tag-description">Description:</dt>
|
|
6431
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
7559
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetches forum categories for the given brand.</li></ul></dd>
|
|
6432
7560
|
|
|
6433
7561
|
|
|
6434
7562
|
|
|
6435
7563
|
<dt class="tag-source">Source:</dt>
|
|
6436
7564
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
6437
|
-
<a href="
|
|
7565
|
+
<a href="forums_categories.ts.html">forums/categories.ts</a>, <a href="forums_categories.ts.html#line10">line 10</a>
|
|
6438
7566
|
</li></ul></dd>
|
|
6439
7567
|
|
|
6440
7568
|
|
|
@@ -6506,13 +7634,16 @@
|
|
|
6506
7634
|
|
|
6507
7635
|
<tr>
|
|
6508
7636
|
|
|
6509
|
-
<td class="name"><code>
|
|
7637
|
+
<td class="name"><code>brand</code></td>
|
|
6510
7638
|
|
|
6511
7639
|
|
|
6512
7640
|
<td class="type">
|
|
6513
7641
|
|
|
6514
7642
|
|
|
6515
|
-
<span class="param-type">
|
|
7643
|
+
<span class="param-type">string</span>
|
|
7644
|
+
|
|
|
7645
|
+
|
|
7646
|
+
<span class="param-type">null</span>
|
|
6516
7647
|
|
|
6517
7648
|
|
|
6518
7649
|
|
|
@@ -6523,7 +7654,7 @@
|
|
|
6523
7654
|
|
|
6524
7655
|
|
|
6525
7656
|
|
|
6526
|
-
<td class="description last">The
|
|
7657
|
+
<td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
|
|
6527
7658
|
</tr>
|
|
6528
7659
|
|
|
6529
7660
|
|
|
@@ -6579,7 +7710,7 @@
|
|
|
6579
7710
|
|
|
6580
7711
|
|
|
6581
7712
|
<div class="param-desc">
|
|
6582
|
-
- A promise that resolves to the
|
|
7713
|
+
- A promise that resolves to the list of forum categories.
|
|
6583
7714
|
</div>
|
|
6584
7715
|
|
|
6585
7716
|
|
|
@@ -6590,7 +7721,7 @@
|
|
|
6590
7721
|
</dt>
|
|
6591
7722
|
<dd>
|
|
6592
7723
|
|
|
6593
|
-
<span class="param-type">Promise.<
|
|
7724
|
+
<span class="param-type">Promise.<ForumCategory></span>
|
|
6594
7725
|
|
|
6595
7726
|
|
|
6596
7727
|
|
|
@@ -6606,7 +7737,7 @@
|
|
|
6606
7737
|
|
|
6607
7738
|
|
|
6608
7739
|
|
|
6609
|
-
<h4 class="name" id="~
|
|
7740
|
+
<h4 class="name" id="~fetchLatestThreads"><span class="type-signature type-signature-async, inner">(async, inner) </span>fetchLatestThreads<span class="signature">(brand)</span><span class="type-signature"> → {Promise.<<a href="global.html#PaginatedResponse">PaginatedResponse</a>.<ForumThread>>}</span></h4>
|
|
6610
7741
|
|
|
6611
7742
|
|
|
6612
7743
|
|
|
@@ -6616,13 +7747,13 @@
|
|
|
6616
7747
|
<dl class="details">
|
|
6617
7748
|
|
|
6618
7749
|
<dt class="tag-description">Description:</dt>
|
|
6619
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetches forum
|
|
7750
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetches latest forum Threads for the given brand and not blocked to current user.</li></ul></dd>
|
|
6620
7751
|
|
|
6621
7752
|
|
|
6622
7753
|
|
|
6623
7754
|
<dt class="tag-source">Source:</dt>
|
|
6624
7755
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
6625
|
-
<a href="
|
|
7756
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line174">line 174</a>
|
|
6626
7757
|
</li></ul></dd>
|
|
6627
7758
|
|
|
6628
7759
|
|
|
@@ -6701,9 +7832,6 @@
|
|
|
6701
7832
|
|
|
6702
7833
|
|
|
6703
7834
|
<span class="param-type">string</span>
|
|
6704
|
-
|
|
|
6705
|
-
|
|
6706
|
-
<span class="param-type">null</span>
|
|
6707
7835
|
|
|
6708
7836
|
|
|
6709
7837
|
|
|
@@ -6770,7 +7898,7 @@
|
|
|
6770
7898
|
|
|
6771
7899
|
|
|
6772
7900
|
<div class="param-desc">
|
|
6773
|
-
- A promise that resolves to the list of forum
|
|
7901
|
+
- A promise that resolves to the list of forum threads.
|
|
6774
7902
|
</div>
|
|
6775
7903
|
|
|
6776
7904
|
|
|
@@ -6781,7 +7909,7 @@
|
|
|
6781
7909
|
</dt>
|
|
6782
7910
|
<dd>
|
|
6783
7911
|
|
|
6784
|
-
<span class="param-type">Promise.<
|
|
7912
|
+
<span class="param-type">Promise.<<a href="global.html#PaginatedResponse">PaginatedResponse</a>.<ForumThread>></span>
|
|
6785
7913
|
|
|
6786
7914
|
|
|
6787
7915
|
|
|
@@ -8984,7 +10112,7 @@
|
|
|
8984
10112
|
<br class="clear">
|
|
8985
10113
|
|
|
8986
10114
|
<footer>
|
|
8987
|
-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on
|
|
10115
|
+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Mon Sep 29 2025 11:36:51 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
|
|
8988
10116
|
</footer>
|
|
8989
10117
|
|
|
8990
10118
|
<script>prettyPrint();</script>
|