Query document libraries

The examples below show you how to query all of the available document libraries or how to query only a specific document library by its ID.

Query a single document library

To query a specific document library by its ID, you must perform the following:

  1. Get the document library.
    First, get an instance of the document library with the specified ID.
  2. Return the document library.

The following code samples query a document library by its ID.

Native API

First, you get an instance of the LibrariesManager class. To get the specified document library, you query all document libraries and filter the collection by the Id property. If the specified document library does not exist, the query will return null. Finally, you return the document library.

You can also use the following code to retrieve the document library:

NOTE: If the document library does not exist, an exception of type ItemNotFoundException is thrown.

Fluent API

First, you get the singular facade of the document library with the specified Id. To get an instance of the document library, you call the Getmethod of the facade.

You can also use the following code to retrieve the document library:

Query all document libraries

When querying all document libraries, you must perform the following:

  1. Query all document libraries.
    First, get a query of all available document libraries.
  2. Return the document libraries.

The following code queries all document libraries:

Native API

First, you get an instance of the LibrariesManager class. Then, you query all available document libraries. Finally, you return the document libraries as a list. If no document libraries exist, the list will be empty.

Fluent API

First, you get an instance of the plural document libraries facade. Then, you get all available document libraries. Finally, you return the document libraries as a list. If no document libraries exist, the list will be empty.

Was this article helpful?