Enables scripted content fragments to use Wikis
Properties
Name | Type | Description | Default | Options |
---|---|---|---|---|
ApplicationTypeId | Guid | Wikis application type identifier | ||
ContentTypeId | Guid | Wikis content type identifier | ||
Current | Wiki | Returns the current contextual wiki | ||
IsCurrentExplicit | bool | Returns true when the current wiki page is the default of the current wiki | ||
TotalLicensedRemaining | int | Total number licensed wikis |
Methods
Create
Create a Wiki
Usage
#set($wikiResponse = $core_v2_wiki.Create($groupId, $name))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
groupId | int | Group Id | Required | ||
name | string | Name | Required |
Return Type
Create
Create a Wiki
Usage
#set($wikiResponse = $core_v2_wiki.Create($groupId, $name, "%{Description = $descriptionArg, Enabled = $enabledArg, Key = $keyArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
groupId | int | Group Id | Required | ||
name | string | Name | Required | ||
Description | string | Description | Optional | Empty String | |
Enabled | bool | Enabled | Optional | True | |
Key | string | If not specified, the key will be generated | Optional |
Return Type
Delete
Delete a Wiki
Usage
#set($additionalInfoResponse = $core_v2_wiki.Delete($id))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
id | int | Id | Required |
Return Type
Get
Get a Wiki
Usage
#set($wikiResponse = $core_v2_wiki.Get("%{GroupId = $groupIdArg, Id = $idArg, Key = $keyArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
GroupId | int | Either Id or Key + GroupId are required | Optional | ||
Id | int | Either Id or Key + GroupId are required | Optional | ||
Key | string | Either Id or Key + GroupId are required | Optional |
Return Type
Get
Get a Wiki
Usage
#set($wikiResponse = $core_v2_wiki.Get($applicationId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
applicationId | Guid | Application Id | Required |
Return Type
List
List Wikis
Usage
#set($pagedListResponse = $core_v2_wiki.List("%{ApplicationIds = $applicationIdsArg, GroupId = $groupIdArg, IncludeDisabled = $includeDisabledArg, IncludeSubGroups = $includeSubGroupsArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, PermissionId = $permissionIdArg, SortBy = $sortByArg, UserId = $userIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
ApplicationIds | string | Comma separated list of ApplicationIds. Used to limit to a specific set of wikis as well as sort order if SoryBy is set to ApplicationIdsOrder | Optional | ||
GroupId | int | Group Id | Optional | ||
IncludeDisabled | bool | Include Disabled | Optional | False | |
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 | Used to get a list of wikis for which the accessing or impersonated user has the provided Permission ID. | Optional | ||
SortBy | string | Sort By | Optional | Name | ApplicationIdsOrder, Name, Score:SCORE_ID |
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 wikis available for a quick post context for the accessing user and current group
Usage
#set($iListResponse = $core_v2_wiki.ListForQuickPost())
Return Type
IList<Wiki>
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_wiki.ListTaggedContent($tags, "%{GroupId = $groupIdArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, WikiId = $wikiIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
tags | IList<string> | Tags | Required | ||
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 | |
WikiId | int | Wiki Id | Optional |
Return Type
ListTags
Lists tags in a wiki. DEPRECATED: This method is supported for backwards compatibility, but $core_v2_tags.List() should be used if possible.
Usage
#set($pagedListResponse = $core_v2_wiki.ListTags("%{FilterTags = $filterTagsArg, GroupId = $groupIdArg, MinimumItemsPerTag = $minimumItemsPerTagArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, WikiId = $wikiIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
FilterTags | IList<string> | Filter Tags | 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 | |
WikiId | int | Wiki Id | Optional |
Return Type
Search
Search for wikis or groups
Usage
#set($pagedListResponse = $core_v2_wiki.Search($queryText, "%{GroupId = $groupIdArg, IncludeSubGroups = $includeSubGroupsArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
queryText | string | Query Text | 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
Update
Update a Wiki
Usage
#set($wikiResponse = $core_v2_wiki.Update($id, "%{Description = $descriptionArg, Enabled = $enabledArg, GroupId = $groupIdArg, Key = $keyArg, Name = $nameArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
id | int | Id | Required | ||
Description | string | Description | Optional | Default is an empty string. | |
Enabled | bool | Enabled | Optional | True | |
GroupId | int | Group Id | Optional | ||
Key | string | Key | Optional | ||
Name | string | Name | Optional |