Class EnvironmentApi

EnvironmentApi - object-oriented interface

Hierarchy

BaseAPI
- EnvironmentApi

Index

Constructors

Properties

axios basePath configuration

Methods

getDefaultDirectoryBrowser getDirectoryContents getDrives getParentPath validatePath

Constructors

constructor

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

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration | undefined

Methods

getDefaultDirectoryBrowser

getDefaultDirectoryBrowser(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<DefaultDirectoryBrowserInfoDto, any, {}>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<DefaultDirectoryBrowserInfoDto, any, {}>>

Throws
- Defined in generated-client/api/environment-api.ts:414

getDirectoryContents

getDirectoryContents(
requestParameters: EnvironmentApiGetDirectoryContentsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<FileSystemEntryInfo[], any, {}>>
Parameters
- requestParameters: EnvironmentApiGetDirectoryContentsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<FileSystemEntryInfo[], any, {}>>

Throws
- Defined in generated-client/api/environment-api.ts:425

getDrives

getDrives(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<FileSystemEntryInfo[], any, {}>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<FileSystemEntryInfo[], any, {}>>

Throws
- Defined in generated-client/api/environment-api.ts:435

getParentPath

getParentPath(
requestParameters: EnvironmentApiGetParentPathRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<string, any, {}>>
Parameters
- requestParameters: EnvironmentApiGetParentPathRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<string, any, {}>>

Throws
- Defined in generated-client/api/environment-api.ts:446

validatePath

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

Throws
- Defined in generated-client/api/environment-api.ts:457