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

new SubscriberPackageVersion(options): SubscriberPackageVersion
Parameters
- options: SubscriberPackageVersionOptions
Returns SubscriberPackageVersion
- Defined in src/package/subscriberPackageVersion.ts:112

Methods

getCspTrustedSites

getCspTrustedSites(): Promise<SubscriberPackageCspTrustedSites>
Return CSP trusted sites for the SubscriberPackageVersion.

Returns Promise<SubscriberPackageCspTrustedSites>
The CSP trusted sites.
- Defined in src/package/subscriberPackageVersion.ts:332

getData

getData(options?): Promise<undefined | PackagingSObjects.SubscriberPackageVersion>
Get the SubscriberPackageVersion SObject data for this SubscriberPackageVersion.
Parameters
- options: {
  force?: boolean;
  includeHighCostFields?: boolean;
  } = ...
  - Optional force?: boolean
  - Optional includeHighCostFields?: boolean
Returns Promise<undefined | PackagingSObjects.SubscriberPackageVersion>
SObject data.
- Defined in src/package/subscriberPackageVersion.ts:351

getDependencies

getDependencies(): Promise<SubscriberPackageDependencies>
Return dependencies for the SubscriberPackageVersion.

Returns Promise<SubscriberPackageDependencies>
The dependencies.
- Defined in src/package/subscriberPackageVersion.ts:485

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.
- Defined in src/package/subscriberPackageVersion.ts:467

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>
- Defined in src/package/subscriberPackageVersion.ts:494

getId

getId(): Promise<string>
Get the package version ID for this SubscriberPackageVersion.

Returns Promise<string>
The SubscriberPackageVersion Id (04t).
- Defined in src/package/subscriberPackageVersion.ts:240

getInstallValidationStatus

getInstallValidationStatus(): Promise<InstallValidationStatus>
Get the installation validation status for the SubscriberPackageVersion.

Returns Promise<InstallValidationStatus>
The installation validation status.
- Defined in src/package/subscriberPackageVersion.ts:341

getPackageType

getPackageType(): Promise<PackageType>
Get the package type for this SubscriberPackageVersion.

Returns Promise<PackageType>
The package type.
- Defined in src/package/subscriberPackageVersion.ts:249

getPassword

getPassword(): Optional<string>
Get the password passed in the constructor

Returns Optional<string>
the password
- Defined in src/package/subscriberPackageVersion.ts:258

getRemoteSiteSettings

getRemoteSiteSettings(): Promise<SubscriberPackageRemoteSiteSettings>
Return remote site settings for the SubscriberPackageVersion.

Returns Promise<SubscriberPackageRemoteSiteSettings>
The remote site settings.
- Defined in src/package/subscriberPackageVersion.ts:323

getSubscriberPackageId

getSubscriberPackageId(): Promise<string>
Get the subscriber package Id (033) for this SubscriberPackageVersion.

Returns Promise<string>
The subscriber package Id.
- Defined in src/package/subscriberPackageVersion.ts:267

getVersionNumber

getVersionNumber(): Promise<VersionNumber>
Get a VersionNumber instance for this SubscriberPackageVersion.

Returns Promise<VersionNumber>
The version number.
- Defined in src/package/subscriberPackageVersion.ts:276

install

install(pkgInstallCreateRequest, options?): Promise<PackageInstallRequest>
Installs a package version in a subscriber org.

Package Version install emits the following events:
- PackageEvents.install.warning
- PackageEvents.install.presend
- PackageEvents.install.postsend
- PackageEvents.install['subscriber-status']
Parameters
- pkgInstallCreateRequest: PackageInstallCreateRequest
- options: PackageInstallOptions = allZeroesInstallOptions
Returns Promise<PackageInstallRequest>
- Defined in src/package/subscriberPackageVersion.ts:416

isDeprecated

isDeprecated(): Promise<boolean>
Is the SubscriberPackageVersion deprecated?

Returns Promise<boolean>
True if the SubscriberPackageVersion is deprecated.
- Defined in src/package/subscriberPackageVersion.ts:296

isManaged

isManaged(): Promise<boolean>
Is the package a managed package?

Returns Promise<boolean>
- Defined in src/package/subscriberPackageVersion.ts:287

isOrgDependent

isOrgDependent(): Promise<boolean>
Is the SubscriberPackageVersion org dependent?

