Enables scripted content fragments to use WikiComments
Methods
Create
Create a wiki page comment. DEPRECATED: Use $core_v2_comments.Create() instead.
Usage
#set($wikiCommentResponse = $core_v2_wikiComment.Create($wikiId, $wikiPageId, $body, "%{ExtendedAttributes = $extendedAttributesArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
wikiId | int? | Wiki Id | Required | ||
wikiPageId | int | Wiki Page Id | Required | ||
body | string | Body | Required | ||
ExtendedAttributes | string | Extended attributes are key-value pairs set using the syntax _ExtendedAttributes_key=value. i.e. _ExtendedAttributes_MyKey=MyValue sets ExtendedAttributes["MyKey"] to "MyValue". | 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 |
Return Type
Create
Create a wiki page comment. DEPRECATED: Use $core_v2_comments.Create() instead.
Usage
#set($wikiCommentResponse = $core_v2_wikiComment.Create($wikiId, $wikiPageId, $body))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
wikiId | int? | Wiki Id | Required | ||
wikiPageId | int | Wiki Page Id | Required | ||
body | string | Body | Required |
Return Type
Delete
Delete a wiki page comment. DEPRECATED: Use $core_v2_comments.Delete() instead.
Usage
#set($additionalInfoResponse = $core_v2_wikiComment.Delete($id, $wikiId, $wikiPageId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
id | int | Comment Id | Required | ||
wikiId | int | Wiki Id | Required | ||
wikiPageId | int | Wiki Page Id | Required |
Return Type
Get
Get a single wiki page comment. DEPRECATED: Use $core_v2_comments.Get() instead.
Usage
#set($wikiCommentResponse = $core_v2_wikiComment.Get($id))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
id | int | Wiki Page Id | Required |
Return Type
List
List comments for a wiki page. DEPRECATED: Use $core_v2_comments.List() instead.
Usage
#set($pagedListResponse = $core_v2_wikiComment.List($wikiId, $wikiPageId, "%{PageIndex = $pageIndexArg, PageSize = $pageSizeArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
wikiId | int? | Wiki Id | Required | ||
wikiPageId | int | Wiki Page Id | Required | ||
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
List
List comments for a wiki page. DEPRECATED: Use $core_v2_comments.List() instead.
Usage
#set($pagedListResponse = $core_v2_wikiComment.List($wikiId, $wikiPageId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
wikiId | int? | Wiki Id | Required | ||
wikiPageId | int | Wiki Page Id | Required |
Return Type
Update
Update a wiki page comment. DEPRECATED: Use $core_v2_comments.Update() instead.
Usage
#set($wikiCommentResponse = $core_v2_wikiComment.Update($wikiId, $wikiPageId, $id))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
wikiId | int? | Wiki Id | Required | ||
wikiPageId | int | Wiki Page Id | Required | ||
id | int | Comment Id | Required |
Return Type
Update
Update a wiki page comment. DEPRECATED: Use $core_v2_comments.Update() instead.
Usage
#set($wikiCommentResponse = $core_v2_wikiComment.Update($wikiId, $wikiPageId, $id, "%{Body = $bodyArg, ExtendedAttributes = $extendedAttributesArg, IsApproved = $isApprovedArg, PublishedDate = $publishedDateArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
wikiId | int? | Wiki Id | Required | ||
wikiPageId | int | Wiki Page Id | Required | ||
id | int | Comment Id | Required | ||
Body | string | Body | Optional | ||
ExtendedAttributes | string | Extended attributes are key-value pairs set using the syntax _ExtendedAttributes_key=value. i.e. _ExtendedAttributes_MyKey=MyValue sets ExtendedAttributes["MyKey"] to "MyValue". | Optional | ||
IsApproved | bool | Is Approved | Optional | True | |
PublishedDate | DateTime | Published Date | Optional | Current Date/Time |