From f0e0915e51a60c913bafc01f52af696c80b7383c Mon Sep 17 00:00:00 2001 From: Heeam-Shin Date: Tue, 5 Nov 2024 16:11:55 +0900 Subject: [PATCH] webOS OSE v2.27.0 Release: [[Content]] - Update lv. 30 & 31 APIs - Update build guide for built image extension change - Update release notes and blog news for release --- content/en/_index.html | 2 +- .../webos-ose-2-27-0-release-notes.md | 103 ++ .../2024-11-05-webos-ose-2-27-0-release.md | 35 + .../docs/guides/setup/building-webos-ose.md | 6 +- .../ls2-api/com-palm-service-tellurium.html | 4 +- .../ls2-api/com-webos-appinstallservice.html | 12 +- .../ls2-api/com-webos-bootmanager.html | 4 +- .../reference/ls2-api/com-webos-media.html | 38 +- .../ls2-api/com-webos-notification.html | 46 +- .../com-webos-service-activitymanager.html | 21 +- .../ls2-api/com-webos-service-alarm.html | 4 +- .../com-webos-service-applicationmanager.html | 16 +- .../ls2-api/com-webos-service-audio.html | 20 +- .../com-webos-service-audiooutput.html | 47 +- .../ls2-api/com-webos-service-bluetooth2.html | 555 +++++----- .../ls2-api/com-webos-service-bugreport.html | 4 +- .../ls2-api/com-webos-service-bus.html | 295 ++++-- .../ls2-api/com-webos-service-config.html | 4 +- .../com-webos-service-configurator.html | 4 +- .../com-webos-service-connectionmanager.html | 250 ++--- .../ls2-api/com-webos-service-db.html | 20 +- .../ls2-api/com-webos-service-devmode.html | 67 +- .../com-webos-service-downloadmanager.html | 301 +++--- .../ls2-api/com-webos-service-location.html | 590 ++++++++++- .../com-webos-service-mediacontroller.html | 926 +++++++++++++++-- .../ls2-api/com-webos-service-pdm.html | 4 +- .../com-webos-service-preferences.html | 4 +- .../ls2-api/com-webos-service-sdkagent.html | 352 ++++--- .../ls2-api/com-webos-service-settings.html | 4 +- .../ls2-api/com-webos-service-sleep.html | 327 +++--- .../com-webos-service-systemservice.html | 65 +- .../com-webos-service-videooutput.html | 4 +- .../ls2-api/com-webos-service-wifi.html | 947 +++++------------- .../ls2-api/com-webos-surfacemanager.html | 4 +- .../docs/reference/ls2-api/ls2-api-index.html | 12 +- .../luna-service2-library-api-reference.html | 361 +++---- .../docs/tools/sdk/cli/cli-release-notes.md | 7 +- .../emulator-user-guide.md | 6 +- .../en/docs/tools/sdk/vs-code-extension.md | 4 +- 39 files changed, 3247 insertions(+), 2228 deletions(-) create mode 100644 content/en/about/release-notes/webos-ose-2-27-0-release-notes.md create mode 100644 content/en/blog/posts/2024-11-05-webos-ose-2-27-0-release.md diff --git a/content/en/_index.html b/content/en/_index.html index 477b098b..4588a536 100644 --- a/content/en/_index.html +++ b/content/en/_index.html @@ -5,7 +5,7 @@
News
- webOS Studio v2.1.0 and CLI v3.1.0 has been released! + }}">webOS OSE 2.27.0 has been released!
diff --git a/content/en/about/release-notes/webos-ose-2-27-0-release-notes.md b/content/en/about/release-notes/webos-ose-2-27-0-release-notes.md new file mode 100644 index 00000000..2b89f8be --- /dev/null +++ b/content/en/about/release-notes/webos-ose-2-27-0-release-notes.md @@ -0,0 +1,103 @@ +--- +title: webOS OSE 2.27.0 +display_title: webOS OSE 2.27.0 Release Notes +date: 2024-11-05 +weight: 46 +toc: true +layout: release-notes +--- + +This version corresponds to the [GitHub releases](https://github.com/webosose/build-webos/releases) from build #738 to build #799. + +## New and Changed Features + +### Core Applications + +#### System + +- Settings + - Introduce `custom.js` for customizing color theme of the Settings app. +- Enact browser + - Stabilize the code and fix minor bugs. + +#### Sample Apps + +- Fixed a bug where the video call app launched WebEx URLs on another display. + +### Application Framework + +#### Web + +- Enact + - Upgrade Enact CLI to v6.1.2. + - Upgrade jsdoc-to-ts to v1.0.6. + - Upgrade Sandstone v2.9.1. + +### Managers & Services + +#### App + +- WAM + - Apply C++20. + +#### Display + +- LSM + - Fix the frame drop issue. + +#### Media + +- mediacontroller + - Add a new method: `setSupportedAction` + +#### Connectivity + +- nettools + - Refactor build process. + +#### Misc. + +- Sys Service + - Remove Qt dependency from luna-sysservice. +- Peripheral Service + - Remove the virtual UART Device. + +#### External Device + +- Fix crash issues in the storage access service. + +### Base Components + +#### Display + +- Qt + - Upgrade Qt from v6.7.2. + +#### JS Service + +- Node.js + - Upgrade Node.js to v20.12.2. + +#### Web Engine + +- Replace the App Shell-based Enact browser with a Browser Shell-based browser. + +#### performance + +- Introduce polkit. + +### BSP + +#### Media + +- Change PCM operation to non-atomic to prevent scheduling bug. + +### Build System & SCM + +- Fix a bug where a fetch process was failed (from https://freedesktop.org). +- Apply a memory leak patch for OpenSSL. +- Change the file extension of emulator images: `.wic.vmdk` > `.wic.vmdk.gz` + +## Known Issues + +N/A diff --git a/content/en/blog/posts/2024-11-05-webos-ose-2-27-0-release.md b/content/en/blog/posts/2024-11-05-webos-ose-2-27-0-release.md new file mode 100644 index 00000000..c75af487 --- /dev/null +++ b/content/en/blog/posts/2024-11-05-webos-ose-2-27-0-release.md @@ -0,0 +1,35 @@ +--- +title: webOS OSE 2.27.0 Release +date: 2024-11-05 +slug: webos-ose-2-27-0-release +posttype: release +toc: true +--- + +We're pleased to announce the release of webOS Open Source Edition (OSE) 2.27.0. + +The highlights of this release are as follows: + +- [Migrating to a Browser Shell-Based Browser](#migrating-to-a-browser-shell-based-browser) +- [Enhancing PWA Usability](#enhancing-pwa-usability) +- [Changing the File Extension of Build Images](#changing-the-file-extension-of-build-images) + +For more details on this release, see the [release notes](/about/release-notes/webos-ose-2-27-0-release-notes). + +## Migrating to a Browser Shell-Based Browser + +With the support for Chromium version 120 in OSE, we have transitioned from an app shell-based browser to a browser shell-based browser. This change enhances the overall functionality and flexibility of the browser. + +## Enhancing PWA Usability + +In the previous release, Progressive Web Application (PWA) was introduced to OSE, allowing users to install their favorite websites in the form of an app. In this release, we have added several useful features to PWA, making it more convenient for users: + +- Implemented back and forward navigation +- Improved user-friendly scrolling +- Implemented push notification feature + +## Changing the File Extension of Build Images + +The file extension for emulator images are changed: `.wic.vmdk` -> `wic.vmdk.gz`. + +This change make the build process more efficient. \ No newline at end of file diff --git a/content/en/docs/guides/setup/building-webos-ose.md b/content/en/docs/guides/setup/building-webos-ose.md index 538637bf..b9b6e016 100644 --- a/content/en/docs/guides/setup/building-webos-ose.md +++ b/content/en/docs/guides/setup/building-webos-ose.md @@ -1,7 +1,7 @@ --- title: Building webOS OSE display_title: Building webOS Open Source Edition -date: 2023-04-27 +date: 2024-10-14 weight: 20 toc: true --- @@ -153,8 +153,8 @@ To check if the image has been built successfully, check the following directori * 32-bit: `BUILD/deploy/images/raspberrypi3/webos-image-raspberrypi3.rootfs.rpi-sdimg`. * 64-bit: `BUILD/deploy/images/raspberrypi3-64/webos-image-raspberrypi3-64.rootfs.rpi-sdimg`. * For the emulator, the resulting image will be created at - * 32-bit: `BUILD/deploy/images/qemux86/webos-image-qemux86-master-*-wic.vmdk`. - * 64-bit: `BUILD/deploy/images/qemux86-64/webos-image-qemux86-64-master-*-wic.vmdk`. + * 32-bit: `BUILD/deploy/images/qemux86/webos-image-qemux86-master-*-wic.vmdk.gz`. + * 64-bit: `BUILD/deploy/images/qemux86-64/webos-image-qemux86-64-master-*-wic.vmdk.gz`. If the built image exists, move on to the [Next Steps]({{< relref "#next-steps" >}}). diff --git a/content/en/docs/reference/ls2-api/com-palm-service-tellurium.html b/content/en/docs/reference/ls2-api/com-palm-service-tellurium.html index 7ecdb670..482a8cb8 100644 --- a/content/en/docs/reference/ls2-api/com-palm-service-tellurium.html +++ b/content/en/docs/reference/ls2-api/com-palm-service-tellurium.html @@ -1,7 +1,7 @@ --- title: com.palm.service.tellurium -date: 2024-05-27 -api_level: 29 +date: 2024-10-30 +api_level: 30 weight: 7 toc: true --- diff --git a/content/en/docs/reference/ls2-api/com-webos-appinstallservice.html b/content/en/docs/reference/ls2-api/com-webos-appinstallservice.html index 1b1fe8fe..17c5813e 100644 --- a/content/en/docs/reference/ls2-api/com-webos-appinstallservice.html +++ b/content/en/docs/reference/ls2-api/com-webos-appinstallservice.html @@ -1,7 +1,7 @@ --- title: com.webos.appInstallService -date: 2024-05-27 -api_level: 29 +date: 2024-10-30 +api_level: 30 weight: 10 toc: true --- @@ -1203,14 +1203,6 @@

details

State of the requested progress.

- - update - Optional - Boolean - -

This indicates whether the operation is to update an app or not when installing an app.

- - client Optional diff --git a/content/en/docs/reference/ls2-api/com-webos-bootmanager.html b/content/en/docs/reference/ls2-api/com-webos-bootmanager.html index 977c4380..62aadfb3 100644 --- a/content/en/docs/reference/ls2-api/com-webos-bootmanager.html +++ b/content/en/docs/reference/ls2-api/com-webos-bootmanager.html @@ -1,7 +1,7 @@ --- title: com.webos.bootManager -date: 2024-05-27 -api_level: 29 +date: 2024-10-30 +api_level: 30 weight: 20 toc: true --- diff --git a/content/en/docs/reference/ls2-api/com-webos-media.html b/content/en/docs/reference/ls2-api/com-webos-media.html index a131fcf2..ac1a32c6 100644 --- a/content/en/docs/reference/ls2-api/com-webos-media.html +++ b/content/en/docs/reference/ls2-api/com-webos-media.html @@ -1,7 +1,7 @@ --- title: com.webos.media -date: 2024-05-27 -api_level: 29 +date: 2024-10-30 +api_level: 30 weight: 30 toc: true --- @@ -59,9 +59,10 @@

Parameters

resources Required - Object array: resources + String -

See "resources" object.

+

Resource information.

+

Note: Resources information must be provided as a stringified form of the "resources" object array.

@@ -1551,7 +1552,7 @@

Parameters

String

Indicates the pipeline status.

-

Possible values are: 

+

Possible values are:

- - errorCode - Optional - Number - -

The error code for the failed operation.

- - - - errorText - Optional - String - -

Indicates the reason for the failure of the operation.

- -
@@ -1667,7 +1652,7 @@

Example

pause

-
ACG: media
+
ACG: media.operation
  • Added: API level 11
    • @@ -2391,10 +2376,10 @@

    Parameters

    resources Required - Object array: resources + String

    Resource information.

    -

    Note: Resources information must be provided as a stringified form of one of the "resources" object.

    +

    Note: Resources information must be provided as a stringified form of the "resources" object array.

    @@ -3221,7 +3206,7 @@

    Call Returns

    mediaId - Required + Optional String

    Indicates the unique identifier of the camera pipeline.

    @@ -3854,7 +3839,8 @@

    Parameters

    Required String -

    A string representation of the "resources" object.

    +

    Resource information.

    +

    Note: Resources information must be provided as a stringified form of the "resources" object array.

    diff --git a/content/en/docs/reference/ls2-api/com-webos-notification.html b/content/en/docs/reference/ls2-api/com-webos-notification.html index 1042d122..421fc22d 100644 --- a/content/en/docs/reference/ls2-api/com-webos-notification.html +++ b/content/en/docs/reference/ls2-api/com-webos-notification.html @@ -1,7 +1,7 @@ --- title: com.webos.notification -date: 2024-05-27 -api_level: 29 +date: 2024-10-30 +api_level: 30 weight: 40 toc: true --- @@ -799,6 +799,10 @@

    Parameters

    String

    Defines the toast type.

    +

    Possible values are:

    +
      +
    • "standard", "light"  (Default): standard
      • +
    @@ -873,6 +877,14 @@

    Call Returns

    Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

    + + errorCode + Optional + Number + +

    The error code for the failed operation.

    + +
@@ -892,14 +904,7 @@

Error Codes Reference

- None - Unknown Source - -

Indicates that the system was unable to retrieve the app source id from the System Bus message.

- - - - None + 100 Message is not parsed

Indicates that the JSON message parsing error occured.

@@ -912,24 +917,24 @@

Error Codes Reference

- None - Invalid id specified + 103 + Unknown Source -

Indicates that the app is missing from the requested message.

+

Indicates that the system was unable to retrieve the app source id from the System Bus message.

- None - Invalid source id specified + 105 + Message can't be empty -

Indicates that the app Id given in the requested message does not match with the system bus caller Id.

+

Indicates that the message field in the requested message is empty.

- None - Message can't be empty + 111 + Invalid source id specified -

Indicates that the message field in the requested message is empty.

+

Indicates that the app Id given in the requested message does not match with the system bus caller Id.

@@ -1279,7 +1284,7 @@

Subscription Returns

timestamp - Required + Optional String

Indicates the timestamp string.

@@ -1318,6 +1323,7 @@

Subscription Returns

Optional Object: onFailAction +

This parameter is retired.

Indicates the action to be performed on failure to create an alert.

diff --git a/content/en/docs/reference/ls2-api/com-webos-service-activitymanager.html b/content/en/docs/reference/ls2-api/com-webos-service-activitymanager.html index ccfa9a6b..b96efc74 100644 --- a/content/en/docs/reference/ls2-api/com-webos-service-activitymanager.html +++ b/content/en/docs/reference/ls2-api/com-webos-service-activitymanager.html @@ -1,7 +1,7 @@ --- title: com.webos.service.activitymanager -date: 2024-05-27 -api_level: 29 +date: 2024-10-30 +api_level: 30 weight: 70 toc: true --- @@ -20,27 +20,27 @@

Overview of the API

An Activity can have the state shown in the diagram above. What the Activity does for each state is as follows.

-

# luna-send -n 1 luna://com.webos.service.audiooutput/audio/setSoundOut '{"soundOut":"alsa"}'

+

# luna-send -n 1 luna://com.webos.service.audiooutput/audio/setSoundOut '{"soundOut":"ALSA"}'

Response:

{
-    "soundOut":"alsa",
+    "soundOut":"ALSA",
   "returnValue":true
}

@@ -908,7 +908,7 @@

Example

      {
         "muted":false,
         "volume":10,
-          "soundOutput":"alsa"
+          "soundOutput":"ALSA"
      }
   ]
} @@ -950,7 +950,7 @@

Parameters

Indicates the audio output device. Possible values are:

@@ -1041,11 +1041,11 @@

Example

Example scenario

-

# luna-send -n 1 luna://com.webos.service.audiooutput/audio/volume/muteSoundOut '{"soundOutput":"alsa","mute":false}'

+

# luna-send -n 1 luna://com.webos.service.audiooutput/audio/volume/muteSoundOut '{"soundOutput":"ALSA","mute":false}'

Response:

{
   "returnValue":true,
-    "soundOutput":"alsa",
+    "soundOutput":"ALSA",
   "mute":true
}

@@ -1086,7 +1086,7 @@

Parameters

Indicates the audio output device. Possible values are:

@@ -1174,10 +1174,10 @@

Example

Example scenario

-

# luna-send -n 1 luna://com.webos.service.audiooutput/audio/volume/set '{"soundOutput":"alsa","volume":10}'

+

# luna-send -n 1 luna://com.webos.service.audiooutput/audio/volume/set '{"soundOutput":"ALSA","volume":10}'

Response:

{
-    "soundOutput":"alsa",
+    "soundOutput":"ALSA",
   "volume":10,
   "returnValue":true
} @@ -1298,10 +1298,10 @@

Example

Example scenario

-

# luna-send -n 1 luna://com.webos.service.audiooutput/audio/volume/up '{"soundOutput":"alsa"}'

+

# luna-send -n 1 luna://com.webos.service.audiooutput/audio/volume/up '{"soundOutput":"ALSA"}'

Response:

{
-    "soundOutput":"alsa",
+    "soundOutput":"ALSA",
   "volume":11,
   "returnValue":true
} @@ -1338,11 +1338,11 @@

audio

String

Indicates the audio source.

+

Note: Returns empty string if no source and sink are connected.

Possible values are:

-

Note: Returns empty string if no source and sink are connected.

@@ -1351,11 +1351,11 @@

audio

String

Indicates the audio sink.

+

Note: Returns empty string if no source and sink are connected.

Possible values are:

-

Note: Returns empty string if no source and sink are connected.

@@ -1363,10 +1363,11 @@

audio

Optional Boolean -

Indicates if the audio is muted. Possible values are:

+

Indicates if the audio is muted.

+

Possible values are:

@@ -1376,11 +1377,11 @@

audio

String

Indicates the audio output device.

+

Note: Returns "null" string if no output device is set.

Possible values are:

-

Note: Returns "null" string if no output device is set.

@@ -1437,7 +1438,7 @@

volumeStatus

Indicates the audio output device.

Possible values are:

diff --git a/content/en/docs/reference/ls2-api/com-webos-service-bluetooth2.html b/content/en/docs/reference/ls2-api/com-webos-service-bluetooth2.html index 2930f5ec..82731b9c 100644 --- a/content/en/docs/reference/ls2-api/com-webos-service-bluetooth2.html +++ b/content/en/docs/reference/ls2-api/com-webos-service-bluetooth2.html @@ -1,7 +1,7 @@ --- title: com.webos.service.bluetooth2 -date: 2024-05-27 -api_level: 29 +date: 2024-10-30 +api_level: 30 weight: 110 toc: true --- @@ -1462,12 +1462,12 @@

Parameters

Boolean

Indicates if subscribed to get notifications.

+

Note: Set to true, since caller must subscribe to this method.

Possible values are:

-

Note: Set subscribe to true. The caller must subscribe to this method.

@@ -1499,8 +1499,8 @@

Call Returns

Indicates the status of the operation.

Possible values are:

@@ -2767,7 +2767,7 @@

Subscription Returns

adapters Required - Object array: bluetooth2AdapterStatus + Object array: bluetooth2Adapter

Contains information of all the adapters currently available in the system.

Note:

@@ -2781,7 +2781,7 @@

Subscription Returns

errorCode Optional - String + Number

The error code for the failed operation.

@@ -2827,10 +2827,7 @@

Example

Example code

-

# luna-send -i -f luna://com.webos.service.bluetooth2/adapter/queryAvailable '{
-         "subscribe":true
- }' -

+

# luna-send -i -f luna://com.webos.service.bluetooth2/adapter/queryAvailable '{"subscribe":true}'

Response:

{  
   "subscribed":false,
@@ -2850,7 +2847,7 @@

Example

   "returnValue":true
}

-

Subscription return: 

+

Subscription response: 

