Skip to content

@ubstream/ubstream-node-client-sdk / Exports / LibrariesMetadataSchemasClient

Class: LibrariesMetadataSchemasClient

This class provides access to methods to retrieve metadata schemas of medias.

Hierarchy

  • AbstractClient

↳ LibrariesMetadataSchemasClient

Table of contents

Methods

Methods

listMetadataSchemas

▸ listMetadataSchemas(libraryId): Promise<IPublicMediaSchemaQuery>

Parameters

Name Type Description
libraryId string The uuid of the targeted library.

Returns

Promise<IPublicMediaSchemaQuery>

Promise object representing all the metadata schemas.

Summary

Retrieve the metadata schemas for all media types.

Example

const result = await client.libraries.metadataSchemas.listMetadataSchemas("library_id");
const matadataSchemas = result.$resources;

listMetadataSchemasByMediaType

▸ listMetadataSchemasByMediaType(libraryId, mediaType): Promise<IPublicSchemaQuery>

Parameters

Name Type Description
libraryId string The uuid of the targeted library.
mediaType string The media type of the targeted schema.
  • beevirtua
  • audio
  • animation
  • video
  • image
  • link
  • file

    • Returns

    Promise<IPublicSchemaQuery>

    Promise object representing all metadata schemas enabled for a media-type.

    Summary

    Retrieve the metadata schemas for a single type of media.

    Example

    const result = await client.libraries.metadataSchemas.listMetadataSchemasByMediaType("library_id", 'image');
const matadataSchemasByMediaType = result.$resources;