<< Up | < Previous Page | Next Page >

How to Use the API JavaDocs

A complete description of the classes, interfaces, methods, and enumerated values in the API can be found in the following root path: ...sdk_4_0/client/docs/api/index.html. Opening this file will display the API JavaDocs in a web browser. It is similar in format to any generated Java documentation, as shown in Figure 2.1 there is a navigator bar displaying the following options: Overview, Package, Class, Use, Tree, Deprecated, Index, and Help.

Figure 2.1: Overview Page

From this page, any of the needed information concerning the API can be accessed. The packages contain different classes and interfaces. The names are indicative of what they contain, except for com.attask.common which includes all of the exceptions or fault that can occur in @task. Each package name is a link and opens up a view similar to that found in Figure 2.2.

Figure 2.2: Interface Summary

From here you can perform a search for the information that you desire. All of the class names are linked, and open to a class description that includes all of the methods, interfaces, searchable fields, etc., that are associate with the class.

Using the Messages and Enum classes