core_v2_mediaUrls Script API

Ben Tiedt — Fri, 23 Apr 2021 19:55:16 GMT

Current Revision posted to API Documentation by Ben Tiedt on 04/23/2021 19:55:16

Enables scripted content fragments to render links to media-related URLs.

Properties
AddGallery
AddMedia
DownloadMedia
EditGallery
EditMedia
Gallery
GroupAggregate
GroupAggregateRss
GroupAggregateTags
ManageFiles
ManageGallery
Media
ModerateGallery
NextMedia
PreviousMedia
Rss
ShareMedia
Slideshow
Tags
TagsRss
UploadMedia

Properties

Name	Access	Type	Description
Current	Read	`String`	Current
IsMediaUrl	Read	`Boolean`	Is Media Url

Methods

AddGallery

AddGallery Overload 1

Velocity

#set($stringResponse = $core_v2_mediaUrls.AddGallery($groupId))

JavaScript

var stringResponse = core_v2_mediaUrls.AddGallery(groupId);

Parameters

Name	Type	Description	Required	Default	Options
groupId	`Int32`	Group Id	Required

AddGallery Overload 2

Velocity

#set($stringResponse = $core_v2_mediaUrls.AddGallery($groupId, $checkPermissions))

JavaScript

var stringResponse = core_v2_mediaUrls.AddGallery(groupId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
groupId	`Int32`	Group Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

AddMedia

AddMedia Overload 1

Velocity

#set($stringResponse = $core_v2_mediaUrls.AddMedia($galleryId))

JavaScript

var stringResponse = core_v2_mediaUrls.AddMedia(galleryId);

Parameters

Name	Type	Description	Required	Default	Options
galleryId	`Int32`	Gallery Id	Required

AddMedia Overload 2

Velocity

#set($stringResponse = $core_v2_mediaUrls.AddMedia($galleryId, $checkPermissions))

JavaScript

var stringResponse = core_v2_mediaUrls.AddMedia(galleryId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
galleryId	`Int32`	Gallery Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

AddMedia Overload 3

Velocity

#set($stringResponse = $core_v2_mediaUrls.AddMedia($galleryId, $temporaryStoreId))

JavaScript

var stringResponse = core_v2_mediaUrls.AddMedia(galleryId, temporaryStoreId);

Parameters

Name	Type	Description	Required	Default	Options
galleryId	`Int32`	Gallery Id	Required
temporaryStoreId	`String`	Temporary Store Id	Required

AddMedia Overload 4

Velocity

#set($stringResponse = $core_v2_mediaUrls.AddMedia($galleryId, $temporaryStoreId, $checkPermissions))

JavaScript

var stringResponse = core_v2_mediaUrls.AddMedia(galleryId, temporaryStoreId, checkPermissions);

Parameters

Name	Type	Description	Required
galleryId	`Int32`	Gallery Id	Required
temporaryStoreId	`String`	Temporary Store Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

DownloadMedia

DownloadMedia Overload 1

Velocity

#set($stringResponse = $core_v2_mediaUrls.DownloadMedia($mediaId))

JavaScript

var stringResponse = core_v2_mediaUrls.DownloadMedia(mediaId);

Parameters

Name	Type	Description	Required	Default	Options
mediaId	`Int32`	Media Id	Required

DownloadMedia Overload 2

Velocity

#set($stringResponse = $core_v2_mediaUrls.DownloadMedia($mediaId, $checkPermissions))

JavaScript

var stringResponse = core_v2_mediaUrls.DownloadMedia(mediaId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
mediaId	`Int32`	Media Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

EditGallery

EditGallery Overload 1

Velocity

#set($stringResponse = $core_v2_mediaUrls.EditGallery($galleryId))

JavaScript

var stringResponse = core_v2_mediaUrls.EditGallery(galleryId);

Parameters

Name	Type	Description	Required	Default	Options
galleryId	`Int32`	Gallery Id	Required

EditGallery Overload 2

Velocity

#set($stringResponse = $core_v2_mediaUrls.EditGallery($galleryId, $checkPermissions))

JavaScript

var stringResponse = core_v2_mediaUrls.EditGallery(galleryId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
galleryId	`Int32`	Gallery Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

EditMedia

EditMedia Overload 1

Velocity

#set($stringResponse = $core_v2_mediaUrls.EditMedia($mediaId))

JavaScript

var stringResponse = core_v2_mediaUrls.EditMedia(mediaId);

Parameters

Name	Type	Description	Required	Default	Options
mediaId	`Int32`	Media Id	Required

EditMedia Overload 2

Velocity

#set($stringResponse = $core_v2_mediaUrls.EditMedia($mediaId, $checkPermissions))

JavaScript

var stringResponse = core_v2_mediaUrls.EditMedia(mediaId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
mediaId	`Int32`	Media Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

Gallery

Gallery Overload 1

Velocity

#set($stringResponse = $core_v2_mediaUrls.Gallery($galleryId))

JavaScript

var stringResponse = core_v2_mediaUrls.Gallery(galleryId);

Parameters

Name	Type	Description	Required	Default	Options
galleryId	`Int32`	Gallery Id	Required

Gallery Overload 2

Velocity

#set($stringResponse = $core_v2_mediaUrls.Gallery($galleryId, $checkPermissions))

JavaScript

var stringResponse = core_v2_mediaUrls.Gallery(galleryId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
galleryId	`Int32`	Gallery Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

GroupAggregate

GroupAggregate Overload 1

Velocity

#set($stringResponse = $core_v2_mediaUrls.GroupAggregate($groupId))

JavaScript

var stringResponse = core_v2_mediaUrls.GroupAggregate(groupId);

Parameters

Name	Type	Description	Required	Default	Options
groupId	`Int32`	Group Id	Required

GroupAggregate Overload 2

Velocity

#set($stringResponse = $core_v2_mediaUrls.GroupAggregate($groupId, $checkPermissions))

JavaScript

var stringResponse = core_v2_mediaUrls.GroupAggregate(groupId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
groupId	`Int32`	Group Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

GroupAggregateRss

GroupAggregateRss Overload 1

Velocity

#set($stringResponse = $core_v2_mediaUrls.GroupAggregateRss($groupId))

JavaScript

var stringResponse = core_v2_mediaUrls.GroupAggregateRss(groupId);

Parameters

Name	Type	Description	Required	Default	Options
groupId	`Int32`	Group Id	Required

GroupAggregateRss Overload 2

Velocity

#set($stringResponse = $core_v2_mediaUrls.GroupAggregateRss($groupId, $checkPermissions))

JavaScript

var stringResponse = core_v2_mediaUrls.GroupAggregateRss(groupId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
groupId	`Int32`	Group Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

GroupAggregateTags

GroupAggregateTags Overload 1

Velocity

#set($stringResponse = $core_v2_mediaUrls.GroupAggregateTags($groupId))

JavaScript

var stringResponse = core_v2_mediaUrls.GroupAggregateTags(groupId);

Parameters

Name	Type	Description	Required	Default	Options
groupId	`Int32`	Group Id	Required

GroupAggregateTags Overload 2

Velocity

#set($stringResponse = $core_v2_mediaUrls.GroupAggregateTags($groupId, $checkPermissions))

JavaScript

var stringResponse = core_v2_mediaUrls.GroupAggregateTags(groupId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
groupId	`Int32`	Group Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

GroupAggregateTags Overload 3

Velocity

#set($stringResponse = $core_v2_mediaUrls.GroupAggregateTags($groupId, $tags))

JavaScript

var stringResponse = core_v2_mediaUrls.GroupAggregateTags(groupId, tags);

Parameters

Name	Type	Description	Required	Default	Options
groupId	`Int32`	Group Id	Required
tags	`IList of String`	Tags	Required

GroupAggregateTags Overload 4

Velocity

#set($stringResponse = $core_v2_mediaUrls.GroupAggregateTags($groupId, $tags, $checkPermissions))

JavaScript

var stringResponse = core_v2_mediaUrls.GroupAggregateTags(groupId, tags, checkPermissions);

Parameters

Name	Type	Description	Required
groupId	`Int32`	Group Id	Required
tags	`IList of String`	Tags	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

ManageFiles

ManageFiles Overload 1

Velocity

#set($stringResponse = $core_v2_mediaUrls.ManageFiles($galleryId))

JavaScript

var stringResponse = core_v2_mediaUrls.ManageFiles(galleryId);

Parameters

Name	Type	Description	Required	Default	Options
galleryId	`Int32`	Gallery Id	Required

ManageFiles Overload 2

Velocity

#set($stringResponse = $core_v2_mediaUrls.ManageFiles($galleryId, $checkPermissions))

JavaScript

var stringResponse = core_v2_mediaUrls.ManageFiles(galleryId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
galleryId	`Int32`	Gallery Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

ManageGallery

ManageGallery Overload 1

Velocity

#set($stringResponse = $core_v2_mediaUrls.ManageGallery($galleryId))

JavaScript

var stringResponse = core_v2_mediaUrls.ManageGallery(galleryId);

Parameters

Name	Type	Description	Required	Default	Options
galleryId	`Int32`	Gallery Id	Required

ManageGallery Overload 2

Velocity

#set($stringResponse = $core_v2_mediaUrls.ManageGallery($galleryId, $checkPermissions))

JavaScript

var stringResponse = core_v2_mediaUrls.ManageGallery(galleryId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
galleryId	`Int32`	Gallery Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

Media

Media Overload 1

Velocity

#set($stringResponse = $core_v2_mediaUrls.Media($mediaId))

JavaScript

var stringResponse = core_v2_mediaUrls.Media(mediaId);

Parameters

Name	Type	Description	Required	Default	Options
mediaId	`Int32`	Media Id	Required

Media Overload 2

Velocity

#set($stringResponse = $core_v2_mediaUrls.Media($mediaId, $checkPermissions))

JavaScript

var stringResponse = core_v2_mediaUrls.Media(mediaId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
mediaId	`Int32`	Media Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

ModerateGallery

ModerateGallery Overload 1

Velocity

#set($stringResponse = $core_v2_mediaUrls.ModerateGallery($galleryId))

JavaScript

var stringResponse = core_v2_mediaUrls.ModerateGallery(galleryId);

Parameters

Name	Type	Description	Required	Default	Options
galleryId	`Int32`	Gallery Id	Required

ModerateGallery Overload 2

Velocity

#set($stringResponse = $core_v2_mediaUrls.ModerateGallery($galleryId, $checkPermissions))

JavaScript

var stringResponse = core_v2_mediaUrls.ModerateGallery(galleryId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
galleryId	`Int32`	Gallery Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

NextMedia

NextMedia Overload 1

Velocity

#set($stringResponse = $core_v2_mediaUrls.NextMedia($mediaId))

JavaScript

var stringResponse = core_v2_mediaUrls.NextMedia(mediaId);

Parameters

Name	Type	Description	Required	Default	Options
mediaId	`Int32`	Media Id	Required

NextMedia Overload 2

Velocity

#set($stringResponse = $core_v2_mediaUrls.NextMedia($mediaId, $checkPermissions))

JavaScript

var stringResponse = core_v2_mediaUrls.NextMedia(mediaId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
mediaId	`Int32`	Media Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

PreviousMedia

PreviousMedia Overload 1

Velocity

#set($stringResponse = $core_v2_mediaUrls.PreviousMedia($mediaId))

JavaScript

var stringResponse = core_v2_mediaUrls.PreviousMedia(mediaId);

Parameters

Name	Type	Description	Required	Default	Options
mediaId	`Int32`	Media Id	Required

PreviousMedia Overload 2

Velocity

#set($stringResponse = $core_v2_mediaUrls.PreviousMedia($mediaId, $checkPermissions))

JavaScript

var stringResponse = core_v2_mediaUrls.PreviousMedia(mediaId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
mediaId	`Int32`	Media Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

Rss

Rss Overload 1

Velocity

#set($stringResponse = $core_v2_mediaUrls.Rss($galleryId))

JavaScript

var stringResponse = core_v2_mediaUrls.Rss(galleryId);

Parameters

Name	Type	Description	Required	Default	Options
galleryId	`Int32`	Gallery Id	Required

Rss Overload 2

Velocity

#set($stringResponse = $core_v2_mediaUrls.Rss($galleryid, $checkPermissions))

JavaScript

var stringResponse = core_v2_mediaUrls.Rss(galleryid, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
galleryid	`Int32`	Galleryid	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

ShareMedia

ShareMedia Overload 1

Velocity

#set($stringResponse = $core_v2_mediaUrls.ShareMedia($mediaId))

JavaScript

var stringResponse = core_v2_mediaUrls.ShareMedia(mediaId);

Parameters

Name	Type	Description	Required	Default	Options
mediaId	`Int32`	Media Id	Required

ShareMedia Overload 2

Velocity

#set($stringResponse = $core_v2_mediaUrls.ShareMedia($mediaId, $checkPermissions))

JavaScript

var stringResponse = core_v2_mediaUrls.ShareMedia(mediaId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
mediaId	`Int32`	Media Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

ShareMedia Overload 3

Velocity

#set($stringResponse = $core_v2_mediaUrls.ShareMedia($mediaId, "%{ CheckPermissions = $checkPermissionsArg, Modal = $modalArg }"))

JavaScript

var stringResponse = core_v2_mediaUrls.ShareMedia(mediaId, { CheckPermissions: checkPermissionsArg, Modal: modalArg });

Parameters

Name	Type	Description	Required	Default
mediaId	`Int32`	Media Id	Required
options	Options	Set of optional parameters including:	Required
CheckPermissions		Enable checking permissions before returning the URL	Optional	True
Modal		Will the URL be rendered within a modal	Optional	True

Returns

String

Slideshow

Slideshow Overload 1

Velocity

#set($stringResponse = $core_v2_mediaUrls.Slideshow($galleryId))

JavaScript

var stringResponse = core_v2_mediaUrls.Slideshow(galleryId);

Parameters

Name	Type	Description	Required	Default	Options
galleryId	`Int32`	Gallery Id	Required

Slideshow Overload 2

Velocity

#set($stringResponse = $core_v2_mediaUrls.Slideshow($galleryId, $checkPermissions))

JavaScript

var stringResponse = core_v2_mediaUrls.Slideshow(galleryId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
galleryId	`Int32`	Gallery Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

Tags Overload 1

Velocity

#set($stringResponse = $core_v2_mediaUrls.Tags($galleryId))

JavaScript

var stringResponse = core_v2_mediaUrls.Tags(galleryId);

Parameters

Name	Type	Description	Required	Default	Options
galleryId	`Int32`	Gallery Id	Required

Tags Overload 2

Velocity

#set($stringResponse = $core_v2_mediaUrls.Tags($galleryId, $checkPermissions))

JavaScript

var stringResponse = core_v2_mediaUrls.Tags(galleryId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
galleryId	`Int32`	Gallery Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Tags Overload 3

Velocity

#set($stringResponse = $core_v2_mediaUrls.Tags($galleryId, $tags))

JavaScript

var stringResponse = core_v2_mediaUrls.Tags(galleryId, tags);

Parameters

Name	Type	Description	Required	Default	Options
galleryId	`Int32`	Gallery Id	Required
tags	`IList of String`	Tags	Required

Tags Overload 4

Velocity

#set($stringResponse = $core_v2_mediaUrls.Tags($galleryId, $tags, $checkPermissions))

JavaScript

var stringResponse = core_v2_mediaUrls.Tags(galleryId, tags, checkPermissions);

Parameters

Name	Type	Description	Required
galleryId	`Int32`	Gallery Id	Required
tags	`IList of String`	Tags	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

TagsRss

TagsRss Overload 1

Velocity

#set($stringResponse = $core_v2_mediaUrls.TagsRss($galleryId, $tags))

JavaScript

var stringResponse = core_v2_mediaUrls.TagsRss(galleryId, tags);

Parameters

Name	Type	Description	Required	Default	Options
galleryId	`Int32`	Gallery Id	Required
tags	`IList of String`	Tags	Required

TagsRss Overload 2

Velocity

#set($stringResponse = $core_v2_mediaUrls.TagsRss($galleryId, $tags, $checkPermissions))

JavaScript

var stringResponse = core_v2_mediaUrls.TagsRss(galleryId, tags, checkPermissions);

Parameters

Name	Type	Description	Required
galleryId	`Int32`	Gallery Id	Required
tags	`IList of String`	Tags	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

UploadMedia

UploadMedia Overload 1

Velocity

#set($stringResponse = $core_v2_mediaUrls.UploadMedia($galleryId))

JavaScript

var stringResponse = core_v2_mediaUrls.UploadMedia(galleryId);

Parameters

Name	Type	Description	Required	Default	Options
galleryId	`Int32`	Gallery Id	Required

UploadMedia Overload 2

Velocity

#set($stringResponse = $core_v2_mediaUrls.UploadMedia($galleryId, $checkPermissions))

JavaScript

var stringResponse = core_v2_mediaUrls.UploadMedia(galleryId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
galleryId	`Int32`	Gallery Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String