musora-content-services 2.44.0 → 2.46.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/.claude/settings.local.json +8 -0
- package/.coderabbit.yaml +0 -0
- package/.editorconfig +0 -0
- package/.github/pull_request_template.md +0 -0
- package/.github/workflows/conventional-commits.yaml +0 -0
- package/.github/workflows/docs.js.yml +0 -0
- package/.github/workflows/node.js.yml +0 -0
- package/.prettierignore +0 -0
- package/.prettierrc +0 -0
- package/CHANGELOG.md +19 -0
- package/README.md +0 -0
- package/babel.config.cjs +0 -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/fonts/Montserrat/Montserrat-Bold.eot +0 -0
- package/docs/fonts/Montserrat/Montserrat-Bold.ttf +0 -0
- package/docs/fonts/Montserrat/Montserrat-Bold.woff +0 -0
- package/docs/fonts/Montserrat/Montserrat-Bold.woff2 +0 -0
- package/docs/fonts/Montserrat/Montserrat-Regular.eot +0 -0
- package/docs/fonts/Montserrat/Montserrat-Regular.ttf +0 -0
- package/docs/fonts/Montserrat/Montserrat-Regular.woff +0 -0
- package/docs/fonts/Montserrat/Montserrat-Regular.woff2 +0 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.eot +0 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.svg +0 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.ttf +0 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff +0 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-light-webfont.woff2 +0 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.eot +0 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.svg +0 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.ttf +0 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff +0 -0
- package/docs/fonts/Source-Sans-Pro/sourcesanspro-regular-webfont.woff2 +0 -0
- package/docs/forums_categories.ts.html +2 -2
- package/docs/forums_discussions.js.html +0 -0
- package/docs/forums_forum.js.html +0 -0
- package/docs/forums_forums.ts.html +2 -2
- package/docs/forums_posts.ts.html +132 -0
- package/docs/forums_threads.ts.html +2 -2
- package/docs/gamification_awards.js.html +0 -0
- package/docs/gamification_awards.ts.html +2 -2
- package/docs/gamification_gamification.js.html +2 -2
- package/docs/gamification_types.js.html +0 -0
- 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-Config.html +2 -2
- package/docs/module-Content-Services-V2.html +2 -2
- package/docs/module-ForumDiscussions.html +0 -0
- package/docs/module-Forums.html +4085 -202
- 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-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/scripts/collapse.js +0 -0
- package/docs/scripts/commonNav.js +0 -0
- package/docs/scripts/linenumber.js +0 -0
- package/docs/scripts/nav.js +0 -0
- package/docs/scripts/polyfill.js +0 -0
- package/docs/scripts/prettify/Apache-License-2.0.txt +0 -0
- package/docs/scripts/prettify/lang-css.js +0 -0
- package/docs/scripts/prettify/prettify.js +0 -0
- package/docs/scripts/search.js +0 -0
- package/docs/styles/jsdoc.css +0 -0
- package/docs/styles/prettify.css +0 -0
- package/docs/userActivity.js.html +2 -2
- 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 +5 -5
- package/docs/user_types.js.html +2 -2
- package/docs/user_user-management-system.js.html +2 -2
- package/jest.config.js +0 -0
- package/jsdoc.json +0 -0
- package/package.json +1 -1
- package/src/contentMetaData.js +31 -362
- package/src/contentTypeConfig.js +3 -2
- package/src/filterBuilder.js +0 -0
- package/src/index.d.ts +7 -2
- package/src/index.js +7 -2
- package/src/infrastructure/http/HttpClient.ts +0 -0
- package/src/infrastructure/http/executors/FetchRequestExecutor.ts +0 -0
- package/src/infrastructure/http/index.ts +0 -0
- package/src/infrastructure/http/interfaces/HeaderProvider.ts +0 -0
- package/src/infrastructure/http/interfaces/HttpError.ts +0 -0
- package/src/infrastructure/http/interfaces/NetworkError.ts +0 -0
- package/src/infrastructure/http/interfaces/RequestExecutor.ts +0 -0
- package/src/infrastructure/http/interfaces/RequestOptions.ts +0 -0
- package/src/infrastructure/http/providers/DefaultHeaderProvider.ts +0 -0
- package/src/lib/httpHelper.js +0 -0
- package/src/lib/lastUpdated.js +0 -0
- package/src/services/api/types.js +0 -0
- package/src/services/api/types.ts +0 -0
- package/src/services/config.js +0 -0
- package/src/services/content-org/content-org.js +0 -0
- package/src/services/content-org/guided-courses.ts +0 -0
- package/src/services/content-org/playlists-types.js +0 -0
- package/src/services/content-org/playlists.js +0 -0
- package/src/services/content.js +0 -0
- package/src/services/contentAggregator.js +0 -0
- package/src/services/contentLikes.js +0 -0
- package/src/services/dataContext.js +0 -0
- package/src/services/dateUtils.js +0 -0
- package/src/services/eventsAPI.js +0 -0
- package/src/services/forum.js +0 -0
- package/src/services/forums/forums.ts +0 -0
- package/src/services/forums/posts.ts +60 -0
- package/src/services/forums/types.ts +2 -0
- package/src/services/gamification/gamification.js +0 -0
- package/src/services/imageSRCBuilder.js +0 -0
- package/src/services/imageSRCVerify.js +0 -0
- package/src/services/railcontent.js +0 -0
- package/src/services/recommendations.js +0 -0
- package/src/services/types.js +0 -0
- package/src/services/user/account.ts +0 -0
- package/src/services/user/chat.js +0 -0
- package/src/services/user/interests.js +0 -0
- package/src/services/user/management.js +0 -0
- package/src/services/user/notifications.js +0 -0
- package/src/services/user/payments.ts +0 -0
- package/src/services/user/permissions.js +0 -0
- package/src/services/user/profile.js +0 -0
- package/src/services/user/sessions.js +3 -3
- package/src/services/user/types.js +0 -0
- package/src/services/user/user-management-system.js +0 -0
- package/src/services/userActivity.js +1 -1
- package/test/HttpClient.test.js +0 -0
- package/test/content.test.js +0 -0
- package/test/contentLikes.test.js +0 -0
- package/test/contentProgress.test.js +0 -0
- package/test/dataContext.test.js +0 -0
- package/test/forum.test.js +0 -0
- package/test/imageSRCBuilder.test.js +0 -0
- package/test/imageSRCVerify.test.js +0 -0
- package/test/initializeTests.js +0 -0
- package/test/lib/lastUpdated.test.js +0 -0
- package/test/live/contentProgressLive.test.js +0 -0
- package/test/live/railcontentLive.test.js +0 -0
- package/test/localStorageMock.js +0 -0
- package/test/log.js +0 -0
- package/test/mockData/mockData_fetchByRailContentIds_one_content.json +0 -0
- package/test/mockData/mockData_progress_content.json +0 -0
- package/test/mockData/mockData_sanity_progress_content.json +0 -0
- package/test/mockData/mockData_user_practices.json +0 -0
- package/test/notifications.test.js +0 -0
- package/test/progressRows.test.js +0 -0
- package/test/sanityQueryService.test.js +0 -0
- package/test/streakMessage.test.js +0 -0
- package/test/user/permissions.test.js +0 -0
- package/test/userActivity.test.js +0 -0
- package/tools/generate-index.cjs +0 -0
- package/.yarnrc.yml +0 -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#~createThread">createThread</a></li><li data-type='method'><a href="module-Forums.html#~fetchForumCategories">fetchForumCategories</a></li><li data-type='method'><a href="module-Forums.html#~fetchThreads">fetchThreads</a></li><li data-type='method'><a href="module-Forums.html#~followThread">followThread</a></li><li data-type='method'><a href="module-Forums.html#~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><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#~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>
|
|
33
33
|
|
|
34
34
|
</nav>
|
|
35
35
|
|
|
@@ -272,7 +272,7 @@
|
|
|
272
272
|
|
|
273
273
|
|
|
274
274
|
|
|
275
|
-
<h4 class="name" id="~
|
|
275
|
+
<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>
|
|
276
276
|
|
|
277
277
|
|
|
278
278
|
|
|
@@ -282,13 +282,13 @@
|
|
|
282
282
|
<dl class="details">
|
|
283
283
|
|
|
284
284
|
<dt class="tag-description">Description:</dt>
|
|
285
|
-
<dd class="tag-description"><ul class="dummy"><li>Creates a new
|
|
285
|
+
<dd class="tag-description"><ul class="dummy"><li>Creates a new post under a forum thread.</li></ul></dd>
|
|
286
286
|
|
|
287
287
|
|
|
288
288
|
|
|
289
289
|
<dt class="tag-source">Source:</dt>
|
|
290
290
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
291
|
-
<a href="
|
|
291
|
+
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line16">line 16</a>
|
|
292
292
|
</li></ul></dd>
|
|
293
293
|
|
|
294
294
|
|
|
@@ -366,7 +366,7 @@
|
|
|
366
366
|
<td class="type">
|
|
367
367
|
|
|
368
368
|
|
|
369
|
-
<span class="param-type">
|
|
369
|
+
<span class="param-type">CreatePostParams</span>
|
|
370
370
|
|
|
371
371
|
|
|
372
372
|
|
|
@@ -377,7 +377,7 @@
|
|
|
377
377
|
|
|
378
378
|
|
|
379
379
|
|
|
380
|
-
<td class="description last">The parameters for creating the
|
|
380
|
+
<td class="description last">The parameters for creating the post.</td>
|
|
381
381
|
</tr>
|
|
382
382
|
|
|
383
383
|
|
|
@@ -433,7 +433,7 @@
|
|
|
433
433
|
|
|
434
434
|
|
|
435
435
|
<div class="param-desc">
|
|
436
|
-
- A promise that resolves to the created
|
|
436
|
+
- A promise that resolves to the created post.
|
|
437
437
|
</div>
|
|
438
438
|
|
|
439
439
|
|
|
@@ -444,7 +444,7 @@
|
|
|
444
444
|
</dt>
|
|
445
445
|
<dd>
|
|
446
446
|
|
|
447
|
-
<span class="param-type">Promise.<
|
|
447
|
+
<span class="param-type">Promise.<ForumPost></span>
|
|
448
448
|
|
|
449
449
|
|
|
450
450
|
|
|
@@ -460,7 +460,7 @@
|
|
|
460
460
|
|
|
461
461
|
|
|
462
462
|
|
|
463
|
-
<h4 class="name" id="~
|
|
463
|
+
<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>
|
|
464
464
|
|
|
465
465
|
|
|
466
466
|
|
|
@@ -470,13 +470,13 @@
|
|
|
470
470
|
<dl class="details">
|
|
471
471
|
|
|
472
472
|
<dt class="tag-description">Description:</dt>
|
|
473
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
473
|
+
<dd class="tag-description"><ul class="dummy"><li>Creates a new thread under a forum category.</li></ul></dd>
|
|
474
474
|
|
|
475
475
|
|
|
476
476
|
|
|
477
477
|
<dt class="tag-source">Source:</dt>
|
|
478
478
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
479
|
-
<a href="
|
|
479
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line17">line 17</a>
|
|
480
480
|
</li></ul></dd>
|
|
481
481
|
|
|
482
482
|
|
|
@@ -548,16 +548,13 @@
|
|
|
548
548
|
|
|
549
549
|
<tr>
|
|
550
550
|
|
|
551
|
-
<td class="name"><code>
|
|
551
|
+
<td class="name"><code>params</code></td>
|
|
552
552
|
|
|
553
553
|
|
|
554
554
|
<td class="type">
|
|
555
555
|
|
|
556
556
|
|
|
557
|
-
<span class="param-type">
|
|
558
|
-
|
|
|
559
|
-
|
|
560
|
-
<span class="param-type">null</span>
|
|
557
|
+
<span class="param-type">CreateThreadParams</span>
|
|
561
558
|
|
|
562
559
|
|
|
563
560
|
|
|
@@ -568,7 +565,7 @@
|
|
|
568
565
|
|
|
569
566
|
|
|
570
567
|
|
|
571
|
-
<td class="description last">The
|
|
568
|
+
<td class="description last">The parameters for creating the thread.</td>
|
|
572
569
|
</tr>
|
|
573
570
|
|
|
574
571
|
|
|
@@ -624,7 +621,7 @@
|
|
|
624
621
|
|
|
625
622
|
|
|
626
623
|
<div class="param-desc">
|
|
627
|
-
- A promise that resolves to the
|
|
624
|
+
- A promise that resolves to the created thread.
|
|
628
625
|
</div>
|
|
629
626
|
|
|
630
627
|
|
|
@@ -635,7 +632,7 @@
|
|
|
635
632
|
</dt>
|
|
636
633
|
<dd>
|
|
637
634
|
|
|
638
|
-
<span class="param-type">Promise.<
|
|
635
|
+
<span class="param-type">Promise.<ForumThread></span>
|
|
639
636
|
|
|
640
637
|
|
|
641
638
|
|
|
@@ -651,7 +648,7 @@
|
|
|
651
648
|
|
|
652
649
|
|
|
653
650
|
|
|
654
|
-
<h4 class="name" id="~
|
|
651
|
+
<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>
|
|
655
652
|
|
|
656
653
|
|
|
657
654
|
|
|
@@ -661,13 +658,13 @@
|
|
|
661
658
|
<dl class="details">
|
|
662
659
|
|
|
663
660
|
<dt class="tag-description">Description:</dt>
|
|
664
|
-
<dd class="tag-description"><ul class="dummy"><li>Fetches forum
|
|
661
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetches forum categories for the given brand.</li></ul></dd>
|
|
665
662
|
|
|
666
663
|
|
|
667
664
|
|
|
668
665
|
<dt class="tag-source">Source:</dt>
|
|
669
666
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
670
|
-
<a href="
|
|
667
|
+
<a href="forums_categories.ts.html">forums/categories.ts</a>, <a href="forums_categories.ts.html#line10">line 10</a>
|
|
671
668
|
</li></ul></dd>
|
|
672
669
|
|
|
673
670
|
|
|
@@ -737,30 +734,6 @@
|
|
|
737
734
|
<tbody>
|
|
738
735
|
|
|
739
736
|
|
|
740
|
-
<tr>
|
|
741
|
-
|
|
742
|
-
<td class="name"><code>categoryId</code></td>
|
|
743
|
-
|
|
744
|
-
|
|
745
|
-
<td class="type">
|
|
746
|
-
|
|
747
|
-
|
|
748
|
-
<span class="param-type">number</span>
|
|
749
|
-
|
|
750
|
-
|
|
751
|
-
|
|
752
|
-
|
|
753
|
-
</td>
|
|
754
|
-
|
|
755
|
-
|
|
756
|
-
|
|
757
|
-
|
|
758
|
-
|
|
759
|
-
<td class="description last">The ID of the forum category.</td>
|
|
760
|
-
</tr>
|
|
761
|
-
|
|
762
|
-
|
|
763
|
-
|
|
764
737
|
<tr>
|
|
765
738
|
|
|
766
739
|
<td class="name"><code>brand</code></td>
|
|
@@ -770,30 +743,9 @@
|
|
|
770
743
|
|
|
771
744
|
|
|
772
745
|
<span class="param-type">string</span>
|
|
746
|
+
|
|
|
773
747
|
|
|
774
|
-
|
|
775
|
-
|
|
776
|
-
|
|
777
|
-
</td>
|
|
778
|
-
|
|
779
|
-
|
|
780
|
-
|
|
781
|
-
|
|
782
|
-
|
|
783
|
-
<td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
|
|
784
|
-
</tr>
|
|
785
|
-
|
|
786
|
-
|
|
787
|
-
|
|
788
|
-
<tr>
|
|
789
|
-
|
|
790
|
-
<td class="name"><code>params</code></td>
|
|
791
|
-
|
|
792
|
-
|
|
793
|
-
<td class="type">
|
|
794
|
-
|
|
795
|
-
|
|
796
|
-
<span class="param-type">FetchThreadParams</span>
|
|
748
|
+
<span class="param-type">null</span>
|
|
797
749
|
|
|
798
750
|
|
|
799
751
|
|
|
@@ -804,7 +756,7 @@
|
|
|
804
756
|
|
|
805
757
|
|
|
806
758
|
|
|
807
|
-
<td class="description last">
|
|
759
|
+
<td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
|
|
808
760
|
</tr>
|
|
809
761
|
|
|
810
762
|
|
|
@@ -831,7 +783,7 @@
|
|
|
831
783
|
<dl>
|
|
832
784
|
<dt>
|
|
833
785
|
<div class="param-desc usertext">
|
|
834
|
-
- If the
|
|
786
|
+
- If the request fails.
|
|
835
787
|
</div>
|
|
836
788
|
</dt>
|
|
837
789
|
<dd></dd>
|
|
@@ -860,7 +812,7 @@
|
|
|
860
812
|
|
|
861
813
|
|
|
862
814
|
<div class="param-desc">
|
|
863
|
-
- A promise that resolves to
|
|
815
|
+
- A promise that resolves to the list of forum categories.
|
|
864
816
|
</div>
|
|
865
817
|
|
|
866
818
|
|
|
@@ -871,7 +823,7 @@
|
|
|
871
823
|
</dt>
|
|
872
824
|
<dd>
|
|
873
825
|
|
|
874
|
-
<span class="param-type">Promise.<
|
|
826
|
+
<span class="param-type">Promise.<ForumCategory></span>
|
|
875
827
|
|
|
876
828
|
|
|
877
829
|
|
|
@@ -887,7 +839,7 @@
|
|
|
887
839
|
|
|
888
840
|
|
|
889
841
|
|
|
890
|
-
<h4 class="name" id="~
|
|
842
|
+
<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>
|
|
891
843
|
|
|
892
844
|
|
|
893
845
|
|
|
@@ -897,13 +849,13 @@
|
|
|
897
849
|
<dl class="details">
|
|
898
850
|
|
|
899
851
|
<dt class="tag-description">Description:</dt>
|
|
900
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
852
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetches posts for the given thread.</li></ul></dd>
|
|
901
853
|
|
|
902
854
|
|
|
903
855
|
|
|
904
856
|
<dt class="tag-source">Source:</dt>
|
|
905
857
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
906
|
-
<a href="
|
|
858
|
+
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line37">line 37</a>
|
|
907
859
|
</li></ul></dd>
|
|
908
860
|
|
|
909
861
|
|
|
@@ -963,6 +915,8 @@
|
|
|
963
915
|
<th>Type</th>
|
|
964
916
|
|
|
965
917
|
|
|
918
|
+
<th>Attributes</th>
|
|
919
|
+
|
|
966
920
|
|
|
967
921
|
|
|
968
922
|
|
|
@@ -989,10 +943,18 @@
|
|
|
989
943
|
</td>
|
|
990
944
|
|
|
991
945
|
|
|
946
|
+
<td class="attributes">
|
|
947
|
+
|
|
948
|
+
|
|
949
|
+
|
|
950
|
+
|
|
951
|
+
|
|
952
|
+
</td>
|
|
953
|
+
|
|
992
954
|
|
|
993
955
|
|
|
994
956
|
|
|
995
|
-
<td class="description last">The ID of the thread
|
|
957
|
+
<td class="description last">The ID of the forum thread.</td>
|
|
996
958
|
</tr>
|
|
997
959
|
|
|
998
960
|
|
|
@@ -1013,10 +975,52 @@
|
|
|
1013
975
|
</td>
|
|
1014
976
|
|
|
1015
977
|
|
|
978
|
+
<td class="attributes">
|
|
979
|
+
|
|
980
|
+
|
|
981
|
+
|
|
982
|
+
|
|
983
|
+
|
|
984
|
+
</td>
|
|
985
|
+
|
|
1016
986
|
|
|
1017
987
|
|
|
1018
988
|
|
|
1019
|
-
<td class="description last">The brand
|
|
989
|
+
<td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
|
|
990
|
+
</tr>
|
|
991
|
+
|
|
992
|
+
|
|
993
|
+
|
|
994
|
+
<tr>
|
|
995
|
+
|
|
996
|
+
<td class="name"><code>params</code></td>
|
|
997
|
+
|
|
998
|
+
|
|
999
|
+
<td class="type">
|
|
1000
|
+
|
|
1001
|
+
|
|
1002
|
+
<span class="param-type">FetchPostParams</span>
|
|
1003
|
+
|
|
1004
|
+
|
|
1005
|
+
|
|
1006
|
+
|
|
1007
|
+
</td>
|
|
1008
|
+
|
|
1009
|
+
|
|
1010
|
+
<td class="attributes">
|
|
1011
|
+
|
|
1012
|
+
<optional><br>
|
|
1013
|
+
|
|
1014
|
+
|
|
1015
|
+
|
|
1016
|
+
|
|
1017
|
+
|
|
1018
|
+
</td>
|
|
1019
|
+
|
|
1020
|
+
|
|
1021
|
+
|
|
1022
|
+
|
|
1023
|
+
<td class="description last">Optional parameters such as `page`, `limit`, and `sort`.</td>
|
|
1020
1024
|
</tr>
|
|
1021
1025
|
|
|
1022
1026
|
|
|
@@ -1072,7 +1076,7 @@
|
|
|
1072
1076
|
|
|
1073
1077
|
|
|
1074
1078
|
<div class="param-desc">
|
|
1075
|
-
-
|
|
1079
|
+
- Resolves to a paginated list of forum posts.
|
|
1076
1080
|
</div>
|
|
1077
1081
|
|
|
1078
1082
|
|
|
@@ -1083,7 +1087,7 @@
|
|
|
1083
1087
|
</dt>
|
|
1084
1088
|
<dd>
|
|
1085
1089
|
|
|
1086
|
-
<span class="param-type">Promise.<
|
|
1090
|
+
<span class="param-type">Promise.<<a href="global.html#PaginatedResponse">PaginatedResponse</a>.<ForumPost>></span>
|
|
1087
1091
|
|
|
1088
1092
|
|
|
1089
1093
|
|
|
@@ -1099,7 +1103,7 @@
|
|
|
1099
1103
|
|
|
1100
1104
|
|
|
1101
1105
|
|
|
1102
|
-
<h4 class="name" id="~
|
|
1106
|
+
<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>
|
|
1103
1107
|
|
|
1104
1108
|
|
|
1105
1109
|
|
|
@@ -1109,13 +1113,13 @@
|
|
|
1109
1113
|
<dl class="details">
|
|
1110
1114
|
|
|
1111
1115
|
<dt class="tag-description">Description:</dt>
|
|
1112
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
1116
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetches forum threads for the given category.</li></ul></dd>
|
|
1113
1117
|
|
|
1114
1118
|
|
|
1115
1119
|
|
|
1116
1120
|
<dt class="tag-source">Source:</dt>
|
|
1117
1121
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
1118
|
-
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#
|
|
1122
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line84">line 84</a>
|
|
1119
1123
|
</li></ul></dd>
|
|
1120
1124
|
|
|
1121
1125
|
|
|
@@ -1187,7 +1191,7 @@
|
|
|
1187
1191
|
|
|
1188
1192
|
<tr>
|
|
1189
1193
|
|
|
1190
|
-
<td class="name"><code>
|
|
1194
|
+
<td class="name"><code>categoryId</code></td>
|
|
1191
1195
|
|
|
1192
1196
|
|
|
1193
1197
|
<td class="type">
|
|
@@ -1204,7 +1208,7 @@
|
|
|
1204
1208
|
|
|
1205
1209
|
|
|
1206
1210
|
|
|
1207
|
-
<td class="description last">The ID of the
|
|
1211
|
+
<td class="description last">The ID of the forum category.</td>
|
|
1208
1212
|
</tr>
|
|
1209
1213
|
|
|
1210
1214
|
|
|
@@ -1232,6 +1236,30 @@
|
|
|
1232
1236
|
</tr>
|
|
1233
1237
|
|
|
1234
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>
|
|
1260
|
+
</tr>
|
|
1261
|
+
|
|
1262
|
+
|
|
1235
1263
|
</tbody>
|
|
1236
1264
|
</table>
|
|
1237
1265
|
|
|
@@ -1255,7 +1283,7 @@
|
|
|
1255
1283
|
<dl>
|
|
1256
1284
|
<dt>
|
|
1257
1285
|
<div class="param-desc usertext">
|
|
1258
|
-
- If the request fails.
|
|
1286
|
+
- If the HTTP request fails.
|
|
1259
1287
|
</div>
|
|
1260
1288
|
</dt>
|
|
1261
1289
|
<dd></dd>
|
|
@@ -1284,7 +1312,7 @@
|
|
|
1284
1312
|
|
|
1285
1313
|
|
|
1286
1314
|
<div class="param-desc">
|
|
1287
|
-
- A promise that resolves
|
|
1315
|
+
- A promise that resolves to a paginated list of forum threads.
|
|
1288
1316
|
</div>
|
|
1289
1317
|
|
|
1290
1318
|
|
|
@@ -1295,7 +1323,7 @@
|
|
|
1295
1323
|
</dt>
|
|
1296
1324
|
<dd>
|
|
1297
1325
|
|
|
1298
|
-
<span class="param-type">Promise.<
|
|
1326
|
+
<span class="param-type">Promise.<<a href="global.html#PaginatedResponse">PaginatedResponse</a>.<ForumThread>></span>
|
|
1299
1327
|
|
|
1300
1328
|
|
|
1301
1329
|
|
|
@@ -1311,7 +1339,7 @@
|
|
|
1311
1339
|
|
|
1312
1340
|
|
|
1313
1341
|
|
|
1314
|
-
<h4 class="name" id="~
|
|
1342
|
+
<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>
|
|
1315
1343
|
|
|
1316
1344
|
|
|
1317
1345
|
|
|
@@ -1321,13 +1349,13 @@
|
|
|
1321
1349
|
<dl class="details">
|
|
1322
1350
|
|
|
1323
1351
|
<dt class="tag-description">Description:</dt>
|
|
1324
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
1352
|
+
<dd class="tag-description"><ul class="dummy"><li>Follow a thread.</li></ul></dd>
|
|
1325
1353
|
|
|
1326
1354
|
|
|
1327
1355
|
|
|
1328
1356
|
<dt class="tag-source">Source:</dt>
|
|
1329
1357
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
1330
|
-
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#
|
|
1358
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line52">line 52</a>
|
|
1331
1359
|
</li></ul></dd>
|
|
1332
1360
|
|
|
1333
1361
|
|
|
@@ -1416,7 +1444,7 @@
|
|
|
1416
1444
|
|
|
1417
1445
|
|
|
1418
1446
|
|
|
1419
|
-
<td class="description last">The ID of the thread to
|
|
1447
|
+
<td class="description last">The ID of the thread to lock.</td>
|
|
1420
1448
|
</tr>
|
|
1421
1449
|
|
|
1422
1450
|
|
|
@@ -1440,7 +1468,7 @@
|
|
|
1440
1468
|
|
|
1441
1469
|
|
|
1442
1470
|
|
|
1443
|
-
<td class="description last">The brand
|
|
1471
|
+
<td class="description last">The brand associated with the follow action.</td>
|
|
1444
1472
|
</tr>
|
|
1445
1473
|
|
|
1446
1474
|
|
|
@@ -1496,7 +1524,7 @@
|
|
|
1496
1524
|
|
|
1497
1525
|
|
|
1498
1526
|
<div class="param-desc">
|
|
1499
|
-
- A promise that resolves when the thread is
|
|
1527
|
+
- A promise that resolves when the thread is locked.
|
|
1500
1528
|
</div>
|
|
1501
1529
|
|
|
1502
1530
|
|
|
@@ -1523,7 +1551,7 @@
|
|
|
1523
1551
|
|
|
1524
1552
|
|
|
1525
1553
|
|
|
1526
|
-
<h4 class="name" id="~
|
|
1554
|
+
<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>
|
|
1527
1555
|
|
|
1528
1556
|
|
|
1529
1557
|
|
|
@@ -1533,13 +1561,13 @@
|
|
|
1533
1561
|
<dl class="details">
|
|
1534
1562
|
|
|
1535
1563
|
<dt class="tag-description">Description:</dt>
|
|
1536
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
1564
|
+
<dd class="tag-description"><ul class="dummy"><li>Locks a thread to prevent further posts.</li></ul></dd>
|
|
1537
1565
|
|
|
1538
1566
|
|
|
1539
1567
|
|
|
1540
1568
|
<dt class="tag-source">Source:</dt>
|
|
1541
1569
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
1542
|
-
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#
|
|
1570
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line134">line 134</a>
|
|
1543
1571
|
</li></ul></dd>
|
|
1544
1572
|
|
|
1545
1573
|
|
|
@@ -1628,7 +1656,7 @@
|
|
|
1628
1656
|
|
|
1629
1657
|
|
|
1630
1658
|
|
|
1631
|
-
<td class="description last">The ID of the thread to
|
|
1659
|
+
<td class="description last">The ID of the thread to lock.</td>
|
|
1632
1660
|
</tr>
|
|
1633
1661
|
|
|
1634
1662
|
|
|
@@ -1652,7 +1680,7 @@
|
|
|
1652
1680
|
|
|
1653
1681
|
|
|
1654
1682
|
|
|
1655
|
-
<td class="description last">The brand
|
|
1683
|
+
<td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
|
|
1656
1684
|
</tr>
|
|
1657
1685
|
|
|
1658
1686
|
|
|
@@ -1708,7 +1736,7 @@
|
|
|
1708
1736
|
|
|
1709
1737
|
|
|
1710
1738
|
<div class="param-desc">
|
|
1711
|
-
- A promise that resolves when the thread is
|
|
1739
|
+
- A promise that resolves when the thread is locked.
|
|
1712
1740
|
</div>
|
|
1713
1741
|
|
|
1714
1742
|
|
|
@@ -1735,7 +1763,7 @@
|
|
|
1735
1763
|
|
|
1736
1764
|
|
|
1737
1765
|
|
|
1738
|
-
<h4 class="name" id="~
|
|
1766
|
+
<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>
|
|
1739
1767
|
|
|
1740
1768
|
|
|
1741
1769
|
|
|
@@ -1745,13 +1773,13 @@
|
|
|
1745
1773
|
<dl class="details">
|
|
1746
1774
|
|
|
1747
1775
|
<dt class="tag-description">Description:</dt>
|
|
1748
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
1776
|
+
<dd class="tag-description"><ul class="dummy"><li>Pins a thread to the top of its category.</li></ul></dd>
|
|
1749
1777
|
|
|
1750
1778
|
|
|
1751
1779
|
|
|
1752
1780
|
<dt class="tag-source">Source:</dt>
|
|
1753
1781
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
1754
|
-
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#
|
|
1782
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line108">line 108</a>
|
|
1755
1783
|
</li></ul></dd>
|
|
1756
1784
|
|
|
1757
1785
|
|
|
@@ -1840,7 +1868,7 @@
|
|
|
1840
1868
|
|
|
1841
1869
|
|
|
1842
1870
|
|
|
1843
|
-
<td class="description last">The ID of the thread to
|
|
1871
|
+
<td class="description last">The ID of the thread to pin.</td>
|
|
1844
1872
|
</tr>
|
|
1845
1873
|
|
|
1846
1874
|
|
|
@@ -1920,7 +1948,7 @@
|
|
|
1920
1948
|
|
|
1921
1949
|
|
|
1922
1950
|
<div class="param-desc">
|
|
1923
|
-
- A promise that resolves when the thread is
|
|
1951
|
+
- A promise that resolves when the thread is pinned.
|
|
1924
1952
|
</div>
|
|
1925
1953
|
|
|
1926
1954
|
|
|
@@ -1947,7 +1975,7 @@
|
|
|
1947
1975
|
|
|
1948
1976
|
|
|
1949
1977
|
|
|
1950
|
-
<h4 class="name" id="~
|
|
1978
|
+
<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>
|
|
1951
1979
|
|
|
1952
1980
|
|
|
1953
1981
|
|
|
@@ -1957,13 +1985,13 @@
|
|
|
1957
1985
|
<dl class="details">
|
|
1958
1986
|
|
|
1959
1987
|
<dt class="tag-description">Description:</dt>
|
|
1960
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
1988
|
+
<dd class="tag-description"><ul class="dummy"><li>Unlock a thread to allow further posts.</li></ul></dd>
|
|
1961
1989
|
|
|
1962
1990
|
|
|
1963
1991
|
|
|
1964
1992
|
<dt class="tag-source">Source:</dt>
|
|
1965
1993
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
1966
|
-
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#
|
|
1994
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line65">line 65</a>
|
|
1967
1995
|
</li></ul></dd>
|
|
1968
1996
|
|
|
1969
1997
|
|
|
@@ -2052,7 +2080,7 @@
|
|
|
2052
2080
|
|
|
2053
2081
|
|
|
2054
2082
|
|
|
2055
|
-
<td class="description last">The ID of the thread to
|
|
2083
|
+
<td class="description last">The ID of the thread to unlock.</td>
|
|
2056
2084
|
</tr>
|
|
2057
2085
|
|
|
2058
2086
|
|
|
@@ -2076,7 +2104,7 @@
|
|
|
2076
2104
|
|
|
2077
2105
|
|
|
2078
2106
|
|
|
2079
|
-
<td class="description last">The brand
|
|
2107
|
+
<td class="description last">The brand associated with the unlock action.</td>
|
|
2080
2108
|
</tr>
|
|
2081
2109
|
|
|
2082
2110
|
|
|
@@ -2132,7 +2160,7 @@
|
|
|
2132
2160
|
|
|
2133
2161
|
|
|
2134
2162
|
<div class="param-desc">
|
|
2135
|
-
- A promise that resolves when the thread is
|
|
2163
|
+
- A promise that resolves when the thread is unlocked.
|
|
2136
2164
|
</div>
|
|
2137
2165
|
|
|
2138
2166
|
|
|
@@ -2159,7 +2187,7 @@
|
|
|
2159
2187
|
|
|
2160
2188
|
|
|
2161
2189
|
|
|
2162
|
-
<h4 class="name" id="~
|
|
2190
|
+
<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>
|
|
2163
2191
|
|
|
2164
2192
|
|
|
2165
2193
|
|
|
@@ -2169,13 +2197,13 @@
|
|
|
2169
2197
|
<dl class="details">
|
|
2170
2198
|
|
|
2171
2199
|
<dt class="tag-description">Description:</dt>
|
|
2172
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
2200
|
+
<dd class="tag-description"><ul class="dummy"><li>Unlock a thread to allow further posts.</li></ul></dd>
|
|
2173
2201
|
|
|
2174
2202
|
|
|
2175
2203
|
|
|
2176
2204
|
<dt class="tag-source">Source:</dt>
|
|
2177
2205
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
2178
|
-
<a href="
|
|
2206
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line147">line 147</a>
|
|
2179
2207
|
</li></ul></dd>
|
|
2180
2208
|
|
|
2181
2209
|
|
|
@@ -2247,13 +2275,13 @@
|
|
|
2247
2275
|
|
|
2248
2276
|
<tr>
|
|
2249
2277
|
|
|
2250
|
-
<td class="name"><code>
|
|
2278
|
+
<td class="name"><code>threadId</code></td>
|
|
2251
2279
|
|
|
2252
2280
|
|
|
2253
2281
|
<td class="type">
|
|
2254
2282
|
|
|
2255
2283
|
|
|
2256
|
-
<span class="param-type">
|
|
2284
|
+
<span class="param-type">number</span>
|
|
2257
2285
|
|
|
2258
2286
|
|
|
2259
2287
|
|
|
@@ -2264,12 +2292,36 @@
|
|
|
2264
2292
|
|
|
2265
2293
|
|
|
2266
2294
|
|
|
2267
|
-
<td class="description last">The
|
|
2295
|
+
<td class="description last">The ID of the thread to unlock.</td>
|
|
2268
2296
|
</tr>
|
|
2269
2297
|
|
|
2270
2298
|
|
|
2271
|
-
|
|
2272
|
-
|
|
2299
|
+
|
|
2300
|
+
<tr>
|
|
2301
|
+
|
|
2302
|
+
<td class="name"><code>brand</code></td>
|
|
2303
|
+
|
|
2304
|
+
|
|
2305
|
+
<td class="type">
|
|
2306
|
+
|
|
2307
|
+
|
|
2308
|
+
<span class="param-type">string</span>
|
|
2309
|
+
|
|
2310
|
+
|
|
2311
|
+
|
|
2312
|
+
|
|
2313
|
+
</td>
|
|
2314
|
+
|
|
2315
|
+
|
|
2316
|
+
|
|
2317
|
+
|
|
2318
|
+
|
|
2319
|
+
<td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
|
|
2320
|
+
</tr>
|
|
2321
|
+
|
|
2322
|
+
|
|
2323
|
+
</tbody>
|
|
2324
|
+
</table>
|
|
2273
2325
|
|
|
2274
2326
|
|
|
2275
2327
|
|
|
@@ -2320,7 +2372,7 @@
|
|
|
2320
2372
|
|
|
2321
2373
|
|
|
2322
2374
|
<div class="param-desc">
|
|
2323
|
-
- A promise that resolves
|
|
2375
|
+
- A promise that resolves when the thread is unlocked.
|
|
2324
2376
|
</div>
|
|
2325
2377
|
|
|
2326
2378
|
|
|
@@ -2331,7 +2383,7 @@
|
|
|
2331
2383
|
</dt>
|
|
2332
2384
|
<dd>
|
|
2333
2385
|
|
|
2334
|
-
<span class="param-type">Promise.<
|
|
2386
|
+
<span class="param-type">Promise.<void></span>
|
|
2335
2387
|
|
|
2336
2388
|
|
|
2337
2389
|
|
|
@@ -2347,7 +2399,7 @@
|
|
|
2347
2399
|
|
|
2348
2400
|
|
|
2349
2401
|
|
|
2350
|
-
<h4 class="name" id="~
|
|
2402
|
+
<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>
|
|
2351
2403
|
|
|
2352
2404
|
|
|
2353
2405
|
|
|
@@ -2357,13 +2409,13 @@
|
|
|
2357
2409
|
<dl class="details">
|
|
2358
2410
|
|
|
2359
2411
|
<dt class="tag-description">Description:</dt>
|
|
2360
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
2412
|
+
<dd class="tag-description"><ul class="dummy"><li>Unpins a thread from the top of its category.</li></ul></dd>
|
|
2361
2413
|
|
|
2362
2414
|
|
|
2363
2415
|
|
|
2364
2416
|
<dt class="tag-source">Source:</dt>
|
|
2365
2417
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
2366
|
-
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#
|
|
2418
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line121">line 121</a>
|
|
2367
2419
|
</li></ul></dd>
|
|
2368
2420
|
|
|
2369
2421
|
|
|
@@ -2452,20 +2504,20 @@
|
|
|
2452
2504
|
|
|
2453
2505
|
|
|
2454
2506
|
|
|
2455
|
-
<td class="description last">The ID of the thread to
|
|
2507
|
+
<td class="description last">The ID of the thread to unpin.</td>
|
|
2456
2508
|
</tr>
|
|
2457
2509
|
|
|
2458
2510
|
|
|
2459
2511
|
|
|
2460
2512
|
<tr>
|
|
2461
2513
|
|
|
2462
|
-
<td class="name"><code>
|
|
2514
|
+
<td class="name"><code>brand</code></td>
|
|
2463
2515
|
|
|
2464
2516
|
|
|
2465
2517
|
<td class="type">
|
|
2466
2518
|
|
|
2467
2519
|
|
|
2468
|
-
<span class="param-type">
|
|
2520
|
+
<span class="param-type">string</span>
|
|
2469
2521
|
|
|
2470
2522
|
|
|
2471
2523
|
|
|
@@ -2476,7 +2528,7 @@
|
|
|
2476
2528
|
|
|
2477
2529
|
|
|
2478
2530
|
|
|
2479
|
-
<td class="description last">The
|
|
2531
|
+
<td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
|
|
2480
2532
|
</tr>
|
|
2481
2533
|
|
|
2482
2534
|
|
|
@@ -2532,7 +2584,7 @@
|
|
|
2532
2584
|
|
|
2533
2585
|
|
|
2534
2586
|
<div class="param-desc">
|
|
2535
|
-
- A promise that resolves
|
|
2587
|
+
- A promise that resolves when the thread is unpinned.
|
|
2536
2588
|
</div>
|
|
2537
2589
|
|
|
2538
2590
|
|
|
@@ -2543,7 +2595,7 @@
|
|
|
2543
2595
|
</dt>
|
|
2544
2596
|
<dd>
|
|
2545
2597
|
|
|
2546
|
-
<span class="param-type">Promise.<
|
|
2598
|
+
<span class="param-type">Promise.<void></span>
|
|
2547
2599
|
|
|
2548
2600
|
|
|
2549
2601
|
|
|
@@ -2555,63 +2607,11 @@
|
|
|
2555
2607
|
|
|
2556
2608
|
|
|
2557
2609
|
|
|
2558
|
-
|
|
2559
|
-
|
|
2560
|
-
|
|
2561
|
-
|
|
2562
|
-
|
|
2563
|
-
</article>
|
|
2564
|
-
|
|
2565
|
-
</section>
|
|
2566
|
-
|
|
2567
|
-
|
|
2568
|
-
|
|
2569
|
-
|
|
2570
|
-
|
|
2571
|
-
|
|
2572
|
-
|
|
2573
|
-
<section>
|
|
2574
|
-
|
|
2575
|
-
<header>
|
|
2576
|
-
|
|
2577
|
-
|
|
2578
|
-
|
|
2579
|
-
</header>
|
|
2580
|
-
|
|
2581
|
-
<article>
|
|
2582
|
-
|
|
2583
|
-
<div class="container-overview">
|
|
2584
|
-
|
|
2585
|
-
|
|
2586
|
-
|
|
2587
|
-
|
|
2588
|
-
|
|
2589
|
-
</div>
|
|
2590
|
-
|
|
2591
|
-
|
|
2592
|
-
|
|
2593
|
-
|
|
2594
|
-
|
|
2595
|
-
|
|
2596
|
-
|
|
2597
|
-
|
|
2598
|
-
|
|
2599
|
-
|
|
2600
|
-
|
|
2601
|
-
|
|
2602
|
-
|
|
2603
|
-
|
|
2604
|
-
|
|
2605
|
-
|
|
2606
|
-
|
|
2607
|
-
<h3 class="subsection-title">Methods</h3>
|
|
2608
|
-
|
|
2609
|
-
|
|
2610
2610
|
|
|
2611
2611
|
|
|
2612
2612
|
|
|
2613
2613
|
|
|
2614
|
-
<h4 class="name" id="~
|
|
2614
|
+
<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>
|
|
2615
2615
|
|
|
2616
2616
|
|
|
2617
2617
|
|
|
@@ -2627,7 +2627,7 @@
|
|
|
2627
2627
|
|
|
2628
2628
|
<dt class="tag-source">Source:</dt>
|
|
2629
2629
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
2630
|
-
<a href="forums_categories.ts.html">forums/categories.ts</a>, <a href="forums_categories.ts.html#
|
|
2630
|
+
<a href="forums_categories.ts.html">forums/categories.ts</a>, <a href="forums_categories.ts.html#line53">line 53</a>
|
|
2631
2631
|
</li></ul></dd>
|
|
2632
2632
|
|
|
2633
2633
|
|
|
@@ -2705,7 +2705,7 @@
|
|
|
2705
2705
|
<td class="type">
|
|
2706
2706
|
|
|
2707
2707
|
|
|
2708
|
-
<span class="param-type">
|
|
2708
|
+
<span class="param-type">UpdateForumCategoryParams</span>
|
|
2709
2709
|
|
|
2710
2710
|
|
|
2711
2711
|
|
|
@@ -2799,7 +2799,7 @@
|
|
|
2799
2799
|
|
|
2800
2800
|
|
|
2801
2801
|
|
|
2802
|
-
<h4 class="name" id="~
|
|
2802
|
+
<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>
|
|
2803
2803
|
|
|
2804
2804
|
|
|
2805
2805
|
|
|
@@ -2809,13 +2809,13 @@
|
|
|
2809
2809
|
<dl class="details">
|
|
2810
2810
|
|
|
2811
2811
|
<dt class="tag-description">Description:</dt>
|
|
2812
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
2812
|
+
<dd class="tag-description"><ul class="dummy"><li>Updates an existing thread under a forum category.</li></ul></dd>
|
|
2813
2813
|
|
|
2814
2814
|
|
|
2815
2815
|
|
|
2816
2816
|
<dt class="tag-source">Source:</dt>
|
|
2817
2817
|
<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#
|
|
2818
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line36">line 36</a>
|
|
2819
2819
|
</li></ul></dd>
|
|
2820
2820
|
|
|
2821
2821
|
|
|
@@ -2885,6 +2885,30 @@
|
|
|
2885
2885
|
<tbody>
|
|
2886
2886
|
|
|
2887
2887
|
|
|
2888
|
+
<tr>
|
|
2889
|
+
|
|
2890
|
+
<td class="name"><code>threadId</code></td>
|
|
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
|
+
|
|
2888
2912
|
<tr>
|
|
2889
2913
|
|
|
2890
2914
|
<td class="name"><code>params</code></td>
|
|
@@ -2893,7 +2917,7 @@
|
|
|
2893
2917
|
<td class="type">
|
|
2894
2918
|
|
|
2895
2919
|
|
|
2896
|
-
<span class="param-type">
|
|
2920
|
+
<span class="param-type">UpdateThreadParams</span>
|
|
2897
2921
|
|
|
2898
2922
|
|
|
2899
2923
|
|
|
@@ -2904,7 +2928,7 @@
|
|
|
2904
2928
|
|
|
2905
2929
|
|
|
2906
2930
|
|
|
2907
|
-
<td class="description last">The parameters for
|
|
2931
|
+
<td class="description last">The parameters for updating the thread.</td>
|
|
2908
2932
|
</tr>
|
|
2909
2933
|
|
|
2910
2934
|
|
|
@@ -2960,7 +2984,7 @@
|
|
|
2960
2984
|
|
|
2961
2985
|
|
|
2962
2986
|
<div class="param-desc">
|
|
2963
|
-
- A promise that resolves to the
|
|
2987
|
+
- A promise that resolves to the updated thread.
|
|
2964
2988
|
</div>
|
|
2965
2989
|
|
|
2966
2990
|
|
|
@@ -2983,11 +3007,63 @@
|
|
|
2983
3007
|
|
|
2984
3008
|
|
|
2985
3009
|
|
|
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
|
+
|
|
2986
3037
|
|
|
2987
3038
|
|
|
3039
|
+
|
|
3040
|
+
|
|
3041
|
+
</div>
|
|
2988
3042
|
|
|
2989
3043
|
|
|
2990
|
-
|
|
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
|
+
|
|
3063
|
+
|
|
3064
|
+
|
|
3065
|
+
|
|
3066
|
+
<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>
|
|
2991
3067
|
|
|
2992
3068
|
|
|
2993
3069
|
|
|
@@ -2997,13 +3073,13 @@
|
|
|
2997
3073
|
<dl class="details">
|
|
2998
3074
|
|
|
2999
3075
|
<dt class="tag-description">Description:</dt>
|
|
3000
|
-
<dd class="tag-description"><ul class="dummy"><li>
|
|
3076
|
+
<dd class="tag-description"><ul class="dummy"><li>Creates a new forum category.</li></ul></dd>
|
|
3001
3077
|
|
|
3002
3078
|
|
|
3003
3079
|
|
|
3004
3080
|
<dt class="tag-source">Source:</dt>
|
|
3005
3081
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
3006
|
-
<a href="forums_categories.ts.html">forums/categories.ts</a>, <a href="forums_categories.ts.html#
|
|
3082
|
+
<a href="forums_categories.ts.html">forums/categories.ts</a>, <a href="forums_categories.ts.html#line30">line 30</a>
|
|
3007
3083
|
</li></ul></dd>
|
|
3008
3084
|
|
|
3009
3085
|
|
|
@@ -3075,16 +3151,13 @@
|
|
|
3075
3151
|
|
|
3076
3152
|
<tr>
|
|
3077
3153
|
|
|
3078
|
-
<td class="name"><code>
|
|
3154
|
+
<td class="name"><code>params</code></td>
|
|
3079
3155
|
|
|
3080
3156
|
|
|
3081
3157
|
<td class="type">
|
|
3082
3158
|
|
|
3083
3159
|
|
|
3084
|
-
<span class="param-type">
|
|
3085
|
-
|
|
|
3086
|
-
|
|
3087
|
-
<span class="param-type">null</span>
|
|
3160
|
+
<span class="param-type">CreateForumCategoryParams</span>
|
|
3088
3161
|
|
|
3089
3162
|
|
|
3090
3163
|
|
|
@@ -3095,7 +3168,7 @@
|
|
|
3095
3168
|
|
|
3096
3169
|
|
|
3097
3170
|
|
|
3098
|
-
<td class="description last">The
|
|
3171
|
+
<td class="description last">The parameters for creating the forum category.</td>
|
|
3099
3172
|
</tr>
|
|
3100
3173
|
|
|
3101
3174
|
|
|
@@ -3151,7 +3224,7 @@
|
|
|
3151
3224
|
|
|
3152
3225
|
|
|
3153
3226
|
<div class="param-desc">
|
|
3154
|
-
- A promise that resolves to the
|
|
3227
|
+
- A promise that resolves to the created forum category.
|
|
3155
3228
|
</div>
|
|
3156
3229
|
|
|
3157
3230
|
|
|
@@ -3178,6 +3251,3816 @@
|
|
|
3178
3251
|
|
|
3179
3252
|
|
|
3180
3253
|
|
|
3254
|
+
<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>
|
|
3255
|
+
|
|
3256
|
+
|
|
3257
|
+
|
|
3258
|
+
|
|
3259
|
+
|
|
3260
|
+
|
|
3261
|
+
<dl class="details">
|
|
3262
|
+
|
|
3263
|
+
<dt class="tag-description">Description:</dt>
|
|
3264
|
+
<dd class="tag-description"><ul class="dummy"><li>Creates a new post under a forum thread.</li></ul></dd>
|
|
3265
|
+
|
|
3266
|
+
|
|
3267
|
+
|
|
3268
|
+
<dt class="tag-source">Source:</dt>
|
|
3269
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
3270
|
+
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line16">line 16</a>
|
|
3271
|
+
</li></ul></dd>
|
|
3272
|
+
|
|
3273
|
+
|
|
3274
|
+
|
|
3275
|
+
|
|
3276
|
+
|
|
3277
|
+
|
|
3278
|
+
|
|
3279
|
+
|
|
3280
|
+
|
|
3281
|
+
|
|
3282
|
+
|
|
3283
|
+
|
|
3284
|
+
|
|
3285
|
+
|
|
3286
|
+
|
|
3287
|
+
|
|
3288
|
+
|
|
3289
|
+
|
|
3290
|
+
|
|
3291
|
+
|
|
3292
|
+
|
|
3293
|
+
|
|
3294
|
+
|
|
3295
|
+
|
|
3296
|
+
|
|
3297
|
+
|
|
3298
|
+
|
|
3299
|
+
|
|
3300
|
+
|
|
3301
|
+
|
|
3302
|
+
|
|
3303
|
+
</dl>
|
|
3304
|
+
|
|
3305
|
+
|
|
3306
|
+
|
|
3307
|
+
|
|
3308
|
+
|
|
3309
|
+
|
|
3310
|
+
|
|
3311
|
+
|
|
3312
|
+
|
|
3313
|
+
|
|
3314
|
+
|
|
3315
|
+
|
|
3316
|
+
|
|
3317
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
3318
|
+
|
|
3319
|
+
|
|
3320
|
+
<table class="params">
|
|
3321
|
+
<thead>
|
|
3322
|
+
<tr>
|
|
3323
|
+
|
|
3324
|
+
<th>Name</th>
|
|
3325
|
+
|
|
3326
|
+
|
|
3327
|
+
<th>Type</th>
|
|
3328
|
+
|
|
3329
|
+
|
|
3330
|
+
|
|
3331
|
+
|
|
3332
|
+
|
|
3333
|
+
<th class="last">Description</th>
|
|
3334
|
+
</tr>
|
|
3335
|
+
</thead>
|
|
3336
|
+
|
|
3337
|
+
<tbody>
|
|
3338
|
+
|
|
3339
|
+
|
|
3340
|
+
<tr>
|
|
3341
|
+
|
|
3342
|
+
<td class="name"><code>params</code></td>
|
|
3343
|
+
|
|
3344
|
+
|
|
3345
|
+
<td class="type">
|
|
3346
|
+
|
|
3347
|
+
|
|
3348
|
+
<span class="param-type">CreatePostParams</span>
|
|
3349
|
+
|
|
3350
|
+
|
|
3351
|
+
|
|
3352
|
+
|
|
3353
|
+
</td>
|
|
3354
|
+
|
|
3355
|
+
|
|
3356
|
+
|
|
3357
|
+
|
|
3358
|
+
|
|
3359
|
+
<td class="description last">The parameters for creating the post.</td>
|
|
3360
|
+
</tr>
|
|
3361
|
+
|
|
3362
|
+
|
|
3363
|
+
</tbody>
|
|
3364
|
+
</table>
|
|
3365
|
+
|
|
3366
|
+
|
|
3367
|
+
|
|
3368
|
+
|
|
3369
|
+
|
|
3370
|
+
|
|
3371
|
+
|
|
3372
|
+
|
|
3373
|
+
|
|
3374
|
+
|
|
3375
|
+
|
|
3376
|
+
|
|
3377
|
+
|
|
3378
|
+
|
|
3379
|
+
<h5 class="h5-throws">Throws:</h5>
|
|
3380
|
+
|
|
3381
|
+
|
|
3382
|
+
|
|
3383
|
+
<dl>
|
|
3384
|
+
<dt>
|
|
3385
|
+
<div class="param-desc usertext">
|
|
3386
|
+
- If the request fails.
|
|
3387
|
+
</div>
|
|
3388
|
+
</dt>
|
|
3389
|
+
<dd></dd>
|
|
3390
|
+
<dt>
|
|
3391
|
+
<dl class="param-type">
|
|
3392
|
+
<dt>
|
|
3393
|
+
Type
|
|
3394
|
+
</dt>
|
|
3395
|
+
<dd>
|
|
3396
|
+
|
|
3397
|
+
<span class="param-type">HttpError</span>
|
|
3398
|
+
|
|
3399
|
+
|
|
3400
|
+
|
|
3401
|
+
</dd>
|
|
3402
|
+
</dl>
|
|
3403
|
+
</dt>
|
|
3404
|
+
<dd></dd>
|
|
3405
|
+
</dl>
|
|
3406
|
+
|
|
3407
|
+
|
|
3408
|
+
|
|
3409
|
+
|
|
3410
|
+
|
|
3411
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
3412
|
+
|
|
3413
|
+
|
|
3414
|
+
<div class="param-desc">
|
|
3415
|
+
- A promise that resolves to the created post.
|
|
3416
|
+
</div>
|
|
3417
|
+
|
|
3418
|
+
|
|
3419
|
+
|
|
3420
|
+
<dl class="param-type">
|
|
3421
|
+
<dt>
|
|
3422
|
+
Type
|
|
3423
|
+
</dt>
|
|
3424
|
+
<dd>
|
|
3425
|
+
|
|
3426
|
+
<span class="param-type">Promise.<ForumPost></span>
|
|
3427
|
+
|
|
3428
|
+
|
|
3429
|
+
|
|
3430
|
+
</dd>
|
|
3431
|
+
</dl>
|
|
3432
|
+
|
|
3433
|
+
|
|
3434
|
+
|
|
3435
|
+
|
|
3436
|
+
|
|
3437
|
+
|
|
3438
|
+
|
|
3439
|
+
|
|
3440
|
+
|
|
3441
|
+
|
|
3442
|
+
<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>
|
|
3443
|
+
|
|
3444
|
+
|
|
3445
|
+
|
|
3446
|
+
|
|
3447
|
+
|
|
3448
|
+
|
|
3449
|
+
<dl class="details">
|
|
3450
|
+
|
|
3451
|
+
<dt class="tag-description">Description:</dt>
|
|
3452
|
+
<dd class="tag-description"><ul class="dummy"><li>Creates a new thread under a forum category.</li></ul></dd>
|
|
3453
|
+
|
|
3454
|
+
|
|
3455
|
+
|
|
3456
|
+
<dt class="tag-source">Source:</dt>
|
|
3457
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
3458
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line17">line 17</a>
|
|
3459
|
+
</li></ul></dd>
|
|
3460
|
+
|
|
3461
|
+
|
|
3462
|
+
|
|
3463
|
+
|
|
3464
|
+
|
|
3465
|
+
|
|
3466
|
+
|
|
3467
|
+
|
|
3468
|
+
|
|
3469
|
+
|
|
3470
|
+
|
|
3471
|
+
|
|
3472
|
+
|
|
3473
|
+
|
|
3474
|
+
|
|
3475
|
+
|
|
3476
|
+
|
|
3477
|
+
|
|
3478
|
+
|
|
3479
|
+
|
|
3480
|
+
|
|
3481
|
+
|
|
3482
|
+
|
|
3483
|
+
|
|
3484
|
+
|
|
3485
|
+
|
|
3486
|
+
|
|
3487
|
+
|
|
3488
|
+
|
|
3489
|
+
|
|
3490
|
+
|
|
3491
|
+
</dl>
|
|
3492
|
+
|
|
3493
|
+
|
|
3494
|
+
|
|
3495
|
+
|
|
3496
|
+
|
|
3497
|
+
|
|
3498
|
+
|
|
3499
|
+
|
|
3500
|
+
|
|
3501
|
+
|
|
3502
|
+
|
|
3503
|
+
|
|
3504
|
+
|
|
3505
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
3506
|
+
|
|
3507
|
+
|
|
3508
|
+
<table class="params">
|
|
3509
|
+
<thead>
|
|
3510
|
+
<tr>
|
|
3511
|
+
|
|
3512
|
+
<th>Name</th>
|
|
3513
|
+
|
|
3514
|
+
|
|
3515
|
+
<th>Type</th>
|
|
3516
|
+
|
|
3517
|
+
|
|
3518
|
+
|
|
3519
|
+
|
|
3520
|
+
|
|
3521
|
+
<th class="last">Description</th>
|
|
3522
|
+
</tr>
|
|
3523
|
+
</thead>
|
|
3524
|
+
|
|
3525
|
+
<tbody>
|
|
3526
|
+
|
|
3527
|
+
|
|
3528
|
+
<tr>
|
|
3529
|
+
|
|
3530
|
+
<td class="name"><code>params</code></td>
|
|
3531
|
+
|
|
3532
|
+
|
|
3533
|
+
<td class="type">
|
|
3534
|
+
|
|
3535
|
+
|
|
3536
|
+
<span class="param-type">CreateThreadParams</span>
|
|
3537
|
+
|
|
3538
|
+
|
|
3539
|
+
|
|
3540
|
+
|
|
3541
|
+
</td>
|
|
3542
|
+
|
|
3543
|
+
|
|
3544
|
+
|
|
3545
|
+
|
|
3546
|
+
|
|
3547
|
+
<td class="description last">The parameters for creating the thread.</td>
|
|
3548
|
+
</tr>
|
|
3549
|
+
|
|
3550
|
+
|
|
3551
|
+
</tbody>
|
|
3552
|
+
</table>
|
|
3553
|
+
|
|
3554
|
+
|
|
3555
|
+
|
|
3556
|
+
|
|
3557
|
+
|
|
3558
|
+
|
|
3559
|
+
|
|
3560
|
+
|
|
3561
|
+
|
|
3562
|
+
|
|
3563
|
+
|
|
3564
|
+
|
|
3565
|
+
|
|
3566
|
+
|
|
3567
|
+
<h5 class="h5-throws">Throws:</h5>
|
|
3568
|
+
|
|
3569
|
+
|
|
3570
|
+
|
|
3571
|
+
<dl>
|
|
3572
|
+
<dt>
|
|
3573
|
+
<div class="param-desc usertext">
|
|
3574
|
+
- If the request fails.
|
|
3575
|
+
</div>
|
|
3576
|
+
</dt>
|
|
3577
|
+
<dd></dd>
|
|
3578
|
+
<dt>
|
|
3579
|
+
<dl class="param-type">
|
|
3580
|
+
<dt>
|
|
3581
|
+
Type
|
|
3582
|
+
</dt>
|
|
3583
|
+
<dd>
|
|
3584
|
+
|
|
3585
|
+
<span class="param-type">HttpError</span>
|
|
3586
|
+
|
|
3587
|
+
|
|
3588
|
+
|
|
3589
|
+
</dd>
|
|
3590
|
+
</dl>
|
|
3591
|
+
</dt>
|
|
3592
|
+
<dd></dd>
|
|
3593
|
+
</dl>
|
|
3594
|
+
|
|
3595
|
+
|
|
3596
|
+
|
|
3597
|
+
|
|
3598
|
+
|
|
3599
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
3600
|
+
|
|
3601
|
+
|
|
3602
|
+
<div class="param-desc">
|
|
3603
|
+
- A promise that resolves to the created thread.
|
|
3604
|
+
</div>
|
|
3605
|
+
|
|
3606
|
+
|
|
3607
|
+
|
|
3608
|
+
<dl class="param-type">
|
|
3609
|
+
<dt>
|
|
3610
|
+
Type
|
|
3611
|
+
</dt>
|
|
3612
|
+
<dd>
|
|
3613
|
+
|
|
3614
|
+
<span class="param-type">Promise.<ForumThread></span>
|
|
3615
|
+
|
|
3616
|
+
|
|
3617
|
+
|
|
3618
|
+
</dd>
|
|
3619
|
+
</dl>
|
|
3620
|
+
|
|
3621
|
+
|
|
3622
|
+
|
|
3623
|
+
|
|
3624
|
+
|
|
3625
|
+
|
|
3626
|
+
|
|
3627
|
+
|
|
3628
|
+
|
|
3629
|
+
|
|
3630
|
+
<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>
|
|
3631
|
+
|
|
3632
|
+
|
|
3633
|
+
|
|
3634
|
+
|
|
3635
|
+
|
|
3636
|
+
|
|
3637
|
+
<dl class="details">
|
|
3638
|
+
|
|
3639
|
+
<dt class="tag-description">Description:</dt>
|
|
3640
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetches forum categories for the given brand.</li></ul></dd>
|
|
3641
|
+
|
|
3642
|
+
|
|
3643
|
+
|
|
3644
|
+
<dt class="tag-source">Source:</dt>
|
|
3645
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
3646
|
+
<a href="forums_categories.ts.html">forums/categories.ts</a>, <a href="forums_categories.ts.html#line10">line 10</a>
|
|
3647
|
+
</li></ul></dd>
|
|
3648
|
+
|
|
3649
|
+
|
|
3650
|
+
|
|
3651
|
+
|
|
3652
|
+
|
|
3653
|
+
|
|
3654
|
+
|
|
3655
|
+
|
|
3656
|
+
|
|
3657
|
+
|
|
3658
|
+
|
|
3659
|
+
|
|
3660
|
+
|
|
3661
|
+
|
|
3662
|
+
|
|
3663
|
+
|
|
3664
|
+
|
|
3665
|
+
|
|
3666
|
+
|
|
3667
|
+
|
|
3668
|
+
|
|
3669
|
+
|
|
3670
|
+
|
|
3671
|
+
|
|
3672
|
+
|
|
3673
|
+
|
|
3674
|
+
|
|
3675
|
+
|
|
3676
|
+
|
|
3677
|
+
|
|
3678
|
+
|
|
3679
|
+
</dl>
|
|
3680
|
+
|
|
3681
|
+
|
|
3682
|
+
|
|
3683
|
+
|
|
3684
|
+
|
|
3685
|
+
|
|
3686
|
+
|
|
3687
|
+
|
|
3688
|
+
|
|
3689
|
+
|
|
3690
|
+
|
|
3691
|
+
|
|
3692
|
+
|
|
3693
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
3694
|
+
|
|
3695
|
+
|
|
3696
|
+
<table class="params">
|
|
3697
|
+
<thead>
|
|
3698
|
+
<tr>
|
|
3699
|
+
|
|
3700
|
+
<th>Name</th>
|
|
3701
|
+
|
|
3702
|
+
|
|
3703
|
+
<th>Type</th>
|
|
3704
|
+
|
|
3705
|
+
|
|
3706
|
+
|
|
3707
|
+
|
|
3708
|
+
|
|
3709
|
+
<th class="last">Description</th>
|
|
3710
|
+
</tr>
|
|
3711
|
+
</thead>
|
|
3712
|
+
|
|
3713
|
+
<tbody>
|
|
3714
|
+
|
|
3715
|
+
|
|
3716
|
+
<tr>
|
|
3717
|
+
|
|
3718
|
+
<td class="name"><code>brand</code></td>
|
|
3719
|
+
|
|
3720
|
+
|
|
3721
|
+
<td class="type">
|
|
3722
|
+
|
|
3723
|
+
|
|
3724
|
+
<span class="param-type">string</span>
|
|
3725
|
+
|
|
|
3726
|
+
|
|
3727
|
+
<span class="param-type">null</span>
|
|
3728
|
+
|
|
3729
|
+
|
|
3730
|
+
|
|
3731
|
+
|
|
3732
|
+
</td>
|
|
3733
|
+
|
|
3734
|
+
|
|
3735
|
+
|
|
3736
|
+
|
|
3737
|
+
|
|
3738
|
+
<td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
|
|
3739
|
+
</tr>
|
|
3740
|
+
|
|
3741
|
+
|
|
3742
|
+
</tbody>
|
|
3743
|
+
</table>
|
|
3744
|
+
|
|
3745
|
+
|
|
3746
|
+
|
|
3747
|
+
|
|
3748
|
+
|
|
3749
|
+
|
|
3750
|
+
|
|
3751
|
+
|
|
3752
|
+
|
|
3753
|
+
|
|
3754
|
+
|
|
3755
|
+
|
|
3756
|
+
|
|
3757
|
+
|
|
3758
|
+
<h5 class="h5-throws">Throws:</h5>
|
|
3759
|
+
|
|
3760
|
+
|
|
3761
|
+
|
|
3762
|
+
<dl>
|
|
3763
|
+
<dt>
|
|
3764
|
+
<div class="param-desc usertext">
|
|
3765
|
+
- If the request fails.
|
|
3766
|
+
</div>
|
|
3767
|
+
</dt>
|
|
3768
|
+
<dd></dd>
|
|
3769
|
+
<dt>
|
|
3770
|
+
<dl class="param-type">
|
|
3771
|
+
<dt>
|
|
3772
|
+
Type
|
|
3773
|
+
</dt>
|
|
3774
|
+
<dd>
|
|
3775
|
+
|
|
3776
|
+
<span class="param-type">HttpError</span>
|
|
3777
|
+
|
|
3778
|
+
|
|
3779
|
+
|
|
3780
|
+
</dd>
|
|
3781
|
+
</dl>
|
|
3782
|
+
</dt>
|
|
3783
|
+
<dd></dd>
|
|
3784
|
+
</dl>
|
|
3785
|
+
|
|
3786
|
+
|
|
3787
|
+
|
|
3788
|
+
|
|
3789
|
+
|
|
3790
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
3791
|
+
|
|
3792
|
+
|
|
3793
|
+
<div class="param-desc">
|
|
3794
|
+
- A promise that resolves to the list of forum categories.
|
|
3795
|
+
</div>
|
|
3796
|
+
|
|
3797
|
+
|
|
3798
|
+
|
|
3799
|
+
<dl class="param-type">
|
|
3800
|
+
<dt>
|
|
3801
|
+
Type
|
|
3802
|
+
</dt>
|
|
3803
|
+
<dd>
|
|
3804
|
+
|
|
3805
|
+
<span class="param-type">Promise.<ForumCategory></span>
|
|
3806
|
+
|
|
3807
|
+
|
|
3808
|
+
|
|
3809
|
+
</dd>
|
|
3810
|
+
</dl>
|
|
3811
|
+
|
|
3812
|
+
|
|
3813
|
+
|
|
3814
|
+
|
|
3815
|
+
|
|
3816
|
+
|
|
3817
|
+
|
|
3818
|
+
|
|
3819
|
+
|
|
3820
|
+
|
|
3821
|
+
<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>
|
|
3822
|
+
|
|
3823
|
+
|
|
3824
|
+
|
|
3825
|
+
|
|
3826
|
+
|
|
3827
|
+
|
|
3828
|
+
<dl class="details">
|
|
3829
|
+
|
|
3830
|
+
<dt class="tag-description">Description:</dt>
|
|
3831
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetches posts for the given thread.</li></ul></dd>
|
|
3832
|
+
|
|
3833
|
+
|
|
3834
|
+
|
|
3835
|
+
<dt class="tag-source">Source:</dt>
|
|
3836
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
3837
|
+
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line37">line 37</a>
|
|
3838
|
+
</li></ul></dd>
|
|
3839
|
+
|
|
3840
|
+
|
|
3841
|
+
|
|
3842
|
+
|
|
3843
|
+
|
|
3844
|
+
|
|
3845
|
+
|
|
3846
|
+
|
|
3847
|
+
|
|
3848
|
+
|
|
3849
|
+
|
|
3850
|
+
|
|
3851
|
+
|
|
3852
|
+
|
|
3853
|
+
|
|
3854
|
+
|
|
3855
|
+
|
|
3856
|
+
|
|
3857
|
+
|
|
3858
|
+
|
|
3859
|
+
|
|
3860
|
+
|
|
3861
|
+
|
|
3862
|
+
|
|
3863
|
+
|
|
3864
|
+
|
|
3865
|
+
|
|
3866
|
+
|
|
3867
|
+
|
|
3868
|
+
|
|
3869
|
+
|
|
3870
|
+
</dl>
|
|
3871
|
+
|
|
3872
|
+
|
|
3873
|
+
|
|
3874
|
+
|
|
3875
|
+
|
|
3876
|
+
|
|
3877
|
+
|
|
3878
|
+
|
|
3879
|
+
|
|
3880
|
+
|
|
3881
|
+
|
|
3882
|
+
|
|
3883
|
+
|
|
3884
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
3885
|
+
|
|
3886
|
+
|
|
3887
|
+
<table class="params">
|
|
3888
|
+
<thead>
|
|
3889
|
+
<tr>
|
|
3890
|
+
|
|
3891
|
+
<th>Name</th>
|
|
3892
|
+
|
|
3893
|
+
|
|
3894
|
+
<th>Type</th>
|
|
3895
|
+
|
|
3896
|
+
|
|
3897
|
+
<th>Attributes</th>
|
|
3898
|
+
|
|
3899
|
+
|
|
3900
|
+
|
|
3901
|
+
|
|
3902
|
+
<th class="last">Description</th>
|
|
3903
|
+
</tr>
|
|
3904
|
+
</thead>
|
|
3905
|
+
|
|
3906
|
+
<tbody>
|
|
3907
|
+
|
|
3908
|
+
|
|
3909
|
+
<tr>
|
|
3910
|
+
|
|
3911
|
+
<td class="name"><code>threadId</code></td>
|
|
3912
|
+
|
|
3913
|
+
|
|
3914
|
+
<td class="type">
|
|
3915
|
+
|
|
3916
|
+
|
|
3917
|
+
<span class="param-type">number</span>
|
|
3918
|
+
|
|
3919
|
+
|
|
3920
|
+
|
|
3921
|
+
|
|
3922
|
+
</td>
|
|
3923
|
+
|
|
3924
|
+
|
|
3925
|
+
<td class="attributes">
|
|
3926
|
+
|
|
3927
|
+
|
|
3928
|
+
|
|
3929
|
+
|
|
3930
|
+
|
|
3931
|
+
</td>
|
|
3932
|
+
|
|
3933
|
+
|
|
3934
|
+
|
|
3935
|
+
|
|
3936
|
+
<td class="description last">The ID of the forum thread.</td>
|
|
3937
|
+
</tr>
|
|
3938
|
+
|
|
3939
|
+
|
|
3940
|
+
|
|
3941
|
+
<tr>
|
|
3942
|
+
|
|
3943
|
+
<td class="name"><code>brand</code></td>
|
|
3944
|
+
|
|
3945
|
+
|
|
3946
|
+
<td class="type">
|
|
3947
|
+
|
|
3948
|
+
|
|
3949
|
+
<span class="param-type">string</span>
|
|
3950
|
+
|
|
3951
|
+
|
|
3952
|
+
|
|
3953
|
+
|
|
3954
|
+
</td>
|
|
3955
|
+
|
|
3956
|
+
|
|
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
|
+
|
|
4000
|
+
|
|
4001
|
+
|
|
4002
|
+
<td class="description last">Optional parameters such as `page`, `limit`, and `sort`.</td>
|
|
4003
|
+
</tr>
|
|
4004
|
+
|
|
4005
|
+
|
|
4006
|
+
</tbody>
|
|
4007
|
+
</table>
|
|
4008
|
+
|
|
4009
|
+
|
|
4010
|
+
|
|
4011
|
+
|
|
4012
|
+
|
|
4013
|
+
|
|
4014
|
+
|
|
4015
|
+
|
|
4016
|
+
|
|
4017
|
+
|
|
4018
|
+
|
|
4019
|
+
|
|
4020
|
+
|
|
4021
|
+
|
|
4022
|
+
<h5 class="h5-throws">Throws:</h5>
|
|
4023
|
+
|
|
4024
|
+
|
|
4025
|
+
|
|
4026
|
+
<dl>
|
|
4027
|
+
<dt>
|
|
4028
|
+
<div class="param-desc usertext">
|
|
4029
|
+
- If the request fails.
|
|
4030
|
+
</div>
|
|
4031
|
+
</dt>
|
|
4032
|
+
<dd></dd>
|
|
4033
|
+
<dt>
|
|
4034
|
+
<dl class="param-type">
|
|
4035
|
+
<dt>
|
|
4036
|
+
Type
|
|
4037
|
+
</dt>
|
|
4038
|
+
<dd>
|
|
4039
|
+
|
|
4040
|
+
<span class="param-type">HttpError</span>
|
|
4041
|
+
|
|
4042
|
+
|
|
4043
|
+
|
|
4044
|
+
</dd>
|
|
4045
|
+
</dl>
|
|
4046
|
+
</dt>
|
|
4047
|
+
<dd></dd>
|
|
4048
|
+
</dl>
|
|
4049
|
+
|
|
4050
|
+
|
|
4051
|
+
|
|
4052
|
+
|
|
4053
|
+
|
|
4054
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
4055
|
+
|
|
4056
|
+
|
|
4057
|
+
<div class="param-desc">
|
|
4058
|
+
- Resolves to a paginated list of forum posts.
|
|
4059
|
+
</div>
|
|
4060
|
+
|
|
4061
|
+
|
|
4062
|
+
|
|
4063
|
+
<dl class="param-type">
|
|
4064
|
+
<dt>
|
|
4065
|
+
Type
|
|
4066
|
+
</dt>
|
|
4067
|
+
<dd>
|
|
4068
|
+
|
|
4069
|
+
<span class="param-type">Promise.<<a href="global.html#PaginatedResponse">PaginatedResponse</a>.<ForumPost>></span>
|
|
4070
|
+
|
|
4071
|
+
|
|
4072
|
+
|
|
4073
|
+
</dd>
|
|
4074
|
+
</dl>
|
|
4075
|
+
|
|
4076
|
+
|
|
4077
|
+
|
|
4078
|
+
|
|
4079
|
+
|
|
4080
|
+
|
|
4081
|
+
|
|
4082
|
+
|
|
4083
|
+
|
|
4084
|
+
|
|
4085
|
+
<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>
|
|
4086
|
+
|
|
4087
|
+
|
|
4088
|
+
|
|
4089
|
+
|
|
4090
|
+
|
|
4091
|
+
|
|
4092
|
+
<dl class="details">
|
|
4093
|
+
|
|
4094
|
+
<dt class="tag-description">Description:</dt>
|
|
4095
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetches forum threads for the given category.</li></ul></dd>
|
|
4096
|
+
|
|
4097
|
+
|
|
4098
|
+
|
|
4099
|
+
<dt class="tag-source">Source:</dt>
|
|
4100
|
+
<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#line84">line 84</a>
|
|
4102
|
+
</li></ul></dd>
|
|
4103
|
+
|
|
4104
|
+
|
|
4105
|
+
|
|
4106
|
+
|
|
4107
|
+
|
|
4108
|
+
|
|
4109
|
+
|
|
4110
|
+
|
|
4111
|
+
|
|
4112
|
+
|
|
4113
|
+
|
|
4114
|
+
|
|
4115
|
+
|
|
4116
|
+
|
|
4117
|
+
|
|
4118
|
+
|
|
4119
|
+
|
|
4120
|
+
|
|
4121
|
+
|
|
4122
|
+
|
|
4123
|
+
|
|
4124
|
+
|
|
4125
|
+
|
|
4126
|
+
|
|
4127
|
+
|
|
4128
|
+
|
|
4129
|
+
|
|
4130
|
+
|
|
4131
|
+
|
|
4132
|
+
|
|
4133
|
+
|
|
4134
|
+
</dl>
|
|
4135
|
+
|
|
4136
|
+
|
|
4137
|
+
|
|
4138
|
+
|
|
4139
|
+
|
|
4140
|
+
|
|
4141
|
+
|
|
4142
|
+
|
|
4143
|
+
|
|
4144
|
+
|
|
4145
|
+
|
|
4146
|
+
|
|
4147
|
+
|
|
4148
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
4149
|
+
|
|
4150
|
+
|
|
4151
|
+
<table class="params">
|
|
4152
|
+
<thead>
|
|
4153
|
+
<tr>
|
|
4154
|
+
|
|
4155
|
+
<th>Name</th>
|
|
4156
|
+
|
|
4157
|
+
|
|
4158
|
+
<th>Type</th>
|
|
4159
|
+
|
|
4160
|
+
|
|
4161
|
+
|
|
4162
|
+
|
|
4163
|
+
|
|
4164
|
+
<th class="last">Description</th>
|
|
4165
|
+
</tr>
|
|
4166
|
+
</thead>
|
|
4167
|
+
|
|
4168
|
+
<tbody>
|
|
4169
|
+
|
|
4170
|
+
|
|
4171
|
+
<tr>
|
|
4172
|
+
|
|
4173
|
+
<td class="name"><code>categoryId</code></td>
|
|
4174
|
+
|
|
4175
|
+
|
|
4176
|
+
<td class="type">
|
|
4177
|
+
|
|
4178
|
+
|
|
4179
|
+
<span class="param-type">number</span>
|
|
4180
|
+
|
|
4181
|
+
|
|
4182
|
+
|
|
4183
|
+
|
|
4184
|
+
</td>
|
|
4185
|
+
|
|
4186
|
+
|
|
4187
|
+
|
|
4188
|
+
|
|
4189
|
+
|
|
4190
|
+
<td class="description last">The ID of the forum category.</td>
|
|
4191
|
+
</tr>
|
|
4192
|
+
|
|
4193
|
+
|
|
4194
|
+
|
|
4195
|
+
<tr>
|
|
4196
|
+
|
|
4197
|
+
<td class="name"><code>brand</code></td>
|
|
4198
|
+
|
|
4199
|
+
|
|
4200
|
+
<td class="type">
|
|
4201
|
+
|
|
4202
|
+
|
|
4203
|
+
<span class="param-type">string</span>
|
|
4204
|
+
|
|
4205
|
+
|
|
4206
|
+
|
|
4207
|
+
|
|
4208
|
+
</td>
|
|
4209
|
+
|
|
4210
|
+
|
|
4211
|
+
|
|
4212
|
+
|
|
4213
|
+
|
|
4214
|
+
<td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
|
|
4215
|
+
</tr>
|
|
4216
|
+
|
|
4217
|
+
|
|
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
|
+
</tbody>
|
|
4243
|
+
</table>
|
|
4244
|
+
|
|
4245
|
+
|
|
4246
|
+
|
|
4247
|
+
|
|
4248
|
+
|
|
4249
|
+
|
|
4250
|
+
|
|
4251
|
+
|
|
4252
|
+
|
|
4253
|
+
|
|
4254
|
+
|
|
4255
|
+
|
|
4256
|
+
|
|
4257
|
+
|
|
4258
|
+
<h5 class="h5-throws">Throws:</h5>
|
|
4259
|
+
|
|
4260
|
+
|
|
4261
|
+
|
|
4262
|
+
<dl>
|
|
4263
|
+
<dt>
|
|
4264
|
+
<div class="param-desc usertext">
|
|
4265
|
+
- If the HTTP request fails.
|
|
4266
|
+
</div>
|
|
4267
|
+
</dt>
|
|
4268
|
+
<dd></dd>
|
|
4269
|
+
<dt>
|
|
4270
|
+
<dl class="param-type">
|
|
4271
|
+
<dt>
|
|
4272
|
+
Type
|
|
4273
|
+
</dt>
|
|
4274
|
+
<dd>
|
|
4275
|
+
|
|
4276
|
+
<span class="param-type">HttpError</span>
|
|
4277
|
+
|
|
4278
|
+
|
|
4279
|
+
|
|
4280
|
+
</dd>
|
|
4281
|
+
</dl>
|
|
4282
|
+
</dt>
|
|
4283
|
+
<dd></dd>
|
|
4284
|
+
</dl>
|
|
4285
|
+
|
|
4286
|
+
|
|
4287
|
+
|
|
4288
|
+
|
|
4289
|
+
|
|
4290
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
4291
|
+
|
|
4292
|
+
|
|
4293
|
+
<div class="param-desc">
|
|
4294
|
+
- A promise that resolves to a paginated list of forum threads.
|
|
4295
|
+
</div>
|
|
4296
|
+
|
|
4297
|
+
|
|
4298
|
+
|
|
4299
|
+
<dl class="param-type">
|
|
4300
|
+
<dt>
|
|
4301
|
+
Type
|
|
4302
|
+
</dt>
|
|
4303
|
+
<dd>
|
|
4304
|
+
|
|
4305
|
+
<span class="param-type">Promise.<<a href="global.html#PaginatedResponse">PaginatedResponse</a>.<ForumThread>></span>
|
|
4306
|
+
|
|
4307
|
+
|
|
4308
|
+
|
|
4309
|
+
</dd>
|
|
4310
|
+
</dl>
|
|
4311
|
+
|
|
4312
|
+
|
|
4313
|
+
|
|
4314
|
+
|
|
4315
|
+
|
|
4316
|
+
|
|
4317
|
+
|
|
4318
|
+
|
|
4319
|
+
|
|
4320
|
+
|
|
4321
|
+
<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>
|
|
4322
|
+
|
|
4323
|
+
|
|
4324
|
+
|
|
4325
|
+
|
|
4326
|
+
|
|
4327
|
+
|
|
4328
|
+
<dl class="details">
|
|
4329
|
+
|
|
4330
|
+
<dt class="tag-description">Description:</dt>
|
|
4331
|
+
<dd class="tag-description"><ul class="dummy"><li>Follow a thread.</li></ul></dd>
|
|
4332
|
+
|
|
4333
|
+
|
|
4334
|
+
|
|
4335
|
+
<dt class="tag-source">Source:</dt>
|
|
4336
|
+
<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#line52">line 52</a>
|
|
4338
|
+
</li></ul></dd>
|
|
4339
|
+
|
|
4340
|
+
|
|
4341
|
+
|
|
4342
|
+
|
|
4343
|
+
|
|
4344
|
+
|
|
4345
|
+
|
|
4346
|
+
|
|
4347
|
+
|
|
4348
|
+
|
|
4349
|
+
|
|
4350
|
+
|
|
4351
|
+
|
|
4352
|
+
|
|
4353
|
+
|
|
4354
|
+
|
|
4355
|
+
|
|
4356
|
+
|
|
4357
|
+
|
|
4358
|
+
|
|
4359
|
+
|
|
4360
|
+
|
|
4361
|
+
|
|
4362
|
+
|
|
4363
|
+
|
|
4364
|
+
|
|
4365
|
+
|
|
4366
|
+
|
|
4367
|
+
|
|
4368
|
+
|
|
4369
|
+
|
|
4370
|
+
</dl>
|
|
4371
|
+
|
|
4372
|
+
|
|
4373
|
+
|
|
4374
|
+
|
|
4375
|
+
|
|
4376
|
+
|
|
4377
|
+
|
|
4378
|
+
|
|
4379
|
+
|
|
4380
|
+
|
|
4381
|
+
|
|
4382
|
+
|
|
4383
|
+
|
|
4384
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
4385
|
+
|
|
4386
|
+
|
|
4387
|
+
<table class="params">
|
|
4388
|
+
<thead>
|
|
4389
|
+
<tr>
|
|
4390
|
+
|
|
4391
|
+
<th>Name</th>
|
|
4392
|
+
|
|
4393
|
+
|
|
4394
|
+
<th>Type</th>
|
|
4395
|
+
|
|
4396
|
+
|
|
4397
|
+
|
|
4398
|
+
|
|
4399
|
+
|
|
4400
|
+
<th class="last">Description</th>
|
|
4401
|
+
</tr>
|
|
4402
|
+
</thead>
|
|
4403
|
+
|
|
4404
|
+
<tbody>
|
|
4405
|
+
|
|
4406
|
+
|
|
4407
|
+
<tr>
|
|
4408
|
+
|
|
4409
|
+
<td class="name"><code>threadId</code></td>
|
|
4410
|
+
|
|
4411
|
+
|
|
4412
|
+
<td class="type">
|
|
4413
|
+
|
|
4414
|
+
|
|
4415
|
+
<span class="param-type">number</span>
|
|
4416
|
+
|
|
4417
|
+
|
|
4418
|
+
|
|
4419
|
+
|
|
4420
|
+
</td>
|
|
4421
|
+
|
|
4422
|
+
|
|
4423
|
+
|
|
4424
|
+
|
|
4425
|
+
|
|
4426
|
+
<td class="description last">The ID of the thread to lock.</td>
|
|
4427
|
+
</tr>
|
|
4428
|
+
|
|
4429
|
+
|
|
4430
|
+
|
|
4431
|
+
<tr>
|
|
4432
|
+
|
|
4433
|
+
<td class="name"><code>brand</code></td>
|
|
4434
|
+
|
|
4435
|
+
|
|
4436
|
+
<td class="type">
|
|
4437
|
+
|
|
4438
|
+
|
|
4439
|
+
<span class="param-type">string</span>
|
|
4440
|
+
|
|
4441
|
+
|
|
4442
|
+
|
|
4443
|
+
|
|
4444
|
+
</td>
|
|
4445
|
+
|
|
4446
|
+
|
|
4447
|
+
|
|
4448
|
+
|
|
4449
|
+
|
|
4450
|
+
<td class="description last">The brand associated with the follow action.</td>
|
|
4451
|
+
</tr>
|
|
4452
|
+
|
|
4453
|
+
|
|
4454
|
+
</tbody>
|
|
4455
|
+
</table>
|
|
4456
|
+
|
|
4457
|
+
|
|
4458
|
+
|
|
4459
|
+
|
|
4460
|
+
|
|
4461
|
+
|
|
4462
|
+
|
|
4463
|
+
|
|
4464
|
+
|
|
4465
|
+
|
|
4466
|
+
|
|
4467
|
+
|
|
4468
|
+
|
|
4469
|
+
|
|
4470
|
+
<h5 class="h5-throws">Throws:</h5>
|
|
4471
|
+
|
|
4472
|
+
|
|
4473
|
+
|
|
4474
|
+
<dl>
|
|
4475
|
+
<dt>
|
|
4476
|
+
<div class="param-desc usertext">
|
|
4477
|
+
- If the request fails.
|
|
4478
|
+
</div>
|
|
4479
|
+
</dt>
|
|
4480
|
+
<dd></dd>
|
|
4481
|
+
<dt>
|
|
4482
|
+
<dl class="param-type">
|
|
4483
|
+
<dt>
|
|
4484
|
+
Type
|
|
4485
|
+
</dt>
|
|
4486
|
+
<dd>
|
|
4487
|
+
|
|
4488
|
+
<span class="param-type">HttpError</span>
|
|
4489
|
+
|
|
4490
|
+
|
|
4491
|
+
|
|
4492
|
+
</dd>
|
|
4493
|
+
</dl>
|
|
4494
|
+
</dt>
|
|
4495
|
+
<dd></dd>
|
|
4496
|
+
</dl>
|
|
4497
|
+
|
|
4498
|
+
|
|
4499
|
+
|
|
4500
|
+
|
|
4501
|
+
|
|
4502
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
4503
|
+
|
|
4504
|
+
|
|
4505
|
+
<div class="param-desc">
|
|
4506
|
+
- A promise that resolves when the thread is locked.
|
|
4507
|
+
</div>
|
|
4508
|
+
|
|
4509
|
+
|
|
4510
|
+
|
|
4511
|
+
<dl class="param-type">
|
|
4512
|
+
<dt>
|
|
4513
|
+
Type
|
|
4514
|
+
</dt>
|
|
4515
|
+
<dd>
|
|
4516
|
+
|
|
4517
|
+
<span class="param-type">Promise.<void></span>
|
|
4518
|
+
|
|
4519
|
+
|
|
4520
|
+
|
|
4521
|
+
</dd>
|
|
4522
|
+
</dl>
|
|
4523
|
+
|
|
4524
|
+
|
|
4525
|
+
|
|
4526
|
+
|
|
4527
|
+
|
|
4528
|
+
|
|
4529
|
+
|
|
4530
|
+
|
|
4531
|
+
|
|
4532
|
+
|
|
4533
|
+
<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>
|
|
4534
|
+
|
|
4535
|
+
|
|
4536
|
+
|
|
4537
|
+
|
|
4538
|
+
|
|
4539
|
+
|
|
4540
|
+
<dl class="details">
|
|
4541
|
+
|
|
4542
|
+
<dt class="tag-description">Description:</dt>
|
|
4543
|
+
<dd class="tag-description"><ul class="dummy"><li>Locks a thread to prevent further posts.</li></ul></dd>
|
|
4544
|
+
|
|
4545
|
+
|
|
4546
|
+
|
|
4547
|
+
<dt class="tag-source">Source:</dt>
|
|
4548
|
+
<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#line134">line 134</a>
|
|
4550
|
+
</li></ul></dd>
|
|
4551
|
+
|
|
4552
|
+
|
|
4553
|
+
|
|
4554
|
+
|
|
4555
|
+
|
|
4556
|
+
|
|
4557
|
+
|
|
4558
|
+
|
|
4559
|
+
|
|
4560
|
+
|
|
4561
|
+
|
|
4562
|
+
|
|
4563
|
+
|
|
4564
|
+
|
|
4565
|
+
|
|
4566
|
+
|
|
4567
|
+
|
|
4568
|
+
|
|
4569
|
+
|
|
4570
|
+
|
|
4571
|
+
|
|
4572
|
+
|
|
4573
|
+
|
|
4574
|
+
|
|
4575
|
+
|
|
4576
|
+
|
|
4577
|
+
|
|
4578
|
+
|
|
4579
|
+
|
|
4580
|
+
|
|
4581
|
+
|
|
4582
|
+
</dl>
|
|
4583
|
+
|
|
4584
|
+
|
|
4585
|
+
|
|
4586
|
+
|
|
4587
|
+
|
|
4588
|
+
|
|
4589
|
+
|
|
4590
|
+
|
|
4591
|
+
|
|
4592
|
+
|
|
4593
|
+
|
|
4594
|
+
|
|
4595
|
+
|
|
4596
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
4597
|
+
|
|
4598
|
+
|
|
4599
|
+
<table class="params">
|
|
4600
|
+
<thead>
|
|
4601
|
+
<tr>
|
|
4602
|
+
|
|
4603
|
+
<th>Name</th>
|
|
4604
|
+
|
|
4605
|
+
|
|
4606
|
+
<th>Type</th>
|
|
4607
|
+
|
|
4608
|
+
|
|
4609
|
+
|
|
4610
|
+
|
|
4611
|
+
|
|
4612
|
+
<th class="last">Description</th>
|
|
4613
|
+
</tr>
|
|
4614
|
+
</thead>
|
|
4615
|
+
|
|
4616
|
+
<tbody>
|
|
4617
|
+
|
|
4618
|
+
|
|
4619
|
+
<tr>
|
|
4620
|
+
|
|
4621
|
+
<td class="name"><code>threadId</code></td>
|
|
4622
|
+
|
|
4623
|
+
|
|
4624
|
+
<td class="type">
|
|
4625
|
+
|
|
4626
|
+
|
|
4627
|
+
<span class="param-type">number</span>
|
|
4628
|
+
|
|
4629
|
+
|
|
4630
|
+
|
|
4631
|
+
|
|
4632
|
+
</td>
|
|
4633
|
+
|
|
4634
|
+
|
|
4635
|
+
|
|
4636
|
+
|
|
4637
|
+
|
|
4638
|
+
<td class="description last">The ID of the thread to lock.</td>
|
|
4639
|
+
</tr>
|
|
4640
|
+
|
|
4641
|
+
|
|
4642
|
+
|
|
4643
|
+
<tr>
|
|
4644
|
+
|
|
4645
|
+
<td class="name"><code>brand</code></td>
|
|
4646
|
+
|
|
4647
|
+
|
|
4648
|
+
<td class="type">
|
|
4649
|
+
|
|
4650
|
+
|
|
4651
|
+
<span class="param-type">string</span>
|
|
4652
|
+
|
|
4653
|
+
|
|
4654
|
+
|
|
4655
|
+
|
|
4656
|
+
</td>
|
|
4657
|
+
|
|
4658
|
+
|
|
4659
|
+
|
|
4660
|
+
|
|
4661
|
+
|
|
4662
|
+
<td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
|
|
4663
|
+
</tr>
|
|
4664
|
+
|
|
4665
|
+
|
|
4666
|
+
</tbody>
|
|
4667
|
+
</table>
|
|
4668
|
+
|
|
4669
|
+
|
|
4670
|
+
|
|
4671
|
+
|
|
4672
|
+
|
|
4673
|
+
|
|
4674
|
+
|
|
4675
|
+
|
|
4676
|
+
|
|
4677
|
+
|
|
4678
|
+
|
|
4679
|
+
|
|
4680
|
+
|
|
4681
|
+
|
|
4682
|
+
<h5 class="h5-throws">Throws:</h5>
|
|
4683
|
+
|
|
4684
|
+
|
|
4685
|
+
|
|
4686
|
+
<dl>
|
|
4687
|
+
<dt>
|
|
4688
|
+
<div class="param-desc usertext">
|
|
4689
|
+
- If the request fails.
|
|
4690
|
+
</div>
|
|
4691
|
+
</dt>
|
|
4692
|
+
<dd></dd>
|
|
4693
|
+
<dt>
|
|
4694
|
+
<dl class="param-type">
|
|
4695
|
+
<dt>
|
|
4696
|
+
Type
|
|
4697
|
+
</dt>
|
|
4698
|
+
<dd>
|
|
4699
|
+
|
|
4700
|
+
<span class="param-type">HttpError</span>
|
|
4701
|
+
|
|
4702
|
+
|
|
4703
|
+
|
|
4704
|
+
</dd>
|
|
4705
|
+
</dl>
|
|
4706
|
+
</dt>
|
|
4707
|
+
<dd></dd>
|
|
4708
|
+
</dl>
|
|
4709
|
+
|
|
4710
|
+
|
|
4711
|
+
|
|
4712
|
+
|
|
4713
|
+
|
|
4714
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
4715
|
+
|
|
4716
|
+
|
|
4717
|
+
<div class="param-desc">
|
|
4718
|
+
- A promise that resolves when the thread is locked.
|
|
4719
|
+
</div>
|
|
4720
|
+
|
|
4721
|
+
|
|
4722
|
+
|
|
4723
|
+
<dl class="param-type">
|
|
4724
|
+
<dt>
|
|
4725
|
+
Type
|
|
4726
|
+
</dt>
|
|
4727
|
+
<dd>
|
|
4728
|
+
|
|
4729
|
+
<span class="param-type">Promise.<void></span>
|
|
4730
|
+
|
|
4731
|
+
|
|
4732
|
+
|
|
4733
|
+
</dd>
|
|
4734
|
+
</dl>
|
|
4735
|
+
|
|
4736
|
+
|
|
4737
|
+
|
|
4738
|
+
|
|
4739
|
+
|
|
4740
|
+
|
|
4741
|
+
|
|
4742
|
+
|
|
4743
|
+
|
|
4744
|
+
|
|
4745
|
+
<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>
|
|
4746
|
+
|
|
4747
|
+
|
|
4748
|
+
|
|
4749
|
+
|
|
4750
|
+
|
|
4751
|
+
|
|
4752
|
+
<dl class="details">
|
|
4753
|
+
|
|
4754
|
+
<dt class="tag-description">Description:</dt>
|
|
4755
|
+
<dd class="tag-description"><ul class="dummy"><li>Pins a thread to the top of its category.</li></ul></dd>
|
|
4756
|
+
|
|
4757
|
+
|
|
4758
|
+
|
|
4759
|
+
<dt class="tag-source">Source:</dt>
|
|
4760
|
+
<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#line108">line 108</a>
|
|
4762
|
+
</li></ul></dd>
|
|
4763
|
+
|
|
4764
|
+
|
|
4765
|
+
|
|
4766
|
+
|
|
4767
|
+
|
|
4768
|
+
|
|
4769
|
+
|
|
4770
|
+
|
|
4771
|
+
|
|
4772
|
+
|
|
4773
|
+
|
|
4774
|
+
|
|
4775
|
+
|
|
4776
|
+
|
|
4777
|
+
|
|
4778
|
+
|
|
4779
|
+
|
|
4780
|
+
|
|
4781
|
+
|
|
4782
|
+
|
|
4783
|
+
|
|
4784
|
+
|
|
4785
|
+
|
|
4786
|
+
|
|
4787
|
+
|
|
4788
|
+
|
|
4789
|
+
|
|
4790
|
+
|
|
4791
|
+
|
|
4792
|
+
|
|
4793
|
+
|
|
4794
|
+
</dl>
|
|
4795
|
+
|
|
4796
|
+
|
|
4797
|
+
|
|
4798
|
+
|
|
4799
|
+
|
|
4800
|
+
|
|
4801
|
+
|
|
4802
|
+
|
|
4803
|
+
|
|
4804
|
+
|
|
4805
|
+
|
|
4806
|
+
|
|
4807
|
+
|
|
4808
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
4809
|
+
|
|
4810
|
+
|
|
4811
|
+
<table class="params">
|
|
4812
|
+
<thead>
|
|
4813
|
+
<tr>
|
|
4814
|
+
|
|
4815
|
+
<th>Name</th>
|
|
4816
|
+
|
|
4817
|
+
|
|
4818
|
+
<th>Type</th>
|
|
4819
|
+
|
|
4820
|
+
|
|
4821
|
+
|
|
4822
|
+
|
|
4823
|
+
|
|
4824
|
+
<th class="last">Description</th>
|
|
4825
|
+
</tr>
|
|
4826
|
+
</thead>
|
|
4827
|
+
|
|
4828
|
+
<tbody>
|
|
4829
|
+
|
|
4830
|
+
|
|
4831
|
+
<tr>
|
|
4832
|
+
|
|
4833
|
+
<td class="name"><code>threadId</code></td>
|
|
4834
|
+
|
|
4835
|
+
|
|
4836
|
+
<td class="type">
|
|
4837
|
+
|
|
4838
|
+
|
|
4839
|
+
<span class="param-type">number</span>
|
|
4840
|
+
|
|
4841
|
+
|
|
4842
|
+
|
|
4843
|
+
|
|
4844
|
+
</td>
|
|
4845
|
+
|
|
4846
|
+
|
|
4847
|
+
|
|
4848
|
+
|
|
4849
|
+
|
|
4850
|
+
<td class="description last">The ID of the thread to pin.</td>
|
|
4851
|
+
</tr>
|
|
4852
|
+
|
|
4853
|
+
|
|
4854
|
+
|
|
4855
|
+
<tr>
|
|
4856
|
+
|
|
4857
|
+
<td class="name"><code>brand</code></td>
|
|
4858
|
+
|
|
4859
|
+
|
|
4860
|
+
<td class="type">
|
|
4861
|
+
|
|
4862
|
+
|
|
4863
|
+
<span class="param-type">string</span>
|
|
4864
|
+
|
|
4865
|
+
|
|
4866
|
+
|
|
4867
|
+
|
|
4868
|
+
</td>
|
|
4869
|
+
|
|
4870
|
+
|
|
4871
|
+
|
|
4872
|
+
|
|
4873
|
+
|
|
4874
|
+
<td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
|
|
4875
|
+
</tr>
|
|
4876
|
+
|
|
4877
|
+
|
|
4878
|
+
</tbody>
|
|
4879
|
+
</table>
|
|
4880
|
+
|
|
4881
|
+
|
|
4882
|
+
|
|
4883
|
+
|
|
4884
|
+
|
|
4885
|
+
|
|
4886
|
+
|
|
4887
|
+
|
|
4888
|
+
|
|
4889
|
+
|
|
4890
|
+
|
|
4891
|
+
|
|
4892
|
+
|
|
4893
|
+
|
|
4894
|
+
<h5 class="h5-throws">Throws:</h5>
|
|
4895
|
+
|
|
4896
|
+
|
|
4897
|
+
|
|
4898
|
+
<dl>
|
|
4899
|
+
<dt>
|
|
4900
|
+
<div class="param-desc usertext">
|
|
4901
|
+
- If the request fails.
|
|
4902
|
+
</div>
|
|
4903
|
+
</dt>
|
|
4904
|
+
<dd></dd>
|
|
4905
|
+
<dt>
|
|
4906
|
+
<dl class="param-type">
|
|
4907
|
+
<dt>
|
|
4908
|
+
Type
|
|
4909
|
+
</dt>
|
|
4910
|
+
<dd>
|
|
4911
|
+
|
|
4912
|
+
<span class="param-type">HttpError</span>
|
|
4913
|
+
|
|
4914
|
+
|
|
4915
|
+
|
|
4916
|
+
</dd>
|
|
4917
|
+
</dl>
|
|
4918
|
+
</dt>
|
|
4919
|
+
<dd></dd>
|
|
4920
|
+
</dl>
|
|
4921
|
+
|
|
4922
|
+
|
|
4923
|
+
|
|
4924
|
+
|
|
4925
|
+
|
|
4926
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
4927
|
+
|
|
4928
|
+
|
|
4929
|
+
<div class="param-desc">
|
|
4930
|
+
- A promise that resolves when the thread is pinned.
|
|
4931
|
+
</div>
|
|
4932
|
+
|
|
4933
|
+
|
|
4934
|
+
|
|
4935
|
+
<dl class="param-type">
|
|
4936
|
+
<dt>
|
|
4937
|
+
Type
|
|
4938
|
+
</dt>
|
|
4939
|
+
<dd>
|
|
4940
|
+
|
|
4941
|
+
<span class="param-type">Promise.<void></span>
|
|
4942
|
+
|
|
4943
|
+
|
|
4944
|
+
|
|
4945
|
+
</dd>
|
|
4946
|
+
</dl>
|
|
4947
|
+
|
|
4948
|
+
|
|
4949
|
+
|
|
4950
|
+
|
|
4951
|
+
|
|
4952
|
+
|
|
4953
|
+
|
|
4954
|
+
|
|
4955
|
+
|
|
4956
|
+
|
|
4957
|
+
<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>
|
|
4958
|
+
|
|
4959
|
+
|
|
4960
|
+
|
|
4961
|
+
|
|
4962
|
+
|
|
4963
|
+
|
|
4964
|
+
<dl class="details">
|
|
4965
|
+
|
|
4966
|
+
<dt class="tag-description">Description:</dt>
|
|
4967
|
+
<dd class="tag-description"><ul class="dummy"><li>Unlock a thread to allow further posts.</li></ul></dd>
|
|
4968
|
+
|
|
4969
|
+
|
|
4970
|
+
|
|
4971
|
+
<dt class="tag-source">Source:</dt>
|
|
4972
|
+
<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#line65">line 65</a>
|
|
4974
|
+
</li></ul></dd>
|
|
4975
|
+
|
|
4976
|
+
|
|
4977
|
+
|
|
4978
|
+
|
|
4979
|
+
|
|
4980
|
+
|
|
4981
|
+
|
|
4982
|
+
|
|
4983
|
+
|
|
4984
|
+
|
|
4985
|
+
|
|
4986
|
+
|
|
4987
|
+
|
|
4988
|
+
|
|
4989
|
+
|
|
4990
|
+
|
|
4991
|
+
|
|
4992
|
+
|
|
4993
|
+
|
|
4994
|
+
|
|
4995
|
+
|
|
4996
|
+
|
|
4997
|
+
|
|
4998
|
+
|
|
4999
|
+
|
|
5000
|
+
|
|
5001
|
+
|
|
5002
|
+
|
|
5003
|
+
|
|
5004
|
+
|
|
5005
|
+
|
|
5006
|
+
</dl>
|
|
5007
|
+
|
|
5008
|
+
|
|
5009
|
+
|
|
5010
|
+
|
|
5011
|
+
|
|
5012
|
+
|
|
5013
|
+
|
|
5014
|
+
|
|
5015
|
+
|
|
5016
|
+
|
|
5017
|
+
|
|
5018
|
+
|
|
5019
|
+
|
|
5020
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
5021
|
+
|
|
5022
|
+
|
|
5023
|
+
<table class="params">
|
|
5024
|
+
<thead>
|
|
5025
|
+
<tr>
|
|
5026
|
+
|
|
5027
|
+
<th>Name</th>
|
|
5028
|
+
|
|
5029
|
+
|
|
5030
|
+
<th>Type</th>
|
|
5031
|
+
|
|
5032
|
+
|
|
5033
|
+
|
|
5034
|
+
|
|
5035
|
+
|
|
5036
|
+
<th class="last">Description</th>
|
|
5037
|
+
</tr>
|
|
5038
|
+
</thead>
|
|
5039
|
+
|
|
5040
|
+
<tbody>
|
|
5041
|
+
|
|
5042
|
+
|
|
5043
|
+
<tr>
|
|
5044
|
+
|
|
5045
|
+
<td class="name"><code>threadId</code></td>
|
|
5046
|
+
|
|
5047
|
+
|
|
5048
|
+
<td class="type">
|
|
5049
|
+
|
|
5050
|
+
|
|
5051
|
+
<span class="param-type">number</span>
|
|
5052
|
+
|
|
5053
|
+
|
|
5054
|
+
|
|
5055
|
+
|
|
5056
|
+
</td>
|
|
5057
|
+
|
|
5058
|
+
|
|
5059
|
+
|
|
5060
|
+
|
|
5061
|
+
|
|
5062
|
+
<td class="description last">The ID of the thread to unlock.</td>
|
|
5063
|
+
</tr>
|
|
5064
|
+
|
|
5065
|
+
|
|
5066
|
+
|
|
5067
|
+
<tr>
|
|
5068
|
+
|
|
5069
|
+
<td class="name"><code>brand</code></td>
|
|
5070
|
+
|
|
5071
|
+
|
|
5072
|
+
<td class="type">
|
|
5073
|
+
|
|
5074
|
+
|
|
5075
|
+
<span class="param-type">string</span>
|
|
5076
|
+
|
|
5077
|
+
|
|
5078
|
+
|
|
5079
|
+
|
|
5080
|
+
</td>
|
|
5081
|
+
|
|
5082
|
+
|
|
5083
|
+
|
|
5084
|
+
|
|
5085
|
+
|
|
5086
|
+
<td class="description last">The brand associated with the unlock action.</td>
|
|
5087
|
+
</tr>
|
|
5088
|
+
|
|
5089
|
+
|
|
5090
|
+
</tbody>
|
|
5091
|
+
</table>
|
|
5092
|
+
|
|
5093
|
+
|
|
5094
|
+
|
|
5095
|
+
|
|
5096
|
+
|
|
5097
|
+
|
|
5098
|
+
|
|
5099
|
+
|
|
5100
|
+
|
|
5101
|
+
|
|
5102
|
+
|
|
5103
|
+
|
|
5104
|
+
|
|
5105
|
+
|
|
5106
|
+
<h5 class="h5-throws">Throws:</h5>
|
|
5107
|
+
|
|
5108
|
+
|
|
5109
|
+
|
|
5110
|
+
<dl>
|
|
5111
|
+
<dt>
|
|
5112
|
+
<div class="param-desc usertext">
|
|
5113
|
+
- If the request fails.
|
|
5114
|
+
</div>
|
|
5115
|
+
</dt>
|
|
5116
|
+
<dd></dd>
|
|
5117
|
+
<dt>
|
|
5118
|
+
<dl class="param-type">
|
|
5119
|
+
<dt>
|
|
5120
|
+
Type
|
|
5121
|
+
</dt>
|
|
5122
|
+
<dd>
|
|
5123
|
+
|
|
5124
|
+
<span class="param-type">HttpError</span>
|
|
5125
|
+
|
|
5126
|
+
|
|
5127
|
+
|
|
5128
|
+
</dd>
|
|
5129
|
+
</dl>
|
|
5130
|
+
</dt>
|
|
5131
|
+
<dd></dd>
|
|
5132
|
+
</dl>
|
|
5133
|
+
|
|
5134
|
+
|
|
5135
|
+
|
|
5136
|
+
|
|
5137
|
+
|
|
5138
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
5139
|
+
|
|
5140
|
+
|
|
5141
|
+
<div class="param-desc">
|
|
5142
|
+
- A promise that resolves when the thread is unlocked.
|
|
5143
|
+
</div>
|
|
5144
|
+
|
|
5145
|
+
|
|
5146
|
+
|
|
5147
|
+
<dl class="param-type">
|
|
5148
|
+
<dt>
|
|
5149
|
+
Type
|
|
5150
|
+
</dt>
|
|
5151
|
+
<dd>
|
|
5152
|
+
|
|
5153
|
+
<span class="param-type">Promise.<void></span>
|
|
5154
|
+
|
|
5155
|
+
|
|
5156
|
+
|
|
5157
|
+
</dd>
|
|
5158
|
+
</dl>
|
|
5159
|
+
|
|
5160
|
+
|
|
5161
|
+
|
|
5162
|
+
|
|
5163
|
+
|
|
5164
|
+
|
|
5165
|
+
|
|
5166
|
+
|
|
5167
|
+
|
|
5168
|
+
|
|
5169
|
+
<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>
|
|
5170
|
+
|
|
5171
|
+
|
|
5172
|
+
|
|
5173
|
+
|
|
5174
|
+
|
|
5175
|
+
|
|
5176
|
+
<dl class="details">
|
|
5177
|
+
|
|
5178
|
+
<dt class="tag-description">Description:</dt>
|
|
5179
|
+
<dd class="tag-description"><ul class="dummy"><li>Unlock a thread to allow further posts.</li></ul></dd>
|
|
5180
|
+
|
|
5181
|
+
|
|
5182
|
+
|
|
5183
|
+
<dt class="tag-source">Source:</dt>
|
|
5184
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
5185
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line147">line 147</a>
|
|
5186
|
+
</li></ul></dd>
|
|
5187
|
+
|
|
5188
|
+
|
|
5189
|
+
|
|
5190
|
+
|
|
5191
|
+
|
|
5192
|
+
|
|
5193
|
+
|
|
5194
|
+
|
|
5195
|
+
|
|
5196
|
+
|
|
5197
|
+
|
|
5198
|
+
|
|
5199
|
+
|
|
5200
|
+
|
|
5201
|
+
|
|
5202
|
+
|
|
5203
|
+
|
|
5204
|
+
|
|
5205
|
+
|
|
5206
|
+
|
|
5207
|
+
|
|
5208
|
+
|
|
5209
|
+
|
|
5210
|
+
|
|
5211
|
+
|
|
5212
|
+
|
|
5213
|
+
|
|
5214
|
+
|
|
5215
|
+
|
|
5216
|
+
|
|
5217
|
+
|
|
5218
|
+
</dl>
|
|
5219
|
+
|
|
5220
|
+
|
|
5221
|
+
|
|
5222
|
+
|
|
5223
|
+
|
|
5224
|
+
|
|
5225
|
+
|
|
5226
|
+
|
|
5227
|
+
|
|
5228
|
+
|
|
5229
|
+
|
|
5230
|
+
|
|
5231
|
+
|
|
5232
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
5233
|
+
|
|
5234
|
+
|
|
5235
|
+
<table class="params">
|
|
5236
|
+
<thead>
|
|
5237
|
+
<tr>
|
|
5238
|
+
|
|
5239
|
+
<th>Name</th>
|
|
5240
|
+
|
|
5241
|
+
|
|
5242
|
+
<th>Type</th>
|
|
5243
|
+
|
|
5244
|
+
|
|
5245
|
+
|
|
5246
|
+
|
|
5247
|
+
|
|
5248
|
+
<th class="last">Description</th>
|
|
5249
|
+
</tr>
|
|
5250
|
+
</thead>
|
|
5251
|
+
|
|
5252
|
+
<tbody>
|
|
5253
|
+
|
|
5254
|
+
|
|
5255
|
+
<tr>
|
|
5256
|
+
|
|
5257
|
+
<td class="name"><code>threadId</code></td>
|
|
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>
|
|
5282
|
+
|
|
5283
|
+
|
|
5284
|
+
<td class="type">
|
|
5285
|
+
|
|
5286
|
+
|
|
5287
|
+
<span class="param-type">string</span>
|
|
5288
|
+
|
|
5289
|
+
|
|
5290
|
+
|
|
5291
|
+
|
|
5292
|
+
</td>
|
|
5293
|
+
|
|
5294
|
+
|
|
5295
|
+
|
|
5296
|
+
|
|
5297
|
+
|
|
5298
|
+
<td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
|
|
5299
|
+
</tr>
|
|
5300
|
+
|
|
5301
|
+
|
|
5302
|
+
</tbody>
|
|
5303
|
+
</table>
|
|
5304
|
+
|
|
5305
|
+
|
|
5306
|
+
|
|
5307
|
+
|
|
5308
|
+
|
|
5309
|
+
|
|
5310
|
+
|
|
5311
|
+
|
|
5312
|
+
|
|
5313
|
+
|
|
5314
|
+
|
|
5315
|
+
|
|
5316
|
+
|
|
5317
|
+
|
|
5318
|
+
<h5 class="h5-throws">Throws:</h5>
|
|
5319
|
+
|
|
5320
|
+
|
|
5321
|
+
|
|
5322
|
+
<dl>
|
|
5323
|
+
<dt>
|
|
5324
|
+
<div class="param-desc usertext">
|
|
5325
|
+
- If the request fails.
|
|
5326
|
+
</div>
|
|
5327
|
+
</dt>
|
|
5328
|
+
<dd></dd>
|
|
5329
|
+
<dt>
|
|
5330
|
+
<dl class="param-type">
|
|
5331
|
+
<dt>
|
|
5332
|
+
Type
|
|
5333
|
+
</dt>
|
|
5334
|
+
<dd>
|
|
5335
|
+
|
|
5336
|
+
<span class="param-type">HttpError</span>
|
|
5337
|
+
|
|
5338
|
+
|
|
5339
|
+
|
|
5340
|
+
</dd>
|
|
5341
|
+
</dl>
|
|
5342
|
+
</dt>
|
|
5343
|
+
<dd></dd>
|
|
5344
|
+
</dl>
|
|
5345
|
+
|
|
5346
|
+
|
|
5347
|
+
|
|
5348
|
+
|
|
5349
|
+
|
|
5350
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
5351
|
+
|
|
5352
|
+
|
|
5353
|
+
<div class="param-desc">
|
|
5354
|
+
- A promise that resolves when the thread is unlocked.
|
|
5355
|
+
</div>
|
|
5356
|
+
|
|
5357
|
+
|
|
5358
|
+
|
|
5359
|
+
<dl class="param-type">
|
|
5360
|
+
<dt>
|
|
5361
|
+
Type
|
|
5362
|
+
</dt>
|
|
5363
|
+
<dd>
|
|
5364
|
+
|
|
5365
|
+
<span class="param-type">Promise.<void></span>
|
|
5366
|
+
|
|
5367
|
+
|
|
5368
|
+
|
|
5369
|
+
</dd>
|
|
5370
|
+
</dl>
|
|
5371
|
+
|
|
5372
|
+
|
|
5373
|
+
|
|
5374
|
+
|
|
5375
|
+
|
|
5376
|
+
|
|
5377
|
+
|
|
5378
|
+
|
|
5379
|
+
|
|
5380
|
+
|
|
5381
|
+
<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>
|
|
5382
|
+
|
|
5383
|
+
|
|
5384
|
+
|
|
5385
|
+
|
|
5386
|
+
|
|
5387
|
+
|
|
5388
|
+
<dl class="details">
|
|
5389
|
+
|
|
5390
|
+
<dt class="tag-description">Description:</dt>
|
|
5391
|
+
<dd class="tag-description"><ul class="dummy"><li>Unpins a thread from the top of its category.</li></ul></dd>
|
|
5392
|
+
|
|
5393
|
+
|
|
5394
|
+
|
|
5395
|
+
<dt class="tag-source">Source:</dt>
|
|
5396
|
+
<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#line121">line 121</a>
|
|
5398
|
+
</li></ul></dd>
|
|
5399
|
+
|
|
5400
|
+
|
|
5401
|
+
|
|
5402
|
+
|
|
5403
|
+
|
|
5404
|
+
|
|
5405
|
+
|
|
5406
|
+
|
|
5407
|
+
|
|
5408
|
+
|
|
5409
|
+
|
|
5410
|
+
|
|
5411
|
+
|
|
5412
|
+
|
|
5413
|
+
|
|
5414
|
+
|
|
5415
|
+
|
|
5416
|
+
|
|
5417
|
+
|
|
5418
|
+
|
|
5419
|
+
|
|
5420
|
+
|
|
5421
|
+
|
|
5422
|
+
|
|
5423
|
+
|
|
5424
|
+
|
|
5425
|
+
|
|
5426
|
+
|
|
5427
|
+
|
|
5428
|
+
|
|
5429
|
+
|
|
5430
|
+
</dl>
|
|
5431
|
+
|
|
5432
|
+
|
|
5433
|
+
|
|
5434
|
+
|
|
5435
|
+
|
|
5436
|
+
|
|
5437
|
+
|
|
5438
|
+
|
|
5439
|
+
|
|
5440
|
+
|
|
5441
|
+
|
|
5442
|
+
|
|
5443
|
+
|
|
5444
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
5445
|
+
|
|
5446
|
+
|
|
5447
|
+
<table class="params">
|
|
5448
|
+
<thead>
|
|
5449
|
+
<tr>
|
|
5450
|
+
|
|
5451
|
+
<th>Name</th>
|
|
5452
|
+
|
|
5453
|
+
|
|
5454
|
+
<th>Type</th>
|
|
5455
|
+
|
|
5456
|
+
|
|
5457
|
+
|
|
5458
|
+
|
|
5459
|
+
|
|
5460
|
+
<th class="last">Description</th>
|
|
5461
|
+
</tr>
|
|
5462
|
+
</thead>
|
|
5463
|
+
|
|
5464
|
+
<tbody>
|
|
5465
|
+
|
|
5466
|
+
|
|
5467
|
+
<tr>
|
|
5468
|
+
|
|
5469
|
+
<td class="name"><code>threadId</code></td>
|
|
5470
|
+
|
|
5471
|
+
|
|
5472
|
+
<td class="type">
|
|
5473
|
+
|
|
5474
|
+
|
|
5475
|
+
<span class="param-type">number</span>
|
|
5476
|
+
|
|
5477
|
+
|
|
5478
|
+
|
|
5479
|
+
|
|
5480
|
+
</td>
|
|
5481
|
+
|
|
5482
|
+
|
|
5483
|
+
|
|
5484
|
+
|
|
5485
|
+
|
|
5486
|
+
<td class="description last">The ID of the thread to unpin.</td>
|
|
5487
|
+
</tr>
|
|
5488
|
+
|
|
5489
|
+
|
|
5490
|
+
|
|
5491
|
+
<tr>
|
|
5492
|
+
|
|
5493
|
+
<td class="name"><code>brand</code></td>
|
|
5494
|
+
|
|
5495
|
+
|
|
5496
|
+
<td class="type">
|
|
5497
|
+
|
|
5498
|
+
|
|
5499
|
+
<span class="param-type">string</span>
|
|
5500
|
+
|
|
5501
|
+
|
|
5502
|
+
|
|
5503
|
+
|
|
5504
|
+
</td>
|
|
5505
|
+
|
|
5506
|
+
|
|
5507
|
+
|
|
5508
|
+
|
|
5509
|
+
|
|
5510
|
+
<td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
|
|
5511
|
+
</tr>
|
|
5512
|
+
|
|
5513
|
+
|
|
5514
|
+
</tbody>
|
|
5515
|
+
</table>
|
|
5516
|
+
|
|
5517
|
+
|
|
5518
|
+
|
|
5519
|
+
|
|
5520
|
+
|
|
5521
|
+
|
|
5522
|
+
|
|
5523
|
+
|
|
5524
|
+
|
|
5525
|
+
|
|
5526
|
+
|
|
5527
|
+
|
|
5528
|
+
|
|
5529
|
+
|
|
5530
|
+
<h5 class="h5-throws">Throws:</h5>
|
|
5531
|
+
|
|
5532
|
+
|
|
5533
|
+
|
|
5534
|
+
<dl>
|
|
5535
|
+
<dt>
|
|
5536
|
+
<div class="param-desc usertext">
|
|
5537
|
+
- If the request fails.
|
|
5538
|
+
</div>
|
|
5539
|
+
</dt>
|
|
5540
|
+
<dd></dd>
|
|
5541
|
+
<dt>
|
|
5542
|
+
<dl class="param-type">
|
|
5543
|
+
<dt>
|
|
5544
|
+
Type
|
|
5545
|
+
</dt>
|
|
5546
|
+
<dd>
|
|
5547
|
+
|
|
5548
|
+
<span class="param-type">HttpError</span>
|
|
5549
|
+
|
|
5550
|
+
|
|
5551
|
+
|
|
5552
|
+
</dd>
|
|
5553
|
+
</dl>
|
|
5554
|
+
</dt>
|
|
5555
|
+
<dd></dd>
|
|
5556
|
+
</dl>
|
|
5557
|
+
|
|
5558
|
+
|
|
5559
|
+
|
|
5560
|
+
|
|
5561
|
+
|
|
5562
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
5563
|
+
|
|
5564
|
+
|
|
5565
|
+
<div class="param-desc">
|
|
5566
|
+
- A promise that resolves when the thread is unpinned.
|
|
5567
|
+
</div>
|
|
5568
|
+
|
|
5569
|
+
|
|
5570
|
+
|
|
5571
|
+
<dl class="param-type">
|
|
5572
|
+
<dt>
|
|
5573
|
+
Type
|
|
5574
|
+
</dt>
|
|
5575
|
+
<dd>
|
|
5576
|
+
|
|
5577
|
+
<span class="param-type">Promise.<void></span>
|
|
5578
|
+
|
|
5579
|
+
|
|
5580
|
+
|
|
5581
|
+
</dd>
|
|
5582
|
+
</dl>
|
|
5583
|
+
|
|
5584
|
+
|
|
5585
|
+
|
|
5586
|
+
|
|
5587
|
+
|
|
5588
|
+
|
|
5589
|
+
|
|
5590
|
+
|
|
5591
|
+
|
|
5592
|
+
|
|
5593
|
+
<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>
|
|
5594
|
+
|
|
5595
|
+
|
|
5596
|
+
|
|
5597
|
+
|
|
5598
|
+
|
|
5599
|
+
|
|
5600
|
+
<dl class="details">
|
|
5601
|
+
|
|
5602
|
+
<dt class="tag-description">Description:</dt>
|
|
5603
|
+
<dd class="tag-description"><ul class="dummy"><li>Creates a new forum category.</li></ul></dd>
|
|
5604
|
+
|
|
5605
|
+
|
|
5606
|
+
|
|
5607
|
+
<dt class="tag-source">Source:</dt>
|
|
5608
|
+
<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#line53">line 53</a>
|
|
5610
|
+
</li></ul></dd>
|
|
5611
|
+
|
|
5612
|
+
|
|
5613
|
+
|
|
5614
|
+
|
|
5615
|
+
|
|
5616
|
+
|
|
5617
|
+
|
|
5618
|
+
|
|
5619
|
+
|
|
5620
|
+
|
|
5621
|
+
|
|
5622
|
+
|
|
5623
|
+
|
|
5624
|
+
|
|
5625
|
+
|
|
5626
|
+
|
|
5627
|
+
|
|
5628
|
+
|
|
5629
|
+
|
|
5630
|
+
|
|
5631
|
+
|
|
5632
|
+
|
|
5633
|
+
|
|
5634
|
+
|
|
5635
|
+
|
|
5636
|
+
|
|
5637
|
+
|
|
5638
|
+
|
|
5639
|
+
|
|
5640
|
+
|
|
5641
|
+
|
|
5642
|
+
</dl>
|
|
5643
|
+
|
|
5644
|
+
|
|
5645
|
+
|
|
5646
|
+
|
|
5647
|
+
|
|
5648
|
+
|
|
5649
|
+
|
|
5650
|
+
|
|
5651
|
+
|
|
5652
|
+
|
|
5653
|
+
|
|
5654
|
+
|
|
5655
|
+
|
|
5656
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
5657
|
+
|
|
5658
|
+
|
|
5659
|
+
<table class="params">
|
|
5660
|
+
<thead>
|
|
5661
|
+
<tr>
|
|
5662
|
+
|
|
5663
|
+
<th>Name</th>
|
|
5664
|
+
|
|
5665
|
+
|
|
5666
|
+
<th>Type</th>
|
|
5667
|
+
|
|
5668
|
+
|
|
5669
|
+
|
|
5670
|
+
|
|
5671
|
+
|
|
5672
|
+
<th class="last">Description</th>
|
|
5673
|
+
</tr>
|
|
5674
|
+
</thead>
|
|
5675
|
+
|
|
5676
|
+
<tbody>
|
|
5677
|
+
|
|
5678
|
+
|
|
5679
|
+
<tr>
|
|
5680
|
+
|
|
5681
|
+
<td class="name"><code>params</code></td>
|
|
5682
|
+
|
|
5683
|
+
|
|
5684
|
+
<td class="type">
|
|
5685
|
+
|
|
5686
|
+
|
|
5687
|
+
<span class="param-type">UpdateForumCategoryParams</span>
|
|
5688
|
+
|
|
5689
|
+
|
|
5690
|
+
|
|
5691
|
+
|
|
5692
|
+
</td>
|
|
5693
|
+
|
|
5694
|
+
|
|
5695
|
+
|
|
5696
|
+
|
|
5697
|
+
|
|
5698
|
+
<td class="description last">The parameters for creating the forum category.</td>
|
|
5699
|
+
</tr>
|
|
5700
|
+
|
|
5701
|
+
|
|
5702
|
+
</tbody>
|
|
5703
|
+
</table>
|
|
5704
|
+
|
|
5705
|
+
|
|
5706
|
+
|
|
5707
|
+
|
|
5708
|
+
|
|
5709
|
+
|
|
5710
|
+
|
|
5711
|
+
|
|
5712
|
+
|
|
5713
|
+
|
|
5714
|
+
|
|
5715
|
+
|
|
5716
|
+
|
|
5717
|
+
|
|
5718
|
+
<h5 class="h5-throws">Throws:</h5>
|
|
5719
|
+
|
|
5720
|
+
|
|
5721
|
+
|
|
5722
|
+
<dl>
|
|
5723
|
+
<dt>
|
|
5724
|
+
<div class="param-desc usertext">
|
|
5725
|
+
- If the request fails.
|
|
5726
|
+
</div>
|
|
5727
|
+
</dt>
|
|
5728
|
+
<dd></dd>
|
|
5729
|
+
<dt>
|
|
5730
|
+
<dl class="param-type">
|
|
5731
|
+
<dt>
|
|
5732
|
+
Type
|
|
5733
|
+
</dt>
|
|
5734
|
+
<dd>
|
|
5735
|
+
|
|
5736
|
+
<span class="param-type">HttpError</span>
|
|
5737
|
+
|
|
5738
|
+
|
|
5739
|
+
|
|
5740
|
+
</dd>
|
|
5741
|
+
</dl>
|
|
5742
|
+
</dt>
|
|
5743
|
+
<dd></dd>
|
|
5744
|
+
</dl>
|
|
5745
|
+
|
|
5746
|
+
|
|
5747
|
+
|
|
5748
|
+
|
|
5749
|
+
|
|
5750
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
5751
|
+
|
|
5752
|
+
|
|
5753
|
+
<div class="param-desc">
|
|
5754
|
+
- A promise that resolves to the created forum category.
|
|
5755
|
+
</div>
|
|
5756
|
+
|
|
5757
|
+
|
|
5758
|
+
|
|
5759
|
+
<dl class="param-type">
|
|
5760
|
+
<dt>
|
|
5761
|
+
Type
|
|
5762
|
+
</dt>
|
|
5763
|
+
<dd>
|
|
5764
|
+
|
|
5765
|
+
<span class="param-type">Promise.<ForumCategory></span>
|
|
5766
|
+
|
|
5767
|
+
|
|
5768
|
+
|
|
5769
|
+
</dd>
|
|
5770
|
+
</dl>
|
|
5771
|
+
|
|
5772
|
+
|
|
5773
|
+
|
|
5774
|
+
|
|
5775
|
+
|
|
5776
|
+
|
|
5777
|
+
|
|
5778
|
+
|
|
5779
|
+
|
|
5780
|
+
|
|
5781
|
+
<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>
|
|
5782
|
+
|
|
5783
|
+
|
|
5784
|
+
|
|
5785
|
+
|
|
5786
|
+
|
|
5787
|
+
|
|
5788
|
+
<dl class="details">
|
|
5789
|
+
|
|
5790
|
+
<dt class="tag-description">Description:</dt>
|
|
5791
|
+
<dd class="tag-description"><ul class="dummy"><li>Updates an existing thread under a forum category.</li></ul></dd>
|
|
5792
|
+
|
|
5793
|
+
|
|
5794
|
+
|
|
5795
|
+
<dt class="tag-source">Source:</dt>
|
|
5796
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
5797
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line36">line 36</a>
|
|
5798
|
+
</li></ul></dd>
|
|
5799
|
+
|
|
5800
|
+
|
|
5801
|
+
|
|
5802
|
+
|
|
5803
|
+
|
|
5804
|
+
|
|
5805
|
+
|
|
5806
|
+
|
|
5807
|
+
|
|
5808
|
+
|
|
5809
|
+
|
|
5810
|
+
|
|
5811
|
+
|
|
5812
|
+
|
|
5813
|
+
|
|
5814
|
+
|
|
5815
|
+
|
|
5816
|
+
|
|
5817
|
+
|
|
5818
|
+
|
|
5819
|
+
|
|
5820
|
+
|
|
5821
|
+
|
|
5822
|
+
|
|
5823
|
+
|
|
5824
|
+
|
|
5825
|
+
|
|
5826
|
+
|
|
5827
|
+
|
|
5828
|
+
|
|
5829
|
+
|
|
5830
|
+
</dl>
|
|
5831
|
+
|
|
5832
|
+
|
|
5833
|
+
|
|
5834
|
+
|
|
5835
|
+
|
|
5836
|
+
|
|
5837
|
+
|
|
5838
|
+
|
|
5839
|
+
|
|
5840
|
+
|
|
5841
|
+
|
|
5842
|
+
|
|
5843
|
+
|
|
5844
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
5845
|
+
|
|
5846
|
+
|
|
5847
|
+
<table class="params">
|
|
5848
|
+
<thead>
|
|
5849
|
+
<tr>
|
|
5850
|
+
|
|
5851
|
+
<th>Name</th>
|
|
5852
|
+
|
|
5853
|
+
|
|
5854
|
+
<th>Type</th>
|
|
5855
|
+
|
|
5856
|
+
|
|
5857
|
+
|
|
5858
|
+
|
|
5859
|
+
|
|
5860
|
+
<th class="last">Description</th>
|
|
5861
|
+
</tr>
|
|
5862
|
+
</thead>
|
|
5863
|
+
|
|
5864
|
+
<tbody>
|
|
5865
|
+
|
|
5866
|
+
|
|
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
|
+
<tr>
|
|
5892
|
+
|
|
5893
|
+
<td class="name"><code>params</code></td>
|
|
5894
|
+
|
|
5895
|
+
|
|
5896
|
+
<td class="type">
|
|
5897
|
+
|
|
5898
|
+
|
|
5899
|
+
<span class="param-type">UpdateThreadParams</span>
|
|
5900
|
+
|
|
5901
|
+
|
|
5902
|
+
|
|
5903
|
+
|
|
5904
|
+
</td>
|
|
5905
|
+
|
|
5906
|
+
|
|
5907
|
+
|
|
5908
|
+
|
|
5909
|
+
|
|
5910
|
+
<td class="description last">The parameters for updating the thread.</td>
|
|
5911
|
+
</tr>
|
|
5912
|
+
|
|
5913
|
+
|
|
5914
|
+
</tbody>
|
|
5915
|
+
</table>
|
|
5916
|
+
|
|
5917
|
+
|
|
5918
|
+
|
|
5919
|
+
|
|
5920
|
+
|
|
5921
|
+
|
|
5922
|
+
|
|
5923
|
+
|
|
5924
|
+
|
|
5925
|
+
|
|
5926
|
+
|
|
5927
|
+
|
|
5928
|
+
|
|
5929
|
+
|
|
5930
|
+
<h5 class="h5-throws">Throws:</h5>
|
|
5931
|
+
|
|
5932
|
+
|
|
5933
|
+
|
|
5934
|
+
<dl>
|
|
5935
|
+
<dt>
|
|
5936
|
+
<div class="param-desc usertext">
|
|
5937
|
+
- If the request fails.
|
|
5938
|
+
</div>
|
|
5939
|
+
</dt>
|
|
5940
|
+
<dd></dd>
|
|
5941
|
+
<dt>
|
|
5942
|
+
<dl class="param-type">
|
|
5943
|
+
<dt>
|
|
5944
|
+
Type
|
|
5945
|
+
</dt>
|
|
5946
|
+
<dd>
|
|
5947
|
+
|
|
5948
|
+
<span class="param-type">HttpError</span>
|
|
5949
|
+
|
|
5950
|
+
|
|
5951
|
+
|
|
5952
|
+
</dd>
|
|
5953
|
+
</dl>
|
|
5954
|
+
</dt>
|
|
5955
|
+
<dd></dd>
|
|
5956
|
+
</dl>
|
|
5957
|
+
|
|
5958
|
+
|
|
5959
|
+
|
|
5960
|
+
|
|
5961
|
+
|
|
5962
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
5963
|
+
|
|
5964
|
+
|
|
5965
|
+
<div class="param-desc">
|
|
5966
|
+
- A promise that resolves to the updated thread.
|
|
5967
|
+
</div>
|
|
5968
|
+
|
|
5969
|
+
|
|
5970
|
+
|
|
5971
|
+
<dl class="param-type">
|
|
5972
|
+
<dt>
|
|
5973
|
+
Type
|
|
5974
|
+
</dt>
|
|
5975
|
+
<dd>
|
|
5976
|
+
|
|
5977
|
+
<span class="param-type">Promise.<ForumThread></span>
|
|
5978
|
+
|
|
5979
|
+
|
|
5980
|
+
|
|
5981
|
+
</dd>
|
|
5982
|
+
</dl>
|
|
5983
|
+
|
|
5984
|
+
|
|
5985
|
+
|
|
5986
|
+
|
|
5987
|
+
|
|
5988
|
+
|
|
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
|
+
|
|
6042
|
+
|
|
6043
|
+
|
|
6044
|
+
|
|
6045
|
+
<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>
|
|
6046
|
+
|
|
6047
|
+
|
|
6048
|
+
|
|
6049
|
+
|
|
6050
|
+
|
|
6051
|
+
|
|
6052
|
+
<dl class="details">
|
|
6053
|
+
|
|
6054
|
+
<dt class="tag-description">Description:</dt>
|
|
6055
|
+
<dd class="tag-description"><ul class="dummy"><li>Creates a new forum category.</li></ul></dd>
|
|
6056
|
+
|
|
6057
|
+
|
|
6058
|
+
|
|
6059
|
+
<dt class="tag-source">Source:</dt>
|
|
6060
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
6061
|
+
<a href="forums_categories.ts.html">forums/categories.ts</a>, <a href="forums_categories.ts.html#line30">line 30</a>
|
|
6062
|
+
</li></ul></dd>
|
|
6063
|
+
|
|
6064
|
+
|
|
6065
|
+
|
|
6066
|
+
|
|
6067
|
+
|
|
6068
|
+
|
|
6069
|
+
|
|
6070
|
+
|
|
6071
|
+
|
|
6072
|
+
|
|
6073
|
+
|
|
6074
|
+
|
|
6075
|
+
|
|
6076
|
+
|
|
6077
|
+
|
|
6078
|
+
|
|
6079
|
+
|
|
6080
|
+
|
|
6081
|
+
|
|
6082
|
+
|
|
6083
|
+
|
|
6084
|
+
|
|
6085
|
+
|
|
6086
|
+
|
|
6087
|
+
|
|
6088
|
+
|
|
6089
|
+
|
|
6090
|
+
|
|
6091
|
+
|
|
6092
|
+
|
|
6093
|
+
|
|
6094
|
+
</dl>
|
|
6095
|
+
|
|
6096
|
+
|
|
6097
|
+
|
|
6098
|
+
|
|
6099
|
+
|
|
6100
|
+
|
|
6101
|
+
|
|
6102
|
+
|
|
6103
|
+
|
|
6104
|
+
|
|
6105
|
+
|
|
6106
|
+
|
|
6107
|
+
|
|
6108
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
6109
|
+
|
|
6110
|
+
|
|
6111
|
+
<table class="params">
|
|
6112
|
+
<thead>
|
|
6113
|
+
<tr>
|
|
6114
|
+
|
|
6115
|
+
<th>Name</th>
|
|
6116
|
+
|
|
6117
|
+
|
|
6118
|
+
<th>Type</th>
|
|
6119
|
+
|
|
6120
|
+
|
|
6121
|
+
|
|
6122
|
+
|
|
6123
|
+
|
|
6124
|
+
<th class="last">Description</th>
|
|
6125
|
+
</tr>
|
|
6126
|
+
</thead>
|
|
6127
|
+
|
|
6128
|
+
<tbody>
|
|
6129
|
+
|
|
6130
|
+
|
|
6131
|
+
<tr>
|
|
6132
|
+
|
|
6133
|
+
<td class="name"><code>params</code></td>
|
|
6134
|
+
|
|
6135
|
+
|
|
6136
|
+
<td class="type">
|
|
6137
|
+
|
|
6138
|
+
|
|
6139
|
+
<span class="param-type">CreateForumCategoryParams</span>
|
|
6140
|
+
|
|
6141
|
+
|
|
6142
|
+
|
|
6143
|
+
|
|
6144
|
+
</td>
|
|
6145
|
+
|
|
6146
|
+
|
|
6147
|
+
|
|
6148
|
+
|
|
6149
|
+
|
|
6150
|
+
<td class="description last">The parameters for creating the forum category.</td>
|
|
6151
|
+
</tr>
|
|
6152
|
+
|
|
6153
|
+
|
|
6154
|
+
</tbody>
|
|
6155
|
+
</table>
|
|
6156
|
+
|
|
6157
|
+
|
|
6158
|
+
|
|
6159
|
+
|
|
6160
|
+
|
|
6161
|
+
|
|
6162
|
+
|
|
6163
|
+
|
|
6164
|
+
|
|
6165
|
+
|
|
6166
|
+
|
|
6167
|
+
|
|
6168
|
+
|
|
6169
|
+
|
|
6170
|
+
<h5 class="h5-throws">Throws:</h5>
|
|
6171
|
+
|
|
6172
|
+
|
|
6173
|
+
|
|
6174
|
+
<dl>
|
|
6175
|
+
<dt>
|
|
6176
|
+
<div class="param-desc usertext">
|
|
6177
|
+
- If the request fails.
|
|
6178
|
+
</div>
|
|
6179
|
+
</dt>
|
|
6180
|
+
<dd></dd>
|
|
6181
|
+
<dt>
|
|
6182
|
+
<dl class="param-type">
|
|
6183
|
+
<dt>
|
|
6184
|
+
Type
|
|
6185
|
+
</dt>
|
|
6186
|
+
<dd>
|
|
6187
|
+
|
|
6188
|
+
<span class="param-type">HttpError</span>
|
|
6189
|
+
|
|
6190
|
+
|
|
6191
|
+
|
|
6192
|
+
</dd>
|
|
6193
|
+
</dl>
|
|
6194
|
+
</dt>
|
|
6195
|
+
<dd></dd>
|
|
6196
|
+
</dl>
|
|
6197
|
+
|
|
6198
|
+
|
|
6199
|
+
|
|
6200
|
+
|
|
6201
|
+
|
|
6202
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
6203
|
+
|
|
6204
|
+
|
|
6205
|
+
<div class="param-desc">
|
|
6206
|
+
- A promise that resolves to the created forum category.
|
|
6207
|
+
</div>
|
|
6208
|
+
|
|
6209
|
+
|
|
6210
|
+
|
|
6211
|
+
<dl class="param-type">
|
|
6212
|
+
<dt>
|
|
6213
|
+
Type
|
|
6214
|
+
</dt>
|
|
6215
|
+
<dd>
|
|
6216
|
+
|
|
6217
|
+
<span class="param-type">Promise.<ForumCategory></span>
|
|
6218
|
+
|
|
6219
|
+
|
|
6220
|
+
|
|
6221
|
+
</dd>
|
|
6222
|
+
</dl>
|
|
6223
|
+
|
|
6224
|
+
|
|
6225
|
+
|
|
6226
|
+
|
|
6227
|
+
|
|
6228
|
+
|
|
6229
|
+
|
|
6230
|
+
|
|
6231
|
+
|
|
6232
|
+
|
|
6233
|
+
<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>
|
|
6234
|
+
|
|
6235
|
+
|
|
6236
|
+
|
|
6237
|
+
|
|
6238
|
+
|
|
6239
|
+
|
|
6240
|
+
<dl class="details">
|
|
6241
|
+
|
|
6242
|
+
<dt class="tag-description">Description:</dt>
|
|
6243
|
+
<dd class="tag-description"><ul class="dummy"><li>Creates a new post under a forum thread.</li></ul></dd>
|
|
6244
|
+
|
|
6245
|
+
|
|
6246
|
+
|
|
6247
|
+
<dt class="tag-source">Source:</dt>
|
|
6248
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
6249
|
+
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line16">line 16</a>
|
|
6250
|
+
</li></ul></dd>
|
|
6251
|
+
|
|
6252
|
+
|
|
6253
|
+
|
|
6254
|
+
|
|
6255
|
+
|
|
6256
|
+
|
|
6257
|
+
|
|
6258
|
+
|
|
6259
|
+
|
|
6260
|
+
|
|
6261
|
+
|
|
6262
|
+
|
|
6263
|
+
|
|
6264
|
+
|
|
6265
|
+
|
|
6266
|
+
|
|
6267
|
+
|
|
6268
|
+
|
|
6269
|
+
|
|
6270
|
+
|
|
6271
|
+
|
|
6272
|
+
|
|
6273
|
+
|
|
6274
|
+
|
|
6275
|
+
|
|
6276
|
+
|
|
6277
|
+
|
|
6278
|
+
|
|
6279
|
+
|
|
6280
|
+
|
|
6281
|
+
|
|
6282
|
+
</dl>
|
|
6283
|
+
|
|
6284
|
+
|
|
6285
|
+
|
|
6286
|
+
|
|
6287
|
+
|
|
6288
|
+
|
|
6289
|
+
|
|
6290
|
+
|
|
6291
|
+
|
|
6292
|
+
|
|
6293
|
+
|
|
6294
|
+
|
|
6295
|
+
|
|
6296
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
6297
|
+
|
|
6298
|
+
|
|
6299
|
+
<table class="params">
|
|
6300
|
+
<thead>
|
|
6301
|
+
<tr>
|
|
6302
|
+
|
|
6303
|
+
<th>Name</th>
|
|
6304
|
+
|
|
6305
|
+
|
|
6306
|
+
<th>Type</th>
|
|
6307
|
+
|
|
6308
|
+
|
|
6309
|
+
|
|
6310
|
+
|
|
6311
|
+
|
|
6312
|
+
<th class="last">Description</th>
|
|
6313
|
+
</tr>
|
|
6314
|
+
</thead>
|
|
6315
|
+
|
|
6316
|
+
<tbody>
|
|
6317
|
+
|
|
6318
|
+
|
|
6319
|
+
<tr>
|
|
6320
|
+
|
|
6321
|
+
<td class="name"><code>params</code></td>
|
|
6322
|
+
|
|
6323
|
+
|
|
6324
|
+
<td class="type">
|
|
6325
|
+
|
|
6326
|
+
|
|
6327
|
+
<span class="param-type">CreatePostParams</span>
|
|
6328
|
+
|
|
6329
|
+
|
|
6330
|
+
|
|
6331
|
+
|
|
6332
|
+
</td>
|
|
6333
|
+
|
|
6334
|
+
|
|
6335
|
+
|
|
6336
|
+
|
|
6337
|
+
|
|
6338
|
+
<td class="description last">The parameters for creating the post.</td>
|
|
6339
|
+
</tr>
|
|
6340
|
+
|
|
6341
|
+
|
|
6342
|
+
</tbody>
|
|
6343
|
+
</table>
|
|
6344
|
+
|
|
6345
|
+
|
|
6346
|
+
|
|
6347
|
+
|
|
6348
|
+
|
|
6349
|
+
|
|
6350
|
+
|
|
6351
|
+
|
|
6352
|
+
|
|
6353
|
+
|
|
6354
|
+
|
|
6355
|
+
|
|
6356
|
+
|
|
6357
|
+
|
|
6358
|
+
<h5 class="h5-throws">Throws:</h5>
|
|
6359
|
+
|
|
6360
|
+
|
|
6361
|
+
|
|
6362
|
+
<dl>
|
|
6363
|
+
<dt>
|
|
6364
|
+
<div class="param-desc usertext">
|
|
6365
|
+
- If the request fails.
|
|
6366
|
+
</div>
|
|
6367
|
+
</dt>
|
|
6368
|
+
<dd></dd>
|
|
6369
|
+
<dt>
|
|
6370
|
+
<dl class="param-type">
|
|
6371
|
+
<dt>
|
|
6372
|
+
Type
|
|
6373
|
+
</dt>
|
|
6374
|
+
<dd>
|
|
6375
|
+
|
|
6376
|
+
<span class="param-type">HttpError</span>
|
|
6377
|
+
|
|
6378
|
+
|
|
6379
|
+
|
|
6380
|
+
</dd>
|
|
6381
|
+
</dl>
|
|
6382
|
+
</dt>
|
|
6383
|
+
<dd></dd>
|
|
6384
|
+
</dl>
|
|
6385
|
+
|
|
6386
|
+
|
|
6387
|
+
|
|
6388
|
+
|
|
6389
|
+
|
|
6390
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
6391
|
+
|
|
6392
|
+
|
|
6393
|
+
<div class="param-desc">
|
|
6394
|
+
- A promise that resolves to the created post.
|
|
6395
|
+
</div>
|
|
6396
|
+
|
|
6397
|
+
|
|
6398
|
+
|
|
6399
|
+
<dl class="param-type">
|
|
6400
|
+
<dt>
|
|
6401
|
+
Type
|
|
6402
|
+
</dt>
|
|
6403
|
+
<dd>
|
|
6404
|
+
|
|
6405
|
+
<span class="param-type">Promise.<ForumPost></span>
|
|
6406
|
+
|
|
6407
|
+
|
|
6408
|
+
|
|
6409
|
+
</dd>
|
|
6410
|
+
</dl>
|
|
6411
|
+
|
|
6412
|
+
|
|
6413
|
+
|
|
6414
|
+
|
|
6415
|
+
|
|
6416
|
+
|
|
6417
|
+
|
|
6418
|
+
|
|
6419
|
+
|
|
6420
|
+
|
|
6421
|
+
<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>
|
|
6422
|
+
|
|
6423
|
+
|
|
6424
|
+
|
|
6425
|
+
|
|
6426
|
+
|
|
6427
|
+
|
|
6428
|
+
<dl class="details">
|
|
6429
|
+
|
|
6430
|
+
<dt class="tag-description">Description:</dt>
|
|
6431
|
+
<dd class="tag-description"><ul class="dummy"><li>Creates a new thread under a forum category.</li></ul></dd>
|
|
6432
|
+
|
|
6433
|
+
|
|
6434
|
+
|
|
6435
|
+
<dt class="tag-source">Source:</dt>
|
|
6436
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
6437
|
+
<a href="forums_threads.ts.html">forums/threads.ts</a>, <a href="forums_threads.ts.html#line17">line 17</a>
|
|
6438
|
+
</li></ul></dd>
|
|
6439
|
+
|
|
6440
|
+
|
|
6441
|
+
|
|
6442
|
+
|
|
6443
|
+
|
|
6444
|
+
|
|
6445
|
+
|
|
6446
|
+
|
|
6447
|
+
|
|
6448
|
+
|
|
6449
|
+
|
|
6450
|
+
|
|
6451
|
+
|
|
6452
|
+
|
|
6453
|
+
|
|
6454
|
+
|
|
6455
|
+
|
|
6456
|
+
|
|
6457
|
+
|
|
6458
|
+
|
|
6459
|
+
|
|
6460
|
+
|
|
6461
|
+
|
|
6462
|
+
|
|
6463
|
+
|
|
6464
|
+
|
|
6465
|
+
|
|
6466
|
+
|
|
6467
|
+
|
|
6468
|
+
|
|
6469
|
+
|
|
6470
|
+
</dl>
|
|
6471
|
+
|
|
6472
|
+
|
|
6473
|
+
|
|
6474
|
+
|
|
6475
|
+
|
|
6476
|
+
|
|
6477
|
+
|
|
6478
|
+
|
|
6479
|
+
|
|
6480
|
+
|
|
6481
|
+
|
|
6482
|
+
|
|
6483
|
+
|
|
6484
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
6485
|
+
|
|
6486
|
+
|
|
6487
|
+
<table class="params">
|
|
6488
|
+
<thead>
|
|
6489
|
+
<tr>
|
|
6490
|
+
|
|
6491
|
+
<th>Name</th>
|
|
6492
|
+
|
|
6493
|
+
|
|
6494
|
+
<th>Type</th>
|
|
6495
|
+
|
|
6496
|
+
|
|
6497
|
+
|
|
6498
|
+
|
|
6499
|
+
|
|
6500
|
+
<th class="last">Description</th>
|
|
6501
|
+
</tr>
|
|
6502
|
+
</thead>
|
|
6503
|
+
|
|
6504
|
+
<tbody>
|
|
6505
|
+
|
|
6506
|
+
|
|
6507
|
+
<tr>
|
|
6508
|
+
|
|
6509
|
+
<td class="name"><code>params</code></td>
|
|
6510
|
+
|
|
6511
|
+
|
|
6512
|
+
<td class="type">
|
|
6513
|
+
|
|
6514
|
+
|
|
6515
|
+
<span class="param-type">CreateThreadParams</span>
|
|
6516
|
+
|
|
6517
|
+
|
|
6518
|
+
|
|
6519
|
+
|
|
6520
|
+
</td>
|
|
6521
|
+
|
|
6522
|
+
|
|
6523
|
+
|
|
6524
|
+
|
|
6525
|
+
|
|
6526
|
+
<td class="description last">The parameters for creating the thread.</td>
|
|
6527
|
+
</tr>
|
|
6528
|
+
|
|
6529
|
+
|
|
6530
|
+
</tbody>
|
|
6531
|
+
</table>
|
|
6532
|
+
|
|
6533
|
+
|
|
6534
|
+
|
|
6535
|
+
|
|
6536
|
+
|
|
6537
|
+
|
|
6538
|
+
|
|
6539
|
+
|
|
6540
|
+
|
|
6541
|
+
|
|
6542
|
+
|
|
6543
|
+
|
|
6544
|
+
|
|
6545
|
+
|
|
6546
|
+
<h5 class="h5-throws">Throws:</h5>
|
|
6547
|
+
|
|
6548
|
+
|
|
6549
|
+
|
|
6550
|
+
<dl>
|
|
6551
|
+
<dt>
|
|
6552
|
+
<div class="param-desc usertext">
|
|
6553
|
+
- If the request fails.
|
|
6554
|
+
</div>
|
|
6555
|
+
</dt>
|
|
6556
|
+
<dd></dd>
|
|
6557
|
+
<dt>
|
|
6558
|
+
<dl class="param-type">
|
|
6559
|
+
<dt>
|
|
6560
|
+
Type
|
|
6561
|
+
</dt>
|
|
6562
|
+
<dd>
|
|
6563
|
+
|
|
6564
|
+
<span class="param-type">HttpError</span>
|
|
6565
|
+
|
|
6566
|
+
|
|
6567
|
+
|
|
6568
|
+
</dd>
|
|
6569
|
+
</dl>
|
|
6570
|
+
</dt>
|
|
6571
|
+
<dd></dd>
|
|
6572
|
+
</dl>
|
|
6573
|
+
|
|
6574
|
+
|
|
6575
|
+
|
|
6576
|
+
|
|
6577
|
+
|
|
6578
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
6579
|
+
|
|
6580
|
+
|
|
6581
|
+
<div class="param-desc">
|
|
6582
|
+
- A promise that resolves to the created thread.
|
|
6583
|
+
</div>
|
|
6584
|
+
|
|
6585
|
+
|
|
6586
|
+
|
|
6587
|
+
<dl class="param-type">
|
|
6588
|
+
<dt>
|
|
6589
|
+
Type
|
|
6590
|
+
</dt>
|
|
6591
|
+
<dd>
|
|
6592
|
+
|
|
6593
|
+
<span class="param-type">Promise.<ForumThread></span>
|
|
6594
|
+
|
|
6595
|
+
|
|
6596
|
+
|
|
6597
|
+
</dd>
|
|
6598
|
+
</dl>
|
|
6599
|
+
|
|
6600
|
+
|
|
6601
|
+
|
|
6602
|
+
|
|
6603
|
+
|
|
6604
|
+
|
|
6605
|
+
|
|
6606
|
+
|
|
6607
|
+
|
|
6608
|
+
|
|
6609
|
+
<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>
|
|
6610
|
+
|
|
6611
|
+
|
|
6612
|
+
|
|
6613
|
+
|
|
6614
|
+
|
|
6615
|
+
|
|
6616
|
+
<dl class="details">
|
|
6617
|
+
|
|
6618
|
+
<dt class="tag-description">Description:</dt>
|
|
6619
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetches forum categories for the given brand.</li></ul></dd>
|
|
6620
|
+
|
|
6621
|
+
|
|
6622
|
+
|
|
6623
|
+
<dt class="tag-source">Source:</dt>
|
|
6624
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
6625
|
+
<a href="forums_categories.ts.html">forums/categories.ts</a>, <a href="forums_categories.ts.html#line10">line 10</a>
|
|
6626
|
+
</li></ul></dd>
|
|
6627
|
+
|
|
6628
|
+
|
|
6629
|
+
|
|
6630
|
+
|
|
6631
|
+
|
|
6632
|
+
|
|
6633
|
+
|
|
6634
|
+
|
|
6635
|
+
|
|
6636
|
+
|
|
6637
|
+
|
|
6638
|
+
|
|
6639
|
+
|
|
6640
|
+
|
|
6641
|
+
|
|
6642
|
+
|
|
6643
|
+
|
|
6644
|
+
|
|
6645
|
+
|
|
6646
|
+
|
|
6647
|
+
|
|
6648
|
+
|
|
6649
|
+
|
|
6650
|
+
|
|
6651
|
+
|
|
6652
|
+
|
|
6653
|
+
|
|
6654
|
+
|
|
6655
|
+
|
|
6656
|
+
|
|
6657
|
+
|
|
6658
|
+
</dl>
|
|
6659
|
+
|
|
6660
|
+
|
|
6661
|
+
|
|
6662
|
+
|
|
6663
|
+
|
|
6664
|
+
|
|
6665
|
+
|
|
6666
|
+
|
|
6667
|
+
|
|
6668
|
+
|
|
6669
|
+
|
|
6670
|
+
|
|
6671
|
+
|
|
6672
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
6673
|
+
|
|
6674
|
+
|
|
6675
|
+
<table class="params">
|
|
6676
|
+
<thead>
|
|
6677
|
+
<tr>
|
|
6678
|
+
|
|
6679
|
+
<th>Name</th>
|
|
6680
|
+
|
|
6681
|
+
|
|
6682
|
+
<th>Type</th>
|
|
6683
|
+
|
|
6684
|
+
|
|
6685
|
+
|
|
6686
|
+
|
|
6687
|
+
|
|
6688
|
+
<th class="last">Description</th>
|
|
6689
|
+
</tr>
|
|
6690
|
+
</thead>
|
|
6691
|
+
|
|
6692
|
+
<tbody>
|
|
6693
|
+
|
|
6694
|
+
|
|
6695
|
+
<tr>
|
|
6696
|
+
|
|
6697
|
+
<td class="name"><code>brand</code></td>
|
|
6698
|
+
|
|
6699
|
+
|
|
6700
|
+
<td class="type">
|
|
6701
|
+
|
|
6702
|
+
|
|
6703
|
+
<span class="param-type">string</span>
|
|
6704
|
+
|
|
|
6705
|
+
|
|
6706
|
+
<span class="param-type">null</span>
|
|
6707
|
+
|
|
6708
|
+
|
|
6709
|
+
|
|
6710
|
+
|
|
6711
|
+
</td>
|
|
6712
|
+
|
|
6713
|
+
|
|
6714
|
+
|
|
6715
|
+
|
|
6716
|
+
|
|
6717
|
+
<td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
|
|
6718
|
+
</tr>
|
|
6719
|
+
|
|
6720
|
+
|
|
6721
|
+
</tbody>
|
|
6722
|
+
</table>
|
|
6723
|
+
|
|
6724
|
+
|
|
6725
|
+
|
|
6726
|
+
|
|
6727
|
+
|
|
6728
|
+
|
|
6729
|
+
|
|
6730
|
+
|
|
6731
|
+
|
|
6732
|
+
|
|
6733
|
+
|
|
6734
|
+
|
|
6735
|
+
|
|
6736
|
+
|
|
6737
|
+
<h5 class="h5-throws">Throws:</h5>
|
|
6738
|
+
|
|
6739
|
+
|
|
6740
|
+
|
|
6741
|
+
<dl>
|
|
6742
|
+
<dt>
|
|
6743
|
+
<div class="param-desc usertext">
|
|
6744
|
+
- If the request fails.
|
|
6745
|
+
</div>
|
|
6746
|
+
</dt>
|
|
6747
|
+
<dd></dd>
|
|
6748
|
+
<dt>
|
|
6749
|
+
<dl class="param-type">
|
|
6750
|
+
<dt>
|
|
6751
|
+
Type
|
|
6752
|
+
</dt>
|
|
6753
|
+
<dd>
|
|
6754
|
+
|
|
6755
|
+
<span class="param-type">HttpError</span>
|
|
6756
|
+
|
|
6757
|
+
|
|
6758
|
+
|
|
6759
|
+
</dd>
|
|
6760
|
+
</dl>
|
|
6761
|
+
</dt>
|
|
6762
|
+
<dd></dd>
|
|
6763
|
+
</dl>
|
|
6764
|
+
|
|
6765
|
+
|
|
6766
|
+
|
|
6767
|
+
|
|
6768
|
+
|
|
6769
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
6770
|
+
|
|
6771
|
+
|
|
6772
|
+
<div class="param-desc">
|
|
6773
|
+
- A promise that resolves to the list of forum categories.
|
|
6774
|
+
</div>
|
|
6775
|
+
|
|
6776
|
+
|
|
6777
|
+
|
|
6778
|
+
<dl class="param-type">
|
|
6779
|
+
<dt>
|
|
6780
|
+
Type
|
|
6781
|
+
</dt>
|
|
6782
|
+
<dd>
|
|
6783
|
+
|
|
6784
|
+
<span class="param-type">Promise.<ForumCategory></span>
|
|
6785
|
+
|
|
6786
|
+
|
|
6787
|
+
|
|
6788
|
+
</dd>
|
|
6789
|
+
</dl>
|
|
6790
|
+
|
|
6791
|
+
|
|
6792
|
+
|
|
6793
|
+
|
|
6794
|
+
|
|
6795
|
+
|
|
6796
|
+
|
|
6797
|
+
|
|
6798
|
+
|
|
6799
|
+
|
|
6800
|
+
<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>
|
|
6801
|
+
|
|
6802
|
+
|
|
6803
|
+
|
|
6804
|
+
|
|
6805
|
+
|
|
6806
|
+
|
|
6807
|
+
<dl class="details">
|
|
6808
|
+
|
|
6809
|
+
<dt class="tag-description">Description:</dt>
|
|
6810
|
+
<dd class="tag-description"><ul class="dummy"><li>Fetches posts for the given thread.</li></ul></dd>
|
|
6811
|
+
|
|
6812
|
+
|
|
6813
|
+
|
|
6814
|
+
<dt class="tag-source">Source:</dt>
|
|
6815
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
6816
|
+
<a href="forums_posts.ts.html">forums/posts.ts</a>, <a href="forums_posts.ts.html#line37">line 37</a>
|
|
6817
|
+
</li></ul></dd>
|
|
6818
|
+
|
|
6819
|
+
|
|
6820
|
+
|
|
6821
|
+
|
|
6822
|
+
|
|
6823
|
+
|
|
6824
|
+
|
|
6825
|
+
|
|
6826
|
+
|
|
6827
|
+
|
|
6828
|
+
|
|
6829
|
+
|
|
6830
|
+
|
|
6831
|
+
|
|
6832
|
+
|
|
6833
|
+
|
|
6834
|
+
|
|
6835
|
+
|
|
6836
|
+
|
|
6837
|
+
|
|
6838
|
+
|
|
6839
|
+
|
|
6840
|
+
|
|
6841
|
+
|
|
6842
|
+
|
|
6843
|
+
|
|
6844
|
+
|
|
6845
|
+
|
|
6846
|
+
|
|
6847
|
+
|
|
6848
|
+
|
|
6849
|
+
</dl>
|
|
6850
|
+
|
|
6851
|
+
|
|
6852
|
+
|
|
6853
|
+
|
|
6854
|
+
|
|
6855
|
+
|
|
6856
|
+
|
|
6857
|
+
|
|
6858
|
+
|
|
6859
|
+
|
|
6860
|
+
|
|
6861
|
+
|
|
6862
|
+
|
|
6863
|
+
<h5 class="h5-parameters">Parameters:</h5>
|
|
6864
|
+
|
|
6865
|
+
|
|
6866
|
+
<table class="params">
|
|
6867
|
+
<thead>
|
|
6868
|
+
<tr>
|
|
6869
|
+
|
|
6870
|
+
<th>Name</th>
|
|
6871
|
+
|
|
6872
|
+
|
|
6873
|
+
<th>Type</th>
|
|
6874
|
+
|
|
6875
|
+
|
|
6876
|
+
<th>Attributes</th>
|
|
6877
|
+
|
|
6878
|
+
|
|
6879
|
+
|
|
6880
|
+
|
|
6881
|
+
<th class="last">Description</th>
|
|
6882
|
+
</tr>
|
|
6883
|
+
</thead>
|
|
6884
|
+
|
|
6885
|
+
<tbody>
|
|
6886
|
+
|
|
6887
|
+
|
|
6888
|
+
<tr>
|
|
6889
|
+
|
|
6890
|
+
<td class="name"><code>threadId</code></td>
|
|
6891
|
+
|
|
6892
|
+
|
|
6893
|
+
<td class="type">
|
|
6894
|
+
|
|
6895
|
+
|
|
6896
|
+
<span class="param-type">number</span>
|
|
6897
|
+
|
|
6898
|
+
|
|
6899
|
+
|
|
6900
|
+
|
|
6901
|
+
</td>
|
|
6902
|
+
|
|
6903
|
+
|
|
6904
|
+
<td class="attributes">
|
|
6905
|
+
|
|
6906
|
+
|
|
6907
|
+
|
|
6908
|
+
|
|
6909
|
+
|
|
6910
|
+
</td>
|
|
6911
|
+
|
|
6912
|
+
|
|
6913
|
+
|
|
6914
|
+
|
|
6915
|
+
<td class="description last">The ID of the forum thread.</td>
|
|
6916
|
+
</tr>
|
|
6917
|
+
|
|
6918
|
+
|
|
6919
|
+
|
|
6920
|
+
<tr>
|
|
6921
|
+
|
|
6922
|
+
<td class="name"><code>brand</code></td>
|
|
6923
|
+
|
|
6924
|
+
|
|
6925
|
+
<td class="type">
|
|
6926
|
+
|
|
6927
|
+
|
|
6928
|
+
<span class="param-type">string</span>
|
|
6929
|
+
|
|
6930
|
+
|
|
6931
|
+
|
|
6932
|
+
|
|
6933
|
+
</td>
|
|
6934
|
+
|
|
6935
|
+
|
|
6936
|
+
<td class="attributes">
|
|
6937
|
+
|
|
6938
|
+
|
|
6939
|
+
|
|
6940
|
+
|
|
6941
|
+
|
|
6942
|
+
</td>
|
|
6943
|
+
|
|
6944
|
+
|
|
6945
|
+
|
|
6946
|
+
|
|
6947
|
+
<td class="description last">The brand context (e.g., "drumeo", "singeo").</td>
|
|
6948
|
+
</tr>
|
|
6949
|
+
|
|
6950
|
+
|
|
6951
|
+
|
|
6952
|
+
<tr>
|
|
6953
|
+
|
|
6954
|
+
<td class="name"><code>params</code></td>
|
|
6955
|
+
|
|
6956
|
+
|
|
6957
|
+
<td class="type">
|
|
6958
|
+
|
|
6959
|
+
|
|
6960
|
+
<span class="param-type">FetchPostParams</span>
|
|
6961
|
+
|
|
6962
|
+
|
|
6963
|
+
|
|
6964
|
+
|
|
6965
|
+
</td>
|
|
6966
|
+
|
|
6967
|
+
|
|
6968
|
+
<td class="attributes">
|
|
6969
|
+
|
|
6970
|
+
<optional><br>
|
|
6971
|
+
|
|
6972
|
+
|
|
6973
|
+
|
|
6974
|
+
|
|
6975
|
+
|
|
6976
|
+
</td>
|
|
6977
|
+
|
|
6978
|
+
|
|
6979
|
+
|
|
6980
|
+
|
|
6981
|
+
<td class="description last">Optional parameters such as `page`, `limit`, and `sort`.</td>
|
|
6982
|
+
</tr>
|
|
6983
|
+
|
|
6984
|
+
|
|
6985
|
+
</tbody>
|
|
6986
|
+
</table>
|
|
6987
|
+
|
|
6988
|
+
|
|
6989
|
+
|
|
6990
|
+
|
|
6991
|
+
|
|
6992
|
+
|
|
6993
|
+
|
|
6994
|
+
|
|
6995
|
+
|
|
6996
|
+
|
|
6997
|
+
|
|
6998
|
+
|
|
6999
|
+
|
|
7000
|
+
|
|
7001
|
+
<h5 class="h5-throws">Throws:</h5>
|
|
7002
|
+
|
|
7003
|
+
|
|
7004
|
+
|
|
7005
|
+
<dl>
|
|
7006
|
+
<dt>
|
|
7007
|
+
<div class="param-desc usertext">
|
|
7008
|
+
- If the request fails.
|
|
7009
|
+
</div>
|
|
7010
|
+
</dt>
|
|
7011
|
+
<dd></dd>
|
|
7012
|
+
<dt>
|
|
7013
|
+
<dl class="param-type">
|
|
7014
|
+
<dt>
|
|
7015
|
+
Type
|
|
7016
|
+
</dt>
|
|
7017
|
+
<dd>
|
|
7018
|
+
|
|
7019
|
+
<span class="param-type">HttpError</span>
|
|
7020
|
+
|
|
7021
|
+
|
|
7022
|
+
|
|
7023
|
+
</dd>
|
|
7024
|
+
</dl>
|
|
7025
|
+
</dt>
|
|
7026
|
+
<dd></dd>
|
|
7027
|
+
</dl>
|
|
7028
|
+
|
|
7029
|
+
|
|
7030
|
+
|
|
7031
|
+
|
|
7032
|
+
|
|
7033
|
+
<h5 class="h5-returns">Returns:</h5>
|
|
7034
|
+
|
|
7035
|
+
|
|
7036
|
+
<div class="param-desc">
|
|
7037
|
+
- Resolves to a paginated list of forum posts.
|
|
7038
|
+
</div>
|
|
7039
|
+
|
|
7040
|
+
|
|
7041
|
+
|
|
7042
|
+
<dl class="param-type">
|
|
7043
|
+
<dt>
|
|
7044
|
+
Type
|
|
7045
|
+
</dt>
|
|
7046
|
+
<dd>
|
|
7047
|
+
|
|
7048
|
+
<span class="param-type">Promise.<<a href="global.html#PaginatedResponse">PaginatedResponse</a>.<ForumPost>></span>
|
|
7049
|
+
|
|
7050
|
+
|
|
7051
|
+
|
|
7052
|
+
</dd>
|
|
7053
|
+
</dl>
|
|
7054
|
+
|
|
7055
|
+
|
|
7056
|
+
|
|
7057
|
+
|
|
7058
|
+
|
|
7059
|
+
|
|
7060
|
+
|
|
7061
|
+
|
|
7062
|
+
|
|
7063
|
+
|
|
3181
7064
|
<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>
|
|
3182
7065
|
|
|
3183
7066
|
|
|
@@ -5101,7 +8984,7 @@
|
|
|
5101
8984
|
<br class="clear">
|
|
5102
8985
|
|
|
5103
8986
|
<footer>
|
|
5104
|
-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on
|
|
8987
|
+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a> on Thu Sep 25 2025 14:41:42 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
|
|
5105
8988
|
</footer>
|
|
5106
8989
|
|
|
5107
8990
|
<script>prettyPrint();</script>
|