Documentation for classes includes syntax, usage information, and code samples for methods, properties, and event handlers and listeners for those APIs that belong to a specific class in ActionScript. The classes are listed alphabetically. If you are not sure to which class a certain method or property belongs, you can look it up in the Index.
| Class | Package | Description | |
|---|---|---|---|
| AbstractCouchRequest | com.custardbelly.as3couchdb.service | AbstractCouchRequest is an ICouchRequest implementation with abstract and stubbed methods. | |
| AbstractDatabaseResponder | com.custardbelly.as3couchdb.responder | AbstractDatabaseResponder is an abstract responder to requests made on a database. | |
| AbstractDocumentResponder | com.custardbelly.as3couchdb.responder | AbtstractDocumentResponder is a abstract responder to service requests related to a couch document. | |
| AttachmentRequestQueue | com.custardbelly.as3couchdb.mediator.helper | AttachmentRequestQueue is a request queue for saving and deleting attachments related to a document. | |
| BasicCouchResponder | com.custardbelly.as3couchdb.responder | BasicCouchResponder is a basic responder to service operations with target methods for result and fault responses. | |
| CouchActionType | com.custardbelly.as3couchdb.enum | CouchActionType is a string enumeration of the types of actions that are performed in a service operation. | |
| CouchAttachment | com.custardbelly.as3couchdb.core | CouchAttachment is a respresentation of the JSON object of an attachment associated with a document. | |
| CouchContentType | com.custardbelly.as3couchdb.enum | CouchContentType is a string enumeration of the HTTP content types using in performing service operations. | |
| CouchDatabase | com.custardbelly.as3couchdb.core | CouchDatabase is a base model representing an instance of a Couch Database. | |
| CouchDatabaseActionMediator | com.custardbelly.as3couchdb.mediator | CouchDatabaseActionMediator is an ICouchDatabaseActionMediator implementation that dos invoking operations on a service related to a given CouchDatabase instance. | |
| CouchDatabaseReader | com.custardbelly.as3couchdb.serialize | CouchDatabaseReader interprets data returned from the service and applies attributes to target database. | |
| CouchDatabaseService | com.custardbelly.as3couchdb.service | CouchDatabaseService is an ICouchDatabaseService implementation that communicates with a CouchDB instance to perform any actions related to a database. | |
| CouchDatabaseWriter | com.custardbelly.as3couchdb.serialize | CouchDatabaseWriter interprets a target database and writes any attributes related. | |
| CouchDocument | com.custardbelly.as3couchdb.core | CouchDocument is a base model representing an instance of a document within a databse of CouchDB. | |
| CouchDocumentActionMediator | com.custardbelly.as3couchdb.mediator | CouchDocumentActionMediator is an ICouchDocumentActionMediator implementation that do service operations in relation to a target CouchDocument instance. | |
| CouchDocumentReader | com.custardbelly.as3couchdb.serialize | CouchDocumentReader interprets result returned from service and applies any related attributes to target document. | |
| CouchDocumentService | com.custardbelly.as3couchdb.service | CouchDocumentService is an ICouchDocumentService implementation that communicates with a CouchDB instance to perform any actions related to a document. | |
| CouchDocumentWriter | com.custardbelly.as3couchdb.serialize | CouchDocumentWriter handles writing attributes from a target document to an object that CouchDB can interpret. | |
| CouchEvent | com.custardbelly.as3couchdb.event | CouchEvent is a generic event object dispatched upon success and fauilure of a service operation. | |
| CouchFaultType | com.custardbelly.as3couchdb.enum | CouchFaultType is a string enumeration of finer detail describing a fault from a service operation. | |
| CouchModel | com.custardbelly.as3couchdb.core | CouchModel is a base model class for databases and documents and handles resolving the identity related to the annotated metadata for this instance. | |
| CouchModelEntity | com.custardbelly.as3couchdb.core | CouchModelEntity handles parsing annotated metadata related to the CouchDB database instance. | |
| CouchRequest | com.custardbelly.as3couchdb.service | CouchRequest handles making and responding to requests to the CouchDB instance. | |
| CouchRequestCommand | com.custardbelly.as3couchdb.command | CouchRequestCommand is generic wrapper for invoking a ICouchRequest with held arguments. | |
| CouchRequestMethod | com.custardbelly.as3couchdb.enum | CouchRequestMethod is a string enumeration of the HTTP request types for a service operation. | |
| CouchRequestStatus | com.custardbelly.as3couchdb.enum | CouchRequestStatus is an enumeration of the types of HTTP status codes that are returned during a service operation. | |
| CouchService | com.custardbelly.as3couchdb.service | CouchService is a base service class for communicating with a CouchDB instance. | |
| CouchServiceFault | com.custardbelly.as3couchdb.core | CouchServiceFault is a base fault object describing any errors in performing service operations. | |
| CouchServiceResult | com.custardbelly.as3couchdb.core | CouchServiceResult is a base result object describing the successful result from a service operation. | |
| CouchSession | com.custardbelly.as3couchdb.core | CouchSession is a model for data related to a cookie authentication for a session based on a time limit. | |
| CouchSessionActionMediator | com.custardbelly.as3couchdb.mediator | ||
| CouchUser | com.custardbelly.as3couchdb.core | CouchUser is a generic user class mainly for use with session authentication. | |
| CreateDatabaseCommand | com.custardbelly.as3couchdb.command | CreateDatabaseCommand is a CouchRequestCommand extensions to properly handle the response of database already existant in CouchDB instance. | |
| CreateDatabaseResponder | com.custardbelly.as3couchdb.responder | CreateDatabaseResponder is an ICouchServiceResponder implementation to handle result and fault responses from the creation of a database. | |
| CreateDocumentResponder | com.custardbelly.as3couchdb.responder | CreateDocumentResponder is an ICouchServiceResponder implementation that handle the creation response of a new document. | |
| DeleteDatabaseResponder | com.custardbelly.as3couchdb.responder | DeleteDatabaseResponder is an ICouchServiceResponder impementation to handle service response with regards to the deletion of a database. | |
| DeleteDocumentResponder | com.custardbelly.as3couchdb.responder | DeleteDocumentResponder is an ICouchServiceResponder implementation to handle service response with regards to the deletion of a document. | |
| ExInCouchRequest | com.custardbelly.as3couchdb.service | ExInCouchRequest is an ICouchRequest implementation that uses ExternalInterface calls to communicate with a CouchDB instance. | |
| HTTPCouchRequest | com.custardbelly.as3couchdb.service | HTTPCouchRequest is an ICouchRequest implememntation that uses as3httpclient to communicate with a CouchDB instance. | |
| HTTPSessionRequest | com.custardbelly.as3couchdb.service | HTTPSessionRequest is an ICouchRequest implementation that handles creating a session for other requests. | |
| ICouchDatabaseActionMediator | com.custardbelly.as3couchdb.mediator | ICouchDatabaseActionMediator is a mediator for invoking service operations relate to a target database. | |
| ICouchDatabaseReader | com.custardbelly.as3couchdb.serialize | ICouchDatabaseReader interprets service result and applied attributes to database objects. | |
| ICouchDatabaseService | com.custardbelly.as3couchdb.service | ICouchDatabaseService is an interface for communication with a CouchDB instance. | |
| ICouchDatabaseWriter | com.custardbelly.as3couchdb.serialize | ICouchDatabaseWriter handle serializing service requests in JSON format. | |
| ICouchDocumentActionMediator | com.custardbelly.as3couchdb.mediator | ICouchDocumentActionMediator is a mediator for invoking service operations in relation to a target document. | |
| ICouchDocumentReader | com.custardbelly.as3couchdb.serialize | ICouchDocumentReader interprets service results and applies attributes to targeted documents. | |
| ICouchDocumentService | com.custardbelly.as3couchdb.service | ICouchDocumentService is an interface for communication with a CouchDB instance with regards to documents held on a database. | |
| ICouchDocumentWriter | com.custardbelly.as3couchdb.serialize | ICouchDocumentWriter serialized documents to JSON objects for service requests. | |
| ICouchRequest | com.custardbelly.as3couchdb.service | ICouchRequest represents a request to a CouchDB instance. | |
| ICouchService | com.custardbelly.as3couchdb.service | ICouchService is a base service for handling communication with a CouchDB instance. | |
| ICouchServiceResponder | com.custardbelly.as3couchdb.responder | ICouchServiceResponder is a general responder to service operations that handle success, fault and current HTTP status. | |
| ICouchSessionActionMediator | com.custardbelly.as3couchdb.mediator | ICouchSessionActionMediator is a service mediator for handling sessions. | |
| IRequestCommand | com.custardbelly.as3couchdb.command | IRequestCommand is a base interface for any wrapped requests for CouchDB service communication. | |
| IServiceMediator | com.custardbelly.as3couchdb.mediator | IServiceMediator is a base mediator class representing a middle tier in communication between a CouchModel instance and the CouchDB service. | |
| ReadAllDocumentsResponder | com.custardbelly.as3couchdb.responder | ReadAllDocumentsResponder is a service responder to read in the payload of all documents related to a database in the CouchDB instance. | |
| ReadDatabaseResponder | com.custardbelly.as3couchdb.responder | ReadDatabaseResponder is an ICouchServiceResponder implementation that handle result and fault from a service operation with regards to accessing and reading a database instance from CouchDB. | |
| ReadDocumentResponder | com.custardbelly.as3couchdb.responder | ReadDocumentResponder is an ICouchServiceResponder implementation that handle result and fault of reading and applying attributes to a document instance of CouchDB. | |
| ReadDocumentsFromViewResponder | com.custardbelly.as3couchdb.responder | ReadDocumentsFromViewResponder is a responder to a request make on a view document in the database of the CouchDB instance. | |
| UpdateDocumentResponder | com.custardbelly.as3couchdb.responder | UpdateDocumentResponder is an ICouchServiceResponder that handles result and fault responses from a service with regards to the target document instance in CouchDB. | |
| UUID | com.custardbelly.as3couchdb.util | UUID is a utility class to generate a unique id to be used whe creating and saving a document to a CouchDB instance. |