$core_v2_wiki Widget Extension - Telligent Evolution 7.0 - 7.1 Developer Documentation - Developer Space

Enables scripted content fragments to use Wikis

Properties

Name	Type	Description
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

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

Wiki

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
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

Wiki

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

AdditionalInfo

Get

Get a Wiki

Usage

#set($wikiResponse = $core_v2_wiki.Get("%{GroupId = $groupIdArg, Id = $idArg, Key = $keyArg}"))

Parameters

Name	Type	Description	Required
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

Wiki

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

Wiki

IsFavorite

Returns favorite status for the accessing user

Usage

#set($booleanResponse = $core_v2_wiki.IsFavorite($id))

Parameters

Name	Type	Description	Required	Default	Options
id	`int`	Id	Required

Return Type

bool

List

List Wikis

Usage

#set($pagedListResponse = $core_v2_wiki.List("%{GroupId = $groupIdArg, IncludeDisabled = $includeDisabledArg, IncludeSubGroups = $includeSubGroupsArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, PermissionId = $permissionIdArg, SortBy = $sortByArg, UserId = $userIdArg}"))

Parameters

Name	Type	Description	Required	Default	Options
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 user set in UserId has the provided Permission ID.	Optional
SortBy	`string`	Sort By	Optional	Name	Name, Score:SCORE_ID
UserId	`int`	User ID for which to check permissions. This option is only used whenever the PermissionId is also supplied.	Optional

Return Type

PagedList<Wiki>

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. 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
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

PagedList<TaggedContent>

ListTags

Lists tags in a wiki. 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
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

PagedList<Tag>

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
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

PagedList<SearchResult>

SetFavorite

Sets favorite status for the accessing user

Usage

$core_v2_wiki.SetFavorite($id, $favorite)

Parameters

Name	Type	Description	Required	Default	Options
id	`int`	Id	Required
favorite	`bool`	Favorite Status	Required

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
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

Return Type

Wiki