ImageGallery.createWebPOrBaseImages (Method)
Creates a WebP image for each image in the specified image gallery.
Returns:
JobID (integer)
Arguments:
Name | Type | Required | Description |
---|---|---|---|
galleryIDList | ImageGalleryIDList_0 | Optional. Defaults to '0'. | ID of an image gallery. 0 means all galleries. |
imageIDSizeIDWebPArray | ImageIDSizeIDStruct_Array | Optional. Defaults to '#ArrayNew(1)#'. | An array of image IDs along with the size IDs for which to generate the WebP images. |
imageIDSizeIDBaseArray | ImageIDSizeIDStruct_Array | Optional. Defaults to '#ArrayNew(1)#'. | An array of image IDs along with the size IDs for which to generate the base images. |
mode | WebPImageGenerationMode | Required | String specifying whether to generate the WebP image. Pass 'All' to always generate the WebP image, or pass 'NonExisting' to only generate the WebP image if it is missing. |
Context:
License Requirements | (none) |
Permission Requirements | (none) |
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:
None
Notes:
None