Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add ShowAppMenu RPC to spec #184

Merged
merged 1 commit into from
Oct 14, 2019
Merged

Add ShowAppMenu RPC to spec #184

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
38 changes: 38 additions & 0 deletions MOBILE_API.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2652,6 +2652,7 @@
<element name="GetAppServiceDataID" value="53" hexvalue="35" since="5.1" />
<element name="GetFileID" value="54" hexvalue="36" since="5.1" />
<element name="PerformAppServiceInteractionID" value="55" hexvalue="37" since="5.1" />
<element name="ShowAppMenuID" value="59" hexvalue="3B" since="6.0" />

<!--
Base Notifications
Expand Down Expand Up @@ -4676,6 +4677,43 @@

</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>

Expand Down
25 changes: 25 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1372,6 +1372,7 @@ Enumeration linking function names with function IDs in SmartDeviceLink protocol
|`GetAppServiceDataID`||
|`GetFileID`||
|`PerformAppServiceInteractionID`||
|`ShowAppMenuID`||
|`OnHMIStatusID`||
|`OnAppInterfaceUnregisteredID`||
|`OnButtonEventID`||
Expand Down Expand Up @@ -3187,6 +3188,30 @@ Message Type: **response**
|`info`|String|False|Provides additional human readable info regarding the result.|


### ShowAppMenu
Message Type: **request**

Shows the built in menu view

##### Parameters

| Value | Type | Mandatory | Description |
| ---------- | ---------- |:-----------: |:-----------:|
|`menuID`|Integer|False|If omitted the HMI opens the app's menu.<br>If set to a sub-menu ID the HMI opens the corresponding sub-menu previously added using `AddSubMenu`.|


### ShowAppMenu
Message Type: **response**

##### Parameters

| Value | Type | Mandatory | Description |
| ---------- | ---------- |:-----------: |:-----------:|
|`success`|Boolean|True|true if successful; false, if failed |
|`resultCode`|Result|True|See Result|
|`info`|String|False|Provides additional human readable info regarding the result.|


### CreateInteractionChoiceSet
Message Type: **request**

Expand Down