@ubstream/ubstream-node-client-sdk / Exports / LibrariesClient
Class: LibrariesClient
This class provides access to methods concerning features used in a library context.
Hierarchy
AbstractClient
↳ LibrariesClient
Table of contents
Properties
Methods
Properties
collections
• Readonly collections: LibrariesCollectionsClient
Attribute to access all methods concerning collections of libraries.
medias
• Readonly medias: LibrariesMediasClient
Attribute to access all methods concerning medias of libraries.
metadataSchemas
• Readonly metadataSchemas: LibrariesMetadataSchemasClient
Attribute to access all methods concerning schemas of metadata.
selections
• Readonly selections: LibrariesSelectionsClient
Attribute to access all methods concerning selections in libraries.
trash
• Readonly trash: LibrariesTrashClient
Attribute to access all methods concerning trash collection of libraries.
Methods
buildLibrarySitemap
▸ buildLibrarySitemap(libraryId): Promise<IPublicLibrarySitemapBuildResultData>
Parameters
| Name | Type | Description |
|---|---|---|
libraryId | string | The uuid of the targeted library. |
Returns
Promise<IPublicLibrarySitemapBuildResultData>
Promise object representing sitemap build job submission result. When the sitemap is built, it will be available at the URL: https://ubstream.com/your-hub-alias/sitemap/sitemap.xml
Summary
Build library sitemap.
Example
const { requestId } = await client.libraries.buildLibrarySitemap("library_id");
getLibraryById
▸ getLibraryById(libraryId): Promise<IPublicLibraryData>
Parameters
| Name | Type | Description |
|---|---|---|
libraryId | string | The uuid of the targeted library. |
Returns
Promise<IPublicLibraryData>
Promise object representing the fetched library.
Summary
Retrieve library by its id.
Example
const library = await client.libraries.getLibraryById("library_id");