vlocode-project - v1.40.0-beta-4
    Preparing search index...

    Class SoapClient

    Simple Salesforce SOAP request client

    Index

    Constructors

    constructor

    Properties

    clientName connection endpoint retryDelay retryLimit transport xmlNs defaultClientName

    Methods

    buildRequestBody getFaultCode invoke isRetryable isSessionExpired request

    Constructors

    Properties

    clientName: string = SoapClient.defaultClientName

    API client name used in the SOAP request to identify the client making the request. Defaults to SoapClient.defaultClientName

    connection: SalesforceConnection
    endpoint: string
    retryDelay: number = 3000

    Retry delay in MS after which a retryable SOAP fault is retried.

    retryLimit: number = 3

    Number of retries to attempt after which a request is failed.

    transport: HttpTransport
    xmlNs: string = 'http://soap.sforce.com/2006/08/apex'
    defaultClientName: string = 'Vlocode SOAP client'

    Default API client name used for new SOAP clients.

    Methods

    • Converts the contents of the package to XML that can be saved into a package.xml file

      Parameters

      • request: SoapClientRequest

      Returns string

    • Type Parameters

      • T = object

      Parameters

      • request: SoapClientRequest
      • Optionalattempt: number

      Returns Promise<SoapClientResponse<T>>

    • Make SOAP request.

      Type Parameters

      • T = object

      Parameters

      • method: string

        method name

      • request: object

        request body as JSON object

      • Optionaloptions: SoapRequestOptions

        Optional call options; include debuggingHeader to enable SOAP debugging

      Returns Promise<SoapClientResponse<T>>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods