ImageGallery.getUserGallerySelectList (Method)
Returns a query of select options of image galleries.
Returns:
ImageGallery_GetUserGallerySelectList_Result (query)
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| DefaultSubsite | SubsiteID_0 | Default subsite set for the image gallery; 0 for special cases option like All Visible Galleries, My Favorites Galleries, Other... |
| ID | ImageGalleryID_0_NEG1_NEG2 | ID of the image gallery select option. |
| Name | PlainText_NonNull_255 | Display value for the image gallery select option. |
| SubsiteURL | SubsiteURL_EmptyString | The server-relative URL of the default subsite for the image gallery or empty string. |
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| idList | String | Optional. Defaults to an empty string. | A list of image gallery IDs to filter by, or empty string. |
| includeVisibleGalleriesOption | Boolean | Optional. Defaults to '1'. | Boolean value indicating whether to include All Visible Galleries option or not. |
| includeFavoriteGalleriesOption | Boolean | Optional. Defaults to '1'. | Boolean value indicating whether to include My Favorite Galleries option or not. |
| includeOtherOption | Boolean | Optional. Defaults to '1'. | Boolean value indicating whether to include Other... option or not. |
| includeAllVisibleGalleries | Boolean | Optional. Defaults to '0'. | Boolean value indicating whether to include all the visible image galleries or not. |
| includeFavoriteGalleries | Boolean | Optional. Defaults to '1'. | Boolean value indicating whether to include favorite galleries or not. |
| includeNonFavoriteGalleries | Boolean | Optional. Defaults to '0'. | Boolean value indicating whether to include all non favorite galleries or not. |
| includePrivateImageGallery | Boolean | Optional. Defaults to '1'. | Boolean value indicating whether to include 'My Private Gallery' or not. |
| includePublicImageGallery | Boolean | Optional. Defaults to '1'. | Boolean value indicating whether to include 'Default Public Gallery' or not. |
| includeOpenGalleriesOnly | Boolean | Optional. Defaults to '0'. | Boolean value indicating whether to include only open image galleries or not. |
| includeWebPEnabledGalleriesOnly | Boolean | Optional. Defaults to '0'. | Boolean value indicating whether to include only image galleries which have WebP support enabled or not. |
| includeSizeRestrictedGalleriesOnly | Boolean | Optional. Defaults to '0'. | |
| permissionToCheck | ImageGalleryPermission | Optional. Defaults to 'Read'. | String indicating the permission to check for the current user on an image gallery. |
Context:
| License Requirements | (none) |
| Permission Requirements | (none) |
| Deny Context | (none) |
| Require Context | AuthoringEnabled |
| 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:
None
Notes:
None