Disable gtk-doc since the build fails
[profile/ivi/node-startup-controller.git] / common / nsm-lifecycle-control-dbus.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <node>
3   <!--
4     org.genivi.NodeStateManager.LifecycleControl:
5     @short_description: Interface for testing the interaction between the
6                         Node Startup Controller and the Node State Manager.
7                         It is an excerpt of
8                         "org.genivi.NodeStateManager.LifecycleControl"
9                         using only the methods needed to test the NSC.
10   -->
11   <interface name="org.genivi.NodeStateManager.LifecycleControl">
12     <!--
13       SetNodeState:
14       @NodeStateId: The passed value will be based upon the enum
15                     NSM_NodeState_e
16       @ErrorCode:
17
18       The method is used by other applications to set the NodeState. When
19       this method is called to change the current NodeState a signal will be
20       sent to notify registered consumers of the new state
21     -->
22     <method name="SetNodeState">
23       <arg name="NodeStateId" direction="in" type="i"/>
24       <arg name="ErrorCode" direction="out" type="i"/>
25     </method>
26
27     <!--
28       CheckLucRequired:
29       @LucWanted: This will be a simple TRUE or FALSE to define whether the LUC
30                   is wanted in the current Lifecycle
31
32       This method will be called exclusivley by the Node Startup Controller
33       to find out whether the LUC applications should be started in the
34       current lifecycle. This is required whilst in certain Node Application
35       Modes (i.e. Transport, Factory) we do not want the LUC applications
36       started.
37     -->
38     <method name="CheckLucRequired">
39       <arg name="LucWanted" direction="out" type="b"/>
40     </method>
41
42   </interface>
43 </node>