Class ServerApi

ServerApi - object-oriented interface

Export

Hierarchy

BaseAPI
- ServerApi

Index

Constructors

Properties

axios basePath configuration

Methods

serverListShare serverRetrieveAbout serverRetrieveAnnotationFormats serverRetrievePlugins

Constructors

constructor

new ServerApi(configuration?, basePath?, axios?): ServerApi
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns ServerApi
Inherited from BaseAPI.constructor
- Defined in base.ts:53

Properties

`Protected` axios

axios: AxiosInstance = globalAxios

`Protected` basePath

basePath: string = BASE_PATH

`Protected` configuration

configuration: undefined | Configuration

Methods

serverListShare

serverListShare(requestParameters?, options?): Promise<AxiosResponse<FileInfo[], any>>
Parameters
- requestParameters: ServerApiServerListShareRequest = {}
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<FileInfo[], any>>

Summary
Returns all files and folders that are on the server along specified path

Throws

Memberof
ServerApi
- Defined in api-client/server-api.ts:365

serverRetrieveAbout

serverRetrieveAbout(options?): Promise<AxiosResponse<About, any>>
Parameters
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<About, any>>

Summary
Method provides basic CVAT information

Throws

Memberof
ServerApi
- Defined in api-client/server-api.ts:376

serverRetrieveAnnotationFormats

serverRetrieveAnnotationFormats(options?): Promise<AxiosResponse<DatasetFormats, any>>
Parameters
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<DatasetFormats, any>>

Summary
Method provides the list of supported annotations formats

Throws

Memberof
ServerApi
- Defined in api-client/server-api.ts:387

serverRetrievePlugins

serverRetrievePlugins(options?): Promise<AxiosResponse<Plugins, any>>
Parameters
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<Plugins, any>>

Summary
Method provides allowed plugins

Throws

Memberof
ServerApi
- Defined in api-client/server-api.ts:398

Generated using TypeDoc