Zimlet JavaScript API Reference - AjxException

Class AjxException


This is the base class for all exceptions in the Zimbra Ajax Toolkit.

Defined in: AjxException.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
AjxException(msg, code, method, detail)
Creates an exception.
Field Summary
Field Attributes Field Name and Description
<static>  
AjxException.CANCELED
Operation canceled exception code.
 
Error or fault code, if applicable.
 
Any additional detail.
<static>  
AjxException.INTERNAL_ERROR
Internal error exception code.
<static>  
AjxException.INVALID_OP
Invalid operation exception code.
<static>  
AjxException.INVALID_PARAM
Invalid parameter to method/operation exception code.
<static>  
AjxException.INVALIDPARENT
Invalid parent exception code.
 
Name of the method throwing the exception, if applicable.
 
msg
Human readable message, if applicable.
<static>  
AjxException.NETWORK_ERROR
Network error exception code.
<static>  
AjxException.OUT_OF_RPC_CACHE
Out or RPC cache exception code.
<static>  
AjxException.UNIMPLEMENTED_METHOD
Unimplemented method called exception code.
<static>  
AjxException.UNKNOWN_ERROR
Unknown error exception code.
<static>  
AjxException.UNSUPPORTED
Unsupported operation code.
Method Summary
Method Attributes Method Name and Description
 
dump()
Dumps the exception.
 
Returns a string representation of the object.
Class Detail
AjxException(msg, code, method, detail)
Creates an exception.
Author: Ross Dargahi.
Parameters:
{string} msg Optional
the human readable message
{constant} code Optional
any error or fault code
{string} method Optional
the name of the method throwing the exception
{string} detail Optional
any additional detail
Field Detail
<static> AjxException.CANCELED
Operation canceled exception code.

code
Error or fault code, if applicable.

detail
Any additional detail.

<static> AjxException.INTERNAL_ERROR
Internal error exception code.

<static> AjxException.INVALID_OP
Invalid operation exception code.

<static> AjxException.INVALID_PARAM
Invalid parameter to method/operation exception code.

<static> AjxException.INVALIDPARENT
Invalid parent exception code.

method
Name of the method throwing the exception, if applicable.

msg
Human readable message, if applicable.

<static> AjxException.NETWORK_ERROR
Network error exception code.

<static> AjxException.OUT_OF_RPC_CACHE
Out or RPC cache exception code.

<static> AjxException.UNIMPLEMENTED_METHOD
Unimplemented method called exception code.

<static> AjxException.UNKNOWN_ERROR
Unknown error exception code.

<static> AjxException.UNSUPPORTED
Unsupported operation code.
Method Detail
{string} dump()
Dumps the exception.
Returns:
{string} the state of the exception

{string} toString()
Returns a string representation of the object.
Returns:
{string} a string representation of the object

Documentation generated by JsDoc Toolkit 2.3.0 on Tue Jun 28 2016 21:01:25 GMT-0400 (EDT)