Enables scripted content fragments to use MediaComments
Methods
Create
Create a media comment. DEPRECATED: Use $core_v2_comments.Create() instead.
Usage
#set($mediaCommentResponse = $core_v2_mediaComment.Create($mediaGalleryId, $fileId, $body, "%{ExtendedAttributes = $extendedAttributesArg, IsApproved = $isApprovedArg, PublishedDate = $publishedDateArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
mediaGalleryId | int | Media Gallery Id | Required | ||
fileId | int | File 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 | ||
IsApproved | bool | Is Approved | Optional | True | |
PublishedDate | DateTime | Published Date | Optional | Current Date/Time |
Return Type
Delete
Delete a media gallery comment. DEPRECATED: Use $core_v2_comments.Delete() instead.
Usage
#set($additionalInfoResponse = $core_v2_mediaComment.Delete($id, $mediaGalleryId, $fileId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
id | int | Comment Id | Required | ||
mediaGalleryId | int | Media Gallery Id | Required | ||
fileId | int | File Id | Required |
Return Type
Get
Get a single media post comment. DEPRECATED: Use $core_v2_comments.Get() instead.
Usage
#set($mediaCommentResponse = $core_v2_mediaComment.Get($id))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
id | int | Id | Required |
Return Type
List
List comments for a media post. DEPRECATED: Use $core_v2_comments.List() instead.
Usage
#set($pagedListResponse = $core_v2_mediaComment.List($fileId, "%{IncludeUnpublished = $includeUnpublishedArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
fileId | int | File Id | Required | ||
IncludeUnpublished | bool | Include Unpublished | 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
List
List comments for a media post. DEPRECATED: Use $core_v2_comments.List() instead.
Usage
#set($pagedListResponse = $core_v2_mediaComment.List($fileId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
fileId | int | File Id | Required |
Return Type
Update
Update a media comment. DEPRECATED: Use $core_v2_comments.Create() instead.
Usage
#set($mediaCommentResponse = $core_v2_mediaComment.Update($mediaGalleryId, $fileId, $id, "%{Body = $bodyArg, ExtendedAttributes = $extendedAttributesArg, IsApproved = $isApprovedArg, PublishedDate = $publishedDateArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
mediaGalleryId | int | Media Gallery Id | Required | ||
fileId | int | File 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 |