Function LibraryStructureApiFactory

LibraryStructureApi - factory interface

Export

LibraryStructureApiFactory(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): {
    addMediaPath(
        requestParameters: LibraryStructureApiAddMediaPathRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    addVirtualFolder(
        requestParameters?: LibraryStructureApiAddVirtualFolderRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    getVirtualFolders(
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<VirtualFolderInfo[]>;
    removeMediaPath(
        requestParameters?: LibraryStructureApiRemoveMediaPathRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    removeVirtualFolder(
        requestParameters?: LibraryStructureApiRemoveVirtualFolderRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    renameVirtualFolder(
        requestParameters?: LibraryStructureApiRenameVirtualFolderRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    updateLibraryOptions(
        requestParameters?: LibraryStructureApiUpdateLibraryOptionsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    updateMediaPath(
        requestParameters: LibraryStructureApiUpdateMediaPathRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
}
Parameters
- Optionalconfiguration: Configuration
- OptionalbasePath: string
- Optionalaxios: AxiosInstance
Returns {
    addMediaPath(
        requestParameters: LibraryStructureApiAddMediaPathRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    addVirtualFolder(
        requestParameters?: LibraryStructureApiAddVirtualFolderRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    getVirtualFolders(
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<VirtualFolderInfo[]>;
    removeMediaPath(
        requestParameters?: LibraryStructureApiRemoveMediaPathRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    removeVirtualFolder(
        requestParameters?: LibraryStructureApiRemoveVirtualFolderRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    renameVirtualFolder(
        requestParameters?: LibraryStructureApiRenameVirtualFolderRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    updateLibraryOptions(
        requestParameters?: LibraryStructureApiUpdateLibraryOptionsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    updateMediaPath(
        requestParameters: LibraryStructureApiUpdateMediaPathRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
}
- addMediaPath:function
  - addMediaPath(
    requestParameters: LibraryStructureApiAddMediaPathRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>
  - Parameters
    - requestParameters: LibraryStructureApiAddMediaPathRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<void>
    Throws
    - Defined in generated-client/api/library-structure-api.ts:532
- addVirtualFolder:function
  - addVirtualFolder(
    requestParameters?: LibraryStructureApiAddVirtualFolderRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>
  - Parameters
    - requestParameters: LibraryStructureApiAddVirtualFolderRequest = {}
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<void>
    Throws
    - Defined in generated-client/api/library-structure-api.ts:542
- getVirtualFolders:function
  - getVirtualFolders(
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<VirtualFolderInfo[]>
  - Parameters
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<VirtualFolderInfo[]>
    Throws
    - Defined in generated-client/api/library-structure-api.ts:551
- removeMediaPath:function
  - removeMediaPath(
    requestParameters?: LibraryStructureApiRemoveMediaPathRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>
  - Parameters
    - requestParameters: LibraryStructureApiRemoveMediaPathRequest = {}
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<void>
    Throws
    - Defined in generated-client/api/library-structure-api.ts:561
- removeVirtualFolder:function
  - removeVirtualFolder(
    requestParameters?: LibraryStructureApiRemoveVirtualFolderRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>
  - Parameters
    - requestParameters: LibraryStructureApiRemoveVirtualFolderRequest = {}
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<void>
    Throws
    - Defined in generated-client/api/library-structure-api.ts:571
- renameVirtualFolder:function
  - renameVirtualFolder(
    requestParameters?: LibraryStructureApiRenameVirtualFolderRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>
  - Parameters
    - requestParameters: LibraryStructureApiRenameVirtualFolderRequest = {}
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<void>
    Throws
    - Defined in generated-client/api/library-structure-api.ts:581
- updateLibraryOptions:function
  - updateLibraryOptions(
    requestParameters?: LibraryStructureApiUpdateLibraryOptionsRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>
  - Parameters
    - requestParameters: LibraryStructureApiUpdateLibraryOptionsRequest = {}
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<void>
    Throws
    - Defined in generated-client/api/library-structure-api.ts:591
- updateMediaPath:function
  - updateMediaPath(
    requestParameters: LibraryStructureApiUpdateMediaPathRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>
  - Parameters
    - requestParameters: LibraryStructureApiUpdateMediaPathRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<void>
    Throws
    - Defined in generated-client/api/library-structure-api.ts:601
- Defined in generated-client/api/library-structure-api.ts:522

Function LibraryStructureApiFactory

Export

Parameters

addMediaPath:function

Parameters

Returns AxiosPromise<void>

Throws

addVirtualFolder:function

Parameters

Returns AxiosPromise<void>

Throws

getVirtualFolders:function

Parameters

Returns AxiosPromise<VirtualFolderInfo[]>

Throws

removeMediaPath:function

Parameters

Returns AxiosPromise<void>

Throws

removeVirtualFolder:function

Parameters

Returns AxiosPromise<void>

Throws

renameVirtualFolder:function

Parameters

Returns AxiosPromise<void>

Throws

updateLibraryOptions:function

Parameters

Returns AxiosPromise<void>

Throws

updateMediaPath:function

Parameters

Returns AxiosPromise<void>

Throws

Settings