Image.delete (Method)
Deletes an image.
Returns:
Void
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| imageID | ImageID | Required | An image's ID. |
| ignoreWarnings | Boolean | Optional. Defaults to '0'. | Boolean flag which when set tells CommonSpot that it should ignore warnings. If this value is false, this method throws an error with a warning message. |
Context:
| License Requirements | None |
| Permission Requirements | image: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 |
|---|---|
| 24505 | |
| 24506 | The specified image is not active. |
Notes:
None