API.php
Table of Contents
Functions
- bb_get_declared_apis() : array<string|int, mixed>
- Gets all loaded API Declarations
- bb_get_apimessage() : null|APIMessage
- Gets an API Message with Localized Messages
- bb_format_apimessage() : null|APIMessage
- Gets an API Message with Localized Messages and Formats it
Functions
bb_get_declared_apis()
Gets all loaded API Declarations
bb_get_declared_apis() : array<string|int, mixed>
Return values
array<string|int, mixed>bb_get_apimessage()
Gets an API Message with Localized Messages
bb_get_apimessage(mixed $messagePath[, string $titlePath = "default" ][, bool $error = false ][, bool $vibrate = false ][, bool $forceLoginValidation = false ]) : null|APIMessage
Parameters
- $messagePath : mixed
-
Path to the Message
- $titlePath : string = "default"
-
Path tot the Title (Default: default) - if null no title
- $error : bool = false
-
Is the Message an error
- $vibrate : bool = false
-
If true, device gives haptic feedback
- $forceLoginValidation : bool = false
-
If true, device forced reauthorization by user
Return values
null|APIMessagebb_format_apimessage()
Gets an API Message with Localized Messages and Formats it
bb_format_apimessage(null|array<string|int, mixed> $formats, mixed $messagePath[, string $titlePath = "default" ][, bool $error = false ][, bool $vibrate = false ][, bool $forceLoginValidation = false ]) : null|APIMessage
Parameters
- $formats : null|array<string|int, mixed>
-
String Formats
- $messagePath : mixed
-
Path to the Message
- $titlePath : string = "default"
-
Path tot the Title (Default: default) - if null no title
- $error : bool = false
-
Is the Message an error
- $vibrate : bool = false
-
If true, device gives haptic feedback
- $forceLoginValidation : bool = false
-
If true, device forced reauthorization by user