Methods
(async, inner) createForumCategory(params) → {Promise.<ForumCategory>}
- Description:
- Creates a new forum category.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
params |
CreateForumCategoryParams | The parameters for creating the forum category. |
Throws:
-
- If the request fails.
- Type
- HttpError
Returns:
- A promise that resolves to the created forum category.
- Type
- Promise.<ForumCategory>
(async, inner) createPost(threadId, params) → {Promise.<ForumPost>}
- Description:
- Creates a new post under a forum thread.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
threadId |
||
params |
CreatePostParams | The parameters for creating the post. |
Throws:
-
- If the request fails.
- Type
- HttpError
Returns:
- A promise that resolves to the created post.
- Type
- Promise.<ForumPost>
(async, inner) createThread(params) → {Promise.<ForumThread>}
- Description:
- Creates a new thread under a forum category.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
params |
CreateThreadParams | The parameters for creating the thread. |
Throws:
-
- If the request fails.
- Type
- HttpError
Returns:
- A promise that resolves to the created thread.
- Type
- Promise.<ForumThread>
(async, inner) deleteForumCategory(params) → {Promise.<void>}
- Description:
- Deletes a forum category.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
params |
DeleteForumCategoryParams | The parameters for deleting the forum category. |
Throws:
-
- If the request fails.
- Type
- HttpError
Returns:
- A promise that resolves when the category is deleted.
- Type
- Promise.<void>
(async, inner) deletePost(postId, brand) → {Promise.<void>}
- Description:
- Delete a post.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
postId |
number | The ID of the post to delete. |
brand |
string | The brand associated with the delete action. |
Throws:
-
- If the request fails.
- Type
- HttpError
Returns:
- A promise that resolves when the post is deleted.
- Type
- Promise.<void>
(async, inner) deleteThread(threadId, brand) → {Promise.<void>}
- Description:
- Delete a thread.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
threadId |
number | The ID of the thread. |
brand |
string | The brand associated with the delete action. |
Throws:
-
- If the request fails.
- Type
- HttpError
Returns:
- A promise that resolves when the thread is deleted.
- Type
- Promise.<void>
(async, inner) fetchCommunityGuidelines(brand) → {Promise.<Array.<ForumPost>>}
- Description:
- Fetches community guidelines posts for the given brand.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
brand |
string | The brand context (e.g., "drumeo", "singeo"). |
Throws:
-
- If the request fails.
- Type
- HttpError
Returns:
- Resolves to an array of forum posts.
- Type
- Promise.<Array.<ForumPost>>
(async, inner) fetchFollowedThreads(brand) → {Promise.<PaginatedResponse.<ForumThread>>}
- Description:
- Fetches followed forum Threads for the given brand and current user.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
brand |
string | The brand context (e.g., "drumeo", "singeo"). |
Throws:
-
- If the request fails.
- Type
- HttpError
Returns:
- A promise that resolves to the list of forum threads.
- Type
- Promise.<PaginatedResponse.<ForumThread>>
(async, inner) fetchForumCategories(brand) → {Promise.<ForumCategory>}
- Description:
- Fetches forum categories for the given brand.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
brand |
string | null | The brand context (e.g., "drumeo", "singeo"). |
Throws:
-
- If the request fails.
- Type
- HttpError
Returns:
- A promise that resolves to the list of forum categories.
- Type
- Promise.<ForumCategory>
(async, inner) fetchLatestThreads(brand, params) → {Promise.<PaginatedResponse.<ForumThread>>}
- Description:
- Fetches latest forum Threads for the given brand and not blocked to current user.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
brand |
string | The brand context (e.g., "drumeo", "singeo"). |
params |
FetchLatestThreadParams | Optional pagination parameters. |
Throws:
-
- If the request fails.
- Type
- HttpError
Returns:
- A promise that resolves to the list of forum threads.
- Type
- Promise.<PaginatedResponse.<ForumThread>>
(async, inner) fetchPost(postId, brand) → {Promise.<ForumPost>}
- Description:
- Fetches a single forum post by ID.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
postId |
number | The ID of the post to fetch. |
brand |
string | The brand context (e.g., "drumeo", "singeo"). |
Throws:
-
- If the HTTP request fails.
- Type
- HttpError
Returns:
- A promise that resolves to the forum post.
- Type
- Promise.<ForumPost>
(async, inner) fetchPosts(threadId, brand, paramsopt) → {Promise.<PaginatedResponse.<ForumPost>>}
- Description:
- Fetches posts for the given thread. Automatically marks the thread as read when posts are fetched.
- Source:
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
threadId |
number | The ID of the forum thread. | |
brand |
string | The brand context (e.g., "drumeo", "singeo"). | |
params |
FetchPostParams |
<optional> |
Optional parameters such as `page`, `limit`, and `sort`. |
Throws:
-
- If the request fails.
- Type
- HttpError
Returns:
- Resolves to a paginated list of forum posts.
- Type
- Promise.<PaginatedResponse.<ForumPost>>
(async, inner) fetchThread(threadId, brand) → {Promise.<ForumThread>}
- Description:
- Fetches a single forum thread by ID.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
threadId |
number | The ID of the thread to fetch. |
brand |
string | The brand context (e.g., "drumeo", "singeo"). |
Throws:
-
- If the HTTP request fails.
- Type
- HttpError
Returns:
- A promise that resolves to the forum thread.
- Type
- Promise.<ForumThread>
(async, inner) fetchThreads(categoryId, brand, params) → {Promise.<PaginatedResponse.<ForumThread>>}
- Description:
- Fetches forum threads for the given category.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
categoryId |
number | The ID of the forum category. |
brand |
string | The brand context (e.g., "drumeo", "singeo"). |
params |
FetchThreadParams | Optional additional parameters (e.g., is_followed, sort("last_post_published_on","-last_post_published_on","mine")). |
Throws:
-
- If the HTTP request fails.
- Type
- HttpError
Returns:
- A promise that resolves to a paginated list of forum threads.
- Type
- Promise.<PaginatedResponse.<ForumThread>>
(async, inner) followThread(threadId, brand) → {Promise.<void>}
- Description:
- Follow a thread.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
threadId |
number | The ID of the thread to follow. |
brand |
string | The brand associated with the follow action. |
Throws:
-
- If the request fails.
- Type
- HttpError
Returns:
- A promise that resolves when the thread is followed.
- Type
- Promise.<void>
(async, inner) jumpToPost(postId, brand, paramsopt) → {Promise.<PaginatedResponse.<ForumPost>>}
- Description:
- Fetches posts for the given post, jumping to the post's location in the thread. Automatically marks the thread as read when posts are fetched.
- Source:
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
postId |
number | The ID of the forum post. | |
brand |
string | The brand context (e.g., "drumeo", "singeo"). | |
params |
FetchPostParams |
<optional> |
Optional parameters such as `page`, `limit`, and `sort`. |
Throws:
-
- If the request fails.
- Type
- HttpError
Returns:
- Resolves to a paginated list of forum posts.
- Type
- Promise.<PaginatedResponse.<ForumPost>>
(async, inner) likePost(postId, brand) → {Promise.<void>}
- Description:
- Like a forum post.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
postId |
number | The ID of the post to like. |
brand |
string | The brand context (e.g., "drumeo", "singeo"). |
Throws:
-
- If the request fails.
- Type
- HttpError
Returns:
- A promise that resolves when the post is liked.
- Type
- Promise.<void>
(async, inner) lockThread(threadId, brand) → {Promise.<void>}
- Description:
- Locks a thread to prevent further posts.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
threadId |
number | The ID of the thread to lock. |
brand |
string | The brand context (e.g., "drumeo", "singeo"). |
Throws:
-
- If the request fails.
- Type
- HttpError
Returns:
- A promise that resolves when the thread is locked.
- Type
- Promise.<void>
(async, inner) markThreadAsRead(threadId, brand) → {Promise.<void>}
- Description:
- Marks a thread as read for the authenticated user.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
threadId |
number | The ID of the thread to mark as read. |
brand |
string | The brand context (e.g., "drumeo", "singeo"). |
Throws:
-
- If the request fails.
- Type
- HttpError
Returns:
- A promise that resolves when the thread is marked as read.
- Type
- Promise.<void>
(async, inner) pinThread(threadId, brand) → {Promise.<void>}
- Description:
- Pins a thread to the top of its category.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
threadId |
number | The ID of the thread to pin. |
brand |
string | The brand context (e.g., "drumeo", "singeo"). |
Throws:
-
- If the request fails.
- Type
- HttpError
Returns:
- A promise that resolves when the thread is pinned.
- Type
- Promise.<void>
(async, inner) search(brand, paramsopt) → {Promise.<PaginatedResponse.<ForumPost>>}
- Description:
- Search forum posts.
- Source:
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
brand |
string | The brand context (e.g., "drumeo", "singeo"). | |
params |
SearchParams |
<optional> |
Optional search parameters such as `query`, `page`, `limit`, and `sort`. |
Throws:
-
- If the request fails.
- Type
- HttpError
Returns:
- Resolves to a paginated list of forum posts.
- Type
- Promise.<PaginatedResponse.<ForumPost>>
(async, inner) unfollowThread(threadId, brand) → {Promise.<void>}
- Description:
- Unfollow a thread to allow further posts.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
threadId |
number | The ID of the thread to unfollow. |
brand |
string | The brand associated with the unfollow action. |
Throws:
-
- If the request fails.
- Type
- HttpError
Returns:
- A promise that resolves when the thread is unfollowed.
- Type
- Promise.<void>
(async, inner) unlikePost(postId, brand) → {Promise.<void>}
- Description:
- Unlike a forum post.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
postId |
number | The ID of the post to unlike. |
brand |
string | The brand context (e.g., "drumeo", "singeo"). |
Throws:
-
- If the request fails.
- Type
- HttpError
Returns:
- A promise that resolves when the post is unliked.
- Type
- Promise.<void>
(async, inner) unlockThread(threadId, brand) → {Promise.<void>}
- Description:
- Unlock a thread to allow further posts.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
threadId |
number | The ID of the thread to unlock. |
brand |
string | The brand context (e.g., "drumeo", "singeo"). |
Throws:
-
- If the request fails.
- Type
- HttpError
Returns:
- A promise that resolves when the thread is unlocked.
- Type
- Promise.<void>
(async, inner) unpinThread(threadId, brand) → {Promise.<void>}
- Description:
- Unpins a thread from the top of its category.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
threadId |
number | The ID of the thread to unpin. |
brand |
string | The brand context (e.g., "drumeo", "singeo"). |
Throws:
-
- If the request fails.
- Type
- HttpError
Returns:
- A promise that resolves when the thread is unpinned.
- Type
- Promise.<void>
(async, inner) updateForumCategory(params) → {Promise.<ForumCategory>}
- Description:
- Creates a new forum category.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
params |
UpdateForumCategoryParams | The parameters for creating the forum category. |
Throws:
-
- If the request fails.
- Type
- HttpError
Returns:
- A promise that resolves to the created forum category.
- Type
- Promise.<ForumCategory>
(async, inner) updatePost(postId, params) → {Promise.<ForumPost>}
- Description:
- Creates a new post under a forum thread.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
postId |
||
params |
CreatePostParams | The parameters for updating the post. |
Throws:
-
- If the request fails.
- Type
- HttpError
Returns:
- A promise that resolves to the updated post.
- Type
- Promise.<ForumPost>
(async, inner) updateThread(threadId, params) → {Promise.<ForumThread>}
- Description:
- Updates an existing thread under a forum category.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
threadId |
number | The ID of the thread to update. |
params |
UpdateThreadParams | The parameters for updating the thread. |
Throws:
-
- If the request fails.
- Type
- HttpError
Returns:
- A promise that resolves to the updated thread.
- Type
- Promise.<ForumThread>