Class SalesforceService

constructor

• new SalesforceService(connectionProvider, namespaceService, queryService, logger, fs): SalesforceService

• Parameters

  • connectionProvider: SalesforceConnectionProvider

  • namespaceService: NamespaceService

  • queryService: QueryService

  • logger: Logger

  • fs: FileSystem

  Returns SalesforceService

Readonly batch

Readonly deploy

Readonly logs

Readonly lookupService

Readonly metadataRegistry

Readonly schema

compileClasses

• compileClasses(apexClassBody): Promise<any>

• Compiles the specified class bodies on the server

  Parameters

  • apexClassBody: string[]

    APEX classes to compile

  Returns Promise<any>

delete

• delete(ids, chunkSize?): Promise<{
      error?: string;
      id: string;
      success: boolean;
  }[]>

• Delete one or more records by ID

  Parameters

  • ids: Iterable<string | SObjectRecord>

    list of IDs

  • chunkSize: number = 200

  Returns Promise<{
      error?: string;
      id: string;
      success: boolean;
  }[]>

deleteWhere

• deleteWhere(type, filter?, chunkSize?): Promise<{
      error?: string;
      id: string;
      success: boolean;
  }[]>

• Delete one or more records based on a SOQL filter condition. Returns array of deleted record-ids

  Parameters

  • type: string

    SObject type to delete

  • Optional filter: string | object | (string | object)[]

    Object filter or where-conditional selecting the records to delete

  • chunkSize: number = 200

    Number of records to delete in a single call

  Returns Promise<{
      error?: string;
      id: string;
      success: boolean;
  }[]>

dispose

• dispose(): void

• Returns void

executeAnonymous

• executeAnonymous(apex, options?): Promise<ExecuteAnonymousResult & {
      debugLog?: string;
  }>

• Executes the specified APEX using the SOAP API and returns the result.

  Parameters

  • apex: string

    APEX code to execute

  • Optional options: {
        logLevels?: SoapDebuggingHeader;
        updateNamespace?: boolean;
    }

    • Optional logLevels?: SoapDebuggingHeader

      Optional debug log levels to use

    • Optional updateNamespace?: boolean

      Replace namespace placeholders with the actual namespace

  Returns Promise<ExecuteAnonymousResult & {
      debugLog?: string;
  }>

getApexCodeCoverage

• getApexCodeCoverage(apexClassName): Promise<ApexTestCoverage>

• Parameters

  • apexClassName: string

  Returns Promise<ApexTestCoverage>

• getApexCodeCoverage(apexClassName): Promise<ApexTestCoverage[]>

• Parameters

  • apexClassName: string[]

  Returns Promise<ApexTestCoverage[]>

getApiVersion

• getApiVersion(): string

• Get the version of the current Salesforce connection

  Returns string

getApiVersions

• getApiVersions(count?): Promise<string[]>

• Get a list of available API version on the connected server

  Parameters

  • count: number = 10

  Returns Promise<string[]>

getConnectedUserInfo

• getConnectedUserInfo(): Promise<{
      id: string;
      profileId: any;
      type: string;
      username: string;
  }>

• Gets basic details about the user for the current connection

  Returns Promise<{
      id: string;
      profileId: any;
      type: string;
      username: string;
  }>

getContentVersionData

• getContentVersionData(versionId): Promise<string>

• Get the content of the specified content version object based on the content version Id

  Parameters

  • versionId: string

    Content Version object Id

  Returns Promise<string>

getInstalledPackageDetails

• getInstalledPackageDetails(packageName): Promise<undefined | InstalledPackageMetadata>

• Parameters

  • packageName: string | RegExp

  Returns Promise<undefined | InstalledPackageMetadata>

getInstalledPackageNamespace

• getInstalledPackageNamespace(packageName): Promise<string>

• Parameters

  • packageName: string | RegExp

  Returns Promise<string>

getInstalledPackages

• getInstalledPackages(): Promise<InstalledPackageMetadata[]>

• Returns Promise<InstalledPackageMetadata[]>

getJsForceConnection

• getJsForceConnection(): Promise<SalesforceConnection>

• Returns Promise<SalesforceConnection>

getMetadataInfo

• getMetadataInfo(filePath): Promise<undefined | MetadataInfo>

• Get metadata info about any file; returns metadata type and name or undefined if the specified type is not a Metadata source.

  Parameters

  • filePath: string | FileSystemUri

    Source file path

  Returns Promise<undefined | MetadataInfo>
• getMetadataInfo(filePaths): Promise<(undefined | MetadataInfo)[]>

• Parameters

  • filePaths: (string | FileSystemUri)[]

  Returns Promise<(undefined | MetadataInfo)[]>

