core_v2_wikiUrls Script API

Ben Tiedt — Wed, 20 Nov 2019 14:55:17 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/20/2019 14:55:17

Enables scripted content fragments to render links to Wiki-related URLs.

Properties
AddChildPage
AddPage
AddWiki
Compare
ControlPanel
DeletePage
EditPage
EditWiki
GroupAggregateHome
GroupAggregateRss
GroupAggregateTags
ManageWiki
ManageWikiPageComments
ManageWikiPages
Page
PageComments
PageCommentsRss
PageHistory
PageMerge
PageRss
Revision
Rss
SharePage
Tags
UndeletePage
Wiki

Properties

Name	Access	Type	Description
Current	Read	`String`	Current
IsWikiUrl	Read	`Boolean`	Is Wiki Url

Methods

AddChildPage

AddChildPage Overload 1

Velocity

#set($stringResponse = $core_v2_wikiUrls.AddChildPage($pageId))

JavaScript

var stringResponse = core_v2_wikiUrls.AddChildPage(pageId);

Parameters

Name	Type	Description	Required	Default	Options
pageId	`Int32`	Page Id	Required

AddChildPage Overload 2

Velocity

#set($stringResponse = $core_v2_wikiUrls.AddChildPage($pageId, $checkPermissions))

JavaScript

