Class LibraryApi

LibraryApi - object-oriented interface

Export

LibraryApi

Hierarchy

BaseAPI
- LibraryApi

Constructors

constructor

new LibraryApi(configuration?, basePath?, axios?): LibraryApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns LibraryApi
Inherited from BaseAPI.constructor
- Defined in generated-client/base.ts:52

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

deleteItem

deleteItem(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: LibraryApiDeleteItemRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Deletes an item from the library and filesystem.

Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2447

deleteItems

deleteItems(requestParameters?, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: LibraryApiDeleteItemsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Deletes items from the library and filesystem.

Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2459

getAncestors

getAncestors(requestParameters, options?): Promise<AxiosResponse<BaseItemDto[], any>>
Parameters
- requestParameters: LibraryApiGetAncestorsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDto[], any>>
Summary
Gets all parents of an item.

Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2471

getCriticReviews

getCriticReviews(requestParameters, options?): Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Parameters
- requestParameters: LibraryApiGetCriticReviewsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Summary
Gets critic review for an item.

Deprecated
Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2484

getDownload

getDownload(requestParameters, options?): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: LibraryApiGetDownloadRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Downloads item media.

Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2496

getFile

getFile(requestParameters, options?): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: LibraryApiGetFileRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Get the original file of an item.

Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2508

getItemCounts

getItemCounts(requestParameters?, options?): Promise<AxiosResponse<ItemCounts, any>>
Parameters
- requestParameters: LibraryApiGetItemCountsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ItemCounts, any>>
Summary
Get item counts.

Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2520

getLibraryOptionsInfo

getLibraryOptionsInfo(requestParameters?, options?): Promise<AxiosResponse<LibraryOptionsResultDto, any>>
Parameters
- requestParameters: LibraryApiGetLibraryOptionsInfoRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<LibraryOptionsResultDto, any>>
Summary
Gets the library options info.

Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2532

getMediaFolders

getMediaFolders(requestParameters?, options?): Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Parameters
- requestParameters: LibraryApiGetMediaFoldersRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Summary
Gets all user media folders.

Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2544

getPhysicalPaths

getPhysicalPaths(options?): Promise<AxiosResponse<string[], any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<string[], any>>
Summary
Gets a list of physical paths from virtual folders.

Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2555

getSimilarAlbums

getSimilarAlbums(requestParameters, options?): Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Parameters
- requestParameters: LibraryApiGetSimilarAlbumsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Summary
Gets similar items.

Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2567

getSimilarArtists

getSimilarArtists(requestParameters, options?): Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Parameters
- requestParameters: LibraryApiGetSimilarArtistsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Summary
Gets similar items.

Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2579

getSimilarItems

getSimilarItems(requestParameters, options?): Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Parameters
- requestParameters: LibraryApiGetSimilarItemsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Summary
Gets similar items.

Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2591

getSimilarMovies

getSimilarMovies(requestParameters, options?): Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Parameters
- requestParameters: LibraryApiGetSimilarMoviesRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Summary
Gets similar items.

Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2603

getSimilarShows

getSimilarShows(requestParameters, options?): Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Parameters
- requestParameters: LibraryApiGetSimilarShowsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Summary
Gets similar items.

Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2615

getSimilarTrailers

getSimilarTrailers(requestParameters, options?): Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Parameters
- requestParameters: LibraryApiGetSimilarTrailersRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Summary
Gets similar items.

Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2627

getThemeMedia

getThemeMedia(requestParameters, options?): Promise<AxiosResponse<AllThemeMediaResult, any>>
Parameters
- requestParameters: LibraryApiGetThemeMediaRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<AllThemeMediaResult, any>>
Summary
Get theme songs and videos for an item.

Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2639

getThemeSongs

getThemeSongs(requestParameters, options?): Promise<AxiosResponse<ThemeMediaResult, any>>
Parameters
- requestParameters: LibraryApiGetThemeSongsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ThemeMediaResult, any>>
Summary
Get theme songs for an item.

Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2651

getThemeVideos

getThemeVideos(requestParameters, options?): Promise<AxiosResponse<ThemeMediaResult, any>>
Parameters
- requestParameters: LibraryApiGetThemeVideosRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ThemeMediaResult, any>>
Summary
Get theme videos for an item.

Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2663

postAddedMovies

postAddedMovies(requestParameters?, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: LibraryApiPostAddedMoviesRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Reports that new movies have been added by an external source.

Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2675

postAddedSeries

postAddedSeries(requestParameters?, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: LibraryApiPostAddedSeriesRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Reports that new episodes of a series have been added by an external source.

Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2687

postUpdatedMedia

postUpdatedMedia(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: LibraryApiPostUpdatedMediaRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Reports that new movies have been added by an external source.

Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2699

postUpdatedMovies

postUpdatedMovies(requestParameters?, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: LibraryApiPostUpdatedMoviesRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Reports that new movies have been added by an external source.

Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2711

postUpdatedSeries

postUpdatedSeries(requestParameters?, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: LibraryApiPostUpdatedSeriesRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Reports that new episodes of a series have been added by an external source.

Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2723

refreshLibrary

refreshLibrary(options?): Promise<AxiosResponse<void, any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Starts a library scan.

Throws
Memberof
LibraryApi
- Defined in generated-client/api/library-api.ts:2734

Class LibraryApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns LibraryApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

deleteItem

Parameters

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

deleteItems

Parameters

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

getAncestors

Parameters

Returns Promise<AxiosResponse<BaseItemDto[], any>>

Summary

Throws

Memberof

getCriticReviews

Parameters

Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>

Summary

Deprecated

Throws

Memberof

getDownload

Parameters

Returns Promise<AxiosResponse<File, any>>

Summary

Throws

Memberof

getFile

Parameters

Returns Promise<AxiosResponse<File, any>>

Summary

Throws

Memberof

getItemCounts

Parameters

Returns Promise<AxiosResponse<ItemCounts, any>>

Summary

Throws

Memberof

getLibraryOptionsInfo

Parameters

Returns Promise<AxiosResponse<LibraryOptionsResultDto, any>>

Summary

Throws

Memberof

getMediaFolders

Parameters

Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>

Summary

Throws

Memberof

getPhysicalPaths

Parameters

Returns Promise<AxiosResponse<string[], any>>

Summary

Throws

Memberof

getSimilarAlbums

Parameters

Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>

`Protected`axios

`Protected`basePath

`Protected`configuration