Class EnvironmentApi

EnvironmentApi - object-oriented interface

Export

EnvironmentApi

Hierarchy

BaseAPI
- EnvironmentApi

Index

Constructors

constructor

new EnvironmentApi(configuration?, basePath?, axios?): EnvironmentApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns EnvironmentApi
Inherited from BaseAPI.constructor
- Defined in generated-client/base.ts:52

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

getDefaultDirectoryBrowser

getDefaultDirectoryBrowser(options?): Promise<AxiosResponse<DefaultDirectoryBrowserInfoDto, any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<DefaultDirectoryBrowserInfoDto, any>>
Summary
Get Default directory browser.

Throws
Memberof
EnvironmentApi
- Defined in generated-client/api/environment-api.ts:495

getDirectoryContents

getDirectoryContents(requestParameters, options?): Promise<AxiosResponse<FileSystemEntryInfo[], any>>
Parameters
- requestParameters: EnvironmentApiGetDirectoryContentsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<FileSystemEntryInfo[], any>>
Summary
Gets the contents of a given directory in the file system.

Throws
Memberof
EnvironmentApi
- Defined in generated-client/api/environment-api.ts:507

getDrives

getDrives(options?): Promise<AxiosResponse<FileSystemEntryInfo[], any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<FileSystemEntryInfo[], any>>
Summary
Gets available drives from the server's file system.

Throws
Memberof
EnvironmentApi
- Defined in generated-client/api/environment-api.ts:518

getNetworkShares

getNetworkShares(options?): Promise<AxiosResponse<FileSystemEntryInfo[], any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<FileSystemEntryInfo[], any>>
Summary
Gets network paths.

Deprecated
Throws
Memberof
EnvironmentApi
- Defined in generated-client/api/environment-api.ts:530

getParentPath

getParentPath(requestParameters, options?): Promise<AxiosResponse<string, any>>
Parameters
- requestParameters: EnvironmentApiGetParentPathRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<string, any>>
Summary
Gets the parent path of a given path.

Throws
Memberof
EnvironmentApi
- Defined in generated-client/api/environment-api.ts:542

validatePath

validatePath(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: EnvironmentApiValidatePathRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Validates path.

Throws
Memberof
EnvironmentApi
- Defined in generated-client/api/environment-api.ts:554

Class EnvironmentApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns EnvironmentApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

getDefaultDirectoryBrowser

Parameters

Returns Promise<AxiosResponse<DefaultDirectoryBrowserInfoDto, any>>

Summary

Throws

Memberof

getDirectoryContents

Parameters

Returns Promise<AxiosResponse<FileSystemEntryInfo[], any>>

Summary

Throws

Memberof

getDrives

Parameters

Returns Promise<AxiosResponse<FileSystemEntryInfo[], any>>

Summary

Throws

Memberof

getNetworkShares

Parameters

Returns Promise<AxiosResponse<FileSystemEntryInfo[], any>>

Summary

Deprecated

Throws

Memberof

getParentPath

Parameters

Returns Promise<AxiosResponse<string, any>>

Summary

Throws

Memberof

validatePath

Parameters

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration