Class SubscriberPackageVersion

Provides the ability to get, list, install, and uninstall 2nd generation subscriber package versions.

Examples

List all 2GP installed packages in the org:

const installedPkgs = await SubscriberPackageVersion.installedList(connection);

Install a 2GP subscriber package version:

const installStatus = await new SubscriberPackageVersion(options).install(request, options);

Constructors

constructor

Methods

getCspTrustedSites getData getDependencies getExternalSites getField getId getInstallValidationStatus getPackageType getPassword getRemoteSiteSettings getSubscriberPackageId getVersionNumber install isDeprecated isManaged isOrgDependent isPasswordProtected uninstall waitForPublish getInstallRequest installedList installStatus resolveId uninstallStatus

Constructors

constructor

Methods

getCspTrustedSites

getData

getDependencies

getExternalSites

  • getExternalSites(): Promise<Optional<string[]>>

  • Returns an array of RSS and CSP external sites for the package.

    Returns Promise<Optional<string[]>>

    an array of RSS and CSP site URLs, or undefined if the package doesn't have any.

getField

  • getField<T>(field): Promise<T>

  • Return a field value from the SubscriberPackageVersion SObject using the field name.

    Type Parameters

    • T

    Parameters

    • field: string

    Returns Promise<T>

getId

  • getId(): Promise<string>

  • Get the package version ID for this SubscriberPackageVersion.

    Returns Promise<string>

    The SubscriberPackageVersion Id (04t).

getInstallValidationStatus

getPackageType

getPassword

getRemoteSiteSettings

getSubscriberPackageId

  • getSubscriberPackageId(): Promise<string>

  • Get the subscriber package Id (033) for this SubscriberPackageVersion.

    Returns Promise<string>

    The subscriber package Id (033).

getVersionNumber

install

isDeprecated

  • isDeprecated(): Promise<boolean>

  • Is the SubscriberPackageVersion deprecated?

    Returns Promise<boolean>

    True if the SubscriberPackageVersion is deprecated.

isManaged

isOrgDependent

  • isOrgDependent(): Promise<boolean>

  • Is the SubscriberPackageVersion org dependent?

    Returns Promise<boolean>

    True if the SubscriberPackageVersion is org dependent.

isPasswordProtected

  • isPasswordProtected(): Promise<boolean>

  • Is the SubscriberPackageVersion password protected?

    Returns Promise<boolean>

    True if the SubscriberPackageVersion is password protected.

uninstall

waitForPublish

  • waitForPublish(options?): Promise<void>

  • Wait for the subscriber package version to be replicated across instances and available to be queried against

    Parameters

    • options: {
          installationKey?: string;
          publishFrequency: Duration;
          publishTimeout: Duration;
      } = ...
      • OptionalinstallationKey?: string

        the installation key for the package version

      • publishFrequency: Duration

        how often to check for the package version to be published

      • publishTimeout: Duration

        how long to wait for the package version to be published

    Returns Promise<void>

StaticgetInstallRequest

StaticinstalledList

StaticinstallStatus

StaticresolveId

  • resolveId(connection, pkgDescriptor): Promise<string>

  • Resolve fields from a packageDirectories entry to a SubscriberPackageVersionId (04t). Specifically uses the versionNumber and packageId fields, as well as an optional branch field.

    Parameters

    • connection: Connection<Schema>

      A connection object to the org

    • pkgDescriptor: Partial<PackageDescriptorJson>

      Fields from a packageDirectories entry in sfdx-project.json. The versionNumber and packageId fields are required. Optionally, the branch and package fields can be passed.

    Returns Promise<string>

    the SubscriberPackageVersionId (04t)

StaticuninstallStatus

Settings

Member Visibility

On This Page

Constructors
Methods