Description

Examples: C:/xampp/htdocs/InfohubJsApi/src/adapter/IModelViewer.js, C:/xampp/htdocs/InfohubJsApi/src/tools/ApiResponse.js, and C:/xampp/htdocs/InfohubJsApi/src/tools/RestServices.js.

Inheritance diagram for ApiResponse:

Public Member Functions
	asJson ()
	constructor (status, responsedata, message=null)
get	data ()
	dump (prefix='')
	fromJson (jobj)
	getData ()
	getMessage ()
	getStatus ()
get	message ()
get	status ()

Function Documentation

◆ asJson()

asJson ( )

Examples: C:/xampp/htdocs/InfohubJsApi/src/tools/ApiResponse.js.

◆ constructor()

constructor	(	status,
		responsedata,
		message = null )

Parameters

{*}	status
{*}	responsedata
{string\|null}	message

Examples: C:/xampp/htdocs/InfohubJsApi/src/tools/ApiResponse.js.

◆ data()

get data ( )

Return status a property.

Examples: C:/xampp/htdocs/InfohubJsApi/src/tools/ApiResponse.js.

◆ dump()

dump ( prefix = '' )

Dump to console.log.

Parameters

{*} prefix

Examples: C:/xampp/htdocs/InfohubJsApi/src/tools/ApiResponse.js.

◆ fromJson()

fromJson ( jobj )

Examples: C:/xampp/htdocs/InfohubJsApi/src/tools/ApiResponse.js.

◆ getData()

getData ( )

Returns: {object} Response as JSON object

Examples: C:/xampp/htdocs/InfohubJsApi/src/tools/ApiResponse.js.

◆ getMessage()

getMessage ( )

Returns: {string|null} uman readable status

Examples: C:/xampp/htdocs/InfohubJsApi/src/tools/ApiResponse.js.

◆ getStatus()

getStatus ( )

Returns: {number} Status Code

Examples: C:/xampp/htdocs/InfohubJsApi/src/tools/ApiResponse.js.

◆ message()

get message ( )

Return 'message' as property.

See also: getMessage()

Examples: C:/xampp/htdocs/InfohubJsApi/src/tools/ApiResponse.js, and C:/xampp/htdocs/InfohubJsApi/src/tools/RestServices.js.

◆ status()

get status ( )

Examples: C:/xampp/htdocs/InfohubJsApi/src/tools/ApiResponse.js, and C:/xampp/htdocs/InfohubJsApi/src/tools/RestServices.js.