Returns Promise<boolean>
True if the SubscriberPackageVersion is org dependent.
- Defined in src/package/subscriberPackageVersion.ts:314

isPasswordProtected

isPasswordProtected(): Promise<boolean>
Is the SubscriberPackageVersion password protected?

Returns Promise<boolean>
True if the SubscriberPackageVersion is password protected.
- Defined in src/package/subscriberPackageVersion.ts:305

uninstall

uninstall(frequency?, wait?): Promise<SubscriberPackageVersionUninstallRequest>
Uninstalls a package version from a subscriber org.
Parameters
- frequency: Duration = ...
- wait: Duration = ...
Returns Promise<SubscriberPackageVersionUninstallRequest>
- Defined in src/package/subscriberPackageVersion.ts:454

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;
  } = ...
  - Optional installationKey?: 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>
- Defined in src/package/subscriberPackageVersion.ts:388

`Static` getInstallRequest

getInstallRequest(installRequestId, connection): Promise<PackageInstallRequest>
Retrieves the package version create request.
Parameters
- installRequestId: string
- connection: Connection<Schema>
Returns Promise<PackageInstallRequest>
- Defined in src/package/subscriberPackageVersion.ts:221

`Static` installStatus

installStatus(connection, packageInstallRequestOrId, installationKey?, options?): Promise<PackageInstallRequest>
Fetches the status of a package version install request and will wait for the install to complete, if requested Package Version install emits the following events:
- PackageEvents.install['subscriber-status']
Parameters
- connection: Connection<Schema>
- packageInstallRequestOrId: string | PackageInstallRequest
- Optional installationKey: Nullable<string>
- Optional options: PackageInstallOptions
Returns Promise<PackageInstallRequest>
- Defined in src/package/subscriberPackageVersion.ts:146

`Static` installedList

installedList(conn): Promise<InstalledPackages[]>
list the packages installed in the org
Parameters
- conn: Connection<Schema>
Returns Promise<InstalledPackages[]>
- Defined in src/package/subscriberPackageVersion.ts:174

`Static` uninstallStatus

uninstallStatus(id, connection): Promise<SubscriberPackageVersionUninstallRequest>
Reports on the progress of a package version uninstall.
Parameters
- id: string
  the 06y package version uninstall request id
- connection: Connection<Schema>
Returns Promise<SubscriberPackageVersionUninstallRequest>
- Defined in src/package/subscriberPackageVersion.ts:193

Class SubscriberPackageVersion

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns SubscriberPackageVersion

Methods

getCspTrustedSites

Returns Promise<SubscriberPackageCspTrustedSites>

getData

Parameters

Optional force?: boolean

Optional includeHighCostFields?: boolean

Returns Promise<undefined | PackagingSObjects.SubscriberPackageVersion>

getDependencies

Returns Promise<SubscriberPackageDependencies>

getExternalSites

Returns Promise<Optional<string[]>>

getField

Type Parameters

Parameters

Returns Promise<T>

getId

Returns Promise<string>

getInstallValidationStatus

Returns Promise<InstallValidationStatus>

getPackageType

Returns Promise<PackageType>

getPassword

Returns Optional<string>

getRemoteSiteSettings

Returns Promise<SubscriberPackageRemoteSiteSettings>

getSubscriberPackageId

Returns Promise<string>

getVersionNumber

Returns Promise<VersionNumber>

install

Parameters

Returns Promise<PackageInstallRequest>

isDeprecated

Returns Promise<boolean>

isManaged

Returns Promise<boolean>

isOrgDependent

Returns Promise<boolean>

isPasswordProtected

Returns Promise<boolean>

uninstall

Parameters

Returns Promise<SubscriberPackageVersionUninstallRequest>

waitForPublish

Parameters

Optional installationKey?: string

publishFrequency: Duration

publishTimeout: Duration

Returns Promise<void>

Static getInstallRequest

Parameters

Returns Promise<PackageInstallRequest>

Static installStatus

Parameters

Returns Promise<PackageInstallRequest>

Static installedList

Parameters

Returns Promise<InstalledPackages[]>

Static uninstallStatus

Parameters

Returns Promise<SubscriberPackageVersionUninstallRequest>

Settings

Member Visibility

Theme

On This Page

`Optional` force?: boolean

`Optional` includeHighCostFields?: boolean

`Optional` installationKey?: string

`Static` getInstallRequest

`Static` installStatus

`Static` installedList

`Static` uninstallStatus