Changeset 1546 for trunk/Docs/Request/Request.md

Timestamp:

05/05/08 10:36:32 (1 week ago)

Author:

JanK

Message:

• Class events should now be used without their on prefix, i.e. addEvent('onChainComplete', fn) becomes addEvent('chainComplete'). If you want to add events in the options you need to prefix them with 'on' now ('foo' -> 'onFoo').
  

Note: This is not a breaking change.

- other minor optimizations and doc fixes

Files:

• trunk/Docs/Request/Request.md (modified) (6 diffs)

trunk/Docs/Request/Request.md

@@ -30 +30 @@
 ----------------------------------------
 
-### onRequest
+### request
 
 (*function*) Function to execute when the Request is sent.
@@ -42 +42 @@
 1. instance - (Request) The transport instance.
 
-### onSuccess
+### success
 
 (*function*) Function to execute when the Request completes.
@@ -55 +55 @@
 2. responseXML  - (*mixed*) The response XML from the request.
 
-### onFailure
+### failure
 
 (*function*) Function to execute when the request fails (error status code).
@@ -67 +67 @@
 instance - (Request) The transport instance.
 
-### onException
+### exception
 
 (*function*) Function to execute when setting a request header fails.
@@ -80 +80 @@
 2. value      - (*string*) The value of the failing header.
 
-###     onCancel
+###     cancel
 
 (*function*) Function to execute when a request has been cancelled.
@@ -91 +91 @@
 
 * running  - (*boolean*) True if the request is running.
-* response - (*object*) Object with text and XML as keys. You can access this property in the onSuccess event.
+* response - (*object*) Object with text and XML as keys. You can access this property in the 'success' event.
 
 ### Returns: