ActionScript 3 Class Reference API

Usage

Endpoint

Parameters

version

Required

The version of the API documentation you would like to retrieve. Currently, the only valid value is "flex3", which covers the ActionScript APIs for Flex 3, Flash Player 9 and Adobe AIR 1.1.

api

The class name that you would like information on.

This can be a complete or partial class name. All entries that contain a class name that start with the API parameter will be returned.

If the parameter is not specified, or does not have a value, all classes will be returned. Please use this option responsibly.

Response

All responses are sent as a JSON encoded object.

Success Response

A success response is returned as a JSON encoded object with the following properties:

• result : A string with the value of "success".
• version : the version of the API that the results are being returned for. Currently this will always be "flex3".
• base_path : a URL containing the base path for the documentation.
• items : An array of Objects that contain matches for the API parameter passed in. Each object contains two properties:
  • name : The name of the class
  • path : The path, relative to the base_path property to the online documentation for the class.

Example

http://as3reference.appspot.com/getapi?version=flex3&api=String

{"items": [
{"path": "String.html", "name": "String"}, 
{"path": "mx\/utils\/StringUtil.html", "name": "StringUtil"}, 
{"path": "mx\/validators\/StringValidator.html", "name": "StringValidator"}
], 
"version": "flex3", "base_path": "http:\/\/livedocs.adobe.com\/flex\/3\/langref\/"}

Error Response

If an error occurs, a JSON object with three properties will be returned.

• result : A string with the value of "error"
• message : An error message.
• code : An error code.

Example

http://as3reference.appspot.com/getapi

{"message": "version is required", "code": 7229, "result": "error"}

Release History

September 3, 2008

• Initial release

Feedback

Credits

Created by Mike Chambers