Enables scripted content fragments to use WikiPages
Properties
| Name | Type | Description | Default | Options |
|---|---|---|---|---|
| CommentSubscriptionTypeId | Guid | |||
| ContentTypeId | Guid | Wiki pages content type identifier | ||
| Current | WikiPage | Returns the current contextual wiki page | ||
| CurrentOrDefault | WikiPage | Returns the current or default wiki page | ||
| CurrentPageKey | string | Current Page Key | ||
| CurrentParent | WikiPage | Parent of current wiki page | ||
| Default | WikiPage | Returns the default wiki page for the current wiki context |
Methods
AreRatingsEnabled
Returns whether ratings are enabled on a page. DEPRECATED: Use $core_v2_rating.CanCreate() instead.
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
Create
Creates a Wiki Page
Usage
#set($wikiPageResponse = $core_v2_wikiPage.Create($wikiId, $title, "%{Body = $bodyArg, CreatedDate = $createdDateArg, FeaturedImage = $featuredImageArg, ForumThreadId = $forumThreadIdArg, HideInTableOfContents = $hideInTableOfContentsArg, IsFeatured = $isFeaturedArg, IsLocked = $isLockedArg, IsPublished = $isPublishedArg, MetaDescription = $metaDescriptionArg, MetaKeywords = $metaKeywordsArg, MetaTitle = $metaTitleArg, ParentPageId = $parentPageIdArg, Position = $positionArg, Tags = $tagsArg, UserId = $userIdArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| wikiId | int | Wiki Id | Required | ||
| title | string | Title | Required | ||
| Body | string | Body | Optional | ||
| CreatedDate | DateTime | Date wiki page was created. | Optional | DateTime.Now | |
| FeaturedImage | string | Used to include a featured image when IsFeatured is true. | Optional | ||
| ForumThreadId | int | Related Forum Thread | Optional | ||
| HideInTableOfContents | bool | When true this page will not be listed in the table of contents. | Optional | ||
| IsFeatured | bool | Is Featured | Optional | False | |
| IsLocked | bool | Is Locked | Optional | False | |
| IsPublished | bool | Is Published | Optional | True | |
| MetaDescription | string | Description used in meta description tag. | Optional | ||
| MetaKeywords | string | Keywords for the meta keyword tag. | Optional | ||
| MetaTitle | string | Title used in page's title tag. | Optional | ||
| ParentPageId | int | Parent Page Id | Optional | ||
| Position | int | Position in the table of contents relative to the parent with the first child being 1 and then increasing sequentially. Only applies to listing the table of contents. | Optional | ||
| Tags | string | A comma separated list of tags. | Optional | ||
| UserId | int | User Id | Optional |
Return Type
Delete
Deletes a Wiki Page
Usage
#set($additionalInfoResponse = $core_v2_wikiPage.Delete($wikiPageId, "%{DeleteChildPages = $deleteChildPagesArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| wikiPageId | int | Wiki Page Id | Required | ||
| DeleteChildPages | bool | Also delete any pages with this page as its parent. Optional. | Optional | False |
Return Type
Get
Gets a Wiki Page
Usage
#set($wikiPageResponse = $core_v2_wikiPage.Get("%{ForumThreadId = $forumThreadIdArg, Id = $idArg, PageKey = $pageKeyArg, PageTitle = $pageTitleArg, WikiId = $wikiIdArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| ForumThreadId | int | Related Forum Thread | Optional | ||
| Id | int | Either Id or WikiId and PageTitle should be specified. | Optional | ||
| PageKey | string | Obsolete, Either Id or WikiId and PageTitle should be specified. | Optional | ||
| PageTitle | string | Either Id or WikiId and PageTitle should be specified. | Optional | ||
| WikiId | int | Wiki Id | Optional |
Return Type
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
GetRating
Gets the rating. DEPRECATED: Use $core_v2_ratedItem.Get() instead.
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 |
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, ContentIds = $contentIdsArg, GroupId = $groupIdArg, IncludeSubGroupContent = $includeSubGroupContentArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, ParentPageId = $parentPageIdArg, QueryType = $queryTypeArg, ShowHiddenInTableOfContents = $showHiddenInTableOfContentsArg, SortBy = $sortByArg, SortOrder = $sortOrderArg, Tags = $tagsArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| wikiId | int | Wiki Id | Required | ||
| AuthorId | int | Author Id | Optional | ||
| ContentIds | string | Comma separated list of ContentIds. Used to limit to a specific set of wiki pages as well as sort order if SoryBy is set to ContentIdsOrder | 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 | |
| ShowHiddenInTableOfContents | bool | When true the list will only show items with their HiddenInTableOfContents flag set to true. When false they are excluded. Not specifying a value will show both. | Optional | ||
| SortBy | string | Sort By | Optional | Date | ContentIdsOrder, Date, Score:SCORE_ID, LastUpdatedDate, Title |
| SortOrder | string | Sort Order | Optional | Descending | Ascending, Descending |
| Tags | string | Tags | Optional |
Return Type
SetRating
Sets the rating for the accessing user. DEPRECATED: Use $core_v2_rating.Create() instead.
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
Update
Updates a Wiki Page
Usage
#set($wikiPageResponse = $core_v2_wikiPage.Update($id, "%{Body = $bodyArg, FeaturedImage = $featuredImageArg, ForumThreadId = $forumThreadIdArg, HideInTableOfContents = $hideInTableOfContentsArg, IsFeatured = $isFeaturedArg, IsLocked = $isLockedArg, IsPublished = $isPublishedArg, LastModifiedDate = $lastModifiedDateArg, MetaDescription = $metaDescriptionArg, MetaKeywords = $metaKeywordsArg, MetaTitle = $metaTitleArg, ParentPageId = $parentPageIdArg, Position = $positionArg, 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 | ||
| HideInTableOfContents | bool | When true this page will not be listed in the table of contents. | Optional | ||
| IsFeatured | bool | Is Featured | Optional | False | |
| IsLocked | bool | Is Locked | Optional | False | |
| IsPublished | bool | Is Published | Optional | True | |
| LastModifiedDate | int | Date the wiki page was last modified | Optional | DateTime.Now | |
| MetaDescription | string | Description used in meta description tag. | Optional | ||
| MetaKeywords | string | Keywords for the meta keyword tag. | Optional | ||
| MetaTitle | string | Title used in page's title tag. | Optional | ||
| ParentPageId | int | Parent Page Id | Optional | ||
| Position | int | Position in the table of contents relative to the parent with the first child being 1 and then increasing sequentially. Only applies to listing the table of contents. | 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 |