Orion/Documentation/Developer Guide/Core client services

From Eclipsepedia

Jump to: navigation, search

Contents

Overview of core client services

Orion provides a number of basic infrastructure services that can be used by client scripts for performing various tasks. These services have no user interface component and can be used within any page of a client application. This section of the guide outlines what services are available, along with simple examples of how to use them.

orion.core.favorite

The orion.core.favorite service is used to access and store the user's bookmarks or favorites. While a user may opt to use their own browser's bookmark mechanism instead, there are some specific advantages to using Orion's favorite service instead:

  • Favorites are persisted on the server, so the user can switch to another client computer or browser and access their familiar bookmarks
  • Favorites are associated with a specific Orion application and user, so favorites from different users or applications are not all mixed into a single place.

Here is an example usage of the favorites service:

serviceRegistry.getService("orion.core.favorite").then(function(service) {
  service.makeFavorites(item);
});

See orion.favorites.FavoritesService in the Orion client API reference for a complete list of functions available on the favorite service.

orion.core.file

The orion.core.file service is used to provide file system contents for the Orion workspace. For example a plug-in can use this service to include content from one server into a workspace on another server. Each file service is displayed as a root element in the Orion Navigator page.

The code snippet below demonstrates an use of this service:

 provider.registerServiceProvider("orion.core.file", service, {Name: 'Sample File System'});

The above code will contribute a top level node to the Navigator named "Sample File System". The parameter "service" in the API above must provide the functions specified by the Orion file client API. Refer to orion.fileClient.FileClient in the client API reference for further details. For more information on client-server interaction, see Orion File Server API. For an complete file system example, see the sample file plugin in the Orion Git repository.

orion.core.marker

The marker service is used to store problems found by a builder or syntax validator. A client can register with this service for notification when markers are changed. Here is an example of a component that is registering for notification of marker changes:

 serviceRegistry.getService("orion.core.marker").then(function(markers) {
   markers.addEventListener("problemsChanged", function(problems) {
     //do something with the new problems
   });
 });

Each marker is a simple JSON object with the following properties:

reason
A string stating the description of the problem or marker
line
The line number of the marker
character
The column position of the marker

orion.core.preference

The preferences service manages a hierarchical set of preference nodes. Nodes are identified by a path string, where segments are delimited by the slash character ('/'). Each node is a JSON object with string keys and values that are String, Boolean, or Number.

Here is an example of retrieving a preference storing the list of recently used projects:

 prefService.getPreferences("/window/recent").then(function(prefs) {
   var projects =  prefs.get("projects");
   if (typeof projects === "string") {
     projects = JSON.parse(projects);
   }
   if (projects && projects.length && projects.length > 0) {
     //do something with the projects
   }
 });

And here is an example of adding a new project to the list, and storing the result back in the preference service:

 prefService.getPreferences("/window/recent").then(function(prefs) {
   var projects = prefs.get("projects");
   if (typeof projects === "string") {
     projects = JSON.parse(projects);
   }
   projects.push({name: "My Proj", location: "http://example.com/myproj"});
   prefs.put("projects", projects);
 });

orion.core.user