[
Date Prev][
Date Next][
Thread Prev][
Thread Next][
Date Index][
Thread Index]
[
List Home]
|
[orion-dev] Understanding the client documentation
|
I've implemented plugins by following examples by Mark and Susan; I've used the server REST API just from the docs. The one case that I've not figured out is how to use the client documentation.
For example consider:
It starts with this info at the top:
------
Class orion.fileClient.FileClient
The file client provides a convenience API for interacting with file services provided by plugins. This class handles authorization, and authentication-related error handling.
Defined in:</shared/eclipse/e4/orion/I201203272230/plugins/org.eclipse.orion.client.core/web/orion/fileClient.js>.
-----
However this makes no sense to me. It seems to be describing an API that is inside of a plugin. Yet it talks about services provided by plugins. I gather that the fileClient.js plugin can be loaded in to a page, then -- if you do the right incantation -- you can call the functions listed in the jsdoc.
Is there a example page that uses the fileClient plugin? I guess edit.html uses it, based on lines like
var fileClient = new mFileClient.FileClient(serviceRegistry);
but this is just all the more mysterious because it does not match the docs.
