Namespace: ContentLibrary

Appearition.ContentLibrary

Use the functions under this access the Content Library methods on the Appearition platform

Namespaces

Manage

Methods

Appearition.ContentLibrary.AvailableMediaTypes (requestOptions) static

Retrieves a list of media types available to the user

Name Type Description
requestOptions any

configure callbacks

Appearition.ContentLibrary.GetItem (providerName, itemKey, requestOptions) static

Retrieves an item from the content library

Name Type Description
providerName string

Identified the provider of the content

itemKey string

Identifies the item for the provider in the content library

requestOptions any

configure callbacks

Appearition.ContentLibrary.GetItemDataUrl (providerName, itemKey, requestOptions) static

Returns the file item in the library as a data URL

Name Type Description
providerName string

the name of the provider

itemKey string

identifies the item in the provider

requestOptions any

configure callbacks

Appearition.ContentLibrary.GetThumbnailImageDataUrl (providerName, itemKey, requestOptions) static

Returns the thumbnail image of an item in the library as a data URL

Name Type Description
providerName string

the name of the provider

itemKey string

identifies the item in the provider

requestOptions any

configure callbacks

Appearition.ContentLibrary.ListProviderContentFormatTypes (providerName, requestOptions) static

Retrieves a list of content format types for the given provider

Name Type Description
providerName string

the name of the provider to return the records for

requestOptions any

configure callbacks

Appearition.ContentLibrary.ListProviders (requestOptions) static

Retrieves a list of library providers available to the user

Name Type Description
requestOptions any

configure callbacks

Appearition.ContentLibrary.ListProviderTags (providerName, requestOptions) static

Retrieves a list of tags for the given provider

Name Type Description
providerName string

the name of the provider to return the records for

requestOptions any

configure callbacks

Appearition.ContentLibrary.ListProviderUsageRights (providerName, requestOptions) static

Retrieves a list of usage rights for the given provider

Name Type Description
providerName string

the name of the provider to return the records for

requestOptions any

configure callbacks

Appearition.ContentLibrary.Search (providerName, searchRequest, requestOptions) static

Retrieves a list of tags that are available to be added to an experience record

Name Type Description
providerName string

the name of the provider to return the records for

searchRequest any

contains values used for filtering and paging

requestOptions any

configure callbacks

Type Definitions

Appearition.ContentLibrary.GetItemRequest

Holds the identifiers of the specific content item

Properties:
Name Type Description
providerName string

Content library provider

itemKey string

The unique identifier of the item in provider