Methods
AreRatingsEnabled
Returns whether ratings are enabled on a page
Usage
#set($booleanResponse = $core_v2_wikiPage.AreRatingsEnabled($id))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| id | int | Wiki Page Id | Required | | |
Return Type
bool
Create
Creates a Wiki Page
Usage
#set($wikiPageResponse = $core_v2_wikiPage.Create($wikiId, $title))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| wikiId | int | Wiki Id | Required | | |
| title | string | Title | Required | | |
Return Type
WikiPage
Create
Creates a Wiki Page
Usage
#set($wikiPageResponse = $core_v2_wikiPage.Create($wikiId, $title, "%{Body = $bodyArg, FeaturedImage = $featuredImageArg, ForumThreadId = $forumThreadIdArg, IsFeatured = $isFeaturedArg, IsLocked = $isLockedArg, IsPublished = $isPublishedArg, ParentPageId = $parentPageIdArg, Tags = $tagsArg, UserId = $userIdArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| wikiId | int | Wiki Id | Required | | |
| title | string | Title | Required | | |
| Body | string | Body | Optional | | |
| FeaturedImage | string | Used to include a featured image when IsFeatured is true. | Optional | | |
| ForumThreadId | int | Related Forum Thread | Optional | | |
| IsFeatured | bool | Is Featured | Optional | False | |
| IsLocked | bool | Is Locked | Optional | False | |
| IsPublished | bool | Is Published | Optional | True | |
| ParentPageId | int | Parent Page Id | Optional | | |
| Tags | string | A comma separated list of tags. | Optional | | |
| UserId | int | User Id | Optional | | |
Return Type
WikiPage
Get
Gets a Wiki Page
Usage
#set($wikiPageResponse = $core_v2_wikiPage.Get("%{ForumThreadId = $forumThreadIdArg, Id = $idArg, PageKey = $pageKeyArg, WikiId = $wikiIdArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| ForumThreadId | int | Related Forum Thread | Optional | | |
| Id | int | Either Id or WikiId and PageKey should be specified. | Optional | | |
| PageKey | string | Either Id or WikiId and PageKey should be specified. | Optional | | |
| WikiId | int | Wiki Id | Optional | | |
Return Type
WikiPage
Get
Gets a Wiki Page
Usage
#set($wikiPageResponse = $core_v2_wikiPage.Get($contentId))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| contentId | Guid | Content Id | Required | | |
Return Type
WikiPage
GetRating
Gets the rating
Usage
#set($ratingResponse = $core_v2_wikiPage.GetRating($id))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| id | int | Wiki Page Id | Required | | |
Return Type
Rating
IncrementViewCount
Increments the view count on the wiki page
Usage
$core_v2_wikiPage.IncrementViewCount($id)
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| id | int | Wiki Page Id | Required | | |
IsFavorite
Returns favorite status for the accessing user
Usage
#set($booleanResponse = $core_v2_wikiPage.IsFavorite($id))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| id | int | Wiki Page Id | Required | | |
Return Type
bool
IsSubscribed
Returns subscribed status for the accessing user
Usage
#set($booleanResponse = $core_v2_wikiPage.IsSubscribed($id))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| id | int | Wiki Page Id | Required | | |
Return Type
bool
List
Lists Wiki Pages
Usage
#set($pagedListResponse = $core_v2_wikiPage.List($wikiId, "%{AuthorId = $authorIdArg, GroupId = $groupIdArg, IncludeSubGroupContent = $includeSubGroupContentArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, ParentPageId = $parentPageIdArg, QueryType = $queryTypeArg, SortBy = $sortByArg, Tags = $tagsArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| wikiId | int | Wiki Id | Required | | |
| AuthorId | int | Author Id | Optional | | |
| GroupId | int | Group Id | Optional | | |
| IncludeSubGroupContent | bool | Include Sub Group Content | 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 | |
| ParentPageId | int | Parent Page Id | Optional | | |
| QueryType | string | Query Type | Optional | | All, AllByTags, New, Updated |
| SortBy | string | Sort By | Optional | Date | Date, Score:SCORE_ID |
| Tags | string | Tags | Optional | | |
Return Type
PagedList<WikiPage>
SetFavorite
Sets favorite status for the accessing user
Usage
$core_v2_wikiPage.SetFavorite($id, $favorite)
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| id | int | Wiki Page Id | Required | | |
| favorite | bool | Favorite Status | Required | | |
SetRating
Sets the rating for the accessing user
Usage
$core_v2_wikiPage.SetRating($id, $rating)
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| id | int | Wiki Page Id | Required | | |
| rating | int | Rating value (0-5) | Required | | |
SetSubscribed
Sets subscribed status for the accessing user
Usage
#set($additionalInfoResponse = $core_v2_wikiPage.SetSubscribed($id, $subscribe))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| id | int | Wiki Page Id | Required | | |
| subscribe | bool | Subscribed Status | Required | | |
Return Type
AdditionalInfo
Update
Updates a Wiki Page
Usage
#set($wikiPageResponse = $core_v2_wikiPage.Update($id, "%{Body = $bodyArg, FeaturedImage = $featuredImageArg, ForumThreadId = $forumThreadIdArg, IsFeatured = $isFeaturedArg, IsLocked = $isLockedArg, IsPublished = $isPublishedArg, ParentPageId = $parentPageIdArg, SaveRevision = $saveRevisionArg, Tags = $tagsArg, Title = $titleArg, UserId = $userIdArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| id | int | Id | Required | | |
| Body | string | Body | Optional | | |
| FeaturedImage | string | Used to include a featured image when IsFeatured is true. | Optional | | |
| ForumThreadId | int | Related Forum Thread | Optional | | |
| IsFeatured | bool | Is Featured | Optional | False | |
| IsLocked | bool | Is Locked | Optional | False | |
| IsPublished | bool | Is Published | Optional | True | |
| ParentPageId | int | Parent Page Id | Optional | | |
| SaveRevision | bool | Save Revision | Optional | True | |
| Tags | string | A comma separated list of tags. | Optional | | |
| Title | string | Title | Optional | | |
| UserId | int | User Id | Optional | | |
Return Type
WikiPage