var stringResponse = core_v2_wikiUrls.AddChildPage(pageId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
pageId	`Int32`	Page Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

AddPage

AddPage Overload 1

Velocity

#set($stringResponse = $core_v2_wikiUrls.AddPage($wikiId))

JavaScript

var stringResponse = core_v2_wikiUrls.AddPage(wikiId);

Parameters

Name	Type	Description	Required	Default	Options
wikiId	`Int32`	Wiki Id	Required

AddPage Overload 2

Velocity

#set($stringResponse = $core_v2_wikiUrls.AddPage($wikiId, $checkPermissions))

JavaScript

var stringResponse = core_v2_wikiUrls.AddPage(wikiId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
wikiId	`Int32`	Wiki Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

AddPage Overload 3

Velocity

#set($stringResponse = $core_v2_wikiUrls.AddPage($wikiId, "%{ ForumThreadId = $forumThreadIdArg, ParentPageId = $parentPageIdArg, TemporaryStoreId = $temporaryStoreIdArg }"))

JavaScript

var stringResponse = core_v2_wikiUrls.AddPage(wikiId, { ForumThreadId: forumThreadIdArg, ParentPageId: parentPageIdArg, TemporaryStoreId: temporaryStoreIdArg });

Parameters

Name	Type	Description	Required
wikiId	`Int32`	Wiki Id	Required
ForumThreadId	`Int32`	Forum Thread Id	Optional
ParentPageId	`Int32`	Parent Page Id	Optional
TemporaryStoreId	`Int32`	Temporary Store Id	Optional

AddPage Overload 4

Velocity

#set($stringResponse = $core_v2_wikiUrls.AddPage($wikiId, $checkPermissions, "%{ ForumThreadId = $forumThreadIdArg, ParentPageId = $parentPageIdArg, TemporaryStoreId = $temporaryStoreIdArg }"))

JavaScript

var stringResponse = core_v2_wikiUrls.AddPage(wikiId, checkPermissions, { ForumThreadId: forumThreadIdArg, ParentPageId: parentPageIdArg, TemporaryStoreId: temporaryStoreIdArg });

Parameters

Name	Type	Description	Required
wikiId	`Int32`	Wiki Id	Required
checkPermissions	`Boolean`	Check Permissions	Required
ForumThreadId	`Int32`	Forum Thread Id	Optional
ParentPageId	`Int32`	Parent Page Id	Optional
TemporaryStoreId	`Int32`	Temporary Store Id	Optional

Returns

String

AddWiki

AddWiki Overload 1

Velocity

#set($stringResponse = $core_v2_wikiUrls.AddWiki($groupId))

JavaScript

var stringResponse = core_v2_wikiUrls.AddWiki(groupId);

Parameters

Name	Type	Description	Required	Default	Options
groupId	`Int32`	Group Id	Required

AddWiki Overload 2

Velocity

#set($stringResponse = $core_v2_wikiUrls.AddWiki($groupId, $checkPermissions))

JavaScript

var stringResponse = core_v2_wikiUrls.AddWiki(groupId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
groupId	`Int32`	Group Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

Compare

Compare Overload 1

Velocity

#set($stringResponse = $core_v2_wikiUrls.Compare($pageId, $revision1, $revision2))

JavaScript

var stringResponse = core_v2_wikiUrls.Compare(pageId, revision1, revision2);

Parameters

Name	Type	Description	Required
pageId	`Int32`	Page Id	Required
revision1	`Int32`	Revision 1	Required
revision2	`Int32`	Revision 2	Required

Compare Overload 2

Velocity

#set($stringResponse = $core_v2_wikiUrls.Compare($pageId, $revision1, $revision2, $checkPermissions))

JavaScript

var stringResponse = core_v2_wikiUrls.Compare(pageId, revision1, revision2, checkPermissions);

Parameters

Name	Type	Description	Required
pageId	`Int32`	Page Id	Required
revision1	`Int32`	Revision 1	Required
revision2	`Int32`	Revision 2	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

ControlPanel

ControlPanel Overload 1

Velocity

#set($stringResponse = $core_v2_wikiUrls.ControlPanel($wikiId))

JavaScript

var stringResponse = core_v2_wikiUrls.ControlPanel(wikiId);

Parameters

Name	Type	Description	Required	Default	Options
wikiId	`Int32`	Wiki Id	Required

ControlPanel Overload 2

Velocity

#set($stringResponse = $core_v2_wikiUrls.ControlPanel($wikiId, $checkPermissions))

JavaScript

var stringResponse = core_v2_wikiUrls.ControlPanel(wikiId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
wikiId	`Int32`	Wiki Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

DeletePage

DeletePage Overload 1

Velocity

#set($stringResponse = $core_v2_wikiUrls.DeletePage($pageId))

JavaScript

var stringResponse = core_v2_wikiUrls.DeletePage(pageId);

Parameters

Name	Type	Description	Required	Default	Options
pageId	`Int32`	Page Id	Required

DeletePage Overload 2

Velocity

#set($stringResponse = $core_v2_wikiUrls.DeletePage($pageId, $checkPermissions))

JavaScript

var stringResponse = core_v2_wikiUrls.DeletePage(pageId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
pageId	`Int32`	Page Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

EditPage

EditPage Overload 1

Velocity

#set($stringResponse = $core_v2_wikiUrls.EditPage($pageId))

JavaScript

var stringResponse = core_v2_wikiUrls.EditPage(pageId);

Parameters

Name	Type	Description	Required	Default	Options
pageId	`Int32`	Page Id	Required

EditPage Overload 2

Velocity

#set($stringResponse = $core_v2_wikiUrls.EditPage($pageId, $checkPermissions))

JavaScript

var stringResponse = core_v2_wikiUrls.EditPage(pageId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
pageId	`Int32`	Page Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

EditPage Overload 3

Velocity

#set($stringResponse = $core_v2_wikiUrls.EditPage($pageId, $threadId))

JavaScript

var stringResponse = core_v2_wikiUrls.EditPage(pageId, threadId);

Parameters

Name	Type	Description	Required	Default	Options
pageId	`Int32`	Page Id	Required
threadId	`Int32`	Thread Id	Required

EditPage Overload 4

Velocity

#set($stringResponse = $core_v2_wikiUrls.EditPage($pageId, $threadId, $checkPermissions))

JavaScript

var stringResponse = core_v2_wikiUrls.EditPage(pageId, threadId, checkPermissions);

Parameters

Name	Type	Description	Required
pageId	`Int32`	Page Id	Required
threadId	`Int32`	Thread Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

EditWiki

EditWiki Overload 1

Velocity

#set($stringResponse = $core_v2_wikiUrls.EditWiki($wikiId))

JavaScript

var stringResponse = core_v2_wikiUrls.EditWiki(wikiId);

Parameters

Name	Type	Description	Required	Default	Options
wikiId	`Int32`	Wiki Id	Required

EditWiki Overload 2

Velocity

#set($stringResponse = $core_v2_wikiUrls.EditWiki($wikiId, $checkPermissions))

JavaScript

var stringResponse = core_v2_wikiUrls.EditWiki(wikiId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
wikiId	`Int32`	Wiki Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

GroupAggregateHome

GroupAggregateHome Overload 1

Velocity

#set($stringResponse = $core_v2_wikiUrls.GroupAggregateHome($groupId))

JavaScript

var stringResponse = core_v2_wikiUrls.GroupAggregateHome(groupId);

Parameters

Name	Type	Description	Required	Default	Options
groupId	`Int32`	Group Id	Required

GroupAggregateHome Overload 2

Velocity

#set($stringResponse = $core_v2_wikiUrls.GroupAggregateHome($groupId, $checkPermissions))

JavaScript

var stringResponse = core_v2_wikiUrls.GroupAggregateHome(groupId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
groupId	`Int32`	Group Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

GroupAggregateRss

GroupAggregateRss Overload 1

Velocity

#set($stringResponse = $core_v2_wikiUrls.GroupAggregateRss($groupId))

JavaScript

var stringResponse = core_v2_wikiUrls.GroupAggregateRss(groupId);

Parameters

Name	Type	Description	Required	Default	Options
groupId	`Int32`	Group Id	Required

GroupAggregateRss Overload 2

Velocity

#set($stringResponse = $core_v2_wikiUrls.GroupAggregateRss($groupId, $checkPermissions))

JavaScript

var stringResponse = core_v2_wikiUrls.GroupAggregateRss(groupId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
groupId	`Int32`	Group Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

GroupAggregateTags

GroupAggregateTags Overload 1

Velocity

#set($stringResponse = $core_v2_wikiUrls.GroupAggregateTags($groupId))

JavaScript

var stringResponse = core_v2_wikiUrls.GroupAggregateTags(groupId);

Parameters

Name	Type	Description	Required	Default	Options
groupId	`Int32`	Group Id	Required

GroupAggregateTags Overload 2

Velocity

#set($stringResponse = $core_v2_wikiUrls.GroupAggregateTags($groupId, $checkPermissions))

JavaScript

var stringResponse = core_v2_wikiUrls.GroupAggregateTags(groupId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
groupId	`Int32`	Group Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

GroupAggregateTags Overload 3

Velocity

#set($stringResponse = $core_v2_wikiUrls.GroupAggregateTags($groupId, $tags))

JavaScript

var stringResponse = core_v2_wikiUrls.GroupAggregateTags(groupId, tags);

Parameters

Name	Type	Description	Required	Default	Options
groupId	`Int32`	Group Id	Required
tags	`IList of String`	Tags	Required

GroupAggregateTags Overload 4

Velocity

#set($stringResponse = $core_v2_wikiUrls.GroupAggregateTags($groupId, $tags, $checkPermissions))

JavaScript

var stringResponse = core_v2_wikiUrls.GroupAggregateTags(groupId, tags, checkPermissions);

Parameters

Name	Type	Description	Required
groupId	`Int32`	Group Id	Required
tags	`IList of String`	Tags	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

ManageWiki

ManageWiki Overload 1

Velocity

#set($stringResponse = $core_v2_wikiUrls.ManageWiki($wikiId))

JavaScript

var stringResponse = core_v2_wikiUrls.ManageWiki(wikiId);

Parameters

Name	Type	Description	Required	Default	Options
wikiId	`Int32`	Wiki Id	Required

ManageWiki Overload 2

Velocity

#set($stringResponse = $core_v2_wikiUrls.ManageWiki($wikiId, $checkPermissions))

JavaScript

var stringResponse = core_v2_wikiUrls.ManageWiki(wikiId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
wikiId	`Int32`	Wiki Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

ManageWikiPageComments

ManageWikiPageComments Overload 1

Velocity

#set($stringResponse = $core_v2_wikiUrls.ManageWikiPageComments($wikiId))

JavaScript

var stringResponse = core_v2_wikiUrls.ManageWikiPageComments(wikiId);

Parameters

Name	Type	Description	Required	Default	Options
wikiId	`Int32`	Wiki Id	Required

ManageWikiPageComments Overload 2

Velocity

#set($stringResponse = $core_v2_wikiUrls.ManageWikiPageComments($wikiId, $checkPermissions))

JavaScript

var stringResponse = core_v2_wikiUrls.ManageWikiPageComments(wikiId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
wikiId	`Int32`	Wiki Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

ManageWikiPages

ManageWikiPages Overload 1

Velocity

#set($stringResponse = $core_v2_wikiUrls.ManageWikiPages($wikiId))

JavaScript

var stringResponse = core_v2_wikiUrls.ManageWikiPages(wikiId);

Parameters

Name	Type	Description	Required	Default	Options
wikiId	`Int32`	Wiki Id	Required

ManageWikiPages Overload 2

Velocity

#set($stringResponse = $core_v2_wikiUrls.ManageWikiPages($wikiId, $checkPermissions))

JavaScript

var stringResponse = core_v2_wikiUrls.ManageWikiPages(wikiId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
wikiId	`Int32`	Wiki Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

Page

Page Overload 1

Velocity

#set($stringResponse = $core_v2_wikiUrls.Page($pageId))

JavaScript

var stringResponse = core_v2_wikiUrls.Page(pageId);

Parameters

Name	Type	Description	Required	Default	Options
pageId	`Int32`	Page Id	Required

Page Overload 2

Velocity

#set($stringResponse = $core_v2_wikiUrls.Page($pageId, $checkPermissions))

JavaScript

var stringResponse = core_v2_wikiUrls.Page(pageId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
pageId	`Int32`	Page Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

PageComments

PageComments Overload 1

Velocity

#set($stringResponse = $core_v2_wikiUrls.PageComments($pageId))

JavaScript

var stringResponse = core_v2_wikiUrls.PageComments(pageId);

Parameters

Name	Type	Description	Required	Default	Options
pageId	`Int32`	Page Id	Required

PageComments Overload 2

Velocity

#set($stringResponse = $core_v2_wikiUrls.PageComments($pageId, $checkPermissions))

JavaScript

var stringResponse = core_v2_wikiUrls.PageComments(pageId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
pageId	`Int32`	Page Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

PageCommentsRss

PageCommentsRss Overload 1

Velocity

#set($stringResponse = $core_v2_wikiUrls.PageCommentsRss($pageId))

JavaScript

var stringResponse = core_v2_wikiUrls.PageCommentsRss(pageId);

Parameters

Name	Type	Description	Required	Default	Options
pageId	`Int32`	Page Id	Required

PageCommentsRss Overload 2

Velocity

#set($stringResponse = $core_v2_wikiUrls.PageCommentsRss($pageId, $checkPermissions))

JavaScript

var stringResponse = core_v2_wikiUrls.PageCommentsRss(pageId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
pageId	`Int32`	Page Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

PageHistory

PageHistory Overload 1

Velocity

#set($stringResponse = $core_v2_wikiUrls.PageHistory($pageId))

JavaScript

var stringResponse = core_v2_wikiUrls.PageHistory(pageId);

Parameters

Name	Type	Description	Required	Default	Options
pageId	`Int32`	Page Id	Required

PageHistory Overload 2

Velocity

#set($stringResponse = $core_v2_wikiUrls.PageHistory($pageId, $checkPermissions))

JavaScript

var stringResponse = core_v2_wikiUrls.PageHistory(pageId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
pageId	`Int32`	Page Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

PageMerge

PageMerge Overload 1

Velocity

#set($stringResponse = $core_v2_wikiUrls.PageMerge($pageId, $revision1, $revision2))

JavaScript

var stringResponse = core_v2_wikiUrls.PageMerge(pageId, revision1, revision2);

Parameters

Name	Type	Description	Required
pageId	`Int32`	Page Id	Required
revision1	`Int32`	Revision 1	Required
revision2	`Int32`	Revision 2	Required

PageMerge Overload 2

Velocity

#set($stringResponse = $core_v2_wikiUrls.PageMerge($pageId, $revision1, $revision2, $checkPermissions))

JavaScript

var stringResponse = core_v2_wikiUrls.PageMerge(pageId, revision1, revision2, checkPermissions);

Parameters

Name	Type	Description	Required
pageId	`Int32`	Page Id	Required
revision1	`Int32`	Revision 1	Required
revision2	`Int32`	Revision 2	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

PageRss

PageRss Overload 1

Velocity

#set($stringResponse = $core_v2_wikiUrls.PageRss($pageId))

JavaScript

var stringResponse = core_v2_wikiUrls.PageRss(pageId);

Parameters

Name	Type	Description	Required	Default	Options
pageId	`Int32`	Page Id	Required

PageRss Overload 2

Velocity

#set($stringResponse = $core_v2_wikiUrls.PageRss($pageId, $checkPermissions))

JavaScript

var stringResponse = core_v2_wikiUrls.PageRss(pageId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
pageId	`Int32`	Page Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

Revision

Revision Overload 1

Velocity

#set($stringResponse = $core_v2_wikiUrls.Revision($pageId, $revisionNumber))

JavaScript

var stringResponse = core_v2_wikiUrls.Revision(pageId, revisionNumber);

Parameters

Name	Type	Description	Required	Default	Options
pageId	`Int32`	Page Id	Required
revisionNumber	`Int32`	Revision Number	Required

Revision Overload 2

Velocity

#set($stringResponse = $core_v2_wikiUrls.Revision($pageId, $revisionNumber, $checkPermissions))

JavaScript

var stringResponse = core_v2_wikiUrls.Revision(pageId, revisionNumber, checkPermissions);

Parameters

Name	Type	Description	Required
pageId	`Int32`	Page Id	Required
revisionNumber	`Int32`	Revision Number	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

Rss

Rss Overload 1

Velocity

#set($stringResponse = $core_v2_wikiUrls.Rss($wikiId))

JavaScript

var stringResponse = core_v2_wikiUrls.Rss(wikiId);

Parameters

Name	Type	Description	Required	Default	Options
wikiId	`Int32`	Wiki Id	Required

Rss Overload 2

Velocity

#set($stringResponse = $core_v2_wikiUrls.Rss($wikiId, $checkPermissions))

JavaScript

var stringResponse = core_v2_wikiUrls.Rss(wikiId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
wikiId	`Int32`	Wiki Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

SharePage Overload 1

Velocity

#set($stringResponse = $core_v2_wikiUrls.SharePage($pageId))

JavaScript

var stringResponse = core_v2_wikiUrls.SharePage(pageId);

Parameters

Name	Type	Description	Required	Default	Options
pageId	`Int32`	Page Id	Required

SharePage Overload 2

Velocity

#set($stringResponse = $core_v2_wikiUrls.SharePage($pageId, $checkPermissions))

JavaScript

var stringResponse = core_v2_wikiUrls.SharePage(pageId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
pageId	`Int32`	Page Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

SharePage Overload 3

Velocity

#set($stringResponse = $core_v2_wikiUrls.SharePage($pageId, "%{ CheckPermissions = $checkPermissionsArg, Modal = $modalArg }"))

JavaScript

var stringResponse = core_v2_wikiUrls.SharePage(pageId, { CheckPermissions: checkPermissionsArg, Modal: modalArg });

Parameters

Name	Type	Description	Required	Default
pageId	`Int32`	Page Id	Required
CheckPermissions		Enable checking permissions before returning the URL	Optional	True
Modal		Will the URL be rendered within a modal	Optional	True

Returns

String

UndeletePage

UndeletePage Overload 1

Velocity

#set($stringResponse = $core_v2_wikiUrls.UndeletePage($pageId))

JavaScript

var stringResponse = core_v2_wikiUrls.UndeletePage(pageId);

Parameters

Name	Type	Description	Required	Default	Options
pageId	`Int32`	Page Id	Required

UndeletePage Overload 2

Velocity

#set($stringResponse = $core_v2_wikiUrls.UndeletePage($pageId, $checkPermissions))

JavaScript

var stringResponse = core_v2_wikiUrls.UndeletePage(pageId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
pageId	`Int32`	Page Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

Wiki

Wiki Overload 1

Velocity

#set($stringResponse = $core_v2_wikiUrls.Wiki($wikiId))

JavaScript

var stringResponse = core_v2_wikiUrls.Wiki(wikiId);

Parameters

Name	Type	Description	Required	Default	Options
wikiId	`Int32`	Wiki Id	Required

Wiki Overload 2

Velocity

#set($stringResponse = $core_v2_wikiUrls.Wiki($wikiId, $checkPermissions))

JavaScript

var stringResponse = core_v2_wikiUrls.Wiki(wikiId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
wikiId	`Int32`	Wiki Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String