Methods
Create
Creates a forum
Usage
#set($forumResponse = $core_v2_forum.Create($groupId, $name, "%{AllowedThreadTypes = $allowedThreadTypesArg, DefaultThreadType = $defaultThreadTypeArg, Description = $descriptionArg, EmailFooter = $emailFooterArg, Enabled = $enabledArg, EnableMailingList = $enableMailingListArg, EnableModerationNotifications = $enableModerationNotificationsArg, EnablePassiveMode = $enablePassiveModeArg, EnablePostPoints = $enablePostPointsArg, EnablePostStatistics = $enablePostStatisticsArg, IndexPosts = $indexPostsArg, MailingListAddress = $mailingListAddressArg, MailingListName = $mailingListNameArg, ModeratePosts = $moderatePostsArg, PassiveModeAddress = $passiveModeAddressArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| groupId | int | Group Id | Required | | |
| name | string | Name | Required | | |
| AllowedThreadTypes | string | A comma separated list of thread types supported. | Optional | Discussion | |
| DefaultThreadType | string | The default thread type for the forum if both QuestionAndAnswer and Discussion threads are allowed | Optional | Discussion | |
| Description | string | Description | Optional | | |
| EmailFooter | string | Email Footer | Optional | | |
| Enabled | bool | Enabled | Optional | True | |
| EnableMailingList | bool | Enable Mailing List | Optional | False | |
| EnableModerationNotifications | bool | Enable Moderation Notifications | Optional | False | |
| EnablePassiveMode | bool | Enable Passive Mode | Optional | False | |
| EnablePostPoints | bool | Enable Post Points | Optional | True | |
| EnablePostStatistics | bool | Enable Post Statistics | Optional | True | |
| IndexPosts | bool | Index Posts | Optional | True | |
| MailingListAddress | string | Mailing List Address. Required if EnableMailingList is true | Optional | | |
| MailingListName | string | Mailing List Name. Required if EnableMailingList is true | Optional | | |
| ModeratePosts | bool | Moderate Posts | Optional | False | |
| PassiveModeAddress | string | Passive Mode Address. Required if EnablePassiveMode is true. | Optional | True | |
Return Type
Forum
Create
Creates a forum
Usage
#set($forumResponse = $core_v2_forum.Create($groupId, $name))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| groupId | int | Group Id | Required | | |
| name | string | Name | Required | | |
Return Type
Forum
Delete
Deletes a forum
Usage
#set($additionalInfoResponse = $core_v2_forum.Delete($id))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| id | int | Forum Id | Required | | |
Return Type
AdditionalInfo
Get
Gets a forum
Usage
#set($forumResponse = $core_v2_forum.Get($applicationId))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| applicationId | Guid | Forum Application Id | Required | | |
Return Type
Forum
Get
Gets a forum
Usage
#set($forumResponse = $core_v2_forum.Get($id))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| id | int | Forum Id | Required | | |
Return Type
Forum
IsFavorite
Returns favorited status for the accessing user
Usage
#set($booleanResponse = $core_v2_forum.IsFavorite($forumId))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| forumId | int | Forum Id | Required | | |
Return Type
bool
IsSubscribed
Returns subscribed status for the accessing user
Usage
#set($booleanResponse = $core_v2_forum.IsSubscribed($forumId))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| forumId | int | Forum Id | Required | | |
Return Type
bool
List
Lists forums
Usage
#set($pagedListResponse = $core_v2_forum.List())
Return Type
PagedList<Forum>
List
Lists forums
Usage
#set($pagedListResponse = $core_v2_forum.List("%{GroupId = $groupIdArg, IncludeSubGroups = $includeSubGroupsArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, PermissionId = $permissionIdArg, SortBy = $sortByArg, SortOrder = $sortOrderArg, UserId = $userIdArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| GroupId | int | Group Id | Optional | | |
| IncludeSubGroups | bool | Only used when GroupId is specified. | Optional | False | |
| PageIndex | int | Specify the page number of paged results to return. Zero-based index. | Optional | 0 | |
| PageSize | int | Specify the number of results to return per page. | Optional | 20 | |
| PermissionId | string | Permission Id | Optional | | |
| SortBy | string | Sort By | Optional | SortOrder | DateCreated, LastPost, Name, Post, Score:SCORE_ID, SortOrder, Thread, TotalPosts |
| SortOrder | string | Sort Order | Optional | Ascending | Ascending, Descending |
| UserId | int | User Id | Optional | | |
Return Type
PagedList<Forum>
ListForQuickPost
Lists forums available for a quick post context for the accessing user and current group
Usage
#set($iListResponse = $core_v2_forum.ListForQuickPost())
Return Type
IList<Forum>
ListTaggedContent
Lists tagged content. This method is supported for backwards compatibility, but $core_v2_taggedContent.List() should be used if possible.
Usage
#set($pagedListResponse = $core_v2_forum.ListTaggedContent($tags, "%{ForumId = $forumIdArg, GroupId = $groupIdArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| tags | IList<string> | Tags | Required | | |
| ForumId | int | Forum Id | Optional | | |
| GroupId | int | Group Id | Optional | | |
| PageIndex | int | Specify the page number of paged results to return. Zero-based index. | Optional | 0 | |
| PageSize | int | Specify the number of results to return per page. | Optional | 20 | |
Return Type
PagedList<TaggedContent>
ListTags
Lists tags in a forum. This method is supported for backwards compatibility, but $core_v2_tags.List() should be used if possible.
Usage
#set($pagedListResponse = $core_v2_forum.ListTags("%{FilterTags = $filterTagsArg, ForumId = $forumIdArg, GroupId = $groupIdArg, MinimumItemsPerTag = $minimumItemsPerTagArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| FilterTags | IList<string> | Tags to filter by | Optional | | |
| ForumId | int | Forum Id | Optional | | |
| GroupId | int | Group Id | Optional | | |
| MinimumItemsPerTag | int | Minimum Items Per Tag | Optional | | |
| PageIndex | int | Page Index | Optional | 0 | |
| PageSize | int | Page Size | Optional | 100 | |
Return Type
PagedList<Tag>
MarkAllRead
Marks all threads in a forum as read for the accessing user
Usage
$core_v2_forum.MarkAllRead($forumId, $read)
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| forumId | int | Forum Id | Required | | |
| read | bool | Read Status | Required | | |
Search
Searches forums
Usage
#set($pagedListResponse = $core_v2_forum.Search($queryText, "%{GroupId = $groupIdArg, IncludeSubGroups = $includeSubGroupsArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| queryText | string | Search Query | Required | | |
| GroupId | int | Group Id | Optional | | |
| IncludeSubGroups | bool | Include Sub Groups | Optional | False | |
| PageIndex | int | Specify the page number of paged results to return. Zero-based index. | Optional | 0 | |
| PageSize | int | Specify the number of results to return per page. | Optional | 20 | |
Return Type
PagedList<SearchResult>
SetFavorite
Sets favorite status for the accessing user
Usage
$core_v2_forum.SetFavorite($forumId, $favorite)
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| forumId | int | Forum Id | Required | | |
| favorite | bool | Favorite Status | Required | | |
SetSubscribed
Sets subscribed status for the accessing user
Usage
#set($additionalInfoResponse = $core_v2_forum.SetSubscribed($forumId, $subscribe))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| forumId | int | Forum Id | Required | | |
| subscribe | bool | Subscribed Status | Required | | |
Return Type
AdditionalInfo
SubscriptionType
Gets the subscription type for the accessing user (None, Thread, Post, MailingList)
Usage
#set($stringResponse = $core_v2_forum.SubscriptionType($forumId))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| forumId | int | Forum Id | Required | | |
Return Type
string
Update
Updates a forum
Usage
#set($forumResponse = $core_v2_forum.Update($id, "%{AllowedThreadTypes = $allowedThreadTypesArg, DefaultThreadType = $defaultThreadTypeArg, Description = $descriptionArg, EmailFooter = $emailFooterArg, Enabled = $enabledArg, EnableMailingList = $enableMailingListArg, EnableModerationNotifications = $enableModerationNotificationsArg, EnablePassiveMode = $enablePassiveModeArg, EnablePostPoints = $enablePostPointsArg, EnablePostStatistics = $enablePostStatisticsArg, GroupId = $groupIdArg, IndexPosts = $indexPostsArg, MailingListAddress = $mailingListAddressArg, MailingListName = $mailingListNameArg, ModeratePosts = $moderatePostsArg, Name = $nameArg, PassiveModeAddress = $passiveModeAddressArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| id | int | Forum Id | Required | | |
| AllowedThreadTypes | string | A comma separated list of thread types supported. | Optional | | |
| DefaultThreadType | string | The default thread type for the forum if both QuestionAndAnswer and Discussion threads are allowed | Optional | | |
| Description | string | Description | Optional | | |
| EmailFooter | string | Email Footer | Optional | | |
| Enabled | bool | Enabled | Optional | | |
| EnableMailingList | bool | Enable Mailing List | Optional | | |
| EnableModerationNotifications | bool | Enable Moderation Notifications | Optional | | |
| EnablePassiveMode | bool | Enable Passive Mode | Optional | | |
| EnablePostPoints | bool | Enable Post Points | Optional | | |
| EnablePostStatistics | bool | Enable Post Statistics | Optional | | |
| GroupId | int | Group Id | Optional | | |
| IndexPosts | bool | Index Posts | Optional | | |
| MailingListAddress | string | Mailing List Address. Required if EnableMailingList is true | Optional | | |
| MailingListName | string | Mailing List Name. Required if EnableMailingList is true | Optional | | |
| ModeratePosts | bool | Moderate Posts | Optional | | |
| Name | string | Name | Optional | | |
| PassiveModeAddress | string | Passive Mode Address. Required if EnablePassiveMode is true. | Optional | | |
Return Type
Forum