diff options
Diffstat (limited to 'src/components/interfaces/MOBILE_API.xml')
| -rw-r--r-- | src/components/interfaces/MOBILE_API.xml | 64 |
1 files changed, 60 insertions, 4 deletions
diff --git a/src/components/interfaces/MOBILE_API.xml b/src/components/interfaces/MOBILE_API.xml index 82a5a2e571..0c05e0cb6b 100644 --- a/src/components/interfaces/MOBILE_API.xml +++ b/src/components/interfaces/MOBILE_API.xml @@ -752,7 +752,11 @@ <element name="mediaTrack"> <description>The track field of NGN and GEN1.1 MFD displays. This field is only available for media applications; applies to "Show"</description> </element> - + + <element name="templateTitle" since="6.0"> + <description>The title of the new template that will be displayed; applies to "Show"</description> + </element> + <element name="alertText1"> <description>The first line of the alert text field; applies to "Alert"</description> </element> @@ -891,7 +895,11 @@ <element name="locationImage" since="4.0"> <description>The optional image of a destination / location</description> </element> - + + <element name="alertIcon" since="6.0"> + <description>The image field for Alert</description>> + </element> + </enum> <enum name="CharacterSet" since="1.0"> @@ -2684,6 +2692,7 @@ <element name="UnpublishAppServiceID" value="56" hexvalue="38" since="6.0" /> <element name="CancelInteractionID" value="57" hexvalue="39" since="6.0" /> <element name="CloseApplicationID" value="58" hexvalue="3A" since="6.0" /> + <element name="ShowAppMenuID" value="59" hexvalue="3B" since="6.0" /> <!-- Base Notifications @@ -4737,6 +4746,37 @@ </function> + <function name="ShowAppMenu" functionID="ShowAppMenuID" messagetype="request" since="6.0"> + <description>Shows the built in menu view</description> + <param name="menuID" type="Integer" minvalue="1" maxvalue="2000000000" mandatory="false"> + <description> + If omitted the HMI opens the app's menu. + If set to a sub-menu ID the HMI opens the corresponding sub-menu previously added using `AddSubMenu`. + </description> + </param> + </function> + + <function name="ShowAppMenu" functionID="ShowAppMenuID" messagetype="response" since="6.0"> + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true if successful; false, if failed </description> + </param> + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="INVALID_DATA"/> + <element name="OUT_OF_MEMORY"/> + <element name="TOO_MANY_PENDING_REQUESTS"/> + <element name="APPLICATION_NOT_REGISTERED"/> + <element name="GENERIC_ERROR"/> + <element name="REJECTED"/> + <element name="INVALID_ID"/> + <element name="IN_USE"/> + </param> + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + </function> + <function name="CreateInteractionChoiceSet" functionID="CreateInteractionChoiceSetID" messagetype="request" since="1.0"> <description>creates interaction choice set to be used later by performInteraction</description> @@ -4969,6 +5009,13 @@ If omitted on supported displays, the displayed alert shall not have any SoftButtons. </description> </param> + + <param name="alertIcon" type="Image" mandatory="false" since="6.0"> + <description> + Image struct determining whether static or dynamic icon. + If omitted on supported displays, no (or the default if applicable) icon should be displayed. + </description> + </param> <param name="cancelID" type="Integer" mandatory="false" since="6.0"> <description> @@ -5104,9 +5151,18 @@ </param> <param name="metadataTags" type="MetadataTags" mandatory="false" since="4.5"> - <description>App defined metadata information. See MetadataStruct. Uses mainField1, mainField2, mainField3, mainField4. + <description> + App defined metadata information. See MetadataStruct. Uses mainField1, mainField2, mainField3, mainField4. If omitted on supported displays, the currently set metadata tags will not change. - If any text field contains no tags or the none tag, the metadata tag for that textfield should be removed.</description> + If any text field contains no tags or the none tag, the metadata tag for that textfield should be removed. + </description> + </param> + + <param name="templateTitle" type="String" minlength="0" maxlength="100" mandatory="false" since="6.0"> + <description> + The title of the new template that will be displayed. + How this will be displayed is dependent on the OEM design and implementation of the template. + </description> </param> </function> |