trait PackageAPI extends Package
- Alphabetic
- By Inheritance
- PackageAPI
- Package
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def flush(pc: ParsedCache): Unit
Flush all types to the passed cache
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getDependencies(typeId: TypeIdentifier, outerInheritanceOnly: Boolean, apexOnly: Boolean): Array[TypeIdentifier]
Returns set of Types that are depended on by the passed Type
Returns set of Types that are depended on by the passed Type
If outerInheritanceOnly is true only extending and implementing dependencies are reported for the outer Type of Apex defined types. If apexOnly is true then only Apex defined types are returned.
- Definition Classes
- PackageAPI → Package
- def getDependencyHolders(typeId: TypeIdentifier, apexOnly: Boolean): Array[TypeIdentifier]
Returns set of Types that depend on the passed Type.
Returns set of Types that depend on the passed Type.
The returned array may be stale in that it can contain Types which used to hold a dependency but not longer do. If apexOnly is true then only Apex defined types are returned.
- Definition Classes
- PackageAPI → Package
- def getDependentType(typeName: TypeName): Option[DependentType]
- def getNamespaces(withDependents: Boolean): Array[String]
The namespace of the package or the package and its dependent packages.
The namespace of the package or the package and its dependent packages.
An empty namespace indicates the "unmanaged" package.
- Definition Classes
- PackageAPI → Package
- def getPathsOfType(typeId: TypeIdentifier): Array[String]
Get the path(s) of the metadata file that defined a Type.
Get the path(s) of the metadata file that defined a Type.
Returns an empty array if the Type is not defined within the current package.
- Definition Classes
- PackageAPI → Package
- def getSummaryOfType(typeId: TypeIdentifier): TypeSummary
Get the summary information for a Type.
Get the summary information for a Type.
Returns a null if the Type is not defined within the current package.
- Definition Classes
- PackageAPI → Package
- def getSummaryOfTypeAsJSON(typeId: TypeIdentifier): String
JSON encoding of summary information for a type.
JSON encoding of summary information for a type.
Returns a null if the Type is not defined within the current package.
- Definition Classes
- PackageAPI → Package
- def getTypeIdentifier(typeName: TypeName): TypeIdentifier
Get a TypeIdentifier for a TypeName resolved against this package.
Get a TypeIdentifier for a TypeName resolved against this package.
Returns null if the TypeName is not visible in this package.
- Definition Classes
- PackageAPI → Package
- def getTypeIdentifiers(apexOnly: Boolean): Array[TypeIdentifier]
Get a array of type identifiers from this packages modules.
Get a array of type identifiers from this packages modules.
- Definition Classes
- PackageAPI → Package
- def getTypeOfPath(path: String): TypeIdentifier
Get a Type from the path of a metadata file.
Get a Type from the path of a metadata file.
Returns a null if the path does not identify metadata that creates a Type within the current package.
- Definition Classes
- PackageAPI → Package
- def hasDependency(typeId: TypeIdentifier, dependencyTypeId: TypeIdentifier): Boolean
Returns true if the type identified by typeId depends in the type identified by dependencyTypeId.
Returns true if the type identified by typeId depends in the type identified by dependencyTypeId.
This will return true where the type depends on an inner class of dependencyTypeId. All dependencies of typeId are considered including those of any inner class.
- Definition Classes
- PackageAPI → Package
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isPackagePath(path: String): Boolean
Test if a metadata file path is part of this package.
Test if a metadata file path is part of this package.
Return null if this either not a recognised metadata file type or it is not part of this package.
- Definition Classes
- PackageAPI → Package
- def isPackagePathInternal(path: PathLike): Boolean
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def reValidate(references: Set[TypeId]): Unit
- Attributes
- protected
- def refresh(path: String, highPriority: Boolean): Unit
Refresh a type in the package.
Refresh a type in the package.
This registers that the metadata in a file may need updating. The refresh is queued until the Org metadata is next flushed so that changes are made in batches for efficiency. Refreshing causes dependent metadata to be re-validated so issues may be reported against other metadata types after the flush has completed.
If there is no file at the given path then any previous contribution to the package metadata from this file will be removed so you call this after file deletion.
- Definition Classes
- PackageAPI → Package
- def refreshBatched(refreshRequests: Seq[RefreshRequest]): Boolean
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()