APIMessage
in package
Defines a Message contains Feedback-Behavior
Table of Contents
Properties
Methods
- __construct() : void
- Creates a new Instance of a Message
- AddAlert() : void
- Adds this Message to the Alert-Queue
- ToResponse() : APIResponse
- Creates an APIResponse Object with this Message
Properties
$error
public
mixed
$error
$message
public
mixed
$message
$relogon
public
mixed
$relogon
$title
public
mixed
$title
$vibrate
public
mixed
$vibrate
Methods
__construct()
Creates a new Instance of a Message
public
__construct(mixed $title, mixed $message[, bool $vibrate = false ][, bool $error = false ][, bool $shouldRelogon = false ]) : void
Parameters
- $title : mixed
-
Feedback-Title
- $message : mixed
-
Feedback-Message
- $vibrate : bool = false
-
If true the Device vibrates
- $error : bool = false
-
If true the Device gives haptic feedback about an error
- $shouldRelogon : bool = false
-
If true the User will get logged out and forced to sign in again
AddAlert()
Adds this Message to the Alert-Queue
public
AddAlert() : void
ToResponse()
Creates an APIResponse Object with this Message
public
ToResponse([mixed $code = null ][, mixed $data = null ]) : APIResponse
Parameters
- $code : mixed = null
- $data : mixed = null