ImageGallery.update (Method)
Updates property changes to the specified Image Gallery.
Returns:
ImageGalleryID (structkeylookup)
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| id | ImageGalleryID | Required | The ID of an existing image gallery, or 0 to create a new image gallery. |
| name | PlainText_NonNull_125 | Required | Name of the image gallery. |
| description | PlainText_NonNull_2000 | Required | Description for the image gallery. |
| defaultSubsite | SubsiteID_0 | Optional. Defaults to '0'. | ID of the default subsite for the image gallery. By default, 0 is saved which means no default subsite for the gallery. |
| sizeRestrictionType | ImageGallerySizeRestrictionType | Required | The type of size restriction on images selected for the image gallery. |
| sameSizeRule | ImageGallerySizeRestrictionRule_0 | Optional. Defaults to '0'. | Indicates the rule to apply if the image uploaded to the image gallery is of same size as the largest image specification. |
| biggerSizeSameRatioRule | ImageGallerySizeRestrictionRule_0 | Optional. Defaults to '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. |
| biggerSizeDiffRatioRule | ImageGallerySizeRestrictionRule_0 | Optional. Defaults to '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. |
| smallerSizeSameRatioRule | ImageGallerySizeRestrictionRule_0 | Optional. Defaults to '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. |
| smallerSizeDiffRatioRule | ImageGallerySizeRestrictionRule_0 | Optional. Defaults to '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. |
| isOpen | Boolean | Required | Boolean value indicating whether new images can be uploaded into the image gallery or not. |
| isEnforced | Boolean | Optional. Defaults to '0'. | Boolean value indicating whether the subsite selected for the gallery is enforced. |
| useSiteDefaultSettings | Boolean | Optional. Defaults to '1'. | Boolean flag indicating whether the to use the site-level default settings for support and rendering of WebP images for the specified gallery. |
| renderWebP | Boolean | Optional. Defaults to '0'. | Boolean flag indicating whether the rendering of WebP images is enabled or not. If false, WebP images will not be rendered, nor will information about them be passed to any render handler. |
| conversionType | WebPConversionType_EmtyString | Optional. Defaults to an empty string. | The type of compression to use when generating the WebP image. Either 'lossy', 'lossless' or an empty string if the site-level default is to be used. |
| qualityCompressionSpeed | Integer_0_to_100_NEG1 | Optional. Defaults to '-1'. | The compression factor for RGB channels between 0 and 100. -1 if the site defaults are used. |
Context:
| License Requirements | (none) |
| Permission Requirements | imageGallery:Admin |
| Deny Context | (none) |
| Require Context | AuthoringEnabled |
| Author Lock | (not required) |
| Transaction Logging | If transaction logging is enabled at the site level, calls to this method will be logged |
| Customization | This method may be customized at the site level |
Error Codes:
| Code | Error Message |
|---|---|
| 89502 | Another image gallery already exists with the same name. |
| 89513 | Size restriction rules cannot be saved for an image gallery having no size restrictions. |
Notes:
None