Class PackageApi

PackageApi - object-oriented interface

Export

PackageApi

Hierarchy

BaseAPI
- PackageApi

Index

Constructors

Properties

axios basePath configuration

Methods

cancelPackageInstallation getPackageInfo getPackages getRepositories installPackage setRepositories

Constructors

constructor

new PackageApi(configuration?, basePath?, axios?): PackageApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns PackageApi
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

cancelPackageInstallation

cancelPackageInstallation(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: PackageApiCancelPackageInstallationRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Cancels a package installation.

Throws
Memberof
PackageApi
- Defined in generated-client/api/package-api.ts:531

getPackageInfo

getPackageInfo(requestParameters, options?): Promise<AxiosResponse<PackageInfo, any>>
Parameters
- requestParameters: PackageApiGetPackageInfoRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PackageInfo, any>>
Summary
Gets a package by name or assembly GUID.

Throws
Memberof
PackageApi
- Defined in generated-client/api/package-api.ts:543

getPackages

getPackages(options?): Promise<AxiosResponse<PackageInfo[], any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PackageInfo[], any>>
Summary
Gets available packages.

Throws
Memberof
PackageApi
- Defined in generated-client/api/package-api.ts:554

getRepositories

getRepositories(options?): Promise<AxiosResponse<RepositoryInfo[], any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<RepositoryInfo[], any>>
Summary
Gets all package repositories.

Throws
Memberof
PackageApi
- Defined in generated-client/api/package-api.ts:565

installPackage

installPackage(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: PackageApiInstallPackageRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Installs a package.

Throws
Memberof
PackageApi
- Defined in generated-client/api/package-api.ts:577

setRepositories

setRepositories(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: PackageApiSetRepositoriesRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Sets the enabled and existing package repositories.

Throws
Memberof
PackageApi
- Defined in generated-client/api/package-api.ts:589