Skip to content

Commit c193877

Browse files
committed
added appinfo doc
1 parent b9653ec commit c193877

File tree

2 files changed

+142
-0
lines changed

2 files changed

+142
-0
lines changed

src/views/develop/guides/_sidebar.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
* [Networking](/develop/guides/native/net)
1313
* Startup Script
1414
* System Mods
15+
* [appinfo.json](/develop/guides/appinfo)
1516
* :bi-bug:Debugging
1617
* Inspecting Web App
1718
* GDB
Lines changed: 141 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
1+
# appinfo.json
2+
3+
## Official documentation
4+
5+
* [webOS
6+
TV](https://webostv.developer.lge.com/develop/references/appinfo-json) ([archive.org](https://web.archive.org/web/20230608040557/https://webostv.developer.lge.com/develop/references/appinfo-json))
7+
* [webOS OSE](https://www.webosose.org/docs/guides/development/configuration-files/appinfo-json/) ([archive.org](https://web.archive.org/web/20230510171556/https://www.webosose.org/docs/guides/development/configuration-files/appinfo-json/))
8+
9+
## Caching
10+
11+
SAM may cache the contents of `appinfo.json` at boot, and it is not possible to modify built-in apps before this occurs.
12+
Therefore, if you want to modify `appinfo.json` for built-in apps, you will likely have to restart `sam` for changes to
13+
take effect.
14+
15+
## Undocumented options
16+
17+
## `dialAppName` [string]
18+
19+
Default: none
20+
21+
Settings this option will expose an application available for launched
22+
via [DIAL Protocol](https://en.wikipedia.org/wiki/Discovery_and_Launch) (see:
23+
`/usr/palm/services/com.webos.service.dial`)
24+
25+
YouTube and Netflix apps have some special handling, but they still can be
26+
overriden by an unofficial app.
27+
28+
Official YouTube app has `"dialAppName": "youtube"`. Installed apps are ordered
29+
lexicographically based on their IDs - when multiple apps declare the same
30+
`dialAppName` the last one will be the one triggered via DIAL.
31+
32+
### `noSplashOnLaunch` [boolean]
33+
34+
Default: `false`
35+
36+
Disables app splashscreen.
37+
38+
### `spinnerOnLaunch` [boolean]
39+
40+
Default: `true`
41+
42+
Shows a spinner if splashscreen is disabled. Set this to `false` to disable any
43+
app launch indication.
44+
45+
### `defaultWindowType` [string]
46+
47+
Default: `card`; supported: `favoriteshows`, `favorateshows`, `floating`,
48+
`minimal`, `popup`, `screenSaver`, `showcase`
49+
50+
When set to `overlay` an (web) app will be rendered above existing application.
51+
Make sure its `background-color` is set to `transparent`.
52+
53+
An `overlay` app is automatically closed when opening home screen.
54+
55+
### `tileSize` [string]
56+
57+
Default: `normal`
58+
59+
When set to `large` tile on home screen will be twice the width.
60+
61+
### `visible` [boolean]
62+
63+
Default: `true`
64+
65+
Settings this to `false` will hide an application from home screen. Application
66+
is still launchable via `com.webos.applicationmanager` calls and its services
67+
are callablae.
68+
69+
### `supportGIP` [boolean]
70+
71+
Default: `false`
72+
73+
Allows application to be registered using as an [input
74+
application]({filename}/pages/luna/eim.md).
75+
76+
### `trustLevel` [string]
77+
78+
Default: `default`
79+
80+
This option determines application runtime mode. By default for user-installed
81+
applications only `default` (default) and `netcast` values are supported.
82+
83+
WebApps running as `netcast` have some of their APIs limited:
84+
85+
* `window.PalmServiceBridge` is missing
86+
* `window.PalmSystem.launchParams` equivalent is exposed on
87+
`window.launchParams` instead
88+
89+
### `inspectable` [boolean]
90+
91+
Default: `true` for Developer Mode apps; `false` otherwise
92+
93+
Allows this app to be debugged using Chrome DevTools (`chrome://inspect`). Connect on port 9998 for non-system apps.
94+
95+
### `useCORSWhitelist` [string]
96+
97+
Specifies the name of a JSON file containing a
98+
[CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing)
99+
whitelist configuration. A matching signature file (with the same filename
100+
followed by `.sig`) is required. The signature is Base64-encoded, with the
101+
underlying binary data being 256 bytes long. The signature algorithm is
102+
currently unknown.
103+
104+
### `cloudgame_active` [boolean]
105+
106+
Default: `false`
107+
108+
This option allows application to handle game controller input. Since webOS 8.3.0 (FW 03.30.60), game controller input
109+
becomes recognized as navigation and volume control. For applications that handle game controller input, this causes
110+
double input. Setting this option to `true` will disable this behavior.
111+
112+
### `useAllMouseButtons` [boolean]
113+
114+
Default: `false`
115+
116+
This option allows application to receive all mouse button events. Since webOS 25 (10.x), right mouse button click will
117+
bring up a pop-up menu with BACK and HOME actions. Setting this option to `true` will disable this behavior.
118+
119+
### `vendorExtensions` [object]
120+
121+
#### `vendorExtensions.userAgent` [string]
122+
123+
**Supported only in `netcast` mode**
124+
125+
This replaces `User-Agent` WebAppMgr browser uses. Certain dynamic replacements
126+
are suported:
127+
128+
* `$browserName$` - `LG Browser`
129+
* `$browserVersion$` - `8.00.00`
130+
* `$platformName$` - `webOS.TV`
131+
* `$platformVersion$` - `2016`, `2017`, ...
132+
* `$chipSetName$` - `K3LP`, `M16`, `O20N`, ...
133+
* `$firmwareVersion$` - `03.00.20`, ...
134+
* `$modelName$` - `OLED48C14LB`, ...
135+
* `$networkMode$` - `wireless`/`wired`
136+
137+
#### `vendorExtensions.allowCrossDomain` [boolean]
138+
139+
**Supported only in `netcast` mode**; default: `false`
140+
141+
Disables HTTP CORS request validation.

0 commit comments

Comments
 (0)