@signageos/front-applet 6.5.4 → 6.5.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +8 -0
- package/docs/content/js-browser.md +26 -28
- package/docs/content/js-command.md +4 -0
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -4,6 +4,14 @@ All notable changes to this project will be documented in this file.
|
|
|
4
4
|
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
|
|
5
5
|
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
|
|
6
6
|
|
|
7
|
+
## [6.5.6] - 2024-07-29
|
|
8
|
+
### Fixed
|
|
9
|
+
- Documentation patch: Fill in and correct Browser API description
|
|
10
|
+
|
|
11
|
+
## [6.5.5] - 2024-05-24
|
|
12
|
+
### Fixed
|
|
13
|
+
- Documentation patch: Addind Applet Dispatch Throttling information
|
|
14
|
+
|
|
7
15
|
## [6.5.4] - 2024-05-15
|
|
8
16
|
### Fixed
|
|
9
17
|
- Better description of the serial port options on BrightSign
|
|
@@ -44,37 +44,35 @@ sos.browser.open('https://www.signageos.io'); // Open link in the browser
|
|
|
44
44
|
```
|
|
45
45
|
<br/>
|
|
46
46
|
|
|
47
|
-
Method `open()` also supports properties for browser
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
|
52
|
-
| `
|
|
53
|
-
| `
|
|
54
|
-
| `
|
|
55
|
-
| `
|
|
56
|
-
| `
|
|
57
|
-
| `
|
|
58
|
-
| `
|
|
59
|
-
| `
|
|
60
|
-
| `
|
|
61
|
-
| `method` | String | Can only be **native** (which opens a new, fully sandboxed fullscreen window) or **iframe** (which opens a configurable-sized window). (only Linux) |
|
|
62
|
-
:::
|
|
63
|
-
|
|
47
|
+
Method `open()` also supports properties for browser, all of which are optional.
|
|
48
|
+
|
|
49
|
+
| Property | Type | Description |
|
|
50
|
+
|----------------------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
51
|
+
| `aclDomains` | Array | List of domains to be interpreted according to `aclMode`. Example: `signageos.io`, `www.example.com` |
|
|
52
|
+
| `aclMode` | String | <ul><li>`blacklist` – Allow access to all domains _except_ those in `aclDomains` and their subdomains.</li><li>`whitelist` – Allow access _only_ to domains in `aclDomains` and their subdomains.</li></ul>
|
|
53
|
+
| `readOnlyAddressBar` | Boolean | <ul><li>`true` – The address bar is read-only.</li><li>`false` – The user can navigate away by entering a URL in the address bar.</li></ul> |
|
|
54
|
+
| `coordinates` | Object | Size and position of the browser window. Defaults to fullscreen. (Android, Linux)
|
|
55
|
+
| `idleTimeout` | Number | The browser will automatically close after a specified period of inactivity (in milliseconds). |
|
|
56
|
+
| `theme` | Object | Specify custom UI theme. (Android) |
|
|
57
|
+
| `headlessMode` | Boolean | Headless mode hides the entire address bar (default) |
|
|
58
|
+
| `canUserClose` | Boolean | Whether the user can manually close the browser. Default:<br/>**Headless:** `false`<br/>**With UI:** `true` |
|
|
59
|
+
| `clearData` | Boolean | Clear cache after the browser closes. Default:<br/>**Headless:** `false`<br/>**With UI:** `true` |
|
|
60
|
+
| `method` | String | Can only be **native** (which opens a new, fully sandboxed fullscreen window) or **iframe** (which opens a configurable-sized window). (only Linux) |
|
|
64
61
|
|
|
65
62
|
```javascript
|
|
66
63
|
sos.browser.open('https://www.signageos.io', {
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
64
|
+
aclDomains: ['google.com', 'yahoo.com'],
|
|
65
|
+
aclMode: 'blacklist', // or 'whitelist'
|
|
66
|
+
readOnlyAddressBar: true,
|
|
67
|
+
coordinates: { // Supported only on Linux and Android
|
|
68
|
+
x: 0,
|
|
69
|
+
y: 0,
|
|
70
|
+
height: 500,
|
|
71
|
+
width: 500,
|
|
72
|
+
},
|
|
73
|
+
// theme: { ... } // supported only on Android
|
|
74
|
+
headlessMode: false, // supported only on Android
|
|
75
|
+
});
|
|
78
76
|
```
|
|
79
77
|
|
|
80
78
|
:::note[GitHub Example]
|
|
@@ -28,6 +28,10 @@ All commands will be available in [Applet Command REST API](https://developers.s
|
|
|
28
28
|
|
|
29
29
|
Dispatch() is used for sending your custom logs or data from device to signageOS.
|
|
30
30
|
|
|
31
|
+
:::warning[Throttling in place]
|
|
32
|
+
The maximum allowed frequency for dispatching commands is 30 commands per 30 seconds. Any commands sent that exceed this frequency will be discarded.
|
|
33
|
+
:::
|
|
34
|
+
|
|
31
35
|
### Parameters
|
|
32
36
|
|
|
33
37
|
| Parameter | Type | Required | Description |
|