getMetadataSetupUrl

• getMetadataSetupUrl(file): Promise<string>

• Parameters

  • file: string

  Returns Promise<string>

getMetadataType

• getMetadataType(type): undefined | MetadataType

• When the metadata type is a known metadata type return the type.

  Parameters

  • type: string

  Returns undefined | MetadataType

getMetadataTypes

• getMetadataTypes(): MetadataType[]

• Get the list of supported metadata types for the current organization merged with static metadata from the SFDX registry

  Returns MetadataType[]

getOrganizationDetails

• getOrganizationDetails(): Promise<OrganizationDetails>

• Returns Promise<OrganizationDetails>

getPageUrl

• getPageUrl(page, ops?): Promise<string>

• Parameters

  • page: string

  • Optional ops: {
        namespacePrefix?: string;
        useFrontdoor?: boolean;
    }

    • Optional namespacePrefix?: string

    • Optional useFrontdoor?: boolean

  Returns Promise<string>

getStaticResource

• getStaticResource(resourceName): Promise<{
      getBody: (() => Promise<Buffer>);
      id: any;
      name: any;
      namespace: any;
  }[]>

• Get all static resources matching the specified name, the body of the resource is retrieved when required. The body of the static resource is cached

  Parameters

  • resourceName: string

    Name of the static resource

  Returns Promise<{
      getBody: (() => Promise<Buffer>);
      id: any;
      name: any;
      namespace: any;
  }[]>

insert

• insert(type, records, cancelToken?): AsyncGenerator<BatchResultRecord, void, unknown>

• Insert one or more records into Salesforce; by default uses the standard collections api but switches to bulk API when there are more then 50 records to be inserted.

  Parameters

  • type: string

    Record types to insert

  • records: {
        ref: string;
        values: any;
    }[]

    record data and references

  • Optional cancelToken: CancellationToken

    optional cancellation token

  Returns AsyncGenerator<BatchResultRecord, void, unknown>

  Remarks

  For more control ove the operation users can also directly create a record batch offering more control.

isPackageInstalled

• isPackageInstalled(packageName): Promise<boolean>

• Parameters

  • packageName: string | RegExp

  Returns Promise<boolean>

isProductionOrg

• isProductionOrg(): Promise<boolean>

• Returns Promise<boolean>

loadProfilesFromDisk

• loadProfilesFromDisk(): Promise<{
      file: string;
      profile: SalesforceProfile;
  }[]>

• Load all known Salesforce profiles in the current workspace with the *.profile-meta.xml and the *.profile extension from the file system

  Returns Promise<{
      file: string;
      profile: SalesforceProfile;
  }[]>

lookup

• lookup<T, K>(type, filter?, lookupFields?, limit?, useCache?): Promise<QueryResult<T, K>[]>

• Query multiple records based on the where condition. The filter condition can either be a string or a complex filter object.

  Type Parameters

  • T extends object

  • K extends PropertyKey = keyof T

  Parameters

  • type: string

    SObject type

  • Optional filter: string | T | (string | T)[]

    Object filter or Where conditional string

  • Optional lookupFields: "all" | K[]

    fields to lookup on the record

  • Optional limit: number

    limit the number of results

  • Optional useCache: boolean

    use the query cache

  Returns Promise<QueryResult<T, K>[]>

query

• query<T>(query, useCache?): Promise<T[]>

• Returns a list of records. All records are mapped to record proxy object

  Type Parameters

  • T extends Partial<SObjectRecord>

  Parameters

  • query: string

    SOQL Query to execute

  • Optional useCache: boolean

  Returns Promise<T[]>

requestApexRemote

• requestApexRemote(page, action, method, data): Promise<any>

• Parameters

  • page: string

    Name of the APEX page which exposes the requested class/controller

  • action: string

    Name of the class including namespace when a namespace is required

  • method: HttpMethod

    Name of the method to call on the controller

  • data: any

    Data to pass to the controller

  Returns Promise<any>

update

• update(type, records, options?): AsyncGenerator<BatchResultRecord, void, unknown>

• Update one or more records in Salesforce using the ID field as foreign key; by default uses the standard collections api but switches to bulk API when there.

  Parameters

  • type: string

    Record types to updated; all data should have an ID field

  • records: {
        id: string;
        [key: string]: any;
    }[]

    record data and references

  • Optional options: Partial<{
        bulkApiThreshold: number;
        chunkSize: number;
        useBulkApi: boolean;
    }> & {
        cancelToken?: CancellationToken;
    }

  Returns AsyncGenerator<BatchResultRecord, void, unknown>

  Remarks

  For more control ove the operation users can also directly create a record batch offering more control.