Zimlet JavaScript API Reference - ZmCsfeException

Class ZmCsfeException


Extends AjxException.

This class represents an exception returned by the server as a response, generally as a fault. The fault data is converted to properties of the exception.

Defined in: ZmCsfeException.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ZmCsfeException(params)
Creates an exception.
Fields borrowed from class AjxException:
code, detail, method, msg
Method Summary
Method Attributes Method Name and Description
 
getData(key)
Gets the data.
 
Gets the error message.
<static>  
ZmCsfeException.getErrorMsg(code, args)
Gets the error messages.
 
Returns a string representation of the object.
Methods borrowed from class AjxException:
dump
Class Detail
ZmCsfeException(params)
Creates an exception.
Parameters:
{Hash} params
a hash of parameters
{String} params.msg
the explanation (Fault.Reason.Text)
{String} params.code
the error code (Fault.Detail.Error.Code)
{String} params.method
the request name
{String} params.detail
the Fault.Code.Value
{Object} params.data Optional
an optional structured fault data (Fault.Detail.Error.a)
{String} params.trace
the trace info (Fault.Detail.Error.Trace)
{String} params.request
the SOAP or JSON that represents the request
Method Detail
{Object} getData(key)
Gets the data.
Parameters:
{Object} key
the key
Returns:
{Object} the data

{String} getErrorMsg(args)
Gets the error message.
Parameters:
{Array} args
the message format args
Returns:
{String} the message

<static> {String} ZmCsfeException.getErrorMsg(code, args)
Gets the error messages.
Parameters:
{String} code
the code
{Array} args
the message format args
Returns:
{String} the message

{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:30 GMT-0400 (EDT)