Book Image

Alfresco Developer Guide

Book Image

Alfresco Developer Guide

Overview of this book

Table of Contents (17 chapters)
Alfresco Developer Guide
Credits
About the Author
About the Reviewers
Preface
Index

Appendix A. API Reference and Examples

This section is not a reprint of the Javadoc for every existing Alfresco class. Instead, it focuses on just enough to get you pointed in the right direction. This critical subset of the reference material includes:

  • An index of Alfresco's "public services" classes. These are the interfaces you should be writing against when using the Foundation API.

  • A set of Lucene query syntax examples. It's hard to do anything without a Lucene query—this section gives you the basic syntax.

  • A comprehensive listing of JavaScript root objects and a JavaScript API reference. Ultimately, the Alfresco JavaScript API is implemented in Java, so the JavaScript API is already documented in the Javadoc. But JavaScript is such an integral part of web scripts, and the framework is becoming so popular, that it seemed a good idea to reprint the Javadoc here to make it easily scannable and update it with minor edits to fill in some missing details.

  • A set of basic code snippets by function, and by API. These snippets show you how to perform a basic task with each of the major APIs: Java-based Foundation API, JavaScript API, and Web Services.