protocol/webos-system-ux.xml

<?xml version="1.0" encoding="UTF-8"?>
<protocol name="webos_system_ux">

    <copyright>
      Copyright (c) 2023 LG Electronics, Inc.

      Licensed under the Apache License, Version 2.0 (the "License");
      you may not use this file except in compliance with the License.
      You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0

      Unless required by applicable law or agreed to in writing, software
      distributed under the License is distributed on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      See the License for the specific language governing permissions and
      limitations under the License.
    </copyright>

    <interface name="wl_webos_system_ux" version="1">
      <description summary="api to open sustem ui apps"/>

      <event name="open">
        <description summary="open system ux"/>
        <arg name="app" type="string" summary="name of system ux app"/>
        <arg name="windowType" type="string" summary="name of system ux window type"/>
        <arg name="params" type="string" summary="parameter of system ux app"/>
      </event>

      <request name="opened">
          <description summary="report opened state of the system ux"/>
          <arg name="app" type="string" summary="app name of system ux"/>
      </request>

      <event name="close">
        <description summary="close system ux"/>
        <arg name="app" type="string" summary="name of system ux app"/>
      </event>

      <request name="closed">
          <description summary="report closed state of the system ux"/>
          <arg name="app" type="string" summary="app name of system ux"/>
      </request>

      <request name="request_focus">
          <description summary="request focus"/>
          <arg name="name" type="string"/>
      </request>

      <request name="release_focus">
          <description summary="release focus"/>
          <arg name="name" type="string"/>
      </request>

      <event name="notify">
        <description summary="notify general event to system ux app"/>
        <arg name="action" type="string" summary="name of event action"/>
        <arg name="windowType" type="string" summary="name of system ux window type"/>
        <arg name="params" type="string" summary="event data of system ux app"/>
      </event>

      <request name="invoke">
        <description summary="invoke general request of the system ux"/>
        <arg name="action" type="string" summary="name of request action"/>
        <arg name="windowType" type="string" summary="name of system ux window type"/>
        <arg name="params" type="string" summary="request data of system ux app"/>
      </request>

    </interface>


</protocol>