Interface RetrieveRequest

Hierarchy

  • RetrieveRequest

Properties

apiVersion packageNames? singlePackage? specificFiles? unpackaged?

Properties

apiVersion

apiVersion: string | number

Optional packageNames

packageNames?: string[]

A list of package names to be retrieved. If you are retrieving only unpackaged components, do not specify a name here. You can retrieve packaged and unpackaged components in the same retrieve.

Optional singlePackage

singlePackage?: boolean

Specifies whether only a single package is being retrieved (true) or not (false). If false, then more than one package is being retrieved.

Optional specificFiles

specificFiles?: string[]

A list of file names to be retrieved. If a value is specified for this property, packageNames must be set to null and singlePackage must be set to true.

Optional unpackaged

unpackaged?: RetrievePackage

A list of components to retrieve that are not in a package.

Settings

Member Visibility

Theme

On This Page