Class to hold all the information that is dispatched as an event from Flashr when there is a response to a request. These events are caught by FlashrResponse which decodes them and calls the relevant method on itself.
This code and documentation is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 2.0. http://creativecommons.org/licenses/by-nc-sa/2.0/
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
0.5.0
Kelvin Luck < kelvin at kelvinluck dot com >
$Id: FlashrResponseEvent.as 72 2006-09-01 00:33:02Z kluck $
| com. kelvinluck. flashr. core. FlashrResponseEvent | Class to hold all the information that is dispatched as an event from Flashr when there is a response to a request. |
| status | The status of the response. |
| request | The FlashrRequest that led to this response. |
| type | The type of this event (always onAPIResponse) |
| errorMessage | Contains an error message where status != Flashr.STATUS_OK |
| data | A plain object used to pass the additional data that is required to decypher responses. |
| FlashrResponseEvent | Constructor |
| toString |
var status: Number
The status of the response.
Flashr.STATUS_BUSY, Flashr.STATUS_ERROR_CONNECTING, Flashr.STATUS_INVALID_XML, Flashr.STATUS_USER_NOT_LOGGED_IN, Flashr.STATUS_INVALID_API_KEY, Flashr.STATUS_OK
var request: FlashrRequest
The FlashrRequest that led to this response.
var errorMessage: String
Contains an error message where status != Flashr.STATUS_OK
The status of the response.
var status: Number
The FlashrRequest that led to this response.
var request: FlashrRequest
The type of this event (always onAPIResponse)
var type: String
Contains an error message where status != Flashr.STATUS_OK
var errorMessage: String
There was no errors and valid XML was returned.
public static var STATUS_OK: Number
A plain object used to pass the additional data that is required to decypher responses.
var data: Object
Constructor
function FlashrResponseEvent( request: FlashrRequest )
public function toString():String
The API is already waiting for the response to a method call so cannot make another call
public static var STATUS_BUSY: Number
Could not connect to the server (e.g.
public static var STATUS_ERROR_CONNECTING: Number
The XML returned by the server wasn’t in a rsp / tag.
public static var STATUS_INVALID_XML: Number
The user wasn’t logged in and tried to access a method that requires authentication (returned from flickr.com)
public static var STATUS_USER_NOT_LOGGED_IN: Number
The API key sent to flickr was invalid (returned from flickr.com)
public static var STATUS_INVALID_API_KEY: Number