Enables scripted content fragments to use Forums
Properties
| Name | Type | Description | Default | Options |
|---|---|---|---|---|
| ApplicationTypeId | Guid | Forums application type identifier | ||
| ContentTypeId | Guid | Forums content type identifier | ||
| Current | Forum | Current contextual forum | ||
| TotalLicensedRemaining | int | Total number licensed forums |
Methods
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
Create
Creates a forum
Usage
#set($forumResponse = $core_v2_forum.Create($groupId, $name, "%{AllowedThreadTypes = $allowedThreadTypesArg, AutoLockingDefaultInterval = $autoLockingDefaultIntervalArg, AutoLockingEnabled = $autoLockingEnabledArg, DefaultThreadType = $defaultThreadTypeArg, Description = $descriptionArg, EmailFooter = $emailFooterArg, Enabled = $enabledArg, EnableMailingList = $enableMailingListArg, EnablePassiveMode = $enablePassiveModeArg, EnablePostPoints = $enablePostPointsArg, EnablePostStatistics = $enablePostStatisticsArg, EnableQualityVoting = $enableQualityVotingArg, ExtendedAttributes = $extendedAttributesArg, IndexPosts = $indexPostsArg, Key = $keyArg, 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 | Discussion, QuestionAndAnswer |
| AutoLockingDefaultInterval | int | The number of days before a thread is automatically locked when the Forum Auto-Locking plugin is enabled. If not specified and auto-locking is enabled, the plugin's configuration value is used. | Optional | ||
| AutoLockingEnabled | bool | Turns on auto locking of threads according to the configuration of the Forum Auto Locking plugin if it is enabled. | Optional | False | |
| DefaultThreadType | string | The default thread type for the forum if both QuestionAndAnswer and Discussion threads are allowed | Optional | Discussion | Discussion, QuestionAndAnswer |
| Description | string | Description | Optional | ||
| EmailFooter | string | Email Footer | Optional | ||
| Enabled | bool | Enabled | Optional | True | |
| EnableMailingList | bool | Enable Mailing List | Optional | False | |
| EnablePassiveMode | bool | Enable Passive Mode | Optional | False | |
| EnablePostPoints | bool | Obsolete in 10.0. This option is no longer used. | Optional | True | |
| EnablePostStatistics | bool | Enable Post Statistics | Optional | True | |
| EnableQualityVoting | bool | Enable Quality Voting | Optional | False | |
| ExtendedAttributes | string | Extended attributes are key-value pairs set using the syntax _ExtendedAttributes_key=value. i.e. _ExtendedAttributes_MyKey=MyValue sets ExtendedAttributes["MyKey"] to "MyValue". | Optional | ||
| IndexPosts | bool | Index Posts | Optional | True | |
| Key | string | String identifier uniquely identifying a forum within its containing group. Used in the url. If unspecified, will be auto-generated based on the Name | 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 | False | |
| PassiveModeAddress | string | Passive Mode Address. Required if EnablePassiveMode is true. | Optional | True |
Return Type
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
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
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
IsFavorite
Returns favorited status for the accessing user. DEPRECATED: Use $core_v2_bookmark.Get() instead.
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
List
Lists forums
Usage
#set($pagedListResponse = $core_v2_forum.List("%{ApplicationIds = $applicationIdsArg, GroupId = $groupIdArg, IncludeSubGroups = $includeSubGroupsArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, PermissionId = $permissionIdArg, SortBy = $sortByArg, SortOrder = $sortOrderArg, UserId = $userIdArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| ApplicationIds | string | Used to limit to a specific set of forums as well as sort order if SoryBy is set to ApplicationIdsOrder | Optional | ||
| 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 | ApplicationIdsOrder, DateCreated, LastPost, Name, Post, Score:SCORE_ID, SortOrder, Thread, TotalPosts |
| SortOrder | string | Sort Order | Optional | Ascending | Ascending, Descending |
| UserId | int | Obsolete in 9.2: User Id should no longer be used. Rely on the authenticated or impersonated user instead | Optional |
Return Type
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. DEPRECATED: 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
ListTags
Lists tags in a forum. DEPRECATED: 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
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
SetFavorite
Sets favorite status for the accessing user. DEPRECATED: Use $core_v2_bookmark.Create() or $core_v2_bookmark.Delete() instead.
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
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, AutoLockingDefaultInterval = $autoLockingDefaultIntervalArg, AutoLockingEnabled = $autoLockingEnabledArg, DefaultThreadType = $defaultThreadTypeArg, Description = $descriptionArg, EmailFooter = $emailFooterArg, Enabled = $enabledArg, EnableMailingList = $enableMailingListArg, EnablePassiveMode = $enablePassiveModeArg, EnablePostPoints = $enablePostPointsArg, EnablePostStatistics = $enablePostStatisticsArg, EnableQualityVoting = $enableQualityVotingArg, ExtendedAttributes = $extendedAttributesArg, GroupId = $groupIdArg, IndexPosts = $indexPostsArg, Key = $keyArg, 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 | Discussion, QuestionAndAnswer | |
| AutoLockingDefaultInterval | int | The number of days before a thread is automatically locked when the Forum Auto-Locking plugin is enabled. If not specified and auto-locking is enabled, the plugin's configuration value is used. | Optional | ||
| AutoLockingEnabled | bool | Turns on auto locking of threads according to the configuration of the Forum Auto Locking plugin if it is enabled. | Optional | False | |
| DefaultThreadType | string | The default thread type for the forum if both QuestionAndAnswer and Discussion threads are allowed | Optional | Discussion, QuestionAndAnswer | |
| Description | string | Description | Optional | ||
| EmailFooter | string | Email Footer | Optional | ||
| Enabled | bool | Enabled | Optional | ||
| EnableMailingList | bool | Enable Mailing List | Optional | ||
| EnablePassiveMode | bool | Enable Passive Mode | Optional | ||
| EnablePostPoints | bool | Obsolete in 10.0. This option is no longer used. | Optional | True | |
| EnablePostStatistics | bool | Enable Post Statistics | Optional | ||
| EnableQualityVoting | bool | Enable Quality Voting | Optional | False | |
| ExtendedAttributes | string | Extended attributes are key-value pairs set using the syntax _ExtendedAttributes_key=value. i.e. _ExtendedAttributes_MyKey=MyValue sets ExtendedAttributes["MyKey"] to "MyValue". | Optional | ||
| GroupId | int | Group Id | Optional | ||
| IndexPosts | bool | Index Posts | Optional | ||
| Key | string | String identifier uniquely identifying a forum within its containing group. Used in the url. If unspecified, will be auto-generated based on the Name | 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 |