ImageGallery.getList (Method)
Returns a list of image galleries.
Returns:
ImageGallery_GetList_Result (query)
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| CanAdmin | Boolean | Boolean value indicating if the user has Admin permissions on the gallery. |
| CanAuthor | Boolean | Boolean value indicating if the user has Author permissions on the gallery. |
| CanEdit | Boolean | Boolean value indicating if the user has Edit permissions on the gallery. |
| CanRead | Boolean | Boolean value indicating if the user has Read permissions on the gallery. |
| DefaultSubsite | SubsiteID_0 | ID of the default subsite for the image gallery. 0 means no default subsite set for the image gallery. |
| Description | PlainText_NonNull_2000 | Description for an image gallery. |
| ID | ImageGalleryID | ID of an image gallery. |
| ImagesCount | NonNegativeInteger | The count of images in the image gallery. |
| IsFavorite | Boolean | Boolean value indicating if the image gallery is marked as favorite for the user. |
| IsOpen | Boolean | Boolean value indicating if the image gallery is open or not. |
| LastErrorCount | NonNegativeInteger | Indicates the number of images that had error for the last operation perfomed on the gallery. |
| LastMessage | PlainText_255 | Describes the message for the last operation performed on the image gallery. |
| LastOperation | PlainText_20 | Describes the last operation performed on the image gallery. |
| Name | PlainText_NonNull_125 | Name of an image gallery. |
| RenderWebP | Boolean | Boolean flag indicating whether the webP version of the image should be rendered or not. |
| SizeRestrictionType | ImageGallerySizeRestrictionType | Indicates the size restriction type for the image gallery. |
| Status | PlainText_NonNull_10 | Indicates the status of the image gallery. |
| SubsiteURL | SubsiteURL_EmptyString | The server-relative URL of the default subsite for the image gallery. Empty string means no default subsite set for the image gallery. |
| UseSiteDefaultSettings | Boolean | Boolean value indicating if the site default for webP conversion is used by the image gallery or not. |
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| idList | ImageGalleryIDList_0_NEG1_NEG2 | Optional. Defaults to '-1'. | A list of image gallery IDs to filter by, 0 for all image galleries, -1 for all favorite image galleries, or -2 for all non-favorite image galleries. |
| includePrivateImageGallery | Boolean | Optional. Defaults to '1'. | Boolean value indicating whether to include 'My Private Gallery' or not. |
| searchString | PlainText | Optional. Defaults to an empty string. | The value for which CommonSpot searches. |
| searchOperator | SearchOperator_EmptyString | Optional. Defaults to 'Begins With'. | The search operator or an empty string. The operators are 'Begins With', 'Contains', 'Ends With', or 'Equals'. |
| orderBy | SQLOrderByClause | Optional. Defaults to 'Name ASC'. | The SQL 'order by' clause indicating which column is used as the returned data's sort key. |
Context:
| License Requirements | (none) |
| Permission Requirements | ContributorOrServerCode |
| Deny Context | None |
| Require Context | None |
| Author Lock | (not required) |
| Transaction Logging | Transaction logging is disabled for this method |
| Customization | This method may be customized at the site level |
Error Codes:
| Code | Error Message |
|---|---|
| 89501 | The orderBy argument must be in the form {ColumnName} [Direction] where ColumnName must be Name, Description, Width or Height. Direction is optional with values of ASC or DESC. |
| 89506 | If you specify a search string, then you must also specify a search operator. |
Notes:
None