JavaScript Client SDK
Class Index | File Index

Classes


Class ServerException


Extends Exception.
The ServerException class represents an exception related to an HTTP request to a server. The ServerException class extends the Exception class.
Defined in: Exception.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ServerException(httpStatus, message, code, info)
An ServerException object contains information about an HTTP exception.
Field Summary
Field Attributes Field Name and Description
 
The error code indicating what caused the exception.
 
The HTTP status code of the server response.
 
JSON object containing information about the exception.
 
Description of what caused the exception.
Method Summary
Method Attributes Method Name and Description
 
Returns true if the device is offline, meaning it does not have an internet connection.
 
Returns a String representation of the exception.
Class Detail
ServerException(httpStatus, message, code, info)
An ServerException object contains information about an HTTP exception. An ServerException object is returned when a server request fails.
Parameters:
{Number} httpStatus
The HTTP status code of the server response.
{String} message Optional
Description of what caused the exception.
{Number} code Optional
The error code indicating what caused the exception.
{Object} info Optional
JSON object containing information about the exception.
Since:
1.0
Field Detail
{Number} code
The error code indicating what caused the exception.
{Number} httpStatus
The HTTP status code of the server response.
{Object} info
JSON object containing information about the exception.
{String} message
Description of what caused the exception.
Method Detail
isOffline()
Returns true if the device is offline, meaning it does not have an internet connection.
Since:
1.0
toString()
Returns a String representation of the exception. The String has the form:

"[exceptionName] exceptionMessage"

where exceptionName is the type of the exception object, such as Exception or ServerException.

Since:
1.0

©2013 Verivo Software, Inc. Documentation generated by JsDoc Toolkit 2.4.0 on Mon Apr 27 2015 15:06:21 GMT-0400 (EDT)