Function LibraryStructureApiAxiosParamCreator

LibraryStructureApi - axios parameter creator

Export

  • LibraryStructureApiAxiosParamCreator(configuration?): {
        addMediaPath: ((mediaPathDto: MediaPathDto, refreshLibrary?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        addVirtualFolder: ((name?: string, collectionType?: CollectionTypeOptions, paths?: string[], refreshLibrary?: boolean, addVirtualFolderDto?: AddVirtualFolderDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getVirtualFolders: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        removeMediaPath: ((name?: string, path?: string, refreshLibrary?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        removeVirtualFolder: ((name?: string, refreshLibrary?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        renameVirtualFolder: ((name?: string, newName?: string, refreshLibrary?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        updateLibraryOptions: ((updateLibraryOptionsDto?: UpdateLibraryOptionsDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        updateMediaPath: ((updateMediaPathRequestDto: UpdateMediaPathRequestDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

  • Parameters

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

    • addMediaPath: ((mediaPathDto: MediaPathDto, refreshLibrary?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Add a media path to a library.

      Throws

        • (mediaPathDto, refreshLibrary?, options?): Promise<RequestArgs>

        • Parameters

          • mediaPathDto: MediaPathDto

            The media path dto.

          • OptionalrefreshLibrary: boolean

            Whether to refresh the library.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • addVirtualFolder: ((name?: string, collectionType?: CollectionTypeOptions, paths?: string[], refreshLibrary?: boolean, addVirtualFolderDto?: AddVirtualFolderDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Adds a virtual folder.

      Throws

        • (name?, collectionType?, paths?, refreshLibrary?, addVirtualFolderDto?, options?): Promise<RequestArgs>

        • 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<RequestArgs>

    • getVirtualFolders: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Gets all virtual folders.

      Throws

        • (options?): Promise<RequestArgs>

        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • removeMediaPath: ((name?: string, path?: string, refreshLibrary?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Remove a media path.

      Throws

        • (name?, path?, refreshLibrary?, options?): Promise<RequestArgs>

        • 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<RequestArgs>

    • removeVirtualFolder: ((name?: string, refreshLibrary?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Removes a virtual folder.

      Throws

        • (name?, refreshLibrary?, options?): Promise<RequestArgs>

        • Parameters

          • Optionalname: string

            The name of the folder.

          • OptionalrefreshLibrary: boolean

            Whether to refresh the library.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • renameVirtualFolder: ((name?: string, newName?: string, refreshLibrary?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Renames a virtual folder.

      Throws

        • (name?, newName?, refreshLibrary?, options?): Promise<RequestArgs>

        • 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<RequestArgs>

    • updateLibraryOptions: ((updateLibraryOptionsDto?: UpdateLibraryOptionsDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Update library options.

      Throws

        • (updateLibraryOptionsDto?, options?): Promise<RequestArgs>

        • Parameters

          • OptionalupdateLibraryOptionsDto: UpdateLibraryOptionsDto

            The library name and options.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • updateMediaPath: ((updateMediaPathRequestDto: UpdateMediaPathRequestDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Updates a media path.

      Throws

        • (updateMediaPathRequestDto, options?): Promise<RequestArgs>

        • Parameters

          • updateMediaPathRequestDto: UpdateMediaPathRequestDto

            The name of the library and path infos.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

Settings

Member Visibility