Methods
Create
Creates a Gallery
Usage
#set($galleryResponse = $core_v2_gallery.Create($groupId, $name, "%{Description = $descriptionArg, Enabled = $enabledArg, Key = $keyArg}"))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 | |
| Key | string | If not specified, the key will be generated. | Optional | | |
Return Type
Gallery
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
AdditionalInfo
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
Gallery
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
Gallery
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
IsFavorite
Returns favorited status for the accessing user
Usage
#set($booleanResponse = $core_v2_gallery.IsFavorite($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("%{GroupId = $groupIdArg, IncludeSubGroups = $includeSubGroupsArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, PermissionId = $permissionIdArg, SortBy = $sortByArg, SortOrder = $sortOrderArg, UserId = $userIdArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| 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 user set in UserId has the provided Permission ID. | Optional | | |
| SortBy | string | Sort By | Optional | SortOrder | DateCreate, LastPost, Name, Post, Score:SCORE_ID, SortOrder, Thread, TotalPosts |
| SortOrder | string | Sort Order | Optional | Ascending | Ascending, Descending |
| UserId | int | User ID for which to check permissions. This option is only used whenever the PermissionId is also supplied. | Optional | | |
Return Type
PagedList<Gallery>
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. 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
PagedList<TaggedContent>
ListTags
Lists tags in a Gallery. 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
PagedList<Tag>
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
PagedList<SearchResult>
SetFavorite
Sets favorite status for the accessing user
Usage
$core_v2_gallery.SetFavorite($galleryId, $favorite)
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| galleryId | int | Gallery Id | Required | | |
| favorite | bool | Favorite Status | Required | | |
Update
Updates a Gallery
Usage
#set($galleryResponse = $core_v2_gallery.Update($id, "%{Description = $descriptionArg, Enabled = $enabledArg, GroupId = $groupIdArg, Key = $keyArg, Name = $nameArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| id | int | Id | Required | | |
| Description | string | Description | Optional | An empty string | |
| Enabled | bool | Enabled | Optional | True | |
| GroupId | int | Group Id | Optional | | |
| Key | string | If not specified, the key will be generated. | Optional | | |
| Name | string | Name | Optional | | |
Return Type
Gallery