\Clx\Xms\ApiError

Describes error responses given by XMS.

Summary

Methods
Properties
Constants
getCode()
setCode()
getText()
setText()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

getCode()

getCode() : string

Get the error code that can be used to programmatically recognize the error.

Returns

string —

error code

setCode()

setCode(string  $code) : void

Set the error code that can be used to programmatically recognize the error.

Parameters

string $code

error code

getText()

getText() : string

Get a human readable description of the error.

Returns

string —

error description

setText()

setText(string  $text) : void

Set the human readable description of the error.

Parameters

string $text

error description