Class LibraryStructureApi

LibraryStructureApi - object-oriented interface

Export

LibraryStructureApi

Hierarchy

BaseAPI
- LibraryStructureApi

Index

Constructors

Properties

axios basePath configuration

Methods

addMediaPath addVirtualFolder getVirtualFolders removeMediaPath removeVirtualFolder renameVirtualFolder updateLibraryOptions updateMediaPath

Constructors

constructor

new LibraryStructureApi(configuration?, basePath?, axios?): LibraryStructureApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns LibraryStructureApi
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

addMediaPath

addMediaPath(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: LibraryStructureApiAddMediaPathRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Add a media path to a library.

Throws
Memberof
LibraryStructureApi
- Defined in generated-client/api/library-structure-api.ts:790

addVirtualFolder

addVirtualFolder(requestParameters?, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: LibraryStructureApiAddVirtualFolderRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Adds a virtual folder.

Throws
Memberof
LibraryStructureApi
- Defined in generated-client/api/library-structure-api.ts:802

getVirtualFolders

getVirtualFolders(options?): Promise<AxiosResponse<VirtualFolderInfo[], any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<VirtualFolderInfo[], any>>
Summary
Gets all virtual folders.

Throws
Memberof
LibraryStructureApi
- Defined in generated-client/api/library-structure-api.ts:813

removeMediaPath

removeMediaPath(requestParameters?, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: LibraryStructureApiRemoveMediaPathRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Remove a media path.

Throws
Memberof
LibraryStructureApi
- Defined in generated-client/api/library-structure-api.ts:825

removeVirtualFolder

removeVirtualFolder(requestParameters?, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: LibraryStructureApiRemoveVirtualFolderRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Removes a virtual folder.

Throws
Memberof
LibraryStructureApi
- Defined in generated-client/api/library-structure-api.ts:837

renameVirtualFolder

renameVirtualFolder(requestParameters?, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: LibraryStructureApiRenameVirtualFolderRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Renames a virtual folder.

Throws
Memberof
LibraryStructureApi
- Defined in generated-client/api/library-structure-api.ts:849

updateLibraryOptions

updateLibraryOptions(requestParameters?, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: LibraryStructureApiUpdateLibraryOptionsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Update library options.

Throws
Memberof
LibraryStructureApi
- Defined in generated-client/api/library-structure-api.ts:861

updateMediaPath

updateMediaPath(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: LibraryStructureApiUpdateMediaPathRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Updates a media path.

Throws
Memberof
LibraryStructureApi
- Defined in generated-client/api/library-structure-api.ts:873