Force syncing of org metadata to the cache when not using automatic flushing (see ServerOps).

When using manual flushing this should be called periodically to ensure the cache is kept upto date after metadata changes. If it returns true then getIssues should be called to retrieved the latest set of issues.

Get a array of completion suggestion given a source file contents and a position.

This will attempt to provide a list of possible completion suggestions at the position of the provided source file details. If none can be found it will return an empty array. Both the path and content must be provided for this. The path determines the scope of the search while the content is needed a we assume the on-disk source is not current. It is not necessary for the source content to be free of errors, but errors may impact the results.

Locate a type definition given source file position of the type name to search for.

This will attempt to locate the type definition of a type name at the provided line & offset in the path. The returned location provides information of the extent of the symbols used for the search as well as the file and extent of the found definition. If no symbol can be found that links to a definition it returns an empty array. If content is null, path will be used to load the source code. It is not necessary for the file being searched from to be free of errors, but errors may impact the ability to locate inner classes within that file.

Get Apex type dependency map for all types in the Org.

This is intended to be only used to support exporting of the map for secondary analysis.

Calculate an ordered list of classes which are having a big impact on classes dependencies, aka the 'Bombs'.

The calculation takes into account the number of incoming and outgoing dependencies from each classes. High scoring classes must have a large number of both to be considered 'Bombs'. These classes are scored on a scale 0-100 and ranked highest->lowest. The first 'count' os these are returned for your ridicule.

Get a dependency graph for a type identifier.

Depth should be a positive integer that indicates how far to search from the starting node for the passed TypeIdentifier. The root node of the search is always returned if it can be found. Depths > 0 will include additional nodes.

Retrieve the header for methods, classes and constructors given the position of the hovered code.

This will attempt to locate the type definition of a type name at the provided line & offset in the path. The returned hover item contains the header of the type declaration for a method, constructor or class, as well as the position for the hover popover. If no type declaration can be found for the hovered content or it is an unsupported type, an empty HoverItem is returned. If content is null, path will be used to load the source code. It is not necessary for the file being searched from to be free of errors, but errors may impact the ability to locate inner classes within that file.

Find the location of some form of identifier.

Currently this supports locating Outer & Inner classes and Triggers by name. These must include a namespace using the usual conventions to find a location for the identifier. Returns the file & position within that file if the identifier is found, otherwise returns null.

Locate the implementations of interfaces and abstract methods and classes given the position

This will attempt to locate the concrete implementation of the type definition or method at the provided line & offset in the path. The returned location are calculated based on the direct dependents and transitive dependents to find a concrete class that either has a super type that includes the type or a method signature from the path. If no location is found an empty array is returned. If content is null, path will be used to load the source code. It is not necessary for the file being searched from to be free of errors, but errors may impact the ability to locate inner classes within that file.

Get the package containing the path.

Returns null if no package handling this file is found or the file is not a recognised metadata type.

Locate the references given the location and offset.

This will attempt to find a body declaration (methods, fields or classes) at the given line & offset to find any blocks of code that is uses the found body declaration. This will return an array of locations at the point where the code is being used. If no references are found an empty array will be returned.

Retrieve a list of files and the edits for each to rename a symbol, given the location of one of the uses of the symbol.

This will attempt to locate all occurrence of a symbol provided the line & offset of one such occurrence within a class. The returned array contains each file where changes are to be made, and an array for each file containing locations where changes are due. If no type declaration can be found for the provided symbol or it is an unsupported type, an empty array is returned. If content is null, path will be used to load the source code. It is not necessary for the file being searched from to be free of errors, but errors may impact the ability to locate inner classes within that file.

Find all available test class items or those for given paths.

This provides a summary of available test classes, the path and location within the file. It does not provide test methods. Use a follow-up call to getTestMethodItems to retrieve method locations for a set of paths. Pass an empty array to retrieve all.

Class namespaces are NOT included.

Find test class items related to a given set of files.

Similar to getTestClassNames, however it additionally provides the test class path and location.

Class namespaces are NOT included.

Find test class names that can be used to test the passed set of files.

This calculates a set of tests that should be run when the passed files have been changed. The input files must be Apex classes for this to find results. The results include all tests that directly reference one of the input classes and tests that reference any supertype or interface of an input class.

Class namespaces are included.

Find all test method items or those for given paths.

This provides a summary of available test methods, class name and the path and location within the file. Pass an empty array to retrieve all.

Class namespaces are NOT included.

Get a list of type identifiers available in the org across all packages. This is not all available type identifiers, but just those that will make most sense to list in an IDE for selection.

Returns an array which may be empty.

Test if all metadata changes have been processed.

The Package refresh function queues changes so that they may be processed in batches either when you call flush() or via the automatic flushing mechanism. You can use this function to determine if the queue of changes to be processed is empty.