Class RestDeploymentApi

REST based deployment API implementation that uses the new restful resources to create and update deployments.

Hierarchy

RestDeploymentApi

Implements

DeploymentApi

Index

Constructors

Properties

connection rest

Methods

cancelDeploy checkDeployStatus deploy

Constructors

constructor

new RestDeploymentApi(connection): RestDeploymentApi
Parameters
- connection: SalesforceConnection
Returns RestDeploymentApi
- Defined in packages/salesforce/src/connection/metadata/restDeploymentApi.ts:22

Properties

`Private` connection

connection: SalesforceConnection

`Private` rest

rest: RestClient

Methods

cancelDeploy

cancelDeploy(id): Promise<DeployResult>
Parameters
- id: string
Returns Promise<DeployResult>
Implementation of DeploymentApi.cancelDeploy
- Defined in packages/salesforce/src/connection/metadata/restDeploymentApi.ts:56

checkDeployStatus

checkDeployStatus(id, includeDetails?): Promise<DeployResult>
Parameters
- id: string
- Optional includeDetails: boolean
Returns Promise<DeployResult>
Implementation of DeploymentApi.checkDeployStatus
- Defined in packages/salesforce/src/connection/metadata/restDeploymentApi.ts:51

deploy

deploy(data, deployOptions): Promise<DeployResult>
Parameters
- data: string | Buffer | Stream
- deployOptions: DeployOptions
Returns Promise<DeployResult>
Implementation of DeploymentApi.deploy
- Defined in packages/salesforce/src/connection/metadata/restDeploymentApi.ts:26