Delete documents

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

NOTE: The code examples below work with the ID of the master version of the document. 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.

Delete a single document

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

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

The following code deletes a document 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 DeleteDocument method of the manager with the master version as an argument. Finally, you save the changes.

Fluent API

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

Delete all documents

When deleting all documents, you must perform the following:

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

The following code deletes all documents.

Native API

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

Fluent API

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

Was this article helpful?