Methods
Create
Create a media comment
Usage
#set($mediaCommentResponse = $core_v2_mediaComment.Create($mediaGalleryId, $fileId, $body, "%{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 | | |
| IsApproved | bool | Is Approved | Optional | True | |
| PublishedDate | DateTime | Published Date | Optional | Current Date/Time | |
Return Type
MediaComment
Delete
Delete a media gallery comment
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
AdditionalInfo
Get
Get a single media post comment
Usage
#set($mediaCommentResponse = $core_v2_mediaComment.Get($id))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| id | int | Id | Required | | |
Return Type
MediaComment
List
List comments for a media post
Usage
#set($pagedListResponse = $core_v2_mediaComment.List($fileId))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| fileId | int | File Id | Required | | |
Return Type
PagedList<MediaComment>
List
List comments for a media post
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
PagedList<MediaComment>
Update
Update a media comment
Usage
#set($mediaCommentResponse = $core_v2_mediaComment.Update($mediaGalleryId, $fileId, $id, "%{Body = $bodyArg, 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 | | |
| IsApproved | bool | Is Approved | Optional | True | |
| PublishedDate | DateTime | Published Date | Optional | Current Date/Time | |
Return Type
MediaComment