Enables scripted content fragments to use Galleries
Properties
Name | Type | Description | Default | Options |
---|---|---|---|---|
ApplicationTypeId | Guid | Galleries application type identifier | ||
ContentTypeId | Guid | Galleries content type identifier | ||
Current | Gallery | Current contextual Gallery | ||
TotalLicensedRemaining | int | Total number licensed galleris |
Methods
Create
Creates a Gallery
Usage
#set($galleryResponse = $core_v2_gallery.Create($groupId, $name, "%{Description = $descriptionArg, Enabled = $enabledArg, ExtendedAttributes = $extendedAttributesArg, Key = $keyArg, Owners = $ownersArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
groupId | int | Group Id | Required | ||
name | string | Name | Required | ||
Description | string | Description | Optional | An empty string | |
Enabled | bool | Enabled | Optional | True | |
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 | ||
Key | string | If not specified, the key will be generated. | Optional | ||
Owners | string | Comma separated list of usernames | Optional |
Return Type
Delete
Deletes a Gallery
Usage
#set($additionalInfoResponse = $core_v2_gallery.Delete($id))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
id | int | Id | Required |
Return Type
Get
Gets a Gallery
Usage
#set($galleryResponse = $core_v2_gallery.Get("%{GroupId = $groupIdArg, Id = $idArg, Key = $keyArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
GroupId | int | Either Id or Key + GroupId are required | Optional | ||
Id | int | Either Id or Key + GroupId are required | Optional | ||
Key | string | Either Id or Key + GroupId are required | Optional |
Return Type
Get
Gets a Gallery
Usage
#set($galleryResponse = $core_v2_gallery.Get($applicationId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
applicationId | Guid | Application Id | Required |
Return Type
IsDisclaimerEnabled
Returns whether a gallery is configured to show a disclaimer before downloading
Usage
#set($booleanResponse = $core_v2_gallery.IsDisclaimerEnabled($galleryId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
galleryId | int | Gallery Id | Required |
Return Type
bool
List
Lists Galleries
Usage
#set($pagedListResponse = $core_v2_gallery.List("%{ApplicationIds = $applicationIdsArg, GroupId = $groupIdArg, IncludeSubGroups = $includeSubGroupsArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, PermissionId = $permissionIdArg, SortBy = $sortByArg, SortOrder = $sortOrderArg, UserId = $userIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
ApplicationIds | string | Comma separated list of ApplicationIds. Used to limit to a specific set of galleries as well as sort order if SoryBy is set to ApplicationIdsOrder | Optional | ||
GroupId | int | Group Id | Optional | ||
IncludeSubGroups | bool | Only used when GroupId is specified. | 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 | |
PermissionId | string | Used to get a list of galleries for which the accessing or impersonated user has the provided Permission ID. | Optional | ||
SortBy | string | Sort By | Optional | SortOrder | ApplicationIdsOrder, DateCreate, LastPost, Name, Post, Score:SCORE_ID, SortOrder, Thread, TotalPosts |
SortOrder | string | Sort Order | Optional | Ascending | Ascending, Descending |
UserId | int | Obsolete in 9.2: User Id should no longer be used. Rely on the authenticated or impersonated user instead. | Optional |
Return Type
ListForQuickPost
Lists galleries available for a quick post context for the accessing user and current group
Usage
#set($iListResponse = $core_v2_gallery.ListForQuickPost())
Return Type
IList<Gallery>
ListTaggedContent
Lists tagged content. DEPRECATED: This method is supported for backwards compatibility, but $core_v2_taggedContent.List() should be used if possible.
Usage
#set($pagedListResponse = $core_v2_gallery.ListTaggedContent($tags, "%{GalleryId = $galleryIdArg, GroupId = $groupIdArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
tags | IList<string> | Tags | Required | ||
GalleryId | int | Gallery Id | Optional | ||
GroupId | int | Group Id | Optional | ||
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
ListTags
Lists tags in a Gallery. DEPRECATED: This method is supported for backwards compatibility, but $core_v2_tags.List() should be used if possible.
Usage
#set($pagedListResponse = $core_v2_gallery.ListTags("%{FilterTags = $filterTagsArg, GalleryId = $galleryIdArg, GroupId = $groupIdArg, MinimumItemsPerTag = $minimumItemsPerTagArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
FilterTags | IList<string> | Tags to filter by | Optional | ||
GalleryId | int | Gallery Id | Optional | ||
GroupId | int | Group Id | Optional | ||
MinimumItemsPerTag | int | Minimum Items Per Tag | Optional | ||
PageIndex | int | Page Index | Optional | 0 | |
PageSize | int | Page Size | Optional | 100 |
Return Type
Search
Search Galleries
Usage
#set($pagedListResponse = $core_v2_gallery.Search($queryText, "%{GroupId = $groupIdArg, IncludeSubGroups = $includeSubGroupsArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
queryText | string | Query Text | Required | ||
GroupId | int | Group Id | Optional | ||
IncludeSubGroups | bool | Include Sub Groups | 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
Update
Updates a Gallery
Usage
#set($galleryResponse = $core_v2_gallery.Update($id, "%{Description = $descriptionArg, Enabled = $enabledArg, ExtendedAttributes = $extendedAttributesArg, GroupId = $groupIdArg, Key = $keyArg, Name = $nameArg, Owners = $ownersArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
id | int | Id | Required | ||
Description | string | Description | Optional | An empty string | |
Enabled | bool | Enabled | Optional | True | |
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 | ||
GroupId | int | Group Id | Optional | ||
Key | string | If not specified, the key will be generated. | Optional | ||
Name | string | Name | Optional | ||
Owners | string | Comma separated list of usernames | Optional |