{  
   "subscribed":false,
   "adapters":[  
@@ -4052,7 +4049,7 @@

Call Returns

adapterAddress - Required + Optional String

Indicates the address of the adapter.

@@ -4060,7 +4057,7 @@

Call Returns

subscribed - Required + Optional Boolean

Indicates if subscribed to get notifications.

@@ -4124,7 +4121,7 @@

Subscription Returns

subscribed - Required + Optional Boolean

Indicates if subscribed to get notifications.

@@ -4138,7 +4135,7 @@

Subscription Returns

address - Required + Optional String

Indicates the address (bdaddr) of the remote device.

@@ -4146,7 +4143,7 @@

Subscription Returns

adapterAddress - Required + Optional String

Indicates the address of the adapter.

@@ -4154,7 +4151,7 @@

Subscription Returns

requestId - Required + Optional String

Indicates the unique ID of a request.

@@ -4196,17 +4193,10 @@

Error Codes Reference

- 101, 103, 104, 143, 144 - See API Error Codes Reference - -

See the API Error Codes Reference section.

- - - - 161 - Adapter is turned off + 101, 103, 104, 143, 144, 161, 162 + Depends on error code -

The Bluetooth adapter is turned off.

+

For details of a specific error code, see the API Error Codes Reference section.

@@ -4334,7 +4324,7 @@

Call Returns

adapterAddress - Required + Optional String

Indicates the address of the adapter.

@@ -4342,7 +4332,7 @@

Call Returns

subscribed - Required + Optional Boolean

Indicates if subscribed to get notifications.

@@ -4406,7 +4396,7 @@

Subscription Returns

subscribed - Required + Optional Boolean

Indicates if subscribed to get notifications.

@@ -4420,7 +4410,7 @@

Subscription Returns

address - Required + Optional String

Indicates the address (bdaddr) of the remote device.

@@ -4428,7 +4418,7 @@

Subscription Returns

adapterAddress - Required + Optional String

Indicates the address of the adapter.

@@ -4436,7 +4426,7 @@

Subscription Returns

requestId - Required + Optional String

Indicates the unique ID of a request.

@@ -4478,17 +4468,10 @@

Error Codes Reference

- 101, 103, 104, 143, 144 - See API Error Codes Reference - -

See the API Error Codes Reference section.

- - - - 161 - Adapter is turned off + 101, 103, 104, 143, 144, 161, 162 + Depends on error code -

The Bluetooth adapter is turned off.

+

For details of an error code, see the API Error Codes Reference section.

@@ -6088,7 +6071,7 @@

Call Returns

adapterAddress - Required + Optional String

Indicates the address of the adapter.

@@ -6112,7 +6095,7 @@

Call Returns

subscribed - Required + Optional Boolean

Indicates if subscribed to get notifications.

@@ -6159,7 +6142,7 @@

Subscription Returns

subscribed - Required + Optional Boolean

Indicates if subscribed to get notifications.

@@ -6172,7 +6155,7 @@

Subscription Returns

disconnectByRemote - Required + Optional String

Indicates whether the remote device or the local user initiated the disconnection.

@@ -6185,7 +6168,7 @@

Subscription Returns

adapterAddress - Required + Optional String

Indicates the address of the adapter.

@@ -6226,38 +6209,10 @@

Error Codes Reference

- 102, 103, 105, 106, 127, 143, 144 - See API Error Codes Reference - -

See the API Error Codes Reference section.

- - - - 128 - Device is already connecting - -

The remote Bluetooth device is already connecting to AVRCP profile, so another connection cannot be opened.

- - - - 129 - Device is not paired + 102, 103, 105, 106, 127, 128, 129, 130, 131, 143, 144 + Depends on error code -

The remote Bluetooth device is not paired, so AVRCP connection cannot be opened.

- - - - 130 - Failed to connect with remote device - -

The remote Bluetooth device cannot be connected to AVRCP profile.

- - - - 131 - Already connected - -

The remote Bluetooth device is already connected to the adapter's AVRCP profile, so another connection cannot be opened.

+

For details of an error code, see the API Error Codes Reference section.

@@ -6375,7 +6330,7 @@

Call Returns

adapterAddress - Required + Optional String

Indicates the address of the adapter.

@@ -6416,17 +6371,10 @@

Error Codes Reference

- 102, 105, 106, 127, 143, 144 - See API Error Codes Reference + 102, 105, 106, 127, 132, 143, 144 + Depends on error code -

See the API Error Codes Reference section.

- - - - 132 - Failed to disconnect from remote device - -

The AVRCP connection with the remote Bluetooth device could not be closed.

+

For details of an error code, see the API Error Codes Reference section.

@@ -8046,9 +7994,22 @@

Call Returns

+ + subscribed + Optional + Boolean + +

Indicates if subscribed to get notifications.

+

Possible values are:

+ + + connecting - Required + Optional Boolean

Indicates whether the connection request is currently being processed.

@@ -8061,7 +8022,7 @@

Call Returns

connected - Required + Optional Boolean

Indicates if the connection is open.

@@ -8074,7 +8035,7 @@

Call Returns

adapterAddress - Required + Optional String

Indicates the address of the adapter.

@@ -8132,7 +8093,7 @@

Subscription Returns

subscribed - Required + Optional Boolean

Indicates if subscribed to get notifications.

@@ -8145,7 +8106,7 @@

Subscription Returns

connecting - Required + Optional Boolean

Indicates whether the connection request is currently being processed.

@@ -8158,7 +8119,7 @@

Subscription Returns

connected - Required + Optional Boolean

Indicates if the connection is open.

@@ -8171,7 +8132,7 @@

Subscription Returns

adapterAddress - Required + Optional String

Indicates the address of the adapter.

@@ -8212,17 +8173,10 @@

Error Codes Reference

- 102, 105, 106, 127, 143, 144 - See API Error Codes Reference + 102, 105, 106, 127, 133, 143, 144 + Depends on error code -

See the API Error Codes Reference section.

- - - - 133 - Failed to retrieve state for remote device - -

The AVRCP connection status of the remote Bluetooth device cannot be retrieved.

+

For details of an error code, see the API Error Codes Reference section.

@@ -10145,7 +10099,7 @@

Call Returns

adapterAddress - Required + Optional String

Indicates the address of the adapter.

@@ -10153,7 +10107,7 @@

Call Returns

requestId - Required + Optional String

Indicates the unique ID of a request.

@@ -10195,31 +10149,10 @@

Error Codes Reference

- 127, 143, 144 - See API Error Codes Reference + 127, 143, 144, 186, 187, 188 + Depends on error code -

See API Error Codes Reference.

- - - - 186 - Required 'requestId' parameter is not supplied - -

requestId parameter is missing in arguments.

- - - - 187 - Request is currently not allowed - -

The TG (Target) is not awaiting for media play status request.

- - - - 188 - The supplied requestId does not exist - -

The supplied requestId does not exist, hence the method cannot be completed.

+

For details of an error code, see API Error Codes Reference section.

@@ -10238,26 +10171,18 @@

Example

      "album":"disney frozen",
      "genre":"pop",
      "trackNumber":1,
+       "trackCount":3,
      "duration":225
   }
}'

-

 

-

Response for a successful call:

+

Response:

{  
   "requestId":"001",
   "adapterAddress":"00:00:c5:99:f5:87",
   "returnValue":true
}

-

 

-

Response for a failed call: If the supplied requestId does not exist

-

{  
-    "errorCode":188,
-    "returnValue":false,
-    "errorText":"The supplied requestId does not exist"
- } -

avrcp/supplyMediaPlayStatus

@@ -10353,7 +10278,7 @@

Call Returns

adapterAddress - Required + Optional String

Indicates the address of the adapter.

@@ -10361,7 +10286,7 @@

Call Returns

requestId - Required + Optional String

The unique ID of a request. 

@@ -10403,31 +10328,10 @@

Error Codes Reference

- 127, 143, 144 - See API Error Codes Reference + 127, 143, 144, 186, 187, 188 + Depends on error code -

See API Error Codes Reference.

- - - - 186 - Required 'requestId' parameter is not supplied - -

requestId parameter is missing in arguments.

- - - - 187 - Request is currently not allowed - -

The TG (Target) is not waiting for media playstatus request.

- - - - 188 - The supplied requestId does not exist - -

The supplied requestId does not exist, hence the method cannot be completed.

+

For details of an error code, see the API Error Codes Reference section.

@@ -10447,22 +10351,13 @@

Example

   }
}'

-

 

-

Response for a successful call:

+

Response:

{  
   "requestId":"001",
   "adapterAddress":"00:00:c5:99:f5:87",
   "returnValue":true
}

-

 

-

Response for a failed call: If the supplied requestId does not exist

-

{  
-    "errorCode":188,
-    "returnValue":false,
-    "errorText":"The supplied requestId does not exist"
- } -

device/getDiscoveredDevice

@@ -11132,13 +11027,12 @@

Parameters

Optional Boolean -

Indicates if subscribed to get notifications.

-

 Possible values are:

+

Subscribe to this method if you require notifications about any changes in its response

+

Possible values are:

-

Default: false

@@ -11180,12 +11074,7 @@

Call Returns

Required Boolean -

Indicates if subscribed to get notifications.

-

Possible values are:

- +

Indicates status of subscription (check 'subscribe' parameter).

@@ -11193,13 +11082,12 @@

Call Returns

Required Boolean -

Indicates the status of the operation.

+

Indicates status of method execution.

Possible values are:

-

Note: returnValue will always contain true unless the request for subscription fails.

@@ -11218,22 +11106,6 @@

Call Returns

Contains status information of all the devices known to the system, not just the ones whose status has been changed.

- - errorCode - Optional - Number - -

The error code for the failed operation.

- - - - errorText - Optional - String - -

Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

- - @@ -11260,12 +11132,7 @@

Subscription Returns

Required Boolean -

Indicates if subscribed to get notifications.

-

Possible values are:

- +

Indicates status of subscription (check 'subscribe' parameter).

@@ -11273,13 +11140,7 @@

Subscription Returns

Required Boolean -

Indicates the status of the operation.

-

Possible values are:

- -

Note: returnValue will always contain true unless the request for subscription fails.

+

Indicates status of method execution.

@@ -11298,22 +11159,6 @@

Subscription Returns

Contains the status information of all the devices known to the system, and not just the ones whose status has been changed.

- - errorCode - Optional - Number - -

The error code for the failed operation.

- - - - errorText - Optional - String - -

Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

- - @@ -11333,10 +11178,10 @@

Error Codes Reference

- 101, 143, 144 - See API Error Codes Reference + 101, 143, 144, 162 + Depends on error code -

See API Error Codes Reference.

+

For details of specific error code, see the 'API Error codes Reference' table

@@ -11654,12 +11499,12 @@

Parameters

Optional Boolean -

Indicates whether to set a remote device as a trusted device. Possible values are:

+

Indicates whether to set a remote device as a trusted device.

+

Possible values are:

-

Default value: false

@@ -11667,12 +11512,12 @@

Parameters

Optional Boolean -

Indicates whether to block (if set) or unblock (if reset) a remote device for pairing and profile connections. Possible values are:

+

Indicates whether to block (if set) or unblock (if reset) a remote device for pairing and profile connections.

+

Possible values are:

-

Default value: false

@@ -11704,25 +11549,17 @@

Call Returns

Indicates the status of operation.

Possible values are:

- errorCode - Optional - Number - -

The error code for the failed operation.

- - - - errorText - Optional + adapterAddress + Required String -

Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

+

Indicates the address of the adapter.

@@ -11744,24 +11581,10 @@

Error Codes Reference

- 5, 101, 105, 106, 143, 144 - See API Error Codes Reference + 5, 6, 101, 105, 106, 143, 144, 148, 149 + Depends on error code -

See API Error Codes Reference.

- - - - 148 - No property state has changed - -

Either no parameters are supplied to the device/setState method or the parameters have no state change from their earlier value.

- - - - 149 - Failed to set device properties - -

The Bluetooth stack fails to set the supplied device properties for the given device.

+

For details of specific error code, see the 'API Error codes Reference' table.

@@ -11778,7 +11601,7 @@

Example

}'

Response:

-

{  
+

{
   "returnValue":true
}

@@ -17554,7 +17377,7 @@

le/startAdvertising

Description

-

Start the broadcasting of the Bluetooth Low Energy advertisement.

+

Starts broadcasting the Bluetooth Low Energy advertisement.

Parameters

@@ -33650,7 +33473,7 @@

bluetooth2DeviceStatus

- + - + @@ -33841,6 +33664,55 @@

bluetooth2GattDescriptorInfo

txPowerRequiredOptional Number

Indicates the transmission power level of the remote device.

@@ -33672,7 +33495,7 @@

bluetooth2DeviceStatus

manufacturerData RequiredNumber (uint8_t) arrayObject: bluetooth2GattManufacturerData

Indicates manufacturer-specific company ID and data (if advertised from the remote device, else it will be blank).
+

bluetooth2GattManufacturerData

+
+

Indicates manufacturer-specific company ID and data (if advertised from the remote device, else it will be blank) and scanResponse data 

+

Note: If defined SCAN_RECORD only companyId and data will be available, if not all parameters visible 

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

Name

+ 		+

Required

+ 		+

Type

+ 		+

Description

+
companyIdOptionalNumber (int8_t) array +

Company identifier assigned by the Bluetooth SIG

+
dataOptionalNumber (int8_t) array +

Data of the advertiser

+
scanRecordOptionalNumber (int8_t) array +

Indicates the service data of the remote device (if advertised from the remote device, else it will be blank).

+
+
+

bluetooth2GattPermissionsInfo

Object containing information about the permissions allowed for a client to use a particular characteristic value.

@@ -34491,6 +34363,7 @@

bluetooth2MasInstancesStatus

bluetooth2MediaMetaData

Contains information about a media metadata value.

+

Note : string parameters accepts empty string as some meta data doesn't have particular info, and number parameters accepts non negative numbers

@@ -34510,7 +34383,7 @@

bluetooth2MediaMetaData

- + - + - + - + - + - + - + - + - + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + @@ -35740,6 +35655,27 @@

API Error Codes Reference

Note: Any required parameter missing will be a different error return based on the missing key.

+ + + + + + + + + + + + + + + @@ -35831,6 +35767,27 @@

API Error Codes Reference

The address parameter is mandatory, but was not supplied by the caller of the method.

+ + + + + + + + + + + + + + + diff --git a/content/en/docs/reference/ls2-api/com-webos-service-bugreport.html b/content/en/docs/reference/ls2-api/com-webos-service-bugreport.html index ebd6de3c..6c183b5b 100644 --- a/content/en/docs/reference/ls2-api/com-webos-service-bugreport.html +++ b/content/en/docs/reference/ls2-api/com-webos-service-bugreport.html @@ -1,7 +1,7 @@ --- title: com.webos.service.bugreport -date: 2024-05-27 -api_level: 29 +date: 2024-10-30 +api_level: 30 weight: 115 toc: true --- diff --git a/content/en/docs/reference/ls2-api/com-webos-service-bus.html b/content/en/docs/reference/ls2-api/com-webos-service-bus.html index 6ba0ad55..da26a01f 100644 --- a/content/en/docs/reference/ls2-api/com-webos-service-bus.html +++ b/content/en/docs/reference/ls2-api/com-webos-service-bus.html @@ -1,7 +1,7 @@ --- title: com.webos.service.bus -date: 2024-05-27 -api_level: 29 +date: 2024-10-30 +api_level: 30 weight: 117 toc: true --- @@ -103,21 +103,14 @@

Call Returns

- - - - - -
titleOptionalRequired String

Indicates the title of the media.

@@ -34518,7 +34391,7 @@

bluetooth2MediaMetaData

artistOptionalRequired String

Indicates the name of the artist.

@@ -34526,7 +34399,7 @@

bluetooth2MediaMetaData

albumOptionalRequired String

Indicates the name of album.

@@ -34534,7 +34407,7 @@

bluetooth2MediaMetaData

genreOptionalRequired String

Indicates the genre of the media.

@@ -34542,7 +34415,7 @@

bluetooth2MediaMetaData

trackNumberOptionalRequired Number

Indicates the track number of the media.

@@ -34550,7 +34423,7 @@

bluetooth2MediaMetaData

trackCountOptionalRequired Number

Indicates the total number of tracks in the album.

@@ -34558,7 +34431,7 @@

bluetooth2MediaMetaData

durationOptionalRequired Number

Indicates the playing time of the media in milliseconds.

@@ -35218,7 +35091,7 @@

bluetooth2PlayStatus

durationOptionalRequired Number

Indicates the number representing the current track length in milliseconds.

@@ -35226,7 +35099,7 @@

bluetooth2PlayStatus

positionOptionalRequired Number

Indicates the number representing the current playing time in milliseconds.

@@ -35234,7 +35107,7 @@

bluetooth2PlayStatus

statusOptionalRequired String

Indicates the string representing the play status.

@@ -35444,7 +35317,7 @@

bluetooth2ServiceClass

categoryRequiredOptional String

Indicates the LS2 category methods that can access the service class.

@@ -35704,9 +35577,51 @@

API Error Codes Reference

The SIL (Stack Interface Layer) module used doesn't provide any implementation for the profile.
128Device is already connecting +

Indicates that the remote Bluetooth device is already connected to the profile, hence another connection cannot be opened.

+
129Device is not paired +

The remote Bluetooth device is not paired, so connection cannot be opened.

+
130Failed to connect with remote device +

The remote Bluetooth device cannot be connected to the profile.

+
131Already connected +

The remote Bluetooth device is already connected to the adapter's <profilename> profile, so another connection cannot be opened.

+
132Failed to disconnect from remote device +

Indicates that the connection with the remote Bluetooth device could not be closed.

+
133Failed to retrieve state for remote device +

The connection status of the remote Bluetooth device cannot be retrieved.

+
136Device is not connectedDevice is not connected to profile

The remote Bluetooth device is not connected to our Bluetooth adapter via the profile.
148No property state has changed +

Either no parameters are supplied to the device/setState method or the parameters have no state change from their earlier value.

+
149Failed to set device properties +

The Bluetooth stack fails to set the supplied device properties for the given device.

+
161Adapter is turned off +

The Bluetooth adapter is turned off.

+
162 Adapter Address is not valid
186Required 'requestId' parameter is not supplied +

requestId parameter is missing in arguments.

+
187Request is currently not allowed +

The TG (Target) is not awaiting for media play status request.

+
188The supplied requestId does not exist +

The supplied requestId does not exist, hence the method cannot be completed.

+
213 Failed to configure advertisement Required Boolean -

Indicates the status of operation. Possible values are:

+

Indicates status of method execution.

+

Possible values are:

    -
  • true: Indicates that the operation was successful.
    • -
  • false: Indicates that the operation failed.
    • +
  • true: Successful.
    • +
  • false: Not successful. Check the method's 'Error Codes' section for failure details (errorCode and/or errorText).
errorTextOptionalString -

Indicates the reason for the failure in operation.

-
@@ -217,19 +210,52 @@

Call Returns

Required Boolean -

Indicates the status of operation. Possible values are:

+

Indicates status of method execution.

+

Possible values are:

    -
  • true: Indicates that the operation was successful.
    • -
  • false: Indicates that the operation failed.
    • +
  • true: Successful.
    • +
  • false: Not successful. Check the method's 'Error Codes' section for failure details (errorCode and/or errorText).
+ + +
+

Error Codes Reference

+
+ + - - - + + + + + + + + + + + + + + + + + @@ -237,25 +263,25 @@

Call Returns

Example

-

Example : Add manifest file data to hub security configuration

+

Example : Error response when services that are not present in the hub.configuration security group call this method

-

# luna-send -n 1 -f luna://com.webos.service.bus/addOneManifest '{"prefix": "/prefix", "path": "path/to/manifest.json"}'

+

# luna-send -n 1 -f -m "com.webos.some.not_trusted.service" luna://com.webos.service.bus/addOneManifest '{"prefix": "/prefix", "path": "path/to/manifest.json"}'

Response:

{
-     "returnValue": true
+     "returnValue": false,
+     "errorText": "com.webos.some.not_trusted.service does not allowed to call addOneManifest"
}

-

Example : Error&amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;nbsp;response when services that are not present in the hub.configuration security group call this method

+

Example : Add manifest file data to hub security configuration

-

# luna-send -n 1 -f -m "com.webos.some.not_trusted.service" luna://com.webos.service.bus/addOneManifest '{"prefix": "/prefix", "path": "path/to/manifest.json"}'

+

# luna-send -n 1 -f luna://com.webos.service.bus/addOneManifest '{"prefix": "/prefix", "path": "path/to/manifest.json"}'

Response:

{
-     "returnValue": false,
-     "errorText": "com.webos.some.not_trusted.service does not allowed to call addOneManifest"
+     "returnValue": true
}

@@ -322,7 +348,12 @@

Call Returns

@@ -344,6 +375,38 @@

Call Returns

errorTextOptionalString +

Error Code

+ 		+

Error Text

+ 		+

Error Description

+
-1"Schema error. 19: Missing required key" +

Required Parameter is missing

+
-1"Schema error. 13: Not string" -

Indicates the reason for the failure in operation

+

If parameter is not string type

+
-1"Manifest " " parse error: "Invalid parameters error. Can't open file: "" +

When invalid prefix or file path is given this error appears .

+

*Note - the file path will vary in the error text depending upon the file name.
Required Boolean -

True in case of success, false if input list contains invalid names.

+

Indicates status of method execution.

+

Possible values are:

+
    +
  • true: Successful.
    • +
  • false: Not successful. Check the method's 'Error Codes' section for failure details (errorCode and/or errorText).
    • +
+

Error Codes Reference

+
+ + + + + + + + + + + + + + + + + + +
+

Error Code

+ 		+

Error Text

+ 		+

Error Description

+
-1"Schema error. 3: Not array" +

When type is not array .

+
-1Schema error. 19: Missing required key" +

When required parameter is missing.

+
+

Example

Example : When unknown service is provided in input

@@ -441,35 +504,25 @@

Call Returns

Required Boolean -

Indicates the status of operation. Possible values are:

+

Indicates status of method execution.

+

Possible values are:

    -
  • true: Indicates that the operation was successful.
    • -
  • false: Indicates that the operation failed.
    • +
  • true: Successful.
    • +
  • false: Not successful. Check the method's 'Error Codes' section for failure details (errorCode and/or errorText).
allowed - Optional + Required Boolean -

True if call is allowed, otherwise false. Will not be returned if returnValue is false.

- - - - errorCode - Optional - Number (int32_t) - -

Error code is returned if returnValue is false else no error code is returned if returnValue is true.

- - - - errorText - Optional - String - -

Indicates the reason for the failure in operation.

+

Indicates if call is allowed.

+

Possible values are:

+
    +
  • true: Method call is allowed.
    • +
  • false: Method call is not allowed.
    • +
@@ -585,29 +638,14 @@

Call Returns

Required Boolean -

Indicates the status of operation. Possible values are:

+

Indicates status of method execution.

+

Possible values are:

    -
  • true - Indicates that the operation was successful.
    • -
  • false - Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details.
    • +
  • true: Successful.
    • +
  • false: Not successful. Check the method's 'Error Codes' section for failure details (errorCode and/or errorText).
- - errorCode - Optional - Number - -

The error code for the failed operation.

- - - - errorText - Optional - String - -

Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

- - client Required @@ -650,6 +688,20 @@

Error Codes Reference

Invalid payload format, error message describes the details

+ + -1 + "Schema error. 19: Missing required key" + +

When required parameter is missing

+ + + + -1 + Schema error. 13: Not string" + +

When parameter is not string type

+ +
@@ -773,21 +825,14 @@

Call Returns

Required Boolean -

Indicates the status of operation. Possible values are:

+

Indicates status of method execution.

+

Possible values are:

- - errorText - Optional - String - -

Indicates the reason for the failure in operation

- -
@@ -887,19 +932,44 @@

Call Returns

Required Boolean -

Indicates the status of operation. Possible values are:

+

Indicates status of method execution.

+

Possible values are:

+ + + +

Error Codes Reference

+
+ + - - - + + + + + + + + + + + + @@ -918,7 +988,7 @@

Example

-

Example : Error response&amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;nbsp;when services not present in the hub.configuration security group call this method

+

Example : Error response when services not present in the hub configuration security group call this method

# luna-send -n 1 -f -m "com.webos.some.not_trusted.service" luna://com.webos.service.bus/removeOneManifest '{"prefix": "/prefix", "path": "path/to/manifest.json"}'

@@ -932,7 +1002,7 @@

Example

signal/addmatch

-
ACG: None
+
ACG: servicebus.communication
  • Added: API level 26
    • @@ -1010,10 +1080,12 @@

    Call Returns

@@ -1141,7 +1213,7 @@

Example

signal/registerServiceCategory

-
ACG: None
+
ACG: servicebus.communication
  • Added: API level 26
    • @@ -1211,7 +1283,7 @@

    Call Returns

- + @@ -296,22 +296,6 @@

Call Returns

- - - - - - - - - - - -
errorTextOptionalString +

Error Code

+ 		+

Error Text

+ 		+

Error Description

+
-1"Schema error. 13: Not string" +

When parameter is not string type.

+
-1"Schema error. 19: Missing required key" -

Indicates the reason for the failure in operation

+

When required parameter is missing.
Required Boolean -

If the signal/addmatch method succeeds then the returnValue will contain true.
- If the signal/addmatch method fails then the returnValue will contain false.
- The signal/addmatch method may fail because of missing category parameter. -

+

Indicates status of method execution.

+

Possible values are:

+
    +
  • true: Successful.
    • +
  • false: Not successful. Check the method's 'Error Codes' section for failure details (errorCode and/or errorText).
    • +
category namecategoryname Optional String array @@ -1315,4 +1387,39 @@

Example

+ +

Objects

+
+

ApiPermissionsObject

+
+

Describe the group to which methods of the service belong. The properties of this object serve as patterns for methods (including their categories) and the values for these properties are set of groups for the methods matching the patterns.

+
+ + + + + + + + + + + + + + + +
+

Name

+ 		+

Required

+ 		+

Type

+ 		+

Description

+
<method pattern>RequiredString array +

List of groups that the methods matching the pattern in the property name belong to.

+
+
+
\ No newline at end of file diff --git a/content/en/docs/reference/ls2-api/com-webos-service-config.html b/content/en/docs/reference/ls2-api/com-webos-service-config.html index 3ea7c0f3..ca5a09b6 100644 --- a/content/en/docs/reference/ls2-api/com-webos-service-config.html +++ b/content/en/docs/reference/ls2-api/com-webos-service-config.html @@ -1,7 +1,7 @@ --- title: com.webos.service.config -date: 2024-05-27 -api_level: 29 +date: 2024-10-30 +api_level: 30 weight: 130 toc: true --- diff --git a/content/en/docs/reference/ls2-api/com-webos-service-configurator.html b/content/en/docs/reference/ls2-api/com-webos-service-configurator.html index 7b3362c3..0e87838b 100644 --- a/content/en/docs/reference/ls2-api/com-webos-service-configurator.html +++ b/content/en/docs/reference/ls2-api/com-webos-service-configurator.html @@ -1,7 +1,7 @@ --- title: com.webos.service.configurator -date: 2024-05-27 -api_level: 29 +date: 2024-10-30 +api_level: 30 weight: 140 toc: true --- diff --git a/content/en/docs/reference/ls2-api/com-webos-service-connectionmanager.html b/content/en/docs/reference/ls2-api/com-webos-service-connectionmanager.html index ccc6782c..0d9abdc7 100644 --- a/content/en/docs/reference/ls2-api/com-webos-service-connectionmanager.html +++ b/content/en/docs/reference/ls2-api/com-webos-service-connectionmanager.html @@ -1,7 +1,7 @@ --- title: com.webos.service.connectionmanager -date: 2024-06-05 -api_level: 29 +date: 2024-10-30 +api_level: 30 weight: 150 toc: true --- @@ -203,12 +203,12 @@

Parameters

Optional Boolean -

Subscribe to this method to get notified on changes to the status of the network connection. Possible values are:

+

Subscribe to this method to get notified on changes to the status of the network connection.

+

Possible values are:

    -
  • true - Get notifications
    • -
  • false - Notifications are not required
    • +
  • true: Subscribed.
    • +
  • false (Default): Not subscribed.
-

Default value: false
errorCodeOptionalNumber -

The error code for the failed operation.

-
errorTextOptionalString -

Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

-
@@ -422,7 +406,6 @@

Example

# luna-send -n 1 -f luna://com.webos.service.connectionmanager/getStatus '{}'

-

 

Response:

{
    "returnValue": true,
@@ -484,12 +467,12 @@

Parameters

Optional Boolean -

Subscribe to be notified of changes in interfaces. Possible values are:

+

Subscribe to be notified of changes in interfaces.

+

Possible values are:

-

Default value: false

@@ -518,7 +501,7 @@

Call Returns

Optional Object: wifiInfo -

Information about the Wi-Fi interface.

+

Information about the Wi-Fi interface.

@@ -553,22 +536,6 @@

Call Returns

- - errorCode - Optional - Number - -

The error code for the failed operation.

- - - - errorText - Optional - String - -

Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

- -
@@ -777,22 +744,6 @@

Call Returns

- - errorCode - Optional - Number - -

The error code for the failed operation.

- - - - errorText - Optional - String - -

Indicates the reason for the failure of the operation. See the "Error Codes" section of this method for details.

- - sampleInterval Optional @@ -866,15 +817,15 @@

Subscription Returns

sampleInterval - Required + Optional Number -

The time duration for sampling data activity in msec.

+

The time duration for sampling data activity (in milliseconds).

wired - Required + Optional Object: dataStats

Indicates the data activity for the wired interface.

@@ -882,7 +833,7 @@

Subscription Returns

wifi - Required + Optional Object: dataStats

Indicates the data activity for the Wi-Fi interface.

@@ -1225,29 +1176,14 @@

Call Returns

Required Boolean -

Indicates the status of operation. Possible values are:

+

Indicates the status of operation. 

+

Possible values are:

- - errorCode - Optional - Number - -

The error code for the failed operation.

- - - - errorText - Optional - String - -

Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

- - @@ -1420,29 +1356,14 @@

Call Returns

Required Boolean -

Indicates the status of operation. Possible values are:

+

Indicates the status of operation. 

+

Possible values are:

- - errorCode - Optional - Number - -

The error code for the failed operation.

- - - - errorText - Optional - String - -

Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

- - @@ -1581,29 +1502,14 @@

Call Returns

Required Boolean -

Indicates the status of operation. Possible values are:

+

Indicates the status of operation. 

+

Possible values are:

- - errorCode - Optional - Number - -

The error code for the failed operation.

- - - - errorText - Optional - String - -

Indicates the reason for the failure of the operation. See the "Error Codes" section of this method for details.

- - @@ -1784,27 +1690,11 @@

Call Returns

Indicates the status of operation.

Possible values are:

- - errorCode - Optional - Number - -

The error code for the failed operation.

- - - - errorText - Optional - String - -

Indicates the reason for the failure of the operation. See the "Error Codes" section of this method for details.

- - @@ -1895,6 +1785,25 @@

Example

}

+
+

Example scenario

+
+
+

# luna-send -n 1 -f luna://com.webos.service.connectionmanager/setipv4 '{
+     "ssid": "Connectivity",
+     "method": "manual",
+     "address": "192.168.1.42",
+     "netmask": "255.255.255.0",
+     "gateway": "192.168.1.1",
+     "interfaceName" : "eth0"
+ }' +

