Class SoapDeploymentApi

SOAP based deployment API implementation that uses the File based SOAP APIs to create and update deployments.

Hierarchy

SoapDeploymentApi

Implements

DeploymentApi

Index

Constructors

Properties

connection soap

Methods

cancelDeploy checkDeployStatus deploy invoke

Constructors

constructor

new SoapDeploymentApi(connection): SoapDeploymentApi
Parameters
- connection: SalesforceConnection
Returns SoapDeploymentApi
- Defined in packages/salesforce/src/connection/metadata/soapDeploymentApi.ts:16

Properties

`Private` connection

connection: SalesforceConnection

`Private` soap

soap: SoapClient

Methods

cancelDeploy

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

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/soapDeploymentApi.ts:37

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/soapDeploymentApi.ts:23

`Private` invoke

invoke<K>(method, message, responsePath?): Promise<MetadataResponses[K]>
Type Parameters
- K extends keyof MetadataResponses
Parameters
- method: K
- message: object
- Optional responsePath: string
Returns Promise<MetadataResponses[K]>
- Defined in packages/salesforce/src/connection/metadata/soapDeploymentApi.ts:49