Please note: CPAINT nor this website is under active development. |
Frontend API
Class Summary
The frontend of CPAINT - the client-side part - entirely resides in the file cpaint2.inc.js.
In this section of the documentation we'll introduce to you the various methods available in the frontend
classes of CPAINT. However we'll only introduce the publicly available classes and methods. The others are
irrelevant for your daily work.
However if you need to change or improve CPAINT itself, you'll find JavaDoc-like documentation for all
methods and properties in the frontend file itself.
cpaint
The class cpaint incorporates your API to the frontend. It must be instanciated,
configured and used by your own functions to communicate with the backend.
In return, the cpaint class will create a request, send it, and when the backend
responds it takes care of postprocessing the response, creates a JavaScript object structure if needed and
returns the the final response to your application again.
cpaint_result_object
The class cpaint_result_object is used by the cpaint class to return a JavaScript object-structure instead of a plaintext or XML response.