Enables scripted content fragments to use BlogComments
Methods
Create
Create a new blog post comment. DEPRECATED: Use $core_v2_comments.Create() instead.
Usage
#set($blogCommentResponse = $core_v2_blogComment.Create($blogPostId, $body))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
blogPostId | int | The parent blog post id for the comment. | Required | ||
body | string | Body of the comment | Required |
Return Type
Create
Create a new blog post comment. DEPRECATED: Use $core_v2_comments.Create() instead.
Usage
#set($blogCommentResponse = $core_v2_blogComment.Create($blogPostId, $body, "%{ExtendedAttributes = $extendedAttributesArg, IsApproved = $isApprovedArg, PublishedDate = $publishedDateArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
blogPostId | int | The parent blog post id for the comment. | Required | ||
body | string | Body of the comment | 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 | ||
IsApproved | bool | Whether the comment should be considered approved | Optional | True | |
PublishedDate | DateTime | If PublishedDate is not specified it will default to the current date/time | Optional |
Return Type
Delete
Delete a blog post comment. DEPRECATED: Use $core_v2_comments.Update() instead.
Usage
#set($additionalInfoResponse = $core_v2_blogComment.Delete($id, $blogId, $blogPostId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
id | int | Id of the blog post comment | Required | ||
blogId | int | Id of the parent blog | Required | ||
blogPostId | int | Id of the parent blog post | Required |
Return Type
Get
Get a single blog post comment. DEPRECATED: Use $core_v2_comments.Get() instead.
Usage
#set($blogCommentResponse = $core_v2_blogComment.Get($commentId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
commentId | int | Id of blog post comment | Required |
Return Type
Get
Get a single blog post comment. DEPRECATED: Use $core_v2_comments.Get() instead.
Usage
#set($blogCommentResponse = $core_v2_blogComment.Get($commentId, "%{BlogId = $blogIdArg, BlogPostId = $blogPostIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
commentId | int | Id of blog post comment | Required | ||
BlogId | int | Id of blog | Optional | ||
BlogPostId | int | The parent blog post id for the comment. | Optional |
Return Type
List
Lists blog post comments. DEPRECATED: Use $core_v2_comments.List() instead.
Usage
#set($pagedListResponse = $core_v2_blogComment.List($blogPostId, "%{IncludeUnpublished = $includeUnpublishedArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, SortBy = $sortByArg, SortOrder = $sortOrderArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
blogPostId | int | The parent blog post id. | Required | ||
IncludeUnpublished | bool | defines whether response should include unpublished posts too. Default is published only. | 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. Max 100 | Optional | 20 | |
SortBy | string | Sort By | Optional | MostRecent | ContentIdsOrder, MostComments, MostRecent, MostViewed, Score |
SortOrder | string | Sort Order | Optional | Ascending | Ascending, Descending |
Return Type
List
Lists blog post comments. DEPRECATED: Use $core_v2_comments.List() instead.
Usage
#set($pagedListResponse = $core_v2_blogComment.List($blogPostId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
blogPostId | int | The parent blog post id. | Required |
Return Type
Update
Updates a blog post comment. DEPRECATED: Use $core_v2_comments.Update() instead.
Usage
#set($blogCommentResponse = $core_v2_blogComment.Update($id, "%{Body = $bodyArg, ExtendedAttributes = $extendedAttributesArg, IsApproved = $isApprovedArg, PublishedDate = $publishedDateArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
id | int | Id of the blog post comment | Required | ||
Body | string | Body of the comment | 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 | Whether the comment should be considered approved | Optional | True | |
PublishedDate | DateTime | If PublishedDate is not specified it will default to the current date/time. | Optional |