Function EnvironmentApiAxiosParamCreator

EnvironmentApi - axios parameter creator

Export

  • EnvironmentApiAxiosParamCreator(configuration?): {
        getDefaultDirectoryBrowser: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getDirectoryContents: ((path: string, includeFiles?: boolean, includeDirectories?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getDrives: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getNetworkShares: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getParentPath: ((path: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        validatePath: ((validatePathDto: ValidatePathDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

  • Parameters

    Returns {
        getDefaultDirectoryBrowser: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getDirectoryContents: ((path: string, includeFiles?: boolean, includeDirectories?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getDrives: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getNetworkShares: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getParentPath: ((path: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        validatePath: ((validatePathDto: ValidatePathDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

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

      Summary

      Get Default directory browser.

      Throws

        • (options?): Promise<RequestArgs>

        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getDirectoryContents: ((path: string, includeFiles?: boolean, includeDirectories?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

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

      Throws

        • (path, includeFiles?, includeDirectories?, options?): Promise<RequestArgs>

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

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

      Summary

      Gets available drives from the server's file system.

      Throws

        • (options?): Promise<RequestArgs>

        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

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

      Summary

      Gets network paths.

      Deprecated

      Throws

        • (options?): Promise<RequestArgs>

        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getParentPath: ((path: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Gets the parent path of a given path.

      Throws

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

        • Parameters

          • path: string

            The path.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • validatePath: ((validatePathDto: ValidatePathDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Validates path.

      Throws

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

        • Parameters

          • validatePathDto: ValidatePathDto

            Validate request object.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

Settings

Member Visibility