Delete images

This topic explains how to delete images. The examples below show you how to delete all of the available images or how to delete only a specific image by its ID.

NOTE: The code examples below work with the ID of the master version of the image. Deleting the master version also deletes the other versions of the item. For more information about doing this using the ID of the live version, see For developers: Delete content in For developers: Content lifecycle.

Delete a single image

When deleting a specific image by the ID of its master version, you must perform the following:

  1. Get the image.
    First, get an instance of the master version with the corresponding ID.
  2. Delete the image.
    Mark the master version to be deleted and save the changes.

The following code deletes an image by the ID of its master version:

Native API

First, you get an instance of the LibrariesManager class. Then, you get the master version with the specified ID. To mark the master version to be deleted, you call the DeleteImage method of the manager with the master version as an argument. Finally, you save the changes.

Fluent API

First, you get the singular image facade of the master version with the specified ID. Then, to mark the image to be deleted, you call the Delete method. Finally, you call SaveChanges.

Delete all images

When deleting all images, you must perform the following:

  1. Get the available images.
    Get the master versions of the available images.
  2. Delete each image in the collection.
    Iterate through the collection and delete each image.

The following code deletes all images:

Native API

First, you get an instance of the LibrariesManager class. Then, you get the master versions of the available images. You iterate through the collection and mark each image to be deleted. Finally, you save the changes.

Fluent API

First, you get the plural images facade. Then you call the Delete method to mark each image to be deleted. Finally, you save the changes.

Was this article helpful?