Function LibraryStructureApiFp

Returns {
    addMediaPath(mediaPathDto: MediaPathDto, refreshLibrary?: boolean, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    addVirtualFolder(name?: string, collectionType?: CollectionTypeOptions, paths?: string[], refreshLibrary?: boolean, addVirtualFolderDto?: AddVirtualFolderDto, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    getVirtualFolders(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<VirtualFolderInfo[]>)>;
    removeMediaPath(name?: string, path?: string, refreshLibrary?: boolean, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    removeVirtualFolder(name?: string, refreshLibrary?: boolean, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    renameVirtualFolder(name?: string, newName?: string, refreshLibrary?: boolean, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    updateLibraryOptions(updateLibraryOptionsDto?: UpdateLibraryOptionsDto, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    updateMediaPath(updateMediaPathRequestDto: UpdateMediaPathRequestDto, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
}

• addMediaPath:function

  • addMediaPath(mediaPathDto, refreshLibrary?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

  • Parameters

    • mediaPathDto: MediaPathDto

      The media path dto.
    • OptionalrefreshLibrary: boolean

      Whether to refresh the library.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    Summary

    Add a media path to a library.

    Throws

• addVirtualFolder:function

  • addVirtualFolder(name?, collectionType?, paths?, refreshLibrary?, addVirtualFolderDto?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

  • Parameters

    • Optionalname: string

      The name of the virtual folder.
    • OptionalcollectionType: CollectionTypeOptions

      The type of the collection.
    • Optionalpaths: string[]

      The paths of the virtual folder.
    • OptionalrefreshLibrary: boolean

      Whether to refresh the library.
    • OptionaladdVirtualFolderDto: AddVirtualFolderDto

      The library options.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    Summary

    Adds a virtual folder.

    Throws

• getVirtualFolders:function

  • getVirtualFolders(options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<VirtualFolderInfo[]>)>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<VirtualFolderInfo[]>)>

    Summary

    Gets all virtual folders.

    Throws

• removeMediaPath:function

  • removeMediaPath(name?, path?, refreshLibrary?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

  • Parameters

    • Optionalname: string

      The name of the library.
    • Optionalpath: string

      The path to remove.
    • OptionalrefreshLibrary: boolean

      Whether to refresh the library.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    Summary

    Remove a media path.

    Throws

• removeVirtualFolder:function

  • removeVirtualFolder(name?, refreshLibrary?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

  • Parameters

    • Optionalname: string

      The name of the folder.
    • OptionalrefreshLibrary: boolean

      Whether to refresh the library.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    Summary

    Removes a virtual folder.

    Throws

• renameVirtualFolder:function

  • renameVirtualFolder(name?, newName?, refreshLibrary?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

  • Parameters

    • Optionalname: string

      The name of the virtual folder.
    • OptionalnewName: string

      The new name.
    • OptionalrefreshLibrary: boolean

      Whether to refresh the library.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    Summary

    Renames a virtual folder.

    Throws

• updateLibraryOptions:function

  • updateLibraryOptions(updateLibraryOptionsDto?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

  • Parameters

    • OptionalupdateLibraryOptionsDto: UpdateLibraryOptionsDto

      The library name and options.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    Summary

    Update library options.

    Throws

• updateMediaPath:function

  • updateMediaPath(updateMediaPathRequestDto, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

  • Parameters

    • updateMediaPathRequestDto: UpdateMediaPathRequestDto

      The name of the library and path infos.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    Summary

    Updates a media path.

    Throws