+

Response:

+

{
+     "returnValue": true
+ } +

+

setipv6

@@ -2004,29 +1913,14 @@

Call Returns

Required Boolean -

Indicates the status of operation. Possible values are:

+

Indicates the status of operation.

+

Possible values are:

- - errorCode - Optional - Number - -

The error code for the failed operation.

- - - - errorText - Optional - String - -

Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

- -
@@ -2201,29 +2095,14 @@

Call Returns

Required Boolean -

Indicates the status of operation. Possible values are:

+

Indicates the status of operation. 

+

Possible values are:

- - errorCode - Optional - Number - -

The error code for the failed operation.

- - - - errorText - Optional - String - -

Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

- - @@ -2976,23 +2855,6 @@

wired

wiredInfo

The object containing the MAC address of the wired interface.

-

An example would look like:

-
-

{
-    "macAddress":"aa:bb:cc:dd:ee",
-    "interfaces":[
-       {
-          "name":"eth0",
-          "macAddress":"DC:A6:32:AF:7C:3B"
-       },
-       {
-          "name":"eth1",
-          "macAddress":"DC:A6:32:AF:7C:3C"
-       }
-    ]
- } -

-
diff --git a/content/en/docs/reference/ls2-api/com-webos-service-db.html b/content/en/docs/reference/ls2-api/com-webos-service-db.html index 1a0e4409..efb863c9 100644 --- a/content/en/docs/reference/ls2-api/com-webos-service-db.html +++ b/content/en/docs/reference/ls2-api/com-webos-service-db.html @@ -1,7 +1,7 @@ --- title: com.webos.service.db -date: 2024-05-27 -api_level: 29 +date: 2024-10-30 +api_level: 30 weight: 170 toc: true --- @@ -2430,6 +2430,13 @@

Error Codes Reference

Application profiling is disabled. Enable it by using the "profile" method.

+ + + + +
22"invalid parameters: caller='com.palm.configurator' error='invalid type for property 'query'' +

When Invalid Parameters are passed.

+
@@ -3441,7 +3448,7 @@

listActiveMedia

Description

-

Returns a list of active attached media, and shards. 

+

Returns a list of active attached media, and shards.

Parameters

None

Call Returns

@@ -4625,11 +4632,10 @@

Parameters

Required String -

- Owner of the kind. Only the owner has permission to modify the kind. Depending on whether service/app ID is provided, use one of the following:

+

Owner of the kind. Only the owner has permission to modify the kind. Depending on whether service/app ID is provided, use one of the following:

diff --git a/content/en/docs/reference/ls2-api/com-webos-service-devmode.html b/content/en/docs/reference/ls2-api/com-webos-service-devmode.html index e0ea2240..7ba585b3 100644 --- a/content/en/docs/reference/ls2-api/com-webos-service-devmode.html +++ b/content/en/docs/reference/ls2-api/com-webos-service-devmode.html @@ -1,7 +1,7 @@ --- title: com.webos.service.devmode -date: 2024-05-27 -api_level: 29 +date: 2024-10-30 +api_level: 30 weight: 180 toc: true --- @@ -61,10 +61,11 @@

Call Returns

Required Boolean -

Returns the state of developer mode. Possible values are:

+

Returns the state of developer mode.

+

Possible values are:

@@ -120,33 +121,20 @@

Call Returns

Required Boolean -

Indicates the status of operation. Possible values are:

+

Indicates the status of operation.

+

Possible values are:

passphrase - Optional - String - The passphrase. - - - errorCode - Optional - number - -

The error code for the failed operation.

- - - - errorText - Optional + Required String -

Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

+

The passphrase.

@@ -231,10 +219,11 @@

Parameters

Required Boolean -

The status of developer mode. Possible values are:

+

Status of developer mode.

+

Possible values are:

@@ -264,29 +253,14 @@

Call Returns

Required Boolean -

Indicates the status of operation. Possible values are:

+

Indicates the status of operation.

+

Possible values are:

- - errorCode - Optional - number - -

The error code for the failed operation.

- - - - errorText - Optional - String - -

Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

- - @@ -335,7 +309,6 @@

Example

# luna-send -n 1 luna://com.webos.service.devmode/setDevMode '{"enabled":false}'

-

 

Response:

