summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndriy Melnik <AMelnik@luxoft.com>2014-09-12 10:56:45 +0300
committerAndriy Melnik <AMelnik@luxoft.com>2014-09-12 10:56:58 +0300
commit5dfaea625910c5219fbac3f7e8097eed5b43bc24 (patch)
tree2a533efeb33907de83f683a02d18c59a4b8936f5
parentc86a0dcf4beba40e17d8356551be42e340bf513a (diff)
downloadsdl_core-5dfaea625910c5219fbac3f7e8097eed5b43bc24.tar.gz
APPLINK-8603: changes in description in HMI API
-rw-r--r--src/components/interfaces/HMI_API.xml10
-rw-r--r--src/components/interfaces/QT_HMI_API.xml10
2 files changed, 16 insertions, 4 deletions
diff --git a/src/components/interfaces/HMI_API.xml b/src/components/interfaces/HMI_API.xml
index a8a30b9787..4ad1bfff27 100644
--- a/src/components/interfaces/HMI_API.xml
+++ b/src/components/interfaces/HMI_API.xml
@@ -1874,7 +1874,10 @@
<description>Must be provided if ButtonName is CUSTOM_BUTTON, this references the integer ID passed by a custom button. (e.g. softButtonName)</description>
</param>
<param name="appID" type="Integer" mandatory="false">
- <description>ID of the application.</description>
+ <description>
+ In case the ButtonName is CUSTOM_BUTTON, HMI must include appID parameters to OnButtonPress notification sent to SDL.
+ Otherwise, if appID is not sent together with CUSTOM_BUTTON, this notification will be ignored by SDL.
+ </description>
</param>
</function>
<function name="OnButtonPress" messagetype="notification">
@@ -1886,7 +1889,10 @@
<description>Must be returned if ButtonName is CUSTOM_BUTTON, this references the string passed by a custom button. (e.g. softButtonName)</description>
</param>
<param name="appID" type="Integer" mandatory="false">
- <description>ID of the application.</description>
+ <description>
+ In case the ButtonName is CUSTOM_BUTTON, HMI must include appID parameters to OnButtonEvent notification sent to SDL.
+ Otherwise, if appID is not sent together with CUSTOM_BUTTON, this notification will be ignored by SDL.
+ </description>
</param>
</function>
</interface>
diff --git a/src/components/interfaces/QT_HMI_API.xml b/src/components/interfaces/QT_HMI_API.xml
index 8a30bcfa83..3f6d08b69b 100644
--- a/src/components/interfaces/QT_HMI_API.xml
+++ b/src/components/interfaces/QT_HMI_API.xml
@@ -1768,7 +1768,10 @@
<description>Must be provided if ButtonName is CUSTOM_BUTTON, this references the integer ID passed by a custom button. (e.g. softButtonName)</description>
</param>
<param name="appID" type="Integer" mandatory="false">
- <description>ID of the application.</description>
+ <description>
+ In case the ButtonName is CUSTOM_BUTTON, HMI must include appID parameters to OnButtonPress notification sent to SDL.
+ Otherwise, if appID is not sent together with CUSTOM_BUTTON, this notification will be ignored by SDL.
+ </description>
</param>
</function>
<function name="OnButtonPress" messagetype="notification" provider="hmi">
@@ -1780,7 +1783,10 @@
<description>Must be returned if ButtonName is CUSTOM_BUTTON, this references the string passed by a custom button. (e.g. softButtonName)</description>
</param>
<param name="appID" type="Integer" mandatory="false">
- <description>ID of the application.</description>
+ <description>
+ In case the ButtonName is CUSTOM_BUTTON, HMI must include appID parameters to OnButtonPress notification sent to SDL.
+ Otherwise, if appID is not sent together with CUSTOM_BUTTON, this notification will be ignored by SDL.
+ </description>
</param>
</function>
</interface>