Class PackageBundle

Index

Constructors

Methods

create createVersion delete list

Constructors

constructor

new PackageBundle(): PackageBundle

Returns PackageBundle

Methods

`Static`create

create(
    connection: Connection,
    project: SfProject,
    options: BundleCreateOptions,
): Promise<{ Id: string }>
Create a new package bundle.
Parameters
- connection: Connection
  instance of Connection
- project: SfProject
  instance of SfProject
- options: BundleCreateOptions
  options for creating a bundle - see BundleCreateOptions
Returns Promise<{ Id: string }>
PackageBundle
- Defined in package/packageBundle.ts:45

`Static`createVersion

createVersion(
options: BundleVersionCreateOptions,
polling?: { frequency: Duration; timeout: Duration },
): Promise<PackageBundleVersionCreateRequestResult>
Create a new package bundle version.
Parameters
- options: BundleVersionCreateOptions
  options for creating a bundle version - see BundleVersionCreateOptions
- polling: { frequency: Duration; timeout: Duration } = ...
Returns Promise<PackageBundleVersionCreateRequestResult>
PackageBundle
- Defined in package/packageBundle.ts:61

`Static`delete

delete(
    connection: Connection,
    project: SfProject,
    idOrAlias: string,
): Promise<SaveResult>
Parameters
- connection: Connection
- project: SfProject
- idOrAlias: string
Returns Promise<SaveResult>
- Defined in package/packageBundle.ts:71

`Static`list

list(connection: Connection): Promise<Bundle[]>
Returns all the package bundles that are available in the org, up to 10,000. If more records are needed use the SF_ORG_MAX_QUERY_LIMIT env var.
Parameters
- connection: Connection
Returns Promise<Bundle[]>
- Defined in package/packageBundle.ts:93