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: MediaPathDto,
        refreshLibrary?: boolean,
        options?: RawAxiosRequestConfig,
    ): 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>>

    Throws

• addVirtualFolder: function

  • addVirtualFolder(
        name?: string,
        collectionType?: CollectionTypeOptions,
        paths?: string[],
        refreshLibrary?: boolean,
        addVirtualFolderDto?: AddVirtualFolderDto,
        options?: RawAxiosRequestConfig,
    ): 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>>

    Throws

• getVirtualFolders: function

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

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• removeMediaPath: function

  • removeMediaPath(
        name?: string,
        path?: string,
        refreshLibrary?: boolean,
        options?: RawAxiosRequestConfig,
    ): 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>>

    Throws

• removeVirtualFolder: function

  • removeVirtualFolder(
        name?: string,
        refreshLibrary?: boolean,
        options?: RawAxiosRequestConfig,
    ): 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>>

    Throws

• renameVirtualFolder: function

  • renameVirtualFolder(
        name?: string,
        newName?: string,
        refreshLibrary?: boolean,
        options?: RawAxiosRequestConfig,
    ): 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>>

    Throws

• updateLibraryOptions: function

  • updateLibraryOptions(
        updateLibraryOptionsDto?: UpdateLibraryOptionsDto,
        options?: RawAxiosRequestConfig,
    ): 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>>

    Throws

• updateMediaPath: function

  • updateMediaPath(
        updateMediaPathRequestDto: UpdateMediaPathRequestDto,
        options?: RawAxiosRequestConfig,
    ): 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>>

    Throws