EnvironmentApi - functional programming interface

  • Parameters

    Returns {
        getDefaultDirectoryBrowser(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<DefaultDirectoryBrowserInfoDto>)>;
        getDirectoryContents(path: string, includeFiles?: boolean, includeDirectories?: boolean, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileSystemEntryInfo[]>)>;
        getDrives(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileSystemEntryInfo[]>)>;
        getNetworkShares(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileSystemEntryInfo[]>)>;
        getParentPath(path: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>)>;
        validatePath(validatePathDto: ValidatePathDto, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    }

    • getDefaultDirectoryBrowser:function
    • getDirectoryContents:function
      • Parameters

        • path: string

          The path.

        • OptionalincludeFiles: boolean

          An optional filter to include or exclude files from the results. true/false.

        • OptionalincludeDirectories: boolean

          An optional filter to include or exclude folders from the results. true/false.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Gets the contents of a given directory in the file system.

    • getDrives:function
      • Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Gets available drives from the server's file system.

    • getNetworkShares:function
    • getParentPath:function
      • Parameters

        • path: string

          The path.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Gets the parent path of a given path.

    • validatePath:function
      • Parameters

        • validatePathDto: ValidatePathDto

          Validate request object.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Validates path.