Class SoapDeploymentApi

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

Implements

DeploymentApi

Index

Constructors

Properties

connection soap

Methods

cancelDeploy checkDeployStatus deploy deployRecentValidation invoke

Constructors

constructor

new SoapDeploymentApi(connection: SalesforceConnection): 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: string): 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: string, includeDetails?: boolean): Promise<DeployResult>
Parameters
- id: string
- OptionalincludeDetails: boolean
Returns Promise<DeployResult>
Implementation of DeploymentApi.checkDeployStatus
- Defined in packages/salesforce/src/connection/metadata/soapDeploymentApi.ts:37

deploy

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

deployRecentValidation

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

`Private`invoke

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