ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
com.adobe.icc.services.formbridge 

FormBridgeError  - AS3 Asset Composer
Packagecom.adobe.icc.services.formbridge
Classpublic class FormBridgeError
InheritanceFormBridgeError Inheritance Error Inheritance Object

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

Error resulting from a FormBridge API call.


Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  errorCode : String
[read-only] Fetched error code associated with this error
FormBridgeError
 InheritederrorID : int
[read-only] Contains the reference number associated with the specific error message.
Error
 Inheritedmessage : String
Contains the message associated with the Error object.
Error
 Inheritedname : String
Contains the name of the Error object.
Error
Public Methods
 MethodDefined By
  
FormBridgeError(errorCode:String, message:String = null, id:int = 0)
Constructor
FormBridgeError
  
getErrorMessage(errorCode:String):String
[static] Get the error message associated with the specified error code.
FormBridgeError
 Inherited
getStackTrace():String
Returns the call stack for an error at the time of the error's construction as a string.
Error
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
  
toString(... rest):String
Gets a string representation of this error.
FormBridgeError
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  BAD_PARAMETER : String = "badParm"
[static] Error code for bad parameter.
FormBridgeError
  INVALID_RESPONSE : String = "invalidResponse"
[static] Error code for an invalid response from the API call to the PDF.
FormBridgeError
  UNEXPECTED_MESSAGE : String = "unexpectedMsg"
[static] Error code for unexpected message.
FormBridgeError
  UNSUPPORTED_MESSAGE : String = "unsupportedMsg"
[static] Error code for unsupported message.
FormBridgeError
Property Detail

errorCode

property
errorCode:String  [read-only]

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

Fetched error code associated with this error



Implementation
    public function get errorCode():String
Constructor Detail

FormBridgeError

()Constructor
public function FormBridgeError(errorCode:String, message:String = null, id:int = 0)

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

Constructor

Parameters
errorCode:String — FormBridge error code.
 
message:String (default = null) — Message associated with the error. If null, the message associated with the specified error code will be used as the error's message.
 
id:int (default = 0) — Reference number associated with the error message.
Method Detail

getErrorMessage

()method
public static function getErrorMessage(errorCode:String):String

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

Get the error message associated with the specified error code.

Parameters

errorCode:String — The error code for which to retrieve the message.

Returns
String — The message associated with the specified error code.

toString

()method 
public function toString(... rest):String

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

Gets a string representation of this error.

Parameters

... rest — Ignored.

Returns
String — String representation of this error.

Learn more

See note on overriding Error.toString() and using the rest parameter.
Constant Detail

BAD_PARAMETER

Constant
public static const BAD_PARAMETER:String = "badParm"

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

Error code for bad parameter.

INVALID_RESPONSE

Constant 
public static const INVALID_RESPONSE:String = "invalidResponse"

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

Error code for an invalid response from the API call to the PDF.

UNEXPECTED_MESSAGE

Constant 
public static const UNEXPECTED_MESSAGE:String = "unexpectedMsg"

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

Error code for unexpected message.

UNSUPPORTED_MESSAGE

Constant 
public static const UNSUPPORTED_MESSAGE:String = "unsupportedMsg"

Language Version: ActionScript 3.0
Product Version: Asset Composer Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

Error code for unsupported message.




© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy