ImageGallery.getInfo (Method)
Returns information for the provided image gallery ID.
Returns:
ImageGallery_GetInfo_Struct (struct)
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| biggerSizeDiffRatioRule | ImageGallerySizeRestrictionRule_0 | Indicates the rule to apply if the image uploaded to the image gallery is greater than the largest size specification and is of different ratio if size is constrained by aspect ratio. |
| biggerSizeSameRatioRule | ImageGallerySizeRestrictionRule_0 | Indicates the rule to apply if the image uploaded to the image gallery is greater than the largest size specification and is of same ratio if size is constrained by aspect ratio. |
| ConversionType | WebPConversionType_EmtyString | Type of webP conversion - lossy or lossless. |
| 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. |
| GenerateWebP | Integer_0_to_2 | Value indicating whether we need to generate the webP for the image gallery or not. |
| ID | PositiveInteger | ID of an image gallery. |
| ImagesCount | NonNegativeInteger | The count of images in the image gallery. |
| IsOpen | Boolean | Boolean value which if true, allows new images to be uploaded into the image gallery. Otherwise no new images can be added. |
| LastErrorCount | NonNegativeInteger | Indicates the number of images that had error for the last operation perfomed on the image 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. |
| QualityCompressionSpeed | Integer_0_to_100_NEG1 | The compression factor for RGB channels between 0 and 100. |
| RenderWebP | Boolean | Boolean flag indicating whether the webP version of the image should be rendered or not. |
| sameSizeRule | ImageGallerySizeRestrictionRule_0 | Indicates the rule to apply if the image uploaded to the image gallery is of same size as the largest image specification. |
| SizeRestrictionType | ImageGallerySizeRestrictionType | ID of the size restriction type for the image gallery. |
| smallerSizeDiffRatioRule | ImageGallerySizeRestrictionRule_0 | Indicates the rule to apply if the image uploaded to the image gallery is smaller than the largest size specification and is of different ratio if size is constrained by aspect ratio. |
| smallerSizeSameRatioRule | ImageGallerySizeRestrictionRule_0 | Indicates the rule to apply if the image uploaded to the image gallery is smaller than the largest size specification and is of same ratio if size is constrained by aspect ratio. |
| 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. |
| 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 |
|---|---|---|---|
| id | ImageGalleryID | Required | ID of an image gallery. |
| wantStats | Boolean | Optional. Defaults to 'false'. | True if image count is needed for the specified gallery, false otherwise. |
Context:
| License Requirements | (none) |
| Permission Requirements | (none) |
| 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:
None
Notes:
None