diff options
Diffstat (limited to 'src/components/interfaces/HMI_API.xml')
| -rw-r--r-- | src/components/interfaces/HMI_API.xml | 52 |
1 files changed, 25 insertions, 27 deletions
diff --git a/src/components/interfaces/HMI_API.xml b/src/components/interfaces/HMI_API.xml index 54cf2c1435..717ddb04f3 100644 --- a/src/components/interfaces/HMI_API.xml +++ b/src/components/interfaces/HMI_API.xml @@ -402,7 +402,7 @@ <element name="STOP"> <description>Indicates that a button press of the Play/Pause button would stop the current playback.</description> </element> -</enum> +</enum> <enum name="SystemContext"> <description>Enumeration that describes possible contexts the application might be in on HU.</description> @@ -3486,7 +3486,6 @@ </param> </struct> - <struct name="RemoteControlCapabilities"> <param name="climateControlCapabilities" type="ClimateControlCapabilities" mandatory="false" minsize="1" maxsize="100" array="true"> <description>If included, the platform supports RC climate controls. For this baseline version, maxsize=1. i.e. only one climate control module is supported.</description > @@ -3537,10 +3536,10 @@ <description>The position of the haptic rectangle to be highlighted. The center of this rectangle will be "touched" when a press occurs.</description> </param> </struct> - + <struct name="SyncMsgVersion"> <description>Specifies the version number of the SmartDeviceLink protocol that is supported by the mobile application or app service</description> - + <param name="majorVersion" type="Integer" minvalue="1" maxvalue="10" mandatory="true"> <description>The major version indicates versions that is not-compatible to previous versions.</description> </param> @@ -3561,7 +3560,7 @@ </element> <element name="RPC" > <description>Refers to the RPC service.</description> - </element> + </element> </enum> <enum name="ServiceEvent"> @@ -3570,23 +3569,23 @@ </element> <element name="REQUEST_ACCEPTED" > <description>When a request for a Service is Accepted.</description> - </element> + </element> <element name="REQUEST_REJECTED" > <description>When a request for a Service is Rejected.</description> - </element> - </enum> + </element> + </enum> - <enum name="ServiceUpdateReason"> + <enum name="ServiceStatusUpdateReason"> <element name="PTU_FAILED" > <description>When a Service is rejected because the system was unable to get a required Policy Table Update.</description> </element> <element name="INVALID_CERT" > <description>When a Service is rejected because the security certificate is invalid/expired.</description> - </element> + </element> <element name="INVALID_TIME" > <description>When a Service is rejected because the system was unable to get a valid SystemTime from HMI, which is required for certificate authentication.</description> - </element> - </enum> + </element> + </enum> <!-- App Services --> @@ -3730,7 +3729,7 @@ <param name="apparentTemperature" type="Common.Temperature" mandatory="false"/> <param name="apparentTemperatureHigh" type="Common.Temperature" mandatory="false"/> <param name="apparentTemperatureLow" type="Common.Temperature" mandatory="false"/> - + <param name="weatherSummary" type="String" mandatory="false"/> <param name="time" type="Common.DateTime" mandatory="false"/> <param name="humidity" type="Float" minvalue="0" maxvalue="1" mandatory="false"> @@ -3801,7 +3800,7 @@ <description> Using this action plus a supplied direction can give the type of turn. </description> </element> <element name="EXIT"/> - <element name="STAY"/> + <element name="STAY"/> <element name="MERGE"/> <element name="FERRY"/> <element name="CAR_SHUTTLE_TRAIN"/> @@ -4133,14 +4132,14 @@ <param name="serviceEvent" type="Common.ServiceEvent" mandatory="false"> <description>Specifies service update event.</description> </param> - <param name="reason" type="Common.ServiceUpdateReason" mandatory="false"> + <param name="reason" type="Common.ServiceStatusUpdateReason" mandatory="false"> <description> The reason for a service event. Certain events may not have a reason, such as when a service is ACCEPTED (which is the normal expected behavior). </description> </param> <param name="appID" type="Integer" mandatory="false"> <description>ID of the application which triggered the update.</description> - </param> + </param> </function> <function name="GetSystemTime" messagetype="request"> <description>Request from SDL to HMI to obtain current UTC time.</description> @@ -4492,7 +4491,7 @@ <description>Selected file type.</description> </param> </function> - + <!-- Policies --> <function name="GetSystemInfo" messagetype="request"> <description>Request from SDL to HMI to obtain information about head unit system.</description> @@ -5338,7 +5337,6 @@ </function> <function name="SetAppIcon" messagetype="response"> </function> - <function name="ShowCustomForm" messagetype="request"> <description>Used to show a custom form; it can be a parent or child screen. If no parent screen is designated, it is set as a parent screen.</description> <param name="customFormID" type="String" maxlength="500" mandatory="true"> @@ -6823,18 +6821,18 @@ <function name="GetAppServiceData" messagetype="request"> <description> This request asks the module for current data related to the specific service. It also includes an option to subscribe to that service for future updates</description> - + <param name="serviceType" type="String" mandatory="true"> <description>The type of service that is to be offered by this app. See AppServiceType for known enum equivalent types. Parameter is a string to allow for new service types to be used by apps on older versions of SDL Core.</description> </param> - + <param name="subscribe" type="Boolean" mandatory="false"> <description> If true, the consumer is requesting to subscribe to all future updates from the service publisher. If false, the consumer doesn't wish to subscribe and should be unsubscribed if it was previously subscribed.</description> - </param> + </param> </function> <function name="GetAppServiceData" messagetype="response"> - <description> This response includes the data that was requested from the specific service</description> + <description> This response includes the data that was requested from the specific service</description> <param name="serviceData" type="Common.AppServiceData" mandatory="false"/> </function> @@ -6842,15 +6840,15 @@ <param name="serviceUri" type="String" mandatory="true"> <description>Fully qualified URI based on a predetermined scheme provided by the app service. SDL makes no guarantee that this URI is correct.</description> </param> - + <param name="serviceID" type="String" mandatory="true"> <description>The service ID that the app consumer wishes to send this URI.</description> </param> - + <param name="originApp" type="String" mandatory="false"> <description>This string is the appID of the app requesting the app service provider take the specific action. This will automatically be set by SDL Core in requests originating from the HMI</description> </param> - + <param name="requestServiceActive" type="Boolean" mandatory="false"> <description>This flag signals the requesting consumer would like this service to become the active primary service of the destination's type.</description> </param> @@ -6895,7 +6893,7 @@ </param> <param name="setAsDefault" type="Boolean" mandatory="false"> <description>True if the service was set to the default service of this type. False if the app was not to be the default</description> - </param> + </param> </function> <function name="GetActiveServiceConsent" messagetype="request"> @@ -6906,7 +6904,7 @@ <description>The ID of the service to be activated</description> </param> </function> - + <function name="GetActiveServiceConsent" messagetype="response"> <param name="activate" type="Boolean" mandatory="true"> <description> |