Methods
AreRatingsEnabled
Returns whether ratings are enabled on a media gallery post
Usage
#set($booleanResponse = $core_v2_media.AreRatingsEnabled($id))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| id | int | Id | Required | | |
Return Type
bool
Create
Creates a new media post
Usage
#set($mediaResponse = $core_v2_media.Create($mediaGalleryId, $name, $contentType, $fileName, "%{Description = $descriptionArg, FeaturedImage = $featuredImageArg, FileData = $fileDataArg, FileUrl = $fileUrlArg, IsFeatured = $isFeaturedArg, Tags = $tagsArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| mediaGalleryId | int | Media Gallery Id | Required | | |
| name | string | Name | Required | | |
| contentType | string | Content Type | Required | | |
| fileName | string | File Name | Required | | |
| Description | string | Description | Optional | | |
| FeaturedImage | string | Used to include a featured image when IsFeatured is true. | Optional | | |
| FileData | Byte[] | FileData or FileUrl is required. | Optional | | |
| FileUrl | string | FileData or FileUrl is required. | Optional | | |
| IsFeatured | bool | Is Featured | Optional | False | |
| Tags | string | A comma separated list of tags. | Optional | | |
Return Type
Media
Delete
Deletes a media gallery post
Usage
#set($additionalInfoResponse = $core_v2_media.Delete($mediaGalleryId, $fileId))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| mediaGalleryId | int | Media Gallery Id | Required | | |
| fileId | int | File Id | Required | | |
Return Type
AdditionalInfo
Download
Downloads the media gallery file in response to the the current HTTP request
Usage
$core_v2_media.Download($mediaId)
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| mediaId | int | Media Id | Required | | |
Get
Gets a media gallery post
Usage
#set($mediaResponse = $core_v2_media.Get($mediaGalleryId, $fileId))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| mediaGalleryId | int | Media Gallery Id | Required | | |
| fileId | int | File Id | Required | | |
Return Type
Media
Get
Gets a media gallery post
Usage
#set($mediaResponse = $core_v2_media.Get($contentId))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| contentId | Guid | Content Id | Required | | |
Return Type
Media
Get
Gets a media gallery post
Usage
#set($mediaResponse = $core_v2_media.Get($fileId))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| fileId | int | File Id | Required | | |
Return Type
Media
GetRating
Gets the rating
Usage
#set($ratingResponse = $core_v2_media.GetRating($id))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| id | int | Id | Required | | |
Return Type
Rating
IncrementViewCount
Increments the view count on a media gallery post
Usage
$core_v2_media.IncrementViewCount($id)
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| id | int | Id | Required | | |
IsFavorite
Returns favorite status for the accessing user
Usage
#set($booleanResponse = $core_v2_media.IsFavorite($id))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| id | int | Id | Required | | |
Return Type
bool
IsSubscribed
Returns subscribed status for the accessing user
Usage
#set($booleanResponse = $core_v2_media.IsSubscribed($id))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| id | int | Id | Required | | |
Return Type
bool
List
Lists media gallery posts
Usage
#set($pagedListResponse = $core_v2_media.List("%{GalleryId = $galleryIdArg, GalleryIds = $galleryIdsArg, GroupId = $groupIdArg, IncludeSubGroups = $includeSubGroupsArg, IncludeUnpublished = $includeUnpublishedArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, SortBy = $sortByArg, SortOrder = $sortOrderArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| GalleryId | int | Gallery Id | Optional | | |
| GalleryIds | string | Used to filter by a list of media galleries. Multiple values are separated with commas. | Optional | | |
| GroupId | int | Group Id | Optional | | |
| IncludeSubGroups | bool | Used when filtering by group. | Optional | | |
| IncludeUnpublished | bool | Specifies whether to include unpublished posts. | 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 | |
| SortBy | string | Sort By | Optional | PostDate | Author, Comments, Downloads, PostDate, Rating, Score:SCORE_ID, Subject, Views |
| SortOrder | string | Sort Order | Optional | Ascending | Ascending, Descending |
Return Type
PagedList<Media>
List
Lists media gallery posts
Usage
#set($pagedListResponse = $core_v2_media.List())
Return Type
PagedList<Media>
Preview
Previews a media gallery post
Usage
#set($mediaResponse = $core_v2_media.Preview($mediaGalleryId, $name, $contentType, $fileName, "%{Description = $descriptionArg, FeaturedImage = $featuredImageArg, FileData = $fileDataArg, FileUrl = $fileUrlArg, IsFeatured = $isFeaturedArg, Tags = $tagsArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| mediaGalleryId | int | Media Gallery Id | Required | | |
| name | string | Name | Required | | |
| contentType | string | Content Type | Required | | |
| fileName | string | File Name | Required | | |
| Description | string | Description | Optional | | |
| FeaturedImage | string | Used to include a featured image when IsFeatured is true. | Optional | | |
| FileData | Byte[] | FileData or FileUrl is required. | Optional | | |
| FileUrl | string | FileData or FileUrl is required. | Optional | | |
| IsFeatured | bool | Is Featured | Optional | False | |
| Tags | string | A comma separated list of tags. | Optional | | |
Return Type
Media
Preview
Previews a media gallery post
Usage
#set($mediaResponse = $core_v2_media.Preview($mediaGalleryId, $fileId, "%{ContentType = $contentTypeArg, Description = $descriptionArg, FeaturedImage = $featuredImageArg, FileData = $fileDataArg, FileName = $fileNameArg, FileUrl = $fileUrlArg, IsFeatured = $isFeaturedArg, Name = $nameArg, Tags = $tagsArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| mediaGalleryId | int | Media Gallery Id | Required | | |
| fileId | int | File Id | Required | | |
| ContentType | string | Content Type | Optional | | |
| Description | string | Description | Optional | | |
| FeaturedImage | string | Used to include a featured image when IsFeatured is true. | Optional | | |
| FileData | Byte[] | FileData or FileUrl is required. | Optional | | |
| FileName | string | File Name | Optional | | |
| FileUrl | string | FileData or FileUrl is required. | Optional | | |
| IsFeatured | bool | Is Featured | Optional | False | |
| Name | string | Name | Optional | | |
| Tags | string | A comma separated list of tags. | Optional | | |
Return Type
Media
SetFavorite
Sets favorite status for the accessing user
Usage
$core_v2_media.SetFavorite($id, $favorite)
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| id | int | Id | Required | | |
| favorite | bool | Favorite | Required | | |
SetRating
Sets the rating for the accessing user
Usage
$core_v2_media.SetRating($id, $rating)
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| id | int | Id | Required | | |
| rating | int | Rating | Required | | |
SetSubscribed
Sets subscribed status for the accessing user
Usage
#set($additionalInfoResponse = $core_v2_media.SetSubscribed($id, $subscribe))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| id | int | Id | Required | | |
| subscribe | bool | Subscribe | Required | | |
Return Type
AdditionalInfo
Update
Updates a media post
Usage
#set($mediaResponse = $core_v2_media.Update($mediaGalleryId, $fileId, "%{ContentType = $contentTypeArg, Description = $descriptionArg, FeaturedImage = $featuredImageArg, FileData = $fileDataArg, FileName = $fileNameArg, FileUrl = $fileUrlArg, IsFeatured = $isFeaturedArg, Name = $nameArg, Tags = $tagsArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| mediaGalleryId | int | Media Gallery Id | Required | | |
| fileId | int | File Id | Required | | |
| ContentType | string | Required when updating FileData or FileUrl. | Optional | | |
| Description | string | Description | Optional | | |
| FeaturedImage | string | Used to include a featured image when IsFeatured is true. | Optional | | |
| FileData | Byte[] | File Data | Optional | | |
| FileName | string | Required when updating FileData or FileUrl. | Optional | | |
| FileUrl | string | File Url | Optional | | |
| IsFeatured | bool | Is Featured | Optional | | |
| Name | string | Name | Optional | | |
| Tags | string | A comma separated list of tags. | Optional | | |
Return Type
Media