{
   "returnValue":true
diff --git a/content/en/docs/reference/ls2-api/com-webos-service-downloadmanager.html b/content/en/docs/reference/ls2-api/com-webos-service-downloadmanager.html index 9253d7fe..c97e4df8 100644 --- a/content/en/docs/reference/ls2-api/com-webos-service-downloadmanager.html +++ b/content/en/docs/reference/ls2-api/com-webos-service-downloadmanager.html @@ -1,7 +1,7 @@ --- title: com.webos.service.downloadmanager -date: 2024-05-27 -api_level: 29 +date: 2024-10-30 +api_level: 30 weight: 190 toc: true --- @@ -114,35 +114,41 @@

Call Returns

+

Error Codes Reference

+
+ + + + + + + + + + + + + +
+

Error Code

+ 		+

Error Text

+ 		+

Error Description

+
NoneMissing required key is required but it is missing +

Missing required key is required but it is missing

+
+

Example

Example code

-

Example response for a successful call :
-
- / # luna-send -n 1 -f luna://com.webos.service.downloadmanager/allow1x '{"value" : true}'
-
- {
-
- "returnValue": true,
-
- "value": true
-
- }
-
-
-
- Example response for a failed call : parameter missing
-
- / # luna-send -n 1 -f luna://com.webos.service.downloadmanager/allow1x '{}'
-
- {
-
- "returnValue": false,
-
- "errorText": "Missing required key is required but it is missing"
-
+

# luna-send -n 1 -f luna://com.webos.service.downloadmanager/allow1x '{"value" : true}'

+

Response:

+

{
+     "returnValue": true,
+     "value": true
}

@@ -197,19 +203,11 @@

Example

Example code

-

Example response for a successful call :
-
- / # luna-send -n 1 -f luna://com.webos.service.downloadmanager/cancelAllDownloads '{}'
-
- {
-
- "returnValue": true
-
- }
-
-
-
- Example response for a failed call : always return "true" +

# luna-send -n 1 -f luna://com.webos.service.downloadmanager/cancelAllDownloads '{}'

+

Response:

+

{
+     "returnValue": true
+ }

@@ -359,6 +357,13 @@

Error Codes Reference

Refer to the completionStatusCode parameter above.

+ + None + Missing required key is required but it is missing + +

Missing required key is required but it is missing

+ + @@ -367,38 +372,14 @@

Example

Example code

-

Example response for  successful call :
-
- / # luna-send -n 1 -f luna://com.webos.service.downloadmanager/cancelDownload '{"ticket" : 1}'
-
- {
-
- "ticket": 1,
-
- "aborted": true,
-
- "completionStatusCode": 12,
-
- "returnValue": true,
-
- "completed": false
-
- }
-
-
-
- Example response for a failed call : missing parameter
-
- / # luna-send -n 1 -f luna://com.webos.service.downloadmanager/cancelDownload '{}'
-
- {
-
- "ticket": 0,
-
- "returnValue": false,
-
- "errorText": "Missing required key is required but it is missing"
-
+

# luna-send -n 1 -f luna://com.webos.service.downloadmanager/cancelDownload '{"ticket" : 1}'

+

Response:

+

{
+     "ticket": 1,
+     "aborted": true,
+     "completionStatusCode": 12,
+     "returnValue": true,
+     "completed": false
}

@@ -549,6 +530,13 @@

Error Codes Reference

Refer to the completionStatusCode parameter above.

+ + None + Missing required key is required but it is missing + +

Missing required key is required but it is missing

+ + @@ -557,38 +545,14 @@

Example

Example code

-

Example response for a successful call :
-
- / # luna-send -n 1 -f luna://com.webos.service.downloadmanager/cancelUpload '{"ticket" : 1}'
-
- {
-
- "ticket": 1,
-
- "aborted": true,
-
- "completionStatusCode": 12,
-
- "returnValue": true,
-
- "completed": false
-
- }
-
-
-
- Example response for a failed call : missing parameter
-
- / # luna-send -n 1 -f luna://com.webos.service.downloadmanager/cancelUpload '{}'
-
- {
-
- "ticket": 0,
-
- "returnValue": false,
-
- "errorText": "Missing required key is required but it is missing"
-
+

# luna-send -n 1 -f luna://com.webos.service.downloadmanager/cancelUpload '{"ticket" : 1}'

+

Response:

+

{
+     "ticket": 1,
+     "aborted": true,
+     "completionStatusCode": 12,
+     "returnValue": true,
+     "completed": false
}

@@ -709,6 +673,13 @@

Error Codes Reference

+ + 3 + Fail to find owner + +

Fail to find owner

+ + @@ -717,30 +688,10 @@

Example

Example code

-

Example response for a successful call :
-
- / # luna-send -n 1 -f luna://com.webos.service.downloadmanager/clearHistory '{"owner" : "/var/run/ls2/5Htp9Q"}'
-
- {
-
- "returnValue": true
-
- }
-
-
-
- Example response for a failed call :
-
- / # luna-send -n 1 -f luna://com.webos.service.downloadmanager/clearHistory '{"owner" : "invalid"}'
-
- {
-
- "errorCode": 3,
-
- "returnValue": false,
-
- "errorText": "Fail to find owner"
-
+

# luna-send -n 1 -f luna://com.webos.service.downloadmanager/clearHistory '{"owner" : "/var/run/ls2/5Htp9Q"}'

+

Response:

+

{
+     "returnValue": true
}

@@ -833,37 +784,41 @@

Call Returns

+

Error Codes Reference

+
+ + + + + + + + + + + + + +
+

Error Code

+ 		+

Error Text

+ 		+

Error Description

+
Nonerequested download record not found +

requested download record not found

+
+

Example

Example code

-

Example response for a successful call :
-
- / # luna-send -n 1 -f luna://com.webos.service.downloadmanager/deleteDownloadedFile '{"ticket" : 124}'
-
- {
-
- "ticket": 124,
-
- "returnValue": true
-
- }
-
-
-
- Example response for a failed call : ticket is not in download history
-
- / # luna-send -n 1 -f luna://com.webos.service.downloadmanager/deleteDownloadedFile '{"ticket" : 999}'
-
- {
-
- "ticket": 999,
-
- "errorCode": "requested download record not found",
-
- "returnValue": false
-
+

# luna-send -n 1 -f luna://com.webos.service.downloadmanager/deleteDownloadedFile '{"ticket" : 124}'

+

Response:

+

{
+     "ticket": 124,
+     "returnValue": true
}

@@ -1435,38 +1390,14 @@

Example

Example code

-

Example response for a successful call :
-
- /media/internal/downloads # luna-send -f -i luna://com.webos.service.downloadmanager/download '{"target" : "http://www.google.co.kr"}'
-
- {
-
- "ticket": 18,
-
- "url": "http://www.google.co.kr",
-
- "target": "/media/internal/downloads/fileeAErBg",
-
- "subscribed": false,
-
- "returnValue": true
-
- }
-
- Example response for a failed call : file system full
-
- /media/internal/downloads # luna-send -f -i luna://com.webos.service.downloadmanager/download '{"target" : "http://www.google.co.kr"}'
-
- {
-
- "subscribed": false,
-
- "errorCode": "-4",
-
- "returnValue": false,
-
- "errorText": "start returned with an error code"
-
+

# luna-send -f -i luna://com.webos.service.downloadmanager/download '{"target" : "http://www.google.co.kr"}'

+

Response:

+

{
+     "ticket": 18,
+     "url": "http://www.google.co.kr",
+     "target": "/media/internal/downloads/fileeAErBg",
+     "subscribed": false,
+     "returnValue": true
}

diff --git a/content/en/docs/reference/ls2-api/com-webos-service-location.html b/content/en/docs/reference/ls2-api/com-webos-service-location.html index 3cd4f05d..819fddf3 100644 --- a/content/en/docs/reference/ls2-api/com-webos-service-location.html +++ b/content/en/docs/reference/ls2-api/com-webos-service-location.html @@ -1,7 +1,7 @@ --- title: com.webos.service.location -date: 2024-05-27 -api_level: 29 +date: 2024-10-30 +api_level: 30 weight: 230 toc: true --- @@ -23,30 +23,33 @@

Overview of the API

  • Mock: Enables to test location features with fake information.

    • Note: The location service provider is also called a location source and location handler.

    -

     

    Google Geocoding API Key

    To use the GeoCoding functionality, you must have the Geocoding API keys to authenticate requests associated with your project for usage and billing purposes. You must perform the following steps:

    1. Sign up and create a billing account with Google Maps Platform.
    2. Follow steps to get GeoCoding API key.
    3. Encrypt generated GeoCoding key with base64 encoding, execute following command in terminal
      - $ echo "GEOCODING_KEY" | base64
      - <<ENCRYPTED_GEOCODING_KEY>> +
      +

      + $ echo "GEOCODING_KEY" | base64
      + <<ENCRYPTED_GEOCODING_KEY>> +

      +
    4. Write encrypted key in file /etc/location/wsp.conf present on your device. Create following file:
      -

      {
      -     "wpsName": "google",
      -     "apiKey": "ENCRYPTED_GEOCODING_KEY",
      -     "services": [
      -         {
      -             "features": ["geocode", "reverseGeocode"],
      -             "url": "https://maps.googleapis.com/maps/api/geocode/json?"
      -         }
      -     ]
      - } -

      +

      {
      +     "wpsName": "google",
      +     "apiKey": "ENCRYPTED_GEOCODING_KEY",
      +     "services": [
      +         {
      +             "features": ["geocode", "reverseGeocode"],
      +             "url": "https://maps.googleapis.com/maps/api/geocode/json?"
      +         }
      +     ]
      + } +

    5. If the location service is already running, reboot the device.
      6. @@ -256,12 +259,16 @@

      Description

      Prerequisite: -
    6. For more details, Google official documents.
      7. +
    7. For more details, see Google official documents.

      8. Parameters

      @@ -482,6 +489,231 @@

      Example

      +

      getGpsSatelliteData

      +
      +
      ACG: location.query
      +
      +
        +
      • Added: API level 30
        • +
      +
      +

      Description

      +

      Gets the satellite information.

      +

      Prerequisite: The GPS feature of the device has to be powered ON.

      +

      Parameters

      +
      + + + + + + + + + + + + + + + +
      +

      Name

      +       		+

      Required

      +       		+

      Type

      +       		+

      Description

      +
      subscribeOptionalBoolean +

      Indicates whether to subscribe to related events.

      +

      Possible values are:

      +
        +
      • true: Subscribe.
        • +
      • false: Do not subscribe.
        • +
      +

      Default: true

      +
      +
      +

      Call Returns

      +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      +

      Name

      +       		+

      Required

      +       		+

      Type

      +       		+

      Description

      +
      returnValueRequiredBoolean +

      Indicates the status of the operation.

      +

      Possible values are:

      +
        +
      • true: Indicates that the operation was successful.
        • +
      • false: Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details.
        • +
      +
      errorCodeRequiredNumber +

      The error code for the failed operation.

      +
      visibleSatellitesOptionalNumber +

      Indicates the number of visible (detectable) satellites.

      +
      satellitesOptionalObject array: satellite +

      Contains each satellite's information in an object array.

      +
      errorTextOptionalString +

      Indicates the reason for the failure of the operation. See the "API Error Codes Reference" section for details.

      +
      +
      +

      Subscription Returns

      +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      +

      Name

      +       		+

      Required

      +       		+

      Type

      +       		+

      Description

      +
      returnValueRequiredBoolean +

      Indicates the status of the operation.

      +

      Possible values are:

      +
        +
      • true: Indicates that the operation was successful.
        • +
      • false: Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details.
        • +
      +
      errorCodeRequiredNumber +

      The error code for the failed operation.

      +
      visibleSatellitesOptionalNumber +

      Indicates the number of visible (i.e., detectable) satellites.

      +
      satellitesOptionalObject array: satellite +

      Contains each satellite's information in an object array.

      +
      errorTextOptionalString +

      Indicates the reason for the failure of the operation. See the "Error Codes" section of this method for details.

      +
      +
      +

      Example

      +
      +

      Example code

      +
      +
      +

      # luna-send -f -n 1 luna://com.webos.service.location/getGpsSatelliteData '{}'

      +

      Response:

      +

      {
      +    "visibleSatellites":25,
      +    "satellites":[
      +       {
      +          "prn":1,
      +          "index":0,
      +          "azimuth":64,
      +          "snr":0,
      +          "elevation":15,
      +          "usedInFix":false,
      +          "hasAlmanac":true,
      +          "hasEphemeris":true
      +       },
      +       {
      +          "prn":2,
      +          "index":1,
      +          "azimuth":265,
      +          "snr":0,
      +          "elevation":11,
      +          "usedInFix":false,
      +          "hasAlmanac":true,
      +          "hasEphemeris":true
      +       },
      +       {
      +          "prn":68,
      +          "index":24,
      +          "azimuth":49,
      +          "snr":0,
      +          "elevation":49,
      +          "usedInFix":false,
      +          "hasAlmanac":false,
      +          "hasEphemeris":false
      +       }
      +    ],
      +    "errorCode":0,
      +    "returnValue":true
      + } +

      +
      +

      getGpsStatus

      ACG: location.query
      @@ -1248,6 +1480,213 @@

      Example

      +

      getNmeaData

      +
      +
      ACG: location.query
      +
      +
        +
      • Added: API level 30
        • +
      +
      +

      Description

      +

      Gets a NMEA sentence from a GPS receiver.

      +

      Parameters

      +
      + + + + + + + + + + + + + + + +
      +

      Name

      +       		+

      Required

      +       		+

      Type

      +       		+

      Description

      +
      subscribeOptionalBoolean +

      Indicates whether to subscribe to related events.

      +
        +
      • true: Subscribe.
        • +
      • false: Do not subscribe.
        • +
      +

      Default: true

      +
      +
      +

      Call Returns

      +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      +

      Name

      +       		+

      Required

      +       		+

      Type

      +       		+

      Description

      +
      returnValueRequiredBoolean +

      Indicates the status of the operation.

      +

      Possible values are:

      +
        +
      • true: Indicates that the operation was successful.
        • +
      • false: Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details.
        • +
      +
      errorCodeRequiredNumber +

      The error code for the failed operation.

      +
      timestampOptionalNumber (int64_t) +

      Indicates the time when a raw NMEA sentence is received from the satellite(in milliseconds).

      +
      nmeaOptionalString +

      Contains the NMEA sentence.

      +
      errorTextOptionalString +

      Indicates the reason for the failure of the operation. See the "API Error Codes Reference" section for details.

      +
      +
      +

      Subscription Returns

      +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      +

      Name

      +       		+

      Required

      +       		+

      Type

      +       		+

      Description

      +
      returnValueRequiredBoolean +

      Indicates the status of the operation.

      +

      Possible values are:

      +
        +
      • true: Indicates that the operation was successful.
        • +
      • false: Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details.
        • +
      +
      errorCodeRequiredNumber +

      The error code for the failed operation.

      +
      timestampOptionalNumber (int64_t) +

      Indicates the time when a raw NMEA sentence is received from the satellite(in milliseconds).

      +
      nmeaOptionalString +

      Contains the NMEA sentence.

      +
      errorTextOptionalString +

      Indicates the reason for the failure of the operation. See the "API Error Codes Reference" section for details.

      +
      +
      +

      Example

      +
      +

      Example code

      +
      +
      +

      # luna-send -f -n 1 luna://com.webos.service.location/getNmeaData '{}'

      +

      Response:

      +

      {
      +    "timestamp":1410848850316,
      +    "nmea":"$GPGSV,4,1,13,01,13,067,,02,13,268,,04,33,060,,06,46,286,*7A",
      +    "errorCode":0,
      +    "returnValue":true
      + } +

      +

      Subscription response:
      + {
      +    "timestamp":1410848850316,
      +    "nmea":"$GPGSV,4,1,13,01,13,067,,02,13,268,,04,33,060,,06,46,286,*7A",
      +    "errorCode":0,
      +    "returnValue":true
      + } +

      +

      {
      +    "timestamp":1410848862346,
      +    "nmea":"$GPGSV,4,2,13,01,13,069,,02,13,265,,04,33,060,,03,46,286,*7A",
      +    "errorCode":0,
      +    "returnValue":true
      + } +

      +
      +

      getReverseLocation

      ACG: location.query
      @@ -1265,13 +1704,17 @@

      Description

    8. Prerequisite:
        -
      • Set up the Geocoding API key as described in Overview of the API > "Google Geocoding API Key". 
        • -
      • Enable network location provider state by:
        - # luna-send -f -n 1 luna://com.webos.service.location/setState '{"Handler":"network","state":true}' +
      • Set up the Geocoding API key as described in Overview of the API > Google Geocoding API Key.
        • +
      • Enable network location provider state by: +
        +

        + # luna-send -f -n 1 luna://com.webos.service.location/setState '{"Handler":"network","state":true}' +

        +
      9. -
    9. For more details, Google official documents.
      10. +
    10. For more details, see Google official documents.

      11. Parameters

      @@ -2979,6 +3422,107 @@

      location

      +

      satellite

      +
      +

      Contains satellite information.

      +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      +

      Name

      +       		+

      Required

      +       		+

      Type

      +       		+

      Description

      +
      indexRequiredNumber +

      Indicates the index of the satellite.

      +
      azimuthRequiredNumber (double) +

      Indicates the azimuth value of the satellite(in degrees).

      +
      elevationRequiredNumber (double) +

      Indicates the elevation of the satellite(in degrees).

      +
      prnRequiredNumber +

      Indicates the PRN (pseudo-random number) for the satellite.

      +
      snrRequiredNumber (double) +

      Indicates the signal to noise ratio for the satellite.

      +
      hasAlmanacRequiredBoolean +

      Indicates whether the GPS engine has almanac data for the satellite.

      +

      Possible values are :

      +
        +
      • true: GPS engine has almanac data for the satellite.
        • +
      • false: GPS engine has no almanac data for the satellite.
        • +
      +
      hasEphemerisRequiredBoolean +

      Indicates whether the GPS engine has ephemeris data for the satellite.

      +
        +
      • true: GPS engine has ephemeris data for the satellite.
        • +
      • false: GPS engine has no ephemeris data for the satellite. 
        • +
      +
      usedInFixRequiredBoolean +

      Indicates whether the satellite was used by the GPS engine in calculating the most recent GPS fix.

      +
        +
      • true: Satellite was used.
        • +
      • false: Satellite was not used.
        • +
      +
      +
      +

      API Error Codes Reference

      diff --git a/content/en/docs/reference/ls2-api/com-webos-service-mediacontroller.html b/content/en/docs/reference/ls2-api/com-webos-service-mediacontroller.html index 95a10081..4a2e256d 100644 --- a/content/en/docs/reference/ls2-api/com-webos-service-mediacontroller.html +++ b/content/en/docs/reference/ls2-api/com-webos-service-mediacontroller.html @@ -1,7 +1,7 @@ --- title: com.webos.service.mediacontroller -date: 2024-05-27 -api_level: 29 +date: 2024-10-30 +api_level: 31 weight: 235 toc: true --- @@ -399,6 +399,241 @@

      Example

      +

      getMediaCoverArtPath

      +
      +
      ACG: None
      +
      +
        +
      • Added: API level 30
        • +
      +
      +

      Description

      +

      Downloads requested cover art URI and provides downloaded path.

      +

      Parameters

      +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      +

      Name

      +       		+

      Required

      +       		+

      Type

      +       		+

      Description

      +
      displayIdRequiredNumber +

      Display ID.

      +
      srcRequiredString array +

      Source URIs of cover art images.

      +
      subscribeOptionalBoolean +

      Indicates if subscribed to get notifications.

      +

      Possible values are:

      +
        +
      • true: Subscribed.
        • +
      • false (Default): Not subscribed.
        • +
      +
      +
      +

      Call Returns

      +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      +

      Name

      +       		+

      Required

      +       		+

      Type

      +       		+

      Description

      +
      returnValueRequiredBoolean +

      Indicates the status of the operation.

      +

      Possible values are:

      +
        +
      • true: Successful.
        • +
      • false: Not successful. See 'Error Codes' section for details.
        • +
      +
      coverArtPathInfoRequiredObject array: coverArtPathInfo +

      Provides cover art source and download path.

      +
      subscribedRequiredBoolean +

      Indicates if subscribed to get notifications.

      +

      Possible values are:

      +
        +
      • true: Subscribed.
        • +
      • false: Not subscribed.
        • +
      +
      +
      +

      Subscription Returns

      +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      +

      Name

      +       		+

      Required

      +       		+

      Type

      +       		+

      Description

      +
      srcRequiredString +

      Source URI of Requested downloaded cover Art image.

      +
      srcPathRequiredString +

      Provides cover art source and downloaded path.

      +
      returnValueRequiredBoolean +

      Indicates the status of the operation.

      +

      Possible values are:

      +
        +
      • true: Successful.
        • +
      • false: Not successful. Check the method's 'Error Codes' section for failure details (errorCode and/or errorText).
        • +
      +
      subscribedRequiredBoolean +

      Indicates if subscribe to get notifications.

      +

      Possible values are:

      +
        +
      • true: Subscribed.
        • +
      +
      +
      +

      Error Codes Reference

      +
      + + + + + + + + + + + + + +
      +

      Error Code

      +       		+

      Error Text

      +       		+

      Error Description

      +
      2Check error details +

      For details of a specific error, see the 'API Error codes Reference' table.

      +
      +
      +

      Example

      +
      +

      Example scenario

      +
      +
      +

      # luna-send -n 3 -f luna://com.webos.service.mediacontroller/getMediaCoverArtPath '{
      +     "displayId":0,
      +     "src":["https://storage.googleapis.com/media-session/sintel/artwork-128.png"],
      +     "subscribe":true
      + }' +

      +

      Response:

      +

      {
      +     "subscribed": true,
      +     "returnValue": true,
      +     "coverArtPathInfo": [
      +         {
      +             "src": "https://storage.googleapis.com/media-session/sintel/artwork-128.png",
      +             "srcPath": "/media/internal/.media-session/artwork-128.png"
      +         }
      +     ]
      + } +

      +

      Subscription : 

      +

      {
      +     "subscribed": true,
      +     "returnValue": true,
      +     "src": "https://storage.googleapis.com/media-session/sintel/artwork-128.png",
      +     "srcPath": "/media/internal/.media-session/artwork-128.png"
      + } +

      +
      +

      getMediaMetaData

      ACG: mediacontroller.operation
      @@ -1180,7 +1415,7 @@

      Parameters

      Required Number -

      Indicates the displayId for which the media play status is required.

      +

      Display for which the media play status is required.

      Possible values are:

      • 0
        • @@ -1193,15 +1428,17 @@

        Parameters

        Optional String -

        Indicates the status for the required subscription response.

        -

        Possible values are :

        +

        Indicates the status for the required event type.

        +

        Note: If not set, eventType will send all the possible values as the response. 

        +

        Possible values are:

        • playStatus
        • muteStatus
        • playPosition
        • mediaMetaData
          • +
        • coverArt
          • +
        • supportedActions
        -

        Note: If not set, eventType will send all the possible values as the response.

        @@ -1212,8 +1449,8 @@

        Parameters

        Indicates if subscribed to get notifications.

        Possible values are:

          -
        • true: Subscribed for notifications
          • -
        • false: Not subscribed
          • +
        • true: Subscribed.
          • +
        • false: Not subscribed.
        @@ -1246,8 +1483,8 @@

        Call Returns

        Indicates the status of the operation.

        Possible values are:

          -
        • true: Indicates that the operation was successful.
          • -
        • false: Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details.
          • +
        • true: Successful.
          • +
        • false: Not successful. Check the method's 'Error Codes' section for failure details (errorCode and/or errorText).
        @@ -1256,12 +1493,7 @@

        Call Returns

        Optional Boolean -

        Indicates if subscribed to get notifications.

        -

        Possible values are:

        -
          -
        • true: Subscribed for notifications
          • -
        • false: Not subscribed
          • -
        +

        Indicates if subscribed to get notifications (check subscribe parameter).

        @@ -1269,7 +1501,7 @@

        Call Returns

        Optional Number -

        Indicates the displayId for the required media play status.

        +

        Display ID for the required media play status.

        Possible values are:

        • 0
          • @@ -1283,14 +1515,16 @@

          Call Returns

          String

          Indicates the status for the required subscription response.

          -

          Possible values are :

          +

          Note: If not set, eventType will send all the possible values as the response. 

          +

          Possible values are:

          • playStatus
          • muteStatus
          • playPosition
          • mediaMetaData
            • +
          • coverArt​
            • +
          • supportedActions
          -

          Note: If not set, eventType will send all the possible values as the response. 

          @@ -1299,6 +1533,7 @@

          Call Returns

          String

          Indicates the current play status of the media. 

          +

          Note: Available only if eventType is playStatus.

          Possible values are:

          • PLAYSTATE_NONE
            • @@ -1310,7 +1545,6 @@

            Call Returns

          • PLAYSTATE_BUFFERING
          • PLAYSTATE_ERROR
          -

          Note: The information will be sent if the eventType is playStatus.

          @@ -1319,12 +1553,12 @@

          Call Returns

          String

          Indicates the current status of the media. 

          +

          Note: Available only if eventType is muteStatus.

          Possible values are:

          • mute
          • unmute
          -

          Note: The information will be sent if the eventType is muteStatus.

          @@ -1333,7 +1567,7 @@

          Call Returns

          String

          Indicates the current play position of the media.

          -

          Note: The information will be sent if the eventType is playPosition.

          +

          Note: Available only if eventType is playPosition.

          @@ -1342,23 +1576,25 @@

          Call Returns

          Object: mediaMetaData

          Indicates the metadata information for the playback.

          -

          Note: The information will be sent if the eventType is mediaMetaData.

          +

          Note: Available only if eventType is mediaMetaData.

          - errorCode + coverArt Optional - Number + Object array: coverArtInfo -

          The error code for the failed operation.

          +

          Details of media cover art.

          +

          Note: Available only if eventType is coverArt.

          - errorText + supportedActions Optional - String + String array -

          Indicates the reason for the failure of the operation. See the "Error Codes" section of this method for details.

          +

          List of supported actions that are specified in setSupportedActions method.

          +

          Note: Available only if eventType is supportedActions.

          @@ -1388,11 +1624,6 @@

          Subscription Returns

          Boolean

          Indicates the status of the operation.

          -

          Possible values are:

          -
            -
          • true: Indicates that the operation was successful.
            • -
          • false: Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details.
            • -
          @@ -1400,12 +1631,7 @@

          Subscription Returns

          Optional Boolean -

          Indicates if subscribed to get notifications.

          -

          Possible values are:

          -
            -
          • true: Subscribed for notifications
            • -
          • false: Not subscribed
            • -
          +

          Indicates if subscribed to get notifications (check subscribe parameter).

          @@ -1413,7 +1639,7 @@

          Subscription Returns

          Optional Number -

          Indicates the displayId for the required media play status.

          +

          Display ID for the required media play status.

          Possible values are:

          • 0
            • @@ -1427,14 +1653,16 @@

            Subscription Returns

            String

            Indicates the status for the required subscription response.

            -

            Possible values are :

            +

            Note: If not set, eventType will send all the possible values as the response. 

            +

            Possible values are:

            • playStatus
            • muteStatus
            • playPosition
            • mediaMetaData
              • +
            • coverArt
              • +
            • supportedActions
            -

            Note: If not set, eventType will send all the possible values as the response. 

            @@ -1443,6 +1671,7 @@

            Subscription Returns

            String

            Indicates the current play status of the media. 

            +

            Note: Available only if eventType is playStatus.

            Possible values are:

            • PLAYSTATE_NONE
              • @@ -1454,7 +1683,6 @@

              Subscription Returns

            • PLAYSTATE_BUFFERING
            • PLAYSTATE_ERROR
            -

            Note: The information will be sent if eventType is playStatus.

            @@ -1463,12 +1691,12 @@

            Subscription Returns

            String

            Indicates the current status of the media. 

            +

            Note: Available only if eventType is muteStatus.

            Possible values are:

            • mute
            • unmute
            -

            Note: The information will be sent if the eventType is muteStatus

            @@ -1477,7 +1705,7 @@

            Subscription Returns

            String

            Indicates the current play position of the media playback.

            -

            Note: The information will be sent if the eventType is playPosition.

            +

            Note: Available only if eventType is playPosition.

            @@ -1486,23 +1714,25 @@

            Subscription Returns

            Object: mediaMetaData

            Indicates the metadata information for the playback.

            -

            Note: The information will be sent if the eventType is mediaMetaData.

            +

            Note: Available only if eventType is mediaMetaData.

            - errorCode + coverArt Optional - Number + Object array: coverArtInfo -

            The error code for the failed operation

            +

            Details of media cover art.

            +

            Note: Available only if eventType is coverArt.

            - errorText + supportedActions Optional - String + String array -

            Indicates the reason for the failure of the operation. See the "Error Codes" section of this method for details.

            +

            List of supported actions that are specified in setSupportedActions method.

            +

            Note: Available only if eventType is supportedActions.

            @@ -1524,7 +1754,7 @@

            Error Codes Reference

            - 0, 1, 2, 3, 4, 6, 7, 10 + 2, 10, 11, 12 See the API Error Codes Reference section

            See the API Error Codes Reference section

            @@ -1538,50 +1768,94 @@

            Example

            Example scenario

      -

      # luna-send -n 1 -f luna://com.webos.service.mediacontroller/receiveMediaPlaybackInfo '{
      +

      # luna-send -n 1 -f luna://com.webos.service.mediacontroller/receiveMediaPlaybackInfo '{
         "displayId":0,
      +    "eventType":"supportedActions",
         "subscribe":true
      }'

      Response:

      {
      -    "returnValue":true,
      -    "displayId":0,
      -    "playStatus":"PLAYSTATE_PLAYING",
      -    "muteStatus":"unmute",
      -    "playPosition":"10.10",
      -    "metaData":{
      -       "title":"Big Bang Theory",
      -       "artist":"BIGBANG",
      -       "totalDuration":"20.15",
      -       "album":"BBT",
      -       "genre":"drama",
      -       "trackNumber":2
      -    }
      +     "subscribed": true,
      +     "displayId": 0,
      +     "returnValue": true,
      +     "supportedActions": [
      +         "play",
      +         "pause",
      +         "stop",
      +         "seekTo",
      +         "scrubTo",
      +         "enterPictureInPicture",
      +         "exitPictureInPicture"
      +     ],
      +     "eventType": "supportedActions"
      }

      -

      With eventType as playStatus

      +

      Example scenario

      # luna-send -n 1 -f luna://com.webos.service.mediacontroller/receiveMediaPlaybackInfo '{
         "displayId":0,
      -    "eventType":"playStatus",
         "subscribe":true
      }'

      Response:

      {
      -    "returnValue":true,
      +     "returnValue": true,
      +     "coverArt": [
      +         {
      +             "sizes": [
      +                 {
      +                     "width": 128,
      +                     "height": 128
      +                 }
      +             ],
      +             "src": "https://storage.googleapis.com/media-session/sintel/artwork-128.png",
      +             "type": "image/png"
      +         }
      +     ],
      +     "displayId": 0,
      +     "playPosition": "1.0",
      +     "subscribed": true,
      +     "mediaMetaData": {
      +         "artist": "BigBang",
      +         "trackNumber": 2,
      +         "album": "BBT",
      +         "totalDuration": "20.15",
      +         "title": "BigBangTheory",
      +         "volume": 100,
      +         "genre": "drama"
      +     },
      +     "playStatus": "PLAYSTATE_PLAYING",
      +     "muteStatus": "mute"
      + }
      +   +

      +
      +
      +

      Example : For eventType as playStatus

      +
      +
      +

      # luna-send -n 1 -f luna://com.webos.service.mediacontroller/receiveMediaPlaybackInfo '{
         "displayId":0,
         "eventType":"playStatus",
      -    "playStatus":"PLAYSTATE_PLAYING"
      +    "subscribe":true
      + }' +

      +

      Response:

      +

      {
      +     "playStatus": "PLAYSTATE_PLAYING",
      +     "displayId": 0,
      +     "returnValue": true,
      +     "subscribed": true,
      +     "eventType": "playStatus"
      }

      -

      With eventType as muteStatus

      +

      Example : For eventType as muteStatus

      # luna-send -n 1 -f luna://com.webos.service.mediacontroller/receiveMediaPlaybackInfo '{
      @@ -1592,15 +1866,16 @@

      Example

      Response:

      {
      -    "returnValue":true,
      -    "displayId":0,
      -    "eventType":"muteStatus",
      -    "muteStatus":"unmute"
      +     "subscribed": true,
      +     "displayId": 0,
      +     "returnValue": true,
      +     "muteStatus": "mute",
      +     "eventType": "muteStatus"
      }

      -

      With eventType as playPosition

      +

      Exameple : For eventType as playPosition

      # luna-send -n 1 -f luna://com.webos.service.mediacontroller/receiveMediaPlaybackInfo '{
      @@ -1611,15 +1886,16 @@

      Example

      Response:

      {
      -   "returnValue":true,
      -   "displayId":0,
      -   "eventType":"playPosition",
      -   "playPosition":"10.10"
      +     "playPosition": "1.0",
      +     "displayId": 0,
      +     "returnValue": true,
      +     "subscribed": true,
      +     "eventType": "playPosition"
      }

      -

      With eventType as metaData

      +

      Example : For eventType as metaData

      # luna-send -n 1 -f luna://com.webos.service.mediacontroller/receiveMediaPlaybackInfo '{
      @@ -1630,28 +1906,61 @@

      Example

      Response:

      {
      -   "returnValue":true,
      -   "displayId":0,
      -   "eventType":"mediaMetaData",
      -   "metaData":{
      -       "title":"Big Bang Theory",
      -       "artist":"BIGBANG",
      -       "totalDuration":"20.15",
      -       "album":"BBT",
      -       "genre":"drama",
      -       "trackNumber":2
      -    }
      +     "subscribed": true,
      +     "displayId": 0,
      +     "returnValue": true,
      +     "mediaMetaData": {
      +         "artist": "BigBang",
      +         "trackNumber": 2,
      +         "album": "BBT",
      +         "totalDuration": "20.15",
      +         "title": "BigBangTheory",
      +         "volume": 100,
      +         "genre": "drama"
      +     },
      +     "eventType": "mediaMetaData"
      }

      - -

      registerMediaSession

      -
      -
      ACG: mediacontroller.query
      -
      -
        -
      • Added: API level 12
        • -
      +
      +

      Example : For eventType as coverArt

      +
      +
      +

      # luna-send -n 1 -f luna://com.webos.service.mediacontroller/receiveMediaPlaybackInfo '{
      +    "displayId":0,
      +    "eventType":"coverArt",
      +    "subscribe":true
      + }' +

      +

      Response:

      +

      {
      +     "coverArt": [
      +         {
      +             "sizes": [
      +                 {
      +                     "width": 128,
      +                     "height": 128
      +                 }
      +             ],
      +             "src": "https://storage.googleapis.com/media-session/sintel/artwork-128.png",
      +             "type": "image/png"
      +         }
      +     ],
      +     "displayId": 0,
      +     "returnValue": true,
      +     "subscribed": true,
      +     "eventType": "coverArt"
      + } +

      +
      +
      +

      registerMediaSession

      +
      +
      ACG: mediacontroller.query
      +
      +
        +
      • Added: API level 12
        • +

      Description

      Registers media sessions, subscribes to receive AVRCP key events.

      @@ -1928,6 +2237,150 @@

      Example

      +

      setMediaCoverArt

      +
      +
      ACG: None
      +
      +
        +
      • Added: API level 30
        • +
      +
      +

      Description

      +

      Sets the cover art data for media session. 

      +

      Parameters

      +
      + + + + + + + + + + + + + + + + + + + + + +
      +

      Name

      +       		+

      Required

      +       		+

      Type

      +       		+

      Description

      +
      mediaIdRequiredString +

      Media ID of the registered session.

      +
      coverArtRequiredObject array: coverArtInfo +

      Cover art information of the media session.

      +
      +
      +

      Call Returns

      +
      + + + + + + + + + + + + + + + +
      +

      Name

      +       		+

      Required

      +       		+

      Type

      +       		+

      Description

      +
      returnValueRequiredBoolean +

      Indicates the status of the operation.

      +

      Possible values are:

      +
        +
      • true: Successful.
        • +
      • false: Not successful. See 'Error Codes' section for details.
        • +
      +
      +
      +

      Error Codes Reference

      +
      + + + + + + + + + + + + + +
      +

      Error Code

      +       		+

      Error Text

      +       		+

      Error Description

      +
      0, 2Check error details +

      For details of a specific error, see the 'API Error codes Reference' table.

      +
      +
      +

      Example

      +
      +

      Example scenario

      +
      +
      +

      # luna-send -n 1 -f luna://com.webos.service.mediacontroller/setMediaCoverArt '{
      +    "mediaId":"xDFNUI",
      +    "coverArt":[
      +       {
      +          "src":"https://storage.googleapis.com/media-session/sintel/artwork-96.png",
      +          "type":"image/png",
      +          "sizes":[
      +             {
      +                "height":96,
      +                "width":96
      +             }
      +          ]
      +       },
      +       {
      +          "src":"https://storage.googleapis.com/media-session/sintel/artwork-128.png",
      +          "type":"image/png",
      +          "sizes":[
      +             {
      +                "height":128,
      +                "width":128
      +             }
      +          ]
      +       }
      +    ]
      + }' +

      +

      Response:

      +

      {
      +     "returnValue": true,
      + } +

      +
      +

      setMediaMetaData

      ACG: mediacontroller.query
      @@ -2514,6 +2967,133 @@

      Example

      +

      setSupportedActions

      +
      +
      ACG: None
      +
      +
        +
      • Added: API level 31
        • +
      +
      +

      Description

      +

      Sets the list of supported media actions.

      +

      Parameters

      +
      + + + + + + + + + + + + + + + + + + + + + +
      +

      Name

      +       		+

      Required

      +       		+

      Type

      +       		+

      Description

      +
      mediaIdRequiredString +

      Media ID of the registered session.

      +
      supportedActionsRequiredString array +

      List of actions to be supported. It can include values such as:

      +
        +
      • play
        • +
      • pause
        • +
      • next
        • +
      • previous
        • +
      • mute
        • +
      • unmute
        • +
      +
      +
      +

      Call Returns

      +
      + + + + + + + + + + + + + + + +
      +

      Name

      +       		+

      Required

      +       		+

      Type

      +       		+

      Description

      +
      returnValueRequiredBoolean +

      Indicates the status of the operation.

      +

      Possible values are:

      +
        +
      • true: Successful.
        • +
      • false: Not successful. See 'Error Codes' section for details.
        • +
      +
      +
      +

      Error Codes Reference

      +
      + + + + + + + + + + + + + +
      +

      Error Code

      +       		+

      Error Text

      +       		+

      Error Description

      +
      0, 2Check error details. +

      For details of a specific error, see the API Error Codes Reference table.

      +
      +
      +

      Example

      +
      +

      Example : Set play, pause, and next as supported actions

      +
      +
      +

      # luna-send -n 1 -f luna://com.webos.service.mediacontroller/setSupportedActions '{"mediaId":"xDFNUI", "supportedActions":["play", "pause", "next"]}'

      +

      Response:

      +

      {
      +     "returnValue": true
      + } +

      +
      +

      unregisterMediaSession

      ACG: mediacontroller.query
      @@ -2648,6 +3228,94 @@

      Example

      Objects

      +

      coverArtInfo

      +
      +

      Details of media cover art.

      +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      +

      Name

      +       		+

      Required

      +       		+

      Type

      +       		+

      Description

      +
      srcRequiredString +

      Source URI of cover Art image.

      +
      typeOptionalString +

      Type of image format.

      +
      sizesOptionalObject array: sizes +

      Size of images.

      +
      +
      +
      +

      coverArtPathInfo

      +
      +

      Provides cover art source URI and downloaded path.

      +
      + + + + + + + + + + + + + + + + + + + + + +
      +

      Name

      +       		+

      Required

      +       		+

      Type

      +       		+

      Description

      +
      srcRequiredString +

      Source URI of cover art image.

      +
      srcPathRequiredString +

      Provides downloaded cover art source path

      +
      +
      +

      mediaMetaData

      Contains the mediaMetaData information.

      @@ -2776,6 +3444,46 @@

      mediaSession

      +

      sizes

      +
      +

      Provides possible sizes for each cover art

      +
      + + + + + + + + + + + + + + + + + + + + + +
      +

      Name

      +       		+

      Required

      +       		+

      Type

      +       		+

      Description

      +
      widthOptionalNumber +

      Indicates the width of the image.

      +
      heightOptionalNumber +

      Indicates the height of the image.

      +
      +
      +

      API Error Codes Reference

      @@ -2863,6 +3571,20 @@

      API Error Codes Reference

      Indicates No Error

      + + 11 + Invalid displayId + +

      Indicates invalid displayid

      + + + + 12 + Invalid Event + +

      Indicates invalid event

      + +
      diff --git a/content/en/docs/reference/ls2-api/com-webos-service-pdm.html b/content/en/docs/reference/ls2-api/com-webos-service-pdm.html index 510f365b..40c21027 100644 --- a/content/en/docs/reference/ls2-api/com-webos-service-pdm.html +++ b/content/en/docs/reference/ls2-api/com-webos-service-pdm.html @@ -1,7 +1,7 @@ --- title: com.webos.service.pdm -date: 2024-05-27 -api_level: 29 +date: 2024-10-30 +api_level: 30 weight: 250 toc: true --- diff --git a/content/en/docs/reference/ls2-api/com-webos-service-preferences.html b/content/en/docs/reference/ls2-api/com-webos-service-preferences.html index 3c80298c..4f7ed857 100644 --- a/content/en/docs/reference/ls2-api/com-webos-service-preferences.html +++ b/content/en/docs/reference/ls2-api/com-webos-service-preferences.html @@ -1,7 +1,7 @@ --- title: com.webos.service.preferences -date: 2024-05-27 -api_level: 29 +date: 2024-10-30 +api_level: 30 weight: 270 toc: true --- diff --git a/content/en/docs/reference/ls2-api/com-webos-service-sdkagent.html b/content/en/docs/reference/ls2-api/com-webos-service-sdkagent.html index 5cd8eb2c..21eae2b0 100644 --- a/content/en/docs/reference/ls2-api/com-webos-service-sdkagent.html +++ b/content/en/docs/reference/ls2-api/com-webos-service-sdkagent.html @@ -1,7 +1,7 @@ --- title: com.webos.service.sdkagent -date: 2024-05-27 -api_level: 29 +date: 2024-10-30 +api_level: 30 weight: 280 toc: true --- @@ -64,37 +64,46 @@

      Call Returns

      Boolean

      Indicates the status of the operation.

      -

      Possible values are:

      +

      Possible values are:

      - errorCode + config Optional - Number + Object -

      The error code for the failed operation.

      +

      Telegraf configurations, converted to a JSON object.

      +

      Similar to telegraf.conf, available @ https://docs.influxdata.com/telegraf/v1.21/administration/configuration/.

      +

      Note: Besides the configs that are configured using setConfig method, this method also returns some read-only configurations.

      + + + +

      Error Codes Reference

      +
      + + - - - - + + + - - - + + @@ -210,7 +219,18 @@

      Parameters

      Indicates the inputs to get data from service.

      The inputs can be obtained from the "Input.*" of  the collector/getConfig API.

      For example, the inputs can be as follows: {"processes", "kernel", "cpu", "system", "diskio", "disk", "mem", "swap"}

      -

      If argument is empty, return all collected data

      +

      If argument is empty, return all collected data.

      +

      For more details:

      +

      Note: The inputs can be different depending on the target device.

      @@ -241,35 +261,56 @@

      Call Returns

      - + - + + +
      errorTextOptionalString -

      The reason for the failure of the operation. See the 'API Error Codes Reference' section for details.

      -       		+

      Error Code

      +       		+

      Error Text

      +       		+

      Error Description

      +
      configOptionalObject3, 4Check error details -

      Telegraf configurations, converted to a JSON object.

      -

      Similar to telegraf.conf, available @ https://docs.influxdata.com/telegraf/v1.21/administration/configuration/.

      -

      Note: Besides the configs that are configured using setConfig method, this method also returns some read-only configurations.

      +

      For details of a specific error, see the API Error Codes Reference table.
      Boolean

      Indicates the status of the operation.

      -

      Possible values are:

      +

      Possible values are:

        -
      • true: Operation is successful.
        • -
      • false: Operation has failed. Check the 'errorCode' and 'errorText' fields.
        • +
      • true: Successful.
        • +
      • false: Not successful. Check the method's 'Error Codes' section for failure details (errorCode and/or errorText).
      errorCodedataArray OptionalNumberObject array -

      The error code for the failed operation.

      +

      JSON object with data about the specified input.

      +

      More details on output data:

      +

      For more details:

      +
      +
      +

      Error Codes Reference

      +
      + + - - - - + + + - - - + + @@ -358,39 +399,23 @@

      Call Returns

      - - - - - - - - - - - - - + @@ -402,14 +427,39 @@

      Call Returns

      Indicates whether the service is configured to start on booting up of device.

      Possible values are:

        -
      • true: Configured to start on boot.
        • -
      • false: Not configured to start on boot. 
        • +
      • true: Configured to start on boot.
        • +
      • false: Not configured to start on boot.
      errorTextOptionalString -

      The reason for the failure of the operation. See the 'API Error Codes Reference' section for details.

      -       		+

      Error Code

      +       		+

      Error Text

      +       		+

      Error Description

      +
      dataArrayOptionalObject array3, 4Check error details -

      JSON object with data about the specified input.

      +

      For details of a specific error, see the API Error Codes Reference table.
      Boolean

      Indicates the status of the operation.

      -

      Possible values are:

      +

      Possible values are:

        -
      • true: Operation is successful.
        • -
      • false: Operation has failed. Check the 'errorCode' and 'errorText' fields.
        • +
      • true: Successful.
        • +
      • false: Not successful. Check the method's 'Error Codes' section for failure details (errorCode and/or errorText).
      errorCodeOptionalNumber -

      The error code for the failed operation.

      -
      errorTextOptionalString -

      The reason for the failure of the operation. See the 'API Error Codes Reference' section for details.

      -
      statusOptionalRequired String

      Indicates the status of the Telegraf service.

      Possible values are:

        -
      • active: Service is running.
        • -
      • inactive: Service is not running.
        • +
      • active: Service is running.
        • +
      • inactive: Service is not running.
      +

      Error Codes Reference

      +
      + + + + + + + + + + + + + +
      +

      Error Code

      +       		+

      Error Text

      +       		+

      Error Description

      +
      3Check error details +

      For details of a specific error, see the API Error Codes Reference table.

      +
      +

      Example

      Example scenario

      @@ -461,27 +511,36 @@

      Call Returns

      Boolean

      Indicates the status of the operation.

      -

      Possible values are:

      +

      Possible values are:

        -
      • true: Operation is successful.
        • -
      • false: Operation has failed. Check the 'errorCode' and 'errorText' fields.
        • +
      • true: Successful.
        • +
      • false: Not successful. Check the method's 'Error Codes' section for failure details (errorCode and/or errorText).
      + + +
      +

      Error Codes Reference

      +
      + + - - - - + + + - - - + + @@ -607,27 +666,36 @@

      Call Returns

      + +
      errorCodeOptionalNumber -

      The error code for the failed operation.

      -       		+

      Error Code

      +       		+

      Error Text

      +       		+

      Error Description

      +
      errorTextOptionalString3Check error details. -

      The reason for the failure of the operation. See the 'API Error Codes Reference' section for details.

      +

      For details of a specific error, see the API Error Codes Reference table.
      Boolean

      Indicates the status of the operation.

      -

      Possible values are:

      +

      Possible values are:

        -
      • true: Operation is successful.
        • -
      • false: Operation has failed. Check the 'errorCode' and 'errorText' fields.
        • +
      • true: Successful.
        • +
      • false: Not successful. Check the method's 'Error Codes' section for failure details (errorCode and/or errorText).
      +
      +

      Error Codes Reference

      +
      + + - - - - + + + - - - + + @@ -690,25 +758,34 @@

      Call Returns

      Indicates the status of the operation.

      Possible values are:

        -
      • true: Operation is successful.
        • -
      • false: Operation has failed. Check the 'errorText' fields.
        • +
      • true: Successful.
        • +
      • false: Not successful. Check the method's 'Error Codes' section for failure details (errorCode and/or errorText).
      + +
      errorCodeOptionalNumber -

      The error code for the failed operation.

      -       		+

      Error Code

      +       		+

      Error Text

      +       		+

      Error Description

      +
      errorTextOptionalString2, 3 ,4, 5Check error details -

      The reason for the failure of the operation. See the 'API Error Codes Reference' section for details.

      +

      For details of a specific error, see the API Error Codes Reference table.
      +
      +

      Error Codes Reference

      +
      + + - - - - + + + - - - + + @@ -763,8 +840,8 @@

      Parameters

      Indicates if auto-start is enabled.

      Possible values are:

        -
      • true: Auto-start is enabled.
        • -
      • false: Not enabled.
        • +
      • true: Auto-start is enabled.
        • +
      • false: Not enabled.
      @@ -795,27 +872,36 @@

      Call Returns

      + +
      errorCodeOptionalNumber -

      The error code for the failed operation.

      -       		+

      Error Code

      +       		+

      Error Text

      +       		+

      Error Description

      +
      errorTextOptionalString3Check error details -

      The reason for the failure of the operation. See the 'API Error Codes Reference' section for details.

      +

      For details of a specific error, see the API Error Codes Reference table.
      Boolean

      Indicates the status of the operation.

      -

      Possible values are:

      +

      Possible values are:

        -
      • true: Operation is successful.
        • -
      • false: Operation has failed. Check the 'errorCode' and 'errorText' fields.
        • +
      • true: Successful.
        • +
      • false: Not successful. Check the method's 'Error Codes' section for failure details (errorCode and/or errorText).
      +
      +

      Error Codes Reference

      +
      + + - - - - + + + - - - + + @@ -870,27 +956,36 @@

      Call Returns

      + +
      errorCodeOptionalNumber -

      The error code for the failed operation.

      -       		+

      Error Code

      +       		+

      Error Text

      +       		+

      Error Description

      +
      errorTextOptionalString2, 3Check error details -

      The reason for the failure of the operation. See the 'API Error Codes Reference' section for details.

      +

      For details of a specific error, see the API Error Codes Reference table.
      Boolean

      Indicates the status of the operation.

      -

      Possible values are:

      +

      Possible values are:

        -
      • true: Operation is successful.
        • -
      • false: Operation has failed. Check the 'errorCode' and 'errorText' fields.
        • +
      • true: Successful.
        • +
      • false: Not successful. Check the method's 'Error Codes' section for failure details (errorCode and/or errorText).
      +
      +

      Error Codes Reference

      +
      + + - - - - + + + - - - + + @@ -995,6 +1090,8 @@

      outputs.influxdb

      webOS.processMonitoring

      Config data for processMonitoring.

      +

      Lists the background/foreground applications and their process IDs that are running on webOS platform.

      +

      For more details: https://www.webosose.org/docs/reference/ls2-api/com-webos-service-applicationmanager/#running

      errorCodeOptionalNumber -

      The error code for the failed operation.

      -       		+

      Error Code

      +       		+

      Error Text

      +       		+

      Error Description

      +
      errorTextOptionalString3Check error details -

      The reason for the failure of the operation. See the 'API Error Codes Reference' section for details.

      +

      For details of a specific error, see the API Error Codes Reference table.
      @@ -1035,6 +1132,7 @@

      webOS.processMonitoring

      webOS.webProcessSize

      Config data for webProcessSize.

      +

      Return the list of apps which the process is running and their size. For information, see com.webos.service.webappmanager/getwebprocesssize().

      diff --git a/content/en/docs/reference/ls2-api/com-webos-service-settings.html b/content/en/docs/reference/ls2-api/com-webos-service-settings.html index ab8b7eb1..7fb14d25 100644 --- a/content/en/docs/reference/ls2-api/com-webos-service-settings.html +++ b/content/en/docs/reference/ls2-api/com-webos-service-settings.html @@ -1,7 +1,7 @@ --- title: com.webos.service.settings -date: 2024-05-30 -api_level: 29 +date: 2024-10-30 +api_level: 30 weight: 290 toc: true --- diff --git a/content/en/docs/reference/ls2-api/com-webos-service-sleep.html b/content/en/docs/reference/ls2-api/com-webos-service-sleep.html index 695a2d60..60a93434 100644 --- a/content/en/docs/reference/ls2-api/com-webos-service-sleep.html +++ b/content/en/docs/reference/ls2-api/com-webos-service-sleep.html @@ -1,7 +1,7 @@ --- title: com.webos.service.sleep -date: 2024-05-27 -api_level: 29 +date: 2024-10-30 +api_level: 30 weight: 295 toc: true --- @@ -1352,7 +1352,6 @@

      Example

      # luna-send -n 1 luna://com.webos.service.sleep/shutdown/initiate '{}'

      -

       

      Response:

      { 
        "success":true
      @@ -1393,11 +1392,12 @@

      Parameters

      @@ -1427,21 +1427,14 @@

      Call Returns

      - - - - - -
      Required String -

      Reason for the shutdown. Possible reasons are:

      +

      Reason for the shutdown.

      +

      Possible values are:

        -
      • remoteKey - Power off using remote control
        • -
      • offTimer - Power off using OFF timer
        • -
      • localKey - Power off using using the devices hardware power on/off key
        • +
      • remoteKey: Power off using remote control.
        • +
      • offTimer: Power off using OFF timer.
        • +
      • localKey: Power off using using the devices hardware power on/off key.
      Required Boolean -

      Indicates the status of operation. Possible values are:

      +

      Indicates the status of operation.

      +

      Possible values are:

        -
      • true - Indicates that the operation was successful.
        • -
      • false - Indicates that the operation failed. Check  "errorText" field for details.
        • +
      • true: Successful.
        • +
      • false: Not successful. Check the method's 'Error Codes' section for failure details (errorCode and/or errorText).
      errorTextOptionalString -

      Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

      -
      @@ -1476,7 +1469,6 @@

      Example

      # luna-send -n 1 luna://com.webos.service.sleep/shutdown/machineOff '{"reason":"remoteKey"}'

      -

       

      Response:

      { 
        "returnValue":true
      @@ -1517,11 +1509,12 @@

      Parameters

      Required String -

      The reason why caller wants to reboot the system. Possible reasons are:

      +

      The reason why caller wants to reboot the system.

      +

      Possible values are:

        -
      • reset - Reboot after device was reset
        • -
      • ota - Reboot after OTA update completion
        • -
      • SwDownload - Reboot after software download
        • +
      • reset: Reboot after device was reset.
        • +
      • ota: Reboot after OTA update completion.
        • +
      • SwDownload: Reboot after software download.
      @@ -1551,21 +1544,14 @@

      Call Returns

      Required Boolean -

      Indicates the status of operation. Possible values are:

      +

      Indicates the status of operation.

      +

      Possible values are:

        -
      • true - Indicates that the operation was successful.
        • -
      • false - Indicates that the operation failed. Check  "errorText" field for details
        • +
      • true: Successful.
        • +
      • false: Not successful. Check the method's 'Error Codes' section for failure details (errorCode and/or errorText).
      - - errorText - Optional - String - -

      Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

      - -
      @@ -1600,7 +1586,6 @@

      Example

      # luna-send -n 1 luna://com.webos.service.sleep/shutdown/machineReboot '{"reason":"reset"}'

      -

       

      Response:

      { 
        "returnValue":true
      @@ -1670,21 +1655,14 @@

      Call Returns

      Required Boolean -

      Indicates the status of operation. Possible values are:

      +

      Indicates the status of operation.

      +

      Possible values are:

        -
      • true - Indicates that the operation was successful.
        • -
      • false - Indicates that the operation failed. Check "errorText" field for details
        • +
      • true: Successful.
        • +
      • false: Not successful. Check the method's 'Error Codes' section for failure details (errorCode and/or errorText).
      - - errorText - Optional - String - -

      Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

      - -
      @@ -1710,6 +1688,13 @@

      Error Codes Reference

      The clientId parameter was not provided

      + + -1 + Client not found + +

      Client is not registered.

      + + @@ -1719,7 +1704,6 @@

      Example

      # luna-send -n 1 luna://com.webos.service.sleep/shutdown/shutdownApplicationsAck '{"clientId":"/var/run/ls2/T4fb64.4"}'

      -

       

      Response:

      { 
        "returnValue":true
      @@ -1789,10 +1773,11 @@

      Call Returns

      Required Boolean -

      Indicates the status of operation. Possible values are:

      +

      Indicates the status of operation.

      +

      Possible values are:

        -
      • true - Indicates that the operation was successful.
        • -
      • false - Indicates that the operation failed. Check "errorText" field for details
        • +
      • true: Successful.
        • +
      • false: Not successful. Check the method's 'Error Codes' section for failure details (errorCode and/or errorText).
      @@ -1804,14 +1789,6 @@

      Call Returns

      This is a unique token generated for this client by this method, which should be used by the caller for acknowledging the shutdownApplications signal later.

      - - errorText - Optional - String - -

      Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

      - -
      @@ -1846,11 +1823,10 @@

      Example

      # luna-send -n 1 luna://com.webos.service.sleep/shutdown/shutdownApplicationsRegister '{"clientName":"facebook app"}'

      -

       

      Response:

      { 
        "returnValue":true,
      -   "clientId":"/var/run/ls2/T4fb64.4"
      +   "clientId":"5zUn94NP.2"
      }

      @@ -1917,21 +1893,14 @@

      Call Returns

      Required Boolean -

      Indicates the status of operation. Possible values are:

      +

      Indicates the status of operation.

      +

      Possible values are:

      - - errorText - Optional - String - -

      Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

      - - @@ -1954,7 +1923,14 @@

      Error Codes Reference

      -1 Invalid parameters -

      The clientId parameter was not provided

      +

      The clientId parameter is not provided.

      + + + + -1 + Client not found + +

      Client is not registered.

      @@ -1965,8 +1941,7 @@

      Example

      Example scenario

      -

      # luna-send -n 1 luna://com.webos.service.sleep/shutdown/shutdownServicesAck '{"clientId":"/var/run/ls2/T4fb64.5"}'

      -

       

      +

      # luna-send -n 1 luna://com.webos.service.sleep/shutdown/shutdownServicesAck '{"clientId":"5zUn94NP.2"}'

      Response:

      { 
        "returnValue":true
      @@ -2036,10 +2011,11 @@

      Call Returns

      Required Boolean -

      Indicates the status of operation. Possible values are:

      +

      Indicates the status of operation.

      +

      Possible values are:

        -
      • true - Indicates that the operation was successful.
        • -
      • false - Indicates that the operation failed. Check "errorText" field for details
        • +
      • true: Successful.
        • +
      • false: Not successful. Check the method's 'Error Codes' section for failure details (errorCode and/or errorText).
      @@ -2051,14 +2027,6 @@

      Call Returns

      This is a unique token generated for this client by this method, which should be used by the caller for acknowledging the shutdownApplications signal later.

      - - errorText - Optional - String - -

      Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

      - -
      @@ -2081,7 +2049,7 @@

      Error Codes Reference

      -1 Invalid parameters -

      The clientName parameter was not provided

      +

      The clientName parameter is not provided.

      @@ -2093,11 +2061,10 @@

      Example

      # luna-send -n 1 luna://com.webos.service.sleep/shutdown/shutdownServicesRegister '{"clientName":"facebook service"}'

      -

       

      Response:

      { 
        "returnValue":true,
      -   "clientId":"/var/run/ls2/T4fb64.5"
      +   "clientId":"5zUn94NP.2"
      }

      @@ -2789,6 +2756,142 @@

      Example

      +

      time/alarmRemove

      +
      +
      ACG: sleep.operation
      +
      Deprecated
      +
      +
        +
      • Added: API level 29
        • +
      • Deprecated: API level 30
        • +
      +
      +

      Description

      +

      Removes an alarm by id.

      +

      Parameters

      +
      + + + + + + + + + + + + + + + +
      +

      Name

      +       		+

      Required

      +       		+

      Type

      +       		+

      Description

      +
      alarmIdRequirednumberid of the alarm to be removed.
      +
      +

      Call Returns

      +
      + + + + + + + + + + + + + + + +
      +

      Name

      +       		+

      Required

      +       		+

      Type

      +       		+

      Description

      +
      returnValueRequiredBoolean +
        +
      • If the method succeeds, returnValue will contain true.
        • +
      • If the method fails, returnValue will contain false. 
        • +
      +
      +
      +

      Error Codes Reference

      +
      + + + + + + + + + + + + + +
      +

      Error Code

      +       		+

      Error Text

      +       		+

      Error Description

      +
      -1Malformed json. +

      InValid json format provided.

      +
      +
      +

      Example

      +
      +

      Example scenario

      +
      +
      +

      1. luna-send -n 1 luna://com.webos.service.sleep/time/alarmRemove '{"alarmId":10}'

      +

      Response:
      + {"returnValue":false} +

      +

      2. luna-send -n 1 luna://com.webos.service.sleep/time/alarmRemove '{"alarmId":29}'

      +


      + Response:
      + {"returnValue":true} +

      +

      3. luna-send -n 1 luna://com.webos.service.sleep/time/alarmRemove '{"alarmId":""}'

      +

      Response:
      + {"returnValue":false} +

      +

      4. luna-send -n 1 luna://com.webos.service.sleep/time/alarmRemove '{}'

      +

      Response:
      + {"returnValue":false} +

      +

      5. luna-send -n 1 luna://com.webos.service.sleep/time/alarmRemove '{""}'

      +

      Response:
      + {"returnValue":false, "errorCode":-1,"errorText":"Malformed json."} +

      +

      6. luna-send -n 1 luna://com.webos.service.sleep/time/alarmRemove '{''}'

      +

      Response:
      + {"returnValue":false} +

      +

      7. luna-send -n 1 luna://com.webos.service.sleep/time/alarmRemove '{[]}'

      +

      Response:
      + {"returnValue":false, "errorCode":-1,"errorText":"Malformed json."} +

      +

      8. luna-send -n 1 luna://com.webos.service.sleep/time/alarmRemove '{"key":"k1"}'

      +

      Response:
      + {"returnValue":false} +

      +
      +

      time/internalAlarmFired

      ACG: sleep.operation
      @@ -2798,7 +2901,7 @@

      time/internalAlarmFired

      Description

      - Called when a RTC alarm is fired. +

      Called when an RTC alarm is fired.

      Parameters

      None

      Example

      @@ -2871,10 +2974,11 @@

      Call Returns

      Required Boolean -

      Indicates the status of operation. Possible values are:

      +

      Indicates the status of operation. 

      +

      Possible values are:

      @@ -2886,14 +2990,6 @@

      Call Returns

      Unique identifier for the alarm

      - - errorText - Optional - String - -

      Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

      - - @@ -2934,11 +3030,7 @@

      Example

      Example scenario

      -

      # luna-send -n 1 luna://com.webos.service.sleep/timeout/clear '{
      -        "key":"com.webos.service.activitymanager.wakeup"
      - }' -

      -

       

      +

      # luna-send -n 1 luna://com.webos.service.sleep/timeout/clear '{"key":"com.webos.service.activitymanager.wakeup"}'

      Response:

      {
          "returnValue":true,
      @@ -3073,16 +3165,17 @@

      Call Returns

      Required Boolean -

      Indicates the status of operation. Possible values are:

      +

      Indicates the status of operation.

      +

      Possible values are:

        -
      • true - Indicates that the operation was successful.
        • -
      • false - Indicates that the operation failed. 
        • +
      • true: Successful.
        • +
      • false: Not successful. Check the method's 'Error Codes' section for failure details (errorCode and/or errorText).
      key - Required + Optional String

      Unique key used to identify the alarm

      @@ -3096,14 +3189,6 @@

      Call Returns

      If the existing alarms have been kept

      - - errorText - Optional - String - -

      Indicates the reason for the failure of the operation.

      - -
      @@ -3122,6 +3207,13 @@

      Error Codes Reference

      Error Description

      + + None + Invalid format for 'timeout/set' + +

      Invalid format of parameters.

      + + -1 Malformed JSON object @@ -3145,7 +3237,6 @@

      Example

            "wakeup":true
      }'

      -

       

      Response:

      {
          "returnValue":true,
      diff --git a/content/en/docs/reference/ls2-api/com-webos-service-systemservice.html b/content/en/docs/reference/ls2-api/com-webos-service-systemservice.html index a1f03a56..f1b92120 100644 --- a/content/en/docs/reference/ls2-api/com-webos-service-systemservice.html +++ b/content/en/docs/reference/ls2-api/com-webos-service-systemservice.html @@ -1,7 +1,7 @@ --- title: com.webos.service.systemservice -date: 2024-05-30 -api_level: 29 +date: 2024-10-30 +api_level: 30 weight: 310 toc: true --- @@ -1805,21 +1805,14 @@

      Call Returns

      Required Boolean -

      Indicates the status of operation. Possible values are:

      +

      Indicates the status of operation.

      +

      Possible values are:

      - - errorText - Optional - String - -

      Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

      - - @@ -1839,28 +1832,28 @@

      Error Codes Reference

      - None + 100 input file specification doesn't support non-local files (use file:///path/file or /path/file format

      input file specification does not support non-local files (use file:///path/file or /path/file format)

      - None + 101 source file name missing.

      Can not find file at current path

      - None + 102 Unable to add ringtone.

      Failed to copy ringtone to media partition.

      - None + 103 Source file doesn't exist

      Note: The ringtone file needs to be copied manually to the target first.

      @@ -1948,21 +1941,14 @@

      Call Returns

      Required Boolean -

      Indicates the status of operation. Possible values are:

      +

      Indicates the status of operation.

      +

      Possible values are:

      - - errorText - Optional - String - -

      Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

      - - @@ -1982,21 +1968,21 @@

      Error Codes Reference

      - None + 100 file doesn't exist

      Specified file doesn't exist

      - None + 101 source file name missing.

      specified file to path does not contain the name of file (for example "foo/bar/" but not "foo/bar.mp3")

      - None + 102 Unable to delete ringtone.

      Note: The ringtone file must be present in the location

      @@ -5061,9 +5047,12 @@

      Example

      wallpaper/convert

      ACG: systemsettings.management
      +
      Retired
      • Added: API level 11
        • +
      • Deprecated: API level 30
        • +
      • Retired: API level 30

      Description

      @@ -5302,9 +5291,12 @@

      Example

      wallpaper/deleteWallpaper

      ACG: systemsettings.management
      +
      Retired
      • Added: API level 11
        • +
      • Deprecated: API level 30
        • +
      • Retired: API level 30

      Description

      @@ -5468,9 +5460,12 @@

      Example

      wallpaper/importWallpaper

      ACG: systemsettings.management
      +
      Retired
      • Added: API level 11
        • +
      • Deprecated: API level 30
        • +
      • Retired: API level 30

      Description

      @@ -5536,6 +5531,8 @@

      Description

      +

       

      +

       

      Parameters

      @@ -5745,9 +5742,12 @@

      Example

      wallpaper/info

      ACG: systemsettings.management
      +
      Retired
      • Added: API level 11
        • +
      • Deprecated: API level 30
        • +
      • Retired: API level 30

      Description

      @@ -5905,9 +5905,12 @@

      Example

      wallpaper/refresh

      ACG: systemsettings.management
      +
      Retired
      • Added: API level 11
        • +
      • Deprecated: API level 30
        • +
      • Retired: API level 30

      Description

      diff --git a/content/en/docs/reference/ls2-api/com-webos-service-videooutput.html b/content/en/docs/reference/ls2-api/com-webos-service-videooutput.html index 50fbc193..44c311e7 100644 --- a/content/en/docs/reference/ls2-api/com-webos-service-videooutput.html +++ b/content/en/docs/reference/ls2-api/com-webos-service-videooutput.html @@ -1,7 +1,7 @@ --- title: com.webos.service.videooutput -date: 2024-05-27 -api_level: 29 +date: 2024-10-30 +api_level: 30 weight: 346 toc: true --- diff --git a/content/en/docs/reference/ls2-api/com-webos-service-wifi.html b/content/en/docs/reference/ls2-api/com-webos-service-wifi.html index 83ccd1f5..a6d2062c 100644 --- a/content/en/docs/reference/ls2-api/com-webos-service-wifi.html +++ b/content/en/docs/reference/ls2-api/com-webos-service-wifi.html @@ -1,7 +1,7 @@ --- title: com.webos.service.wifi -date: 2024-05-27 -api_level: 29 +date: 2024-10-30 +api_level: 30 weight: 360 toc: true --- @@ -57,29 +57,12 @@

      Call Returns

      - - - - - - - - - - - - @@ -101,32 +84,10 @@

      Error Codes Reference

      - - + + - - - - - - - - - - - - - - - @@ -180,29 +141,12 @@

      Call Returns

      - - - - - - - - - - - - @@ -224,26 +168,10 @@

      Error Codes Reference

      - - + + - - - - - - - - - - @@ -332,29 +260,14 @@

      Call Returns

      - - - - - - - - - - - -
      Required Boolean +

      Indicates status of method execution.

      +

      Possible values are:

        -
      • If the method succeeds, returnValue will contain true.
        • -
      • If the method fails, returnValue will contain false. 
        • +
      • true: Successful.
        • +
      • false: Not successful. Check the method's 'Error Codes' section for failure details (errorCode and/or errorText).
      -

      The method may fail because of one the error conditions described in the Error Codes Reference table of this method. See the Error Code Reference table for more information.

      -
      errorCodeOptionalNumber -

      errorCode contains the error code if the method fails. The method will return errorCode only if it fails.

      -

      See the Error Codes Reference of this method for more details.

      -
      errorTextOptionalString -

      errorText contains the error text if the method fails. The method will return errorText only if it fails.

      -

      See the Error Codes Reference of this method for more details.
      4Connman service unavailable4, 5, 106, 107Check error details -

      Error when webos-connman-adapter is not able to commmunicate with the connman daemon.

      -
      5WiFi technology unavailable -

      Error when the Wi-Fi technology is not available.

      -

      This could occur either because the wpa-supplicant daemon is not running, or connman is not able to communicate with wpa-supplicant or the device does not have Wi-Fi support.

      -
      106No service is connecting currently -

      There is no connection in progress, so this error indicates there is no connection to cancel.

      -
      107Failed to disconnect currently connecting service -

      Not able to disconnect currently connecting service due to unknown reasons.

      +

      For details of a specific error, see the 'API Error codes Reference' table.
      Required Boolean +

      Indicates status of method execution.

      +

      Possible values are:

        -
      • If the method succeeds, returnValue will contain true.
        • -
      • If the method fails, returnValue will contain false. 
        • +
      • true: Successful.
        • +
      • false: Not successful. Check the method's 'Error Codes' section for failure details (errorCode and/or errorText).
      -

      The method may fail because of one the error conditions described in the Error Codes Reference table of this method. See the Error Code Reference table for more information. 

      -
      errorCodeOptionalNumber -

      errorCode contains the error code if the method fails. The method will return errorCode only if it fails.

      -

      See the Error Codes Reference of this method for more details.

      -
      errorTextOptionalString -

      errorText contains the error text if the method fails. The method will return errorText only if it fails.

      -

      See the Error Codes Reference of this method for more details.
      4Connman service unavailable4, 5, 110Check error details -

      Error when webos-connman-adapter is not able to communicate with the connman daemon.

      -
      5WiFi technology unavailable -

      Error when the Wi-Fi technology is not available
      - This could happen either because the wpa-supplicant daemon is not running, or connman is not able to communicate with wpa-supplicant or the device does not have Wi-Fi support. -

      -
      110Error in cancelling WPS connection -

      Error in the actual call for cancelling the WPS connection process.

      +

      For details of a specific error, see the 'API Error codes Reference' table.
      Required Boolean -

      Indicates the status of operation. Possible values are:

      +

      Indicates the status of operation.

      +

      Possible values are:

        -
      • true - Indicates that the operation was successful.
        • -
      • false - Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details
        • +
      • true: Successful.
        • +
      • false: Not successful. Check the method's 'Error Codes' section for failure details (errorCode and/or errorText).
      errorCodeOptionalNumber -

      The error code for the failed operation.

      -
      errorTextOptionalString -

      Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

      -
      @@ -374,32 +287,10 @@

      Error Codes Reference

      - 1 - Unknown error - -

      Some unknown error in changing the passkey.

      - - - - 4 - Connman service unavailable - -

      Error when webos-connman-adapter is not able to talk to the connman daemon.

      - - - - 5 - WiFi technology unavailable - -

      Error when the Wi-Fi technology is not available.

      -

      This could happen either because the wpa-supplicant daemon is not running, connman is not able to communicate with wpa-supplicant or the device does not have Wi-Fi support.

      - - - - 105 - Profile not found + 1, 4, 5, 105 + Check error details -

      Profile with the given profileId was not found.

      +

      For details of a specific error, see the 'API Error codes Reference' table.

      @@ -523,29 +414,14 @@

      Call Returns

      Required Boolean -

      Indicates the status of operation. Possible values are:

      +

      Indicates the status of operation. 

      +

      Possible values are:

        -
      • true - Indicates that the operation was successful.
        • -
      • false - Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details
        • +
      • true: Successful.
        • +
      • false: Not successful. Check the method's 'Error Codes' section for failure details (errorCode and/or errorText).
      - - errorCode - Optional - Number - -

      The error code for the failed operation.

      - - - - errorText - Optional - String - -

      Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

      - -
      @@ -565,32 +441,10 @@

      Error Codes Reference

      - 1 - Unknown error + 1, 4, 5 + Check error details -

      Connect failed due to unknown reasons.

      - - - - 3 - Invalid Parameters - -

      Error when neither the parameter SSID nor profileId was specified in the connect method call.

      - - - - 4 - Connman service unavailable - -

      Error when webos-connman-adapter is not able to communicate to the connman daemon.

      - - - - 5 - WiFi technology unavailable - -

      Error when the Wi-Fi technology is not available.

      -

      This could happen either because the wpa-supplicant daemon is not running, connman is not able to communicate with wpa-supplicant or the device doesn't have Wi-Fi support.

      +

      For details of a specific error, see the 'API Error codes Reference' table.

      @@ -717,29 +571,12 @@

      Call Returns

      Required Boolean +

      Indicates status of method execution.

      +

      Possible values are:

        -
      • If the method succeeds, returnValue will contain true.
        • -
      • If the method fails, returnValue will contain false. 
        • +
      • true: Successful.
        • +
      • false: Not successful. Check the method's 'Error Codes' section for failure details (errorCode and/or errorText).
      -

      The method may fail because of one the error conditions described in the Error Codes Reference table of this method. See the Error Code Reference table for more information. 

      - - - - errorCode - Optional - Number - -

      errorCode contains the error code if the method fails. The method will return errorCode only if it fails.

      -

      See the Error Codes Reference of this method for more details.

      - - - - errorText - Optional - String - -

      errorText contains the error text if the method fails. The method will return errorText only if it fails.

      -

      See the Error Codes Reference of this method for more details.

      @@ -761,33 +598,10 @@

      Error Codes Reference

      - 1 - Unknown error - -

      An internal error occurred when parsing the JSON object being prepared as a response (extremely unlikely).

      - - - - 4 - Connman service unavailable - -

      Error when webos-connman-adapter is not able to communicate with the connman daemon.

      - - - - 5 - WiFi technology unavailable - -

      Error when the Wi-Fi technology is not available.
      - This could happen either because the wpa-supplicant daemon is not running, or connman is not able to communicate with wpa-supplicant or the device does not have Wi-Fi support. -

      - - - - 109 - Error in generating wps pin + 1, 4, 5, 109 + Check error details -

      Error in opening /dev/urandom for random pin generation.

      +

      For details of a specific error, see the 'API Error codes Reference' table.

      @@ -869,29 +683,14 @@

      Call Returns

      Required Boolean -

      Indicates the status of operation. Possible values are:

      +

      Indicates the status of operation. 

      +

      Possible values are:

        -
      • true - Indicates that the operation was successful.
        • -
      • false - Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details
        • +
      • true: Successful.
        • +
      • false: Not successful. Check the method's 'Error Codes' section for failure details (errorCode and/or errorText).
      - - errorCode - Optional - Number - -

      The error code for the failed operation.

      - - - - errorText - Optional - String - -

      Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

      - -
      @@ -911,25 +710,10 @@

      Error Codes Reference

      - 4 - Connman service unavailable - -

      Error when webos-connman-adapter is not able to communicate with the connman daemon.

      - - - - 5 - WiFi technology unavailable - -

      Error when the Wi-Fi technology is not available.

      -

      This could happen either because the wpa-supplicant daemon is not running, or connman is not able to communicate with wpa-supplicant or the device does not have Wi-Fi support.

      - - - - 105 - Profile not found + 4, 5, 105 + Check error details -

      Profile with the given profileId was not found.

      +

      For details of a specific error, see the 'API Error codes Reference' table.

      @@ -982,12 +766,12 @@

      Parameters

      Optional Boolean -

      Subscribe for notifications of change in the list of found networks. Possible values are:

      +

      Subscribe for notifications of change in the list of found networks.

      +

      Possible values are:

        -
      • true - Get notifications
        • -
      • false - Notifications are not required
        • +
      • true: Subscribed.
        • +
      • false (Default): Not subscribed.
      -

      Default value: false

      @@ -1034,10 +818,11 @@

      Call Returns

      Required Boolean -

      Indicates if subscribed to get notifications. Possible values are:

      +

      Indicates if subscribed to get notifications.

      +

      Possible values are:

        -
      • true - Subscribed for changes.
        • -
      • false - Not subscribed.
        • +
      • true: Subscribed.
        • +
      • false: Not subscribed.
      @@ -1046,29 +831,14 @@

      Call Returns

      Required Boolean -

      Indicates the status of operation. Possible values are:

      +

      Indicates the status of operation.

      +

      Possible values are:

        -
      • true - Indicates that the operation was successful.
        • -
      • false - Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details
        • +
      • true: Successful.
        • +
      • false: Not successful. Check the method's 'Error Codes' section for failure details (errorCode and/or errorText).
      - - errorCode - Optional - Number - -

      The error code for the failed operation.

      - - - - errorText - Optional - String - -

      Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

      - -
      @@ -1095,10 +865,11 @@

      Subscription Returns

      Required Boolean -

      Indicates the status of operation. Possible values are:

      +

      Indicates the status of operation. 

      +

      Possible values are:

      @@ -1115,10 +886,11 @@

      Subscription Returns

      Required Boolean -

      Indicates if subscribed to get notifications. Possible values are:

      +

      Indicates if subscribed to get notifications.

      +

      Possible values are:

      @@ -1141,32 +913,10 @@

      Error Codes Reference

      - 1 - Unknown error + 1, 4, 5, 7 + Check error details -

      An internal error occurred when parsing the JSON object being prepared as a response (extremely unlikely).

      - - - - 4 - Connman service unavailable - -

      Error when webos-connman-adapter is not able to talk to the connman daemon.

      - - - - 5 - WiFi technology unavailable - -

      Error when the Wi-Fi technology is not available.

      -

      This error can occur either because the wpa-supplicant daemon is not running, or connman is not able to communicate with wpa-supplicant or the device does not have Wi-Fi support.

      - - - - 7 - WiFi switched off - -

      Error when Wi-Fi interface is down.

      +

      For details of a specific error, see the 'API Error codes Reference' table.

      @@ -1300,7 +1050,7 @@

      Example

      getNetworks

      -
      ACG: wifi.query
      +
      ACG: wifi.privilegedquery
      • Added: API level 11
        • @@ -1331,10 +1081,11 @@

        Parameters

        Optional Boolean -

        Subscribe for notifications of change in the list of found networks. Possible values are:

        +

        Subscribe for notifications of change in the list of found networks. 

        +

        Possible values are:

          -
        • true - Get notifications
          • -
        • false - (default) Notifications are not required
          • +
        • true: Subscribed.
          • +
        • false (Default): Not subscribed.
        @@ -1372,38 +1123,24 @@

        Call Returns

        Required Boolean -

        Indicates the status of operation. Possible values are:

        +

        Indicates the status of operation. 

        +

        Possible values are:

          -
        • true - Indicates that the operation was successful.
          • -
        • false - Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details
          • +
        • true: Successful.
          • +
        • false: Not successful. Check the method's 'Error Codes' section for failure details (errorCode and/or errorText).
        - - errorCode - Optional - Number - -

        The error code for the failed operation

        - - - - errorText - Optional - String - -

        Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

        - - subscribed Required Boolean -

        Indicates if subscribed to get notifications. Possible values are:

        +

        Indicates if subscribed to get notifications.

        +

        Possible values are:

          -
        • true - Subscribed for changes.
          • -
        • false - Not subscribed.
          • +
        • true: Subscribed.
          • +
        • false: Not subscribed.
        @@ -1433,10 +1170,11 @@

        Subscription Returns

        Required Boolean -

        Indicates the status of operation. Possible values are:

        +

        Indicates the status of operation. 

        +

        Possible values are:

          -
        • true - Indicates that the operation was successful.
          • -
        • false - Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details
          • +
        • true: Successful.
          • +
        • false: Not successful. Check the method's 'Error Codes' section for failure details (errorCode and/or errorText).
        @@ -1453,10 +1191,11 @@

        Subscription Returns

        Required Boolean -

        Indicates if subscribed to get notifications. Possible values are:

        +

        Indicates if subscribed to get notifications.

        +

        Possible values are:

          -
        • true - Subscribed for changes.
          • -
        • false - Not subscribed.
          • +
        • true: Subscribed.
          • +
        • false: Not subscribed.
        @@ -1479,32 +1218,10 @@

        Error Codes Reference

        - 1 - Unknown error - -

        An internal error occurred when parsing the JSON object being prepared as a response (extremely unlikely).

        - - - - 4 - Connman service unavailable - -

        Error when webos-connman-adapter is not able to communicate with the connman daemon.

        - - - - 5 - WiFi technology unavailable - -

        Error when the Wi-Fi technology is not available.

        -

        This error can occur either because the wpa-supplicant daemon is not running, connman is not able to communicate with wpa-supplicant or the device does not have Wi-Fi support.

        - - - - 7 - WiFi switched off + 1, 4, 5, 7 + Check error details -

        Error when Wi-Fi interface is down.

        +

        For details of a specific error, see the 'API Error codes Reference' table.

        @@ -1556,7 +1273,7 @@

        Example

      getprofile

      -
      ACG: wifi.query
      +
      ACG: wifi.privilegedquery
      • Added: API level 11
        • @@ -1624,29 +1341,14 @@

        Call Returns

        Required Boolean -

        Indicates the status of operation. Possible values are:

        +

        Indicates the status of operation. 

        +

        Possible values are:

          -
        • true - Indicates that the operation was successful.
          • -
        • false - Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details
          • +
        • true: Successful.
          • +
        • false: Not successful. Check the method's 'Error Codes' section for failure details (errorCode and/or errorText).
        - - errorCode - Optional - Number - -

        The error code for the failed operation.

        - - - - errorText - Optional - String - -

        Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

        - -
      @@ -1666,32 +1368,10 @@

      Error Codes Reference

      - 1 - Unknown error + 1, 4, 5, 105 + Check error details -

      An internal error occurred when parsing the JSON object being prepared as a response (extremely unlikely).

      - - - - 4 - Connman service unavailable - -

      Error when webos-connman-adapter is not able to communicate with the connman daemon.

      - - - - 5 - WiFi technology unavailable - -

      Error when the Wi-Fi technology is not available.

      -

      This could happen either because the wpa-supplicant daemon is not running, or connman is not able to communicate with wpa-supplicant or the device does not have Wi-Fi support.

      - - - - 105 - Profile not found - -

      A profile with the given profileId was not found.

      +

      For details of a specific error, see the 'API Error codes Reference' table.

      @@ -1722,7 +1402,7 @@

      Example

      getprofilelist

      -
      ACG: wifi.query
      +
      ACG: wifi.privilegedquery
      • Added: API level 11
        • @@ -1763,29 +1443,14 @@

        Call Returns

        Required Boolean -

        Indicates the status of operation. Possible values are:

        +

        Indicates the status of operation.

        +

        Possible values are:

          -
        • true - Indicates that the operation was successful.
          • -
        • false - Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details
          • +
        • true: Successful.
          • +
        • false: Not successful. Check the method's 'Error Codes' section for failure details (errorCode and/or errorText).
        - - errorCode - Optional - Number - -

        The error code for the failed operation.

        - - - - errorText - Optional - String - -

        Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

        - -
      @@ -1805,33 +1470,10 @@

      Error Codes Reference

      - 1 - Unknown error - -

      An internal error occurred when parsing the JSON object being prepared as a response (extremely unlikely).

      - - - - 4 - Connman service unavailable + 1, 4, 5, 105 + Check error details -

      Error when webos-connman-adapter is not able to communicate with the connman daemon.

      - - - - 5 - WiFi technology unavailable - -

      Error when the Wi-Fi technology is not available.

      -

      This could happen either because the wpa-supplicant daemon is not running, or connman is not able to communicate with wpa-supplicant or the device does not have Wi-Fi support.

      -

       

      - - - - 105 - Profile not found - -

      There are no stored Wi-Fi profiles on the system.

      +

      For details of a specific error, see the 'API Error codes Reference' table.

      @@ -1903,10 +1545,11 @@

      Parameters

      Optional Boolean -

      Subscribe for notifications when Wi-Fi connection status changes. Possible values are:

      +

      Subscribe for notifications when Wi-Fi connection status changes. 

      +

      Possible values are:

        -
      • true - Get notifications
        • -
      • false - (default) Notifications are not required.
        • +
      • true: Subscribed.
        • +
      • false (Default): Not subscribed.
      @@ -1936,11 +1579,12 @@

      Call Returns

      Required String -

      Indicates the status of the Wi-Fi. Possible values are:

      +

      Indicates the status of the Wi-Fi.

      +

      Possible values are:

        -
      • serviceEnabled - Wi-Fi is enabled
        • -
      • serviceDisabled - Wi-Fi is disabled
        • -
      • connectionStateChanged - Wi-Fi connection is established
        • +
      • serviceEnabled: Wi-Fi is enabled
        • +
      • serviceDisabled: Wi-Fi is disabled
        • +
      • connectionStateChanged: Wi-Fi connection is established
      @@ -1957,10 +1601,11 @@

      Call Returns

      Required Boolean -

      Indicates if subscribed to get notifications. Possible values are:

      +

      Indicates if subscribed to get notifications.

      +

      Possible values are:

        -
      • true - Subscribed for changes.
        • -
      • false - Not subscribed.
        • +
      • true: Subscribed.
        • +
      • false: Not subscribed.
      @@ -1969,29 +1614,14 @@

      Call Returns

      Required Boolean -

      Indicates the status of operation. Possible values are:

      +

      Indicates the status of operation.

      +

      Possible values are:

        -
      • true - Indicates that the operation was successful.
        • -
      • false - Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details
        • +
      • true: Successful.
        • +
      • false: Not successful. Check the method's 'Error Codes' section for failure details (errorCode and/or errorText).
      - - errorCode - Optional - Number - -

      The error code for the failed operation.

      - - - - errorText - Optional - String - -

      Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

      - -
      @@ -2073,25 +1703,10 @@

      Error Codes Reference

      - 1 - Unknown error - -

      An internal error occurred when parsing the JSON object being prepared as a response (extremely unlikely).

      - - - - 4 - Connman service unavailable - -

      Error when webos-connman-adapter is not able to communicate with the connman daemon.

      - - - - 5 - WiFi technology unavailable + 1, 4, 5 + Check error details -

      Error when the Wi-Fi technology is not available.

      -

      This could happen either because the wpa-supplicant daemon is not running, or connman is not able to communicate with wpa-supplicant or the device does not have Wi-Fi support.

      +

      For details of a specific error, see the 'API Error codes Reference' table.

      @@ -2320,29 +1935,12 @@

      Call Returns

      Required Boolean +

      Indicates status of method execution.

      +

      Possible values are:

        -
      • If the method succeeds, returnValue will contain true.
        • -
      • If the method fails, returnValue will contain false. 
        • +
      • true: Successful.
        • +
      • false: Not successful. Check the method's 'Error Codes' section for failure details (errorCode and/or errorText).
      -

      The method may fail because of one the error conditions described in the Error Codes Reference table of this method. See the Error Code Reference table for more information. 

      - - - - errorCode - Optional - Number - -

      errorCode contains the error code if the method fails. The method will return errorCode only if it fails.

      -

      See the Error Codes Reference of this method for more details.

      - - - - errorText - Optional - String - -

      errorText contains the error text if the method fails. The method will return errorText only if it fails.

      -

      See the Error Codes Reference of this method for more details.

      @@ -3389,7 +2987,7 @@

      Example

      p2p/findservice

      -
      ACG: wifi.query
      +
      ACG: wifi.privilegedquery
      • Added: API level 13
        • @@ -3581,7 +3179,7 @@

        Example

      p2p/getdevicename

      -
      ACG: wifi.query
      +
      ACG: wifi.privilegedquery
      • Added: API level 13
        • @@ -3705,7 +3303,7 @@

        Example

      p2p/getgrouppeers

      -
      ACG: wifi.query
      +
      ACG: wifi.privilegedquery
      • Added: API level 13
        • @@ -3898,7 +3496,7 @@

        Example

      p2p/getgroups

      -
      ACG: wifi.query
      +
      ACG: wifi.privilegedquery
      • Added: API level 13
        • @@ -4113,7 +3711,7 @@

        Example

      p2p/getp2prequests

      -
      ACG: wifi.query
      +
      ACG: wifi.privilegedquery
      • Added: API level 13
        • @@ -4366,7 +3964,7 @@

        Example

      p2p/getpeers

      -
      ACG: wifi.query
      +
      ACG: wifi.privilegedquery
      • Added: API level 13
        • @@ -4609,7 +4207,7 @@

        Example

      p2p/getstate

      -
      ACG: wifi.query
      +
      ACG: wifi.privilegedquery
      • Added: API level 13
        • @@ -4798,7 +4396,7 @@

        Example

      p2p/getwifidisplayinfo

      -
      ACG: wifi.query
      +
      ACG: wifi.privilegedquery
      • Added: API level 13
        • @@ -6519,29 +6117,14 @@

        Call Returns

        Required Boolean -

        Indicates the status of operation. Possible values are:

        +

        Indicates the status of operation. 

        +

        Possible values are:

          -
        • true - Indicates that the operation was successful.
          • -
        • false - Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details
          • +
        • true: Successful.
          • +
        • false: Not successful. Check the method's 'Error Codes' section for failure details (errorCode and/or errorText).
        - - errorText - Optional - String - -

        Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

        - - - - errorCode - Optional - Number - -

        The error code for the failed operation.

        - -
      @@ -6561,46 +6144,10 @@

      Error Codes Reference

      - 1 - Unknown error - -

      An internal error occurred when parsing the JSON object being prepared as a response (extremely unlikely).

      - - - - 4 - Connman service unavailable - -

      Error when webos-connman-adapter is not able to communicate with the connman daemon.

      - - - - 5 - WiFi technology unavailable - -

      Error when the Wi-Fi technology is not available.

      -

      This error can occur because the wpa-supplicant daemon is not running, connman is not able to communicate with wpa-supplicant or the device does not have Wi-Fi support.

      - - - - 7 - WiFi switched off - -

      Error when Wi-Fi interface is down.

      - - - - 108 - Error in scanning network - -

      Error occurred when trying to scan the Wi-Fi interface for networks.

      - - - - 160 - Already actively scanning for networks + 1, 4, 5, 7, 108, 160 + Check error details -

      This error is returned when the scan method is called while clients are subscribed to the findnetworks method.

      +

      For details of a specific error, see the 'API Error codes Reference' table.

      @@ -6779,12 +6326,12 @@

      Parameters

      Required String -

      Indicates whether to enable Wi-Fi. Possible values are: 

      +

      Indicates whether to enable Wi-Fi.

      +

      Possible values are:

        -
      • enabled - Enable Wi-Fi
        • -
      • disabled - Disable Wi-Fi
        • +
      • enabled: Enable Wi-Fi
        • +
      • disabled: Disable Wi-Fi
      -

      Note: Any other value will result in an error.

      @@ -6813,29 +6360,14 @@

      Call Returns

      Required Boolean -

      Indicates the status of operation. Possible values are:

      +

      Indicates the status of operation. 

      +

      Possible values are:

        -
      • true - Indicates that the operation was successful.
        • -
      • false - Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details
        • +
      • true: Successful.
        • +
      • false: Not successful. Check the method's 'Error Codes' section for failure details (errorCode and/or errorText).
      - - errorCode - Optional - Number - -

      The error code for the failed operation.

      - - - - errorText - Optional - String - -

      Indicates the reason for the failure of the operation. See the "Error Codes Reference" section of this method for details.

      - -
      @@ -6855,32 +6387,10 @@

      Error Codes Reference

      - 4 - Connman service unavailable - -

      Error when webos-connman-adapter is not able to communicate with the connman daemon.

      - - - - 5 - WiFi technology unavailable - -

      Error when the Wi-Fi technology is not available.

      -

      This could occur either because the wpa-supplicant daemon is not running, connman is not able to communicate with the wpa-supplicant or the device does not have Wi-Fi support.

      - - - - 103 - Already enabled - -

      Error message when setting the state to enabled if the Wi-Fi is already enabled.

      - - - - 104 - Already disabled + 4, 5, 103, 104 + Check error details -

      Error message when setting the state to disabled if the Wi-Fi is already disabled.

      +

      For details of a specific error, see the 'API Error codes Reference' table.

      @@ -6961,29 +6471,12 @@

      Call Returns

      Required Boolean +

      Indicates status of method execution.

      +

      Possible values are:

        -
      • If the method succeeds, returnValue will contain true.
        • -
      • If the method fails, returnValue will contain false. 
        • +
      • true: Successful.
        • +
      • false: Not successful. Check the method's 'Error Codes' section for failure details (errorCode and/or errorText).
      -

      The method may fail because of one the error conditions described in the Error Codes Reference table of this method. See the Error Code Reference table for more information. 

      - - - - errorCode - Optional - Number - -

      errorCode contains the error code if the method fails. The method will return errorCode only if it fails.

      -

      See the Error Codes Reference of this method for more details.

      - - - - errorText - Optional - String - -

      errorText contains the error text if the method fails. The method will return errorText only if it fails.

      -

      See the Error Codes Reference of this method for more details.

      @@ -7005,26 +6498,10 @@

      Error Codes Reference

      - 1 - Unknown error - -

      Error in starting the WPS authentication process.

      - - - - 4 - Connman service unavailable - -

      Error when webos-connman-adapter is not able to communicate with the connman daemon.

      - - - - 5 - WiFi technology unavailable + 1, 4, 5 + Check error details -

      Error when the Wi-Fi technology is not available.
      - This could happen either because the wpa-supplicant daemon is not running, or connman is not able to communicate with wpa-supplicant or the device does not have Wi-Fi support. -

      +

      For details of a specific error, see the 'API Error codes Reference' table.

      @@ -7154,7 +6631,7 @@

      Example

      tethering/getState

      -
      ACG: wifi.query
      +
      ACG: wifi.privilegedquery
      • Added: API level 11
        • @@ -7409,7 +6886,7 @@

        Example

      tethering/getStationCount

      -
      ACG: wifi.query
      +
      ACG: wifi.privilegedquery
      • Added: API level 11
        • @@ -9127,6 +8604,13 @@

        API Error Codes Reference

        Error Description

        + + 1 + Unknown error + +

        Some unknown error in changing the passkey.

        + + 3 Invalid parameters @@ -9134,6 +8618,28 @@

        API Error Codes Reference

        One or more parameters supplied were invalid.

        + + 4 + Connman service unavailable + +

        Error when webos-connman-adapter is not able to communicate to the connman daemon.

        + + + + 5 + WiFi technology unavailable + +

        Error when the Wi-Fi technology is not available.

        +

        This could happen either because the wpa-supplicant daemon is not running, connman is not able to communicate with wpa-supplicant, or the device doesn't have Wi-Fi support.

        + + + + 7 + WiFi switched off + +

        Error when Wi-Fi interface is down.

        + + 9 Could not validate json message against schema @@ -9141,6 +8647,69 @@

        API Error Codes Reference

        If the parameters passed to any method are not following the schema format.

        + + 103 + Already enabled + +

        Error message when setting the state to enabled if the Wi-Fi is already enabled.

        + + + + 104 + Already disabled + +

        Error message when setting the state to disabled if the Wi-Fi is already disabled.

        + + + + 105 + Profile not found + +

        Profile with the given profileId was not found.

        + + + + 106 + No service is connecting currently + +

        There is no connection in progress, so this error indicates there is no connection to cancel.

        + + + + 107 + Failed to disconnect currently connecting service + +

        Not able to disconnect currently connecting service due to unknown reasons.

        + + + + 108 + Error in scanning network + +

        Error occurred when trying to scan the Wi-Fi interface for networks.

        + + + + 109 + Error in generating wps pin + +

        Error in opening /dev/urandom for random pin generation.

        + + + + 110 + Error in cancelling WPS connection + +

        Error in the actual call for cancelling the WPS connection process.

        + + + + 160 + Already actively scanning for networks + +

        This error is returned when the scan method is called while clients are subscribed to the findnetworks method.

        + +
      diff --git a/content/en/docs/reference/ls2-api/com-webos-surfacemanager.html b/content/en/docs/reference/ls2-api/com-webos-surfacemanager.html index 7c4f3149..f727a54a 100644 --- a/content/en/docs/reference/ls2-api/com-webos-surfacemanager.html +++ b/content/en/docs/reference/ls2-api/com-webos-surfacemanager.html @@ -1,7 +1,7 @@ --- title: com.webos.surfacemanager -date: 2024-05-27 -api_level: 29 +date: 2024-10-30 +api_level: 30 weight: 370 toc: true --- diff --git a/content/en/docs/reference/ls2-api/ls2-api-index.html b/content/en/docs/reference/ls2-api/ls2-api-index.html index 08cc1f38..a41a9a3d 100644 --- a/content/en/docs/reference/ls2-api/ls2-api-index.html +++ b/content/en/docs/reference/ls2-api/ls2-api-index.html @@ -1,6 +1,6 @@ --- title: LS2 API Index -date: 2024-06-05 +date: 2024-10-30 weight: 1 toc: true --- @@ -18,6 +18,16 @@

      API Levels

      Platform Version

      Release Date

      + +

      31

      +

      webOS OSE 2.27.0

      +

      November 01, 2024

      + + +

      30

      +

      Queue (Ref. Platform)

      +

      August 30, 2024

      +

      29

      webOS OSE 2.26.0

      diff --git a/content/en/docs/reference/luna-service2-library/luna-service2-library-api-reference.html b/content/en/docs/reference/luna-service2-library/luna-service2-library-api-reference.html index c6cb0d47..d6f0cc2b 100644 --- a/content/en/docs/reference/luna-service2-library/luna-service2-library-api-reference.html +++ b/content/en/docs/reference/luna-service2-library/luna-service2-library-api-reference.html @@ -1,9 +1,8 @@ --- title: luna-service2 Library API Reference -date: 2022-05-03 +date: 2024-10-30 toc: true --- -

      API Summary

      Luna-service2 (LS2) provides a bus-based IPC mechanism used between components in webOS. It is composed of:

        @@ -13,7 +12,7 @@

        API Summary

        Overview of the API

        Sample Client Usage (calling the 'listContacts()' method from a registered service):

        -

        bool retVal;
        +

        bool retVal;
        LSError lserror;
        LSErrorInit (&lserror);
        LSMessageToken token = LSMESSAGE_TOKEN_INVALID;
        @@ -23,11 +22,12 @@

        Overview of the API

        retVal = LSCallOneReply (serviceHandle, "luna://com.webos.contacts/category/listContacts","{\"json payload\"}", listContactsHandler, userData, &token, &lserror);
        if (!retVal) goto done;
        LSGmainAttach (serviceHandle, loop, &lserror);
        - g_main_loop_run(loop);

        + g_main_loop_run(loop);         +

        Sample Service Usage

        -

        //callback
        +

        //callback
        static bool listContacts( LSHandle *sh, LSMessage *message, void *categoryContext)
        {
            bool retVal;
        @@ -50,43 +50,47 @@

        Overview of the API

        LSErrorInit (&lserror);
        LSHandle *serviceHandle = NULL;
        retVal = LSRegister ( "com.webos.contacts" , &serviceHandle, &lserror);
        - if (!retVal) goto error;

        -

        retVal = LSRegisterCategory (serviceHandle, "/category" , ipcMethods, NULL, NULL, &lserror);
        - if (!retVal) goto error;

        -

        retVal = LSCategorySetData (serviceHandle, "/category" , userData, &lserror);
        - if (!retVal) goto error;

        -

        retVal = LSGmainAttach (serviceHandle, mainLoop, &lserror);
        - if (!retVal) goto error;

        -

        g_main_loop_run(mainLoop);

        -

         

        + if (!retVal) goto error;         +

        +

        retVal = LSRegisterCategory (serviceHandle, "/category" , ipcMethods, NULL, NULL, &lserror);
        + if (!retVal) goto error;         +

        +

        retVal = LSCategorySetData (serviceHandle, "/category" , userData, &lserror);
        + if (!retVal) goto error;         +

        +

        retVal = LSGmainAttach (serviceHandle, mainLoop, &lserror);
        + if (!retVal) goto error;         +

        +

        g_main_loop_run(mainLoop);

        +

         

        Storing a message for replying in another thread.

         Queue messageQueue;
        - ...
        - static bool listContacts(LSHandle *sh, LSMessage *message)
        - {
        -     bool retVal;
        -     LSError lserror;
        -     LSErrorInit (&lserror);
        -     LSMessageRef (message);
        -     queue (messageQueue, message);
        - }
        - ...
        - void SomeOtherThread()
        - {
        -     LSError lserror;
        -     LSErrorInit (&lserror);
        -     LSMessage *message = dequeue(messageQueue);
        -     ...
        -     if (! LSMessageReply (sh, message, "{PAYLOAD IN JSON}" , lserror))
        -     {
        -         LSErrorLog (loggingCtx, msgId, &lserror);
        -         LSErrorFree (&lserror);
        -     }
        -     ....
        - }         -

        + ...
        + static bool listContacts(LSHandle *sh, LSMessage *message)
        + {
        +     bool retVal;
        +     LSError lserror;
        +     LSErrorInit (&lserror);
        +     LSMessageRef (message);
        +     queue (messageQueue, message);
        + }
        + ...
        + void SomeOtherThread()
        + {
        +     LSError lserror;
        +     LSErrorInit (&lserror);
        +     LSMessage *message = dequeue(messageQueue);
        +     ...
        +     if (! LSMessageReply (sh, message, "{PAYLOAD IN JSON}" , lserror))
        +     {
        +         LSErrorLog (loggingCtx, msgId, &lserror);
        +         LSErrorFree (&lserror);
        +     }
        +     ....
        + } +

        Type Definitions

        @@ -326,19 +330,26 @@

        Type Definitions

      + + LSProcessInfo + struct LSProcessInfo + +

      Indicates process information object.

      + +

      Enumerators

      LSMethodFlags

      -Flags are used during method definition in a category. -Can be used to enable incoming message validation against provided schema +Flags are used during method definition in a category. +Can be used to enable incoming message validation against provided schema

      LSSignalFlags

      -Flags are used during signal definition in a category. -Can be used to mark signal as deprecated +Flags are used during signal definition in a category. +Can be used to mark signal as deprecated

      LSPropertyFlags

      -Flags are used during property definition in a category. -Can be used to mark property as deprecated +Flags are used during property definition in a category. +Can be used to mark property as deprecated

      Methods

      AddWatch

      Description

      @@ -370,7 +381,7 @@

      Parameters

      Required _LSTransportChannel * - IN channel to watch + IN channel to watch @@ -378,7 +389,7 @@

      Parameters

      Required GIOCondition - IN condition to watch + IN condition to watch @@ -386,7 +397,7 @@

      Parameters

      Required GMainContext * - IN main context + IN main context @@ -394,7 +405,7 @@

      Parameters

      Required GIOFunc - IN callback when watch is triggered + IN callback when watch is triggered @@ -402,7 +413,7 @@

      Parameters

      Required void * - IN context passed to callback + IN context passed to callback @@ -410,7 +421,7 @@

      Parameters

      Required GDestroyNotify - IN callback when watch is destroyed + IN callback when watch is destroyed @@ -418,7 +429,7 @@

      Parameters

      Required GSource ** - OUT newly created watch + OUT newly created watch @@ -465,7 +476,7 @@

      Parameters

      Required LSHandle * - IN handle to service + IN handle to service @@ -473,7 +484,7 @@

      Parameters

      Required const char * - IN fully qualified path to service's method + IN fully qualified path to service's method @@ -489,7 +500,7 @@

      Parameters

      Required LSFilterFunc - IN function callback to be called when responses arrive + IN function callback to be called when responses arrive @@ -497,7 +508,7 @@

      Parameters

      Required void * - IN user data to be passed to callback + IN user data to be passed to callback @@ -505,7 +516,7 @@

      Parameters

      Required LSMessageToken * - OUT token which identifies responses to this call + OUT token which identifies responses to this call @@ -554,7 +565,7 @@

      Examples

      None

      LSCallCancel

      Description

      -Sends a cancel message to service to end call session and also unregisters any callback associated with call. +Sends a cancel message to service to end call session and also unregisters any callback associated with call.

      Syntax

      LSCallCancel(LSHandle * sh, LSMessageToken token, LSError * lserror)

      Parameters

      @@ -582,7 +593,7 @@

      Parameters

      Required LSHandle * - IN handle to service + IN handle to service @@ -590,7 +601,7 @@

      Parameters

      Required LSMessageToken - IN message token + IN message token @@ -674,7 +685,7 @@

      Parameters

      Required LSHandle * - IN handle to service + IN handle to service @@ -682,7 +693,7 @@

      Parameters

      Required LSCancelNotificationFunc - IN callback function + IN callback function @@ -690,7 +701,7 @@

      Parameters

      Required void * - IN user data to be passed to callback + IN user data to be passed to callback @@ -774,7 +785,7 @@

      Parameters

      Required LSHandle * - IN handle to service + IN handle to service @@ -782,7 +793,7 @@

      Parameters

      Required LSCancelNotificationFunc - IN callback function + IN callback function @@ -790,7 +801,7 @@

      Parameters

      Required void * - IN user data to be passed to callback + IN user data to be passed to callback @@ -872,7 +883,7 @@

      Parameters

      Required LSHandle * - IN handle to service + IN handle to service @@ -880,7 +891,7 @@

      Parameters

      Required LSCancelNotificationFunc - IN callback function + IN callback function @@ -888,7 +899,7 @@

      Parameters

      Required void * - IN user data to be passed to callback + IN user data to be passed to callback @@ -970,7 +981,7 @@

      Parameters

      Required LSHandle * - IN handle to service + IN handle to service @@ -978,7 +989,7 @@

      Parameters

      Required LSCancelNotificationFunc - IN callback function + IN callback function @@ -986,7 +997,7 @@

      Parameters

      Required void * - IN user data to be passed to callback + IN user data to be passed to callback @@ -1063,7 +1074,7 @@

      Parameters

      Required LSHandle * - IN handle to service + IN handle to service @@ -1071,7 +1082,7 @@

      Parameters

      Required const char * - IN fully qualified path to service's method + IN fully qualified path to service's method @@ -1220,7 +1231,7 @@

      Parameters

      Required LSFilterFunc - IN function callback to be called when responses arrive + IN function callback to be called when responses arrive @@ -1228,7 +1239,7 @@

      Parameters

      Required void * - IN user data to be passed to callback + IN user data to be passed to callback @@ -1236,7 +1247,7 @@

      Parameters

      Required LSMessageToken * - OUT token which identifies responses to this call + OUT token which identifies responses to this call @@ -1432,7 +1443,7 @@

      Parameters

      Required LSHandle * - IN handle to service + IN handle to service @@ -1440,7 +1451,7 @@

      Parameters

      Required LSMessageToken - IN message token + IN message token @@ -1448,7 +1459,7 @@

      Parameters

      Required int - IN timeout in ms + IN timeout in ms @@ -1530,7 +1541,7 @@

      Parameters

      Required LSHandle * - IN handle to service + IN handle to service @@ -1538,7 +1549,7 @@

      Parameters

      Required void * - IN token obtained during registration, can't be NULL + IN token obtained during registration, can't be NULL @@ -1620,7 +1631,7 @@

      Parameters

      Required LSHandle * - IN handle to service + IN handle to service @@ -1628,7 +1639,7 @@

      Parameters

      Required void * - IN token obtained during registration, can't be NULL + IN token obtained during registration, can't be NULL @@ -1706,7 +1717,7 @@

      Parameters

      Required LSHandle * - IN handle to service + IN handle to service @@ -1714,7 +1725,7 @@

      Parameters

      Required const char * - IN category name + IN category name @@ -1722,7 +1733,7 @@

      Parameters

      Required void * - IN user data to set + IN user data to set @@ -1933,7 +1944,8 @@

      Examples

                   }
               }
           }
      -  }

      +  } +

      LSErrorFree

      Description

      @@ -1966,7 +1978,7 @@

      Parameters

      Required LSError * - IN LSError structure to free + IN LSError structure to free @@ -1978,7 +1990,7 @@

      Examples

      None

      LSErrorInit

      Description

      -Initializes a LSError. +Initializes a LSError.

      Syntax

      LSErrorInit(LSError * lserror)

      Parameters

      @@ -2144,7 +2156,7 @@

      Parameters

      Required PmLogContext - IN log context + IN log context @@ -2160,7 +2172,7 @@

      Parameters

      Required LSError * - IN LSError structure to log + IN LSError structure to log @@ -2208,7 +2220,7 @@

      Parameters

      Required LSError * - IN LSError structure to log + IN LSError structure to log @@ -2248,7 +2260,7 @@

      Parameters

      Required LSError * - IN LSError structure to print + IN LSError structure to print @@ -2256,7 +2268,7 @@

      Parameters

      Required FILE * - IN handle to file + IN handle to file @@ -2296,7 +2308,7 @@

      Parameters

      Required LSHandle * - IN handle to service + IN handle to service @@ -2304,7 +2316,7 @@

      Parameters

      Required GMainLoop * - IN loop to attach + IN loop to attach @@ -2381,7 +2393,7 @@

      Parameters

      Required LSHandle * - IN handle to service + IN handle to service @@ -2389,7 +2401,7 @@

      Parameters

      Required GMainContext * - IN context + IN context @@ -2472,7 +2484,7 @@

      Parameters

      Required LSHandle * - IN handle to service + IN handle to service @@ -2549,7 +2561,7 @@

      Parameters

      Required LSHandle * - IN handle to service + IN handle to service @@ -2631,7 +2643,7 @@

      Parameters

      Required LSHandle * - IN handle to service + IN handle to service @@ -2639,7 +2651,7 @@

      Parameters

      Required int - IN priority level + IN priority level @@ -2762,7 +2774,7 @@

      Parameters

      Required unsigned int - IN time of inactivity (in ms) before callback invocation + IN time of inactivity (in ms) before callback invocation @@ -2770,7 +2782,7 @@

      Parameters

      Required void(*)(void *) - IN user callback + IN user callback @@ -2778,7 +2790,7 @@

      Parameters

      Required void * - IN user provided data, that will be passed into callback + IN user provided data, that will be passed into callback @@ -2834,7 +2846,7 @@

      Parameters

      Required const char * - IN directory where the pid file should reside + IN directory where the pid file should reside @@ -3791,7 +3803,7 @@

      Examples

      None

      LSMessageGetUniqueToken

      Description

      -Returns a string that uniquely represents this message. +Returns a string that uniquely represents this message.

      Syntax

      LSMessageGetUniqueToken(LSMessage * message)

      Parameters

      @@ -3860,7 +3872,7 @@

      Examples

      None

      LSMessageIsHubErrorMessage

      Description

      -Returns true if the message is an error message from the hub. +Returns true if the message is an error message from the hub.

      Syntax

      LSMessageIsHubErrorMessage(LSMessage * message)

      Parameters

      @@ -4044,7 +4056,7 @@

      Examples

      None

      LSMessagePrint

      Description

      -Convenience function to pretty print a message. +Convenience function to pretty print a message.

      Syntax

      LSMessagePrint(LSMessage * message, FILE * out)

      Parameters

      @@ -4072,7 +4084,7 @@

      Parameters

      Required LSMessage * - IN message to print + IN message to print @@ -4154,7 +4166,7 @@

      Parameters

      Required LSMessage * - IN message to ref + IN message to ref @@ -4195,7 +4207,7 @@

      Parameters

      Required LSHandle * - IN handle to service + IN handle to service @@ -4203,7 +4215,7 @@

      Parameters

      Required LSMessage * - IN message + IN message @@ -4288,7 +4300,7 @@

      Parameters

      Required LSMessage * - IN message + IN message @@ -4296,7 +4308,7 @@

      Parameters

      Required const char * - IN payload to send + IN payload to send @@ -4373,7 +4385,7 @@

      Parameters

      Required LSMessage * - IN message + IN message @@ -4381,7 +4393,7 @@

      Parameters

      Required LSPayload * - IN payload to send + IN payload to send @@ -4459,7 +4471,7 @@

      Parameters

      Required LSMessage * - IN message to unref + IN message to unref @@ -4504,7 +4516,7 @@

      Parameters

      Required LSHandle * - IN handle to service + IN handle to service @@ -4512,7 +4524,7 @@

      Parameters

      Required const char * - IN category name + IN category name @@ -4520,7 +4532,7 @@

      Parameters

      Required const char * - IN method name + IN method name @@ -4528,7 +4540,7 @@

      Parameters

      Required void * - IN user data to set + IN user data to set @@ -5274,7 +5286,7 @@

      Parameters

      Required LSHandle * - IN handle (already connected with LSRegister()) + IN handle (already connected with LSRegister()) @@ -5282,7 +5294,7 @@

      Parameters

      Required const char * - IN full path to role file + IN full path to role file @@ -5364,7 +5376,7 @@

      Parameters

      Required const char * - IN service name + IN service name @@ -5450,7 +5462,7 @@

      Parameters

      Required const char * - IN service name + IN service name @@ -5458,7 +5470,7 @@

      Parameters

      Required const char * - IN application Id + IN application Id @@ -5543,7 +5555,7 @@

      Parameters

      Required LSHandle * - IN handle to service + IN handle to service @@ -5551,7 +5563,7 @@

      Parameters

      Required const char * - IN may be NULL for default '/' category. + IN may be NULL for default '/' category. @@ -5559,7 +5571,7 @@

      Parameters

      Required LSMethod * - IN table of methods. + IN table of methods. @@ -5567,7 +5579,7 @@

      Parameters

      Required LSSignal * - IN table of signals. + IN table of signals. @@ -5575,7 +5587,7 @@

      Parameters

      Required LSProperty * - IN table of properties. + IN table of properties. @@ -5652,7 +5664,7 @@

      Parameters

      Required LSHandle * - IN handle to service + IN handle to service @@ -5660,7 +5672,7 @@

      Parameters

      Required const char * - IN category name + IN category name @@ -5668,7 +5680,7 @@

      Parameters

      Required LSMethod * - IN array of methods + IN array of methods @@ -5676,7 +5688,7 @@

      Parameters

      Required LSSignal * - IN array of signals + IN array of signals @@ -5754,7 +5766,7 @@

      Parameters

      Required LSHandle * - IN handle to service + IN handle to service @@ -5762,7 +5774,7 @@

      Parameters

      Required const char * - IN service name to monitor for connect/disconnect. + IN service name to monitor for connect/disconnect. @@ -5770,7 +5782,7 @@

      Parameters

      Required LSServerStatusFunc - IN function callback + IN function callback @@ -5786,7 +5798,7 @@

      Parameters

      Required void ** - OUT token to use for to unregister the callback + OUT token to use for to unregister the callback @@ -5864,7 +5876,7 @@

      Parameters

      Required LSHandle * - IN handle to service + IN handle to service @@ -5872,7 +5884,7 @@

      Parameters

      Required const char * - IN service name to monitor for connect/disconnect. + IN service name to monitor for connect/disconnect. @@ -5880,7 +5892,7 @@

      Parameters

      Required LSServerStatusFunc - IN function callback + IN function callback @@ -5888,7 +5900,7 @@

      Parameters

      Required void * - IN user data to be passed to callback + IN user data to be passed to callback @@ -5896,7 +5908,7 @@

      Parameters

      Required void ** - OUT token to use for to unregister the callback + OUT token to use for to unregister the callback @@ -5973,7 +5985,7 @@

      Parameters

      Required LSHandle * - IN handle to service + IN handle to service @@ -5981,7 +5993,7 @@

      Parameters

      Required LSDisconnectHandler - IN function callback + IN function callback @@ -5989,7 +6001,7 @@

      Parameters

      Required void * - IN user data to be passed to callback + IN user data to be passed to callback @@ -6066,7 +6078,7 @@

      Parameters

      Required LSHandle * - IN handle to service + IN handle to service @@ -6074,7 +6086,7 @@

      Parameters

      Required const char * - IN fully qualified path to service's method + IN fully qualified path to service's method @@ -6159,7 +6171,7 @@

      Parameters

      Required LSHandle * - IN handle to service + IN handle to service @@ -6167,7 +6179,7 @@

      Parameters

      Required const char * - IN key + IN key @@ -6226,7 +6238,8 @@

      LSSubscriptionAdd

      Description

      Adds a subscription to a list associated with 'key'.

      Note: The call may fail if the client has been disconnected. However, if the call succeeds, the code can install callback to get notification about client       
      -           disconnection or call cancel via LSSubscriptionSetCancelFunction().

      +           disconnection or call cancel via LSSubscriptionSetCancelFunction(). +

      Syntax

      LSSubscriptionAdd(LSHandle * sh, const char * key, LSMessage * message, LSError * lserror)

      Parameters

      @@ -6254,7 +6267,7 @@

      Parameters

      Required LSHandle * - IN handle to service + IN handle to service @@ -6262,7 +6275,7 @@

      Parameters

      Required const char * - IN key + IN key @@ -6270,7 +6283,7 @@

      Parameters

      Required LSMessage * - IN message object + IN message object @@ -6401,7 +6414,7 @@

      Examples

      None

      LSSubscriptionHasNext

      Description

      -Returns whether there is a next item in subscription. +Returns whether there is a next item in subscription.

      Syntax

      LSSubscriptionHasNext(LSSubscriptionIter * iter)

      Parameters

      @@ -6566,7 +6579,7 @@

      Parameters

      Required LSHandle * - IN service handle + IN service handle @@ -6574,7 +6587,7 @@

      Parameters

      Required LSMessage * - IN message object + IN message object @@ -6631,7 +6644,7 @@

      Examples

      None

      LSSubscriptionRelease

      Description

      -Frees up resources for LSSubscriptionIter. +Frees up resources for LSSubscriptionIter.

      Syntax

      LSSubscriptionRelease(LSSubscriptionIter * iter)

      Parameters

      @@ -6659,7 +6672,7 @@

      Parameters

      Required LSSubscriptionIter * - IN Subscription iterator to free + IN Subscription iterator to free @@ -6699,7 +6712,7 @@

      Parameters

      Required LSSubscriptionIter * - IN Subscription iterator + IN Subscription iterator @@ -6711,7 +6724,7 @@

      Examples

      None

      LSSubscriptionReply

      Description

      -Sends a message to subscription list with name 'key'. +Sends a message to subscription list with name 'key'.

      Syntax

      LSSubscriptionReply(LSHandle * sh, const char * key, const char * payload, LSError * lserror)

      Parameters

      @@ -6739,7 +6752,7 @@

      Parameters

      Required LSHandle * - IN handle to service + IN handle to service @@ -6747,7 +6760,7 @@

      Parameters

      Required const char * - IN key + IN key @@ -6837,7 +6850,7 @@

      Parameters

      Required LSHandle * - IN handle to service + IN handle to service @@ -6845,7 +6858,7 @@

      Parameters

      Required LSFilterFunc - IN callback function + IN callback function @@ -6853,7 +6866,7 @@

      Parameters

      Required void * - IN user data to be passed to callback + IN user data to be passed to callback @@ -6930,7 +6943,7 @@

      Parameters

      Required LSHandle * - IN handle to service + IN handle to service @@ -7007,7 +7020,7 @@

      Parameters

      Required _LSTransportChannel * - IN channel that watch is on + IN channel that watch is on @@ -7015,7 +7028,7 @@

      Parameters

      Required GSource ** - IN/OUT watch (set to NULL after destroying) + IN/OUT watch (set to NULL after destroying) @@ -7100,7 +7113,7 @@

      Description

      This API facilitates proxy luna calls.

      Note: It is valid only for services that wish to act as mediators.

      Syntax

      -
      LSCallProxy(typedef LSHandle sh, const char * callee_exe, const char * callee_id	, const char * callee_name, const char * uri, const char * payload, typedef LSFilterFunc callback, void * ctx, typedef LSMessageToken ret_token, struct LSError * lserror)
      +
      LSCallProxy(typedef LSHandle sh, const char * callee_exe, const char * callee_id, const char * callee_name, const char * uri, const char * payload, typedef LSFilterFunc callback, void * ctx, typedef LSMessageToken ret_token, struct LSError * lserror)

      Parameters

      @@ -7138,7 +7151,7 @@

      Parameters

      - +
      callee_id callee_id Required const char * @@ -7750,4 +7763,4 @@

      Returns

      Examples

      -

      None

      +

      None

      \ No newline at end of file diff --git a/content/en/docs/tools/sdk/cli/cli-release-notes.md b/content/en/docs/tools/sdk/cli/cli-release-notes.md index da981e9c..34a334f0 100644 --- a/content/en/docs/tools/sdk/cli/cli-release-notes.md +++ b/content/en/docs/tools/sdk/cli/cli-release-notes.md @@ -1,7 +1,7 @@ --- title: Release Notes display_title: Command-Line Interface Release Notes -date: 2024-09-10 +date: 2024-10-30 weight: 20 toc: true two_depth_toc: true @@ -42,7 +42,10 @@ The following table shows the compatibility between webOS OSE and CLI. -

      3.1.0
      3.0.2

      +

      3.0.2 or later

      +

      2.27.0

      + +

      2.26.0

      diff --git a/content/en/docs/tools/sdk/emulator/virtualbox-emulator/emulator-user-guide.md b/content/en/docs/tools/sdk/emulator/virtualbox-emulator/emulator-user-guide.md index 351ee3e2..caef8bb7 100644 --- a/content/en/docs/tools/sdk/emulator/virtualbox-emulator/emulator-user-guide.md +++ b/content/en/docs/tools/sdk/emulator/virtualbox-emulator/emulator-user-guide.md @@ -1,7 +1,7 @@ --- title: User Guide display_title: VirtualBox Emulator User Guide -date: 2024-07-26 +date: 2024-10-14 weight: 10 toc: true --- @@ -107,7 +107,7 @@ Download the same version of Extension Pack as your installed version of Virtual Build the webOS OSE image for the emulator in [Building webOS OSE]({{< relref "building-webos-ose" >}}). * Make sure you set up the build for the emulator at the [configuration step]({{< relref "building-webos-ose#configuring-the-build" >}}). -* After the build is completed, check that the resulting image (`webos-image-qemux86-64-master-*.wic.vmdk`) has been created properly. +* After the build is completed, check that the resulting image (`webos-image-qemux86-64-master-*.wic.vmdk.gz`) has been created properly. ## Setting Up the Virtual Machine in VirtualBox @@ -308,7 +308,7 @@ vboxmanage setextradata webos-image GUI/ScaleFactor To attach the webOS OSE emulator image (`.vmdk`) to the virtual machine, type: ```shell -vboxmanage storageattach webos-image --storagectl webos-image --type hdd --port 0 --device 0 --medium +vboxmanage storageattach webos-image --storagectl webos-image --type hdd --port 0 --device 0 --medium ``` To launch the virtual machine, type the following in a command shell: diff --git a/content/en/docs/tools/sdk/vs-code-extension.md b/content/en/docs/tools/sdk/vs-code-extension.md index ce6f693c..f0e40751 100644 --- a/content/en/docs/tools/sdk/vs-code-extension.md +++ b/content/en/docs/tools/sdk/vs-code-extension.md @@ -1,6 +1,6 @@ --- title: webOS Studio - VS Code Extension -date: 2024-07-26 +date: 2024-11-04 weight: 30 toc: true --- @@ -367,7 +367,7 @@ Type `new LS2Request` to use [Enact webos Library](https://enactjs.com/docs/modu

    11. The config file is generated in your project folder. You can check the API level in the config file.

      Generated config file -

      If the API level in the config file is not supported by the current profile, an error notification will be displayed. Currently supported API levels in the OSE profile are 20, 21, 22, 23, 24, 25, 27, 28, 29. See also, API Levels

      +

      If the API level in the config file is not supported by the current profile, an error notification will be displayed. Currently supported API levels in the OSE profile are 20-25, 27-29, and 31. See also, API Levels

      Error pop-up for mismatch between API level and the current profile