SiteTools.buildAlternateImageFormats (Method)
Starts a job which builds the alternate image formats for the specified images with in the image gallery.
Returns:
JobID (integer)
Arguments:
Name | Type | Required | Description |
---|---|---|---|
formatList | AlternateImageFormatList | Optional. Defaults to 'CSThumbnail_Large'. | A comma-delimited list of one or more alternate formats to rebuild. |
imageIDList | ImageIDList_EmptyString | Optional. Defaults to an empty string. | A comma-delimited list of zero or more image IDs to build alternate format images for. If this value is an empty string, CommonSpot rebuilds all images in the site. If this field is specified, the 'SubsiteIDList' argument is ignored. |
subsiteIDList | SubsiteIDList_EmptyString | Optional. Defaults to '1'. | A comma-delimited list of zero or more subsite IDs. If this value is 1, CommonSpot begins building formats at the root subsite. |
includeChildSubsites | Boolean | Optional. Defaults to '1'. | Boolean flag which when set to true tells CommonSpot to include descendant subsites. This argument is only used if the 'Scope' is 'Subsites'. |
forceRebuild | Boolean | Optional. Defaults to '0'. | Boolean flag which when set to true indicates that alternate images should be rebuilt even when they already exist. |
Context:
License Requirements | None |
Permission Requirements | Contributor |
Deny Context | None |
Require Context | None |
Author Lock |
Error Codes:
Code | Error Message |
---|---|
71000 | Either ImageIDList or SubsiteIDList needs to be specified. |
Notes:
None