diff options
| author | jacobkeeler <jacob.keeler@livioradio.com> | 2017-06-15 14:59:54 -0400 |
|---|---|---|
| committer | jacobkeeler <jacob.keeler@livioradio.com> | 2017-06-15 15:42:53 -0400 |
| commit | e2761de79ff76ad2e0a50179e1e4caec03f8c072 (patch) | |
| tree | 2d92ce756dfef29f13bcc627490ae42a60de0890 | |
| parent | 22a014b3746b28d2b8a3a4049c60bb76db6a0861 (diff) | |
| download | sdl_core-feature/mandatory_flag.tar.gz | |
Added mandatory flag to all parameters in Mobile and HMI APIsfeature/mandatory_flag
| -rw-r--r-- | src/components/interfaces/HMI_API.xml | 54 | ||||
| -rw-r--r-- | src/components/interfaces/MOBILE_API.xml | 512 | ||||
| -rw-r--r-- | src/components/interfaces/v4_protocol_v1_2_no_extra.xml | 186 | ||||
| -rwxr-xr-x | tools/InterfaceGenerator/generator/parsers/RPCBase.py | 8 |
4 files changed, 382 insertions, 378 deletions
diff --git a/src/components/interfaces/HMI_API.xml b/src/components/interfaces/HMI_API.xml index 0d6d5fad3d..ad21241ad6 100644 --- a/src/components/interfaces/HMI_API.xml +++ b/src/components/interfaces/HMI_API.xml @@ -1279,16 +1279,16 @@ <!-- End of Policies --> <struct name="TextField"> - <param name="name" type="Common.TextFieldName"> + <param name="name" type="Common.TextFieldName" mandatory="true"> <description>The name that identifies the field. See TextFieldName.</description> </param> - <param name="characterSet" type="Common.CharacterSet"> + <param name="characterSet" type="Common.CharacterSet" mandatory="true"> <description>The character set that is supported in this field. See CharacterSet.</description> </param> - <param name="width" type="Integer" minvalue="1" maxvalue="500"> + <param name="width" type="Integer" minvalue="1" maxvalue="500" mandatory="true"> <description>The number of characters in one row of this field.</description> </param> - <param name="rows" type="Integer" minvalue="1" maxvalue="8"> + <param name="rows" type="Integer" minvalue="1" maxvalue="8" mandatory="true"> <description>The number of rows of this field.</description> </param> </struct> @@ -1311,10 +1311,10 @@ <struct name="VehicleDataResult"> <description>Individual published data request result</description> - <param name="dataType" type="Common.VehicleDataType"> + <param name="dataType" type="Common.VehicleDataType" mandatory="true"> <description>Defined published data element type.</description> </param> - <param name="resultCode" type="Common.VehicleDataResultCode"> + <param name="resultCode" type="Common.VehicleDataResultCode" mandatory="true"> <description>Published data result code.</description> </param> </struct> @@ -1924,73 +1924,73 @@ </struct> <struct name="ECallInfo"> - <param name="eCallNotificationStatus" type="Common.VehicleDataNotificationStatus"> + <param name="eCallNotificationStatus" type="Common.VehicleDataNotificationStatus" mandatory="true"> <description>References signal "eCallNotification_4A". See VehicleDataNotificationStatus.</description> </param> - <param name="auxECallNotificationStatus" type="Common.VehicleDataNotificationStatus"> + <param name="auxECallNotificationStatus" type="Common.VehicleDataNotificationStatus" mandatory="true"> <description>References signal "eCallNotification". See VehicleDataNotificationStatus.</description> </param> - <param name="eCallConfirmationStatus" type="Common.ECallConfirmationStatus"> + <param name="eCallConfirmationStatus" type="Common.ECallConfirmationStatus" mandatory="true"> <description>References signal "eCallConfirmation". See ECallConfirmationStatus.</description> </param> </struct> <struct name="AirbagStatus"> - <param name="driverAirbagDeployed" type="Common.VehicleDataEventStatus"> + <param name="driverAirbagDeployed" type="Common.VehicleDataEventStatus" mandatory="true"> <description>References signal "VedsDrvBag_D_Ltchd". See VehicleDataEventStatus.</description> </param> - <param name="driverSideAirbagDeployed" type="Common.VehicleDataEventStatus"> + <param name="driverSideAirbagDeployed" type="Common.VehicleDataEventStatus" mandatory="true"> <description>References signal "VedsDrvSideBag_D_Ltchd". See VehicleDataEventStatus.</description> </param> - <param name="driverCurtainAirbagDeployed" type="Common.VehicleDataEventStatus"> + <param name="driverCurtainAirbagDeployed" type="Common.VehicleDataEventStatus" mandatory="true"> <description>References signal "VedsDrvCrtnBag_D_Ltchd". See VehicleDataEventStatus.</description> </param> - <param name="passengerAirbagDeployed" type="Common.VehicleDataEventStatus"> + <param name="passengerAirbagDeployed" type="Common.VehicleDataEventStatus" mandatory="true"> <description>References signal "VedsPasBag_D_Ltchd". See VehicleDataEventStatus.</description> </param> - <param name="passengerCurtainAirbagDeployed" type="Common.VehicleDataEventStatus"> + <param name="passengerCurtainAirbagDeployed" type="Common.VehicleDataEventStatus" mandatory="true"> <description>References signal "VedsPasCrtnBag_D_Ltchd". See VehicleDataEventStatus.</description> </param> - <param name="driverKneeAirbagDeployed" type="Common.VehicleDataEventStatus"> + <param name="driverKneeAirbagDeployed" type="Common.VehicleDataEventStatus" mandatory="true"> <description>References signal "VedsKneeDrvBag_D_Ltchd". See VehicleDataEventStatus.</description> </param> - <param name="passengerSideAirbagDeployed" type="Common.VehicleDataEventStatus"> + <param name="passengerSideAirbagDeployed" type="Common.VehicleDataEventStatus" mandatory="true"> <description>References signal "VedsPasSideBag_D_Ltchd". See VehicleDataEventStatus.</description> </param> - <param name="passengerKneeAirbagDeployed" type="Common.VehicleDataEventStatus"> + <param name="passengerKneeAirbagDeployed" type="Common.VehicleDataEventStatus" mandatory="true"> <description>References signal "VedsKneePasBag_D_Ltchd". See VehicleDataEventStatus.</description> </param> </struct> <struct name="EmergencyEvent"> - <param name="emergencyEventType" type="Common.EmergencyEventType"> + <param name="emergencyEventType" type="Common.EmergencyEventType" mandatory="true"> <description>References signal "VedsEvntType_D_Ltchd". See EmergencyEventType.</description> </param> - <param name="fuelCutoffStatus" type="Common.FuelCutoffStatus"> + <param name="fuelCutoffStatus" type="Common.FuelCutoffStatus" mandatory="true"> <description>References signal "RCM_FuelCutoff". See FuelCutoffStatus.</description> </param> - <param name="rolloverEvent" type="Common.VehicleDataEventStatus"> + <param name="rolloverEvent" type="Common.VehicleDataEventStatus" mandatory="true"> <description>References signal "VedsEvntRoll_D_Ltchd". See VehicleDataEventStatus.</description> </param> - <param name="maximumChangeVelocity" type="Common.VehicleDataEventStatus"> + <param name="maximumChangeVelocity" type="Common.VehicleDataEventStatus" mandatory="true"> <description>References signal "VedsMaxDeltaV_D_Ltchd". See VehicleDataEventStatus.</description> </param> - <param name="multipleEvents" type="Common.VehicleDataEventStatus"> + <param name="multipleEvents" type="Common.VehicleDataEventStatus" mandatory="true"> <description>References signal "VedsMultiEvnt_D_Ltchd". See VehicleDataEventStatus.</description> </param> </struct> <struct name="ClusterModeStatus"> - <param name="powerModeActive" type="Boolean"> + <param name="powerModeActive" type="Boolean" mandatory="true"> <description>References signal "PowerMode_UB".</description> </param> - <param name="powerModeQualificationStatus" type="Common.PowerModeQualificationStatus"> + <param name="powerModeQualificationStatus" type="Common.PowerModeQualificationStatus" mandatory="true"> <description>References signal "PowerModeQF". See PowerModeQualificationStatus.</description> </param> - <param name="carModeStatus" type="Common.CarModeStatus"> + <param name="carModeStatus" type="Common.CarModeStatus" mandatory="true"> <description>References signal "CarMode". See CarMode.</description> </param> - <param name="powerModeStatus" type="Common.PowerModeStatus"> + <param name="powerModeStatus" type="Common.PowerModeStatus" mandatory="true"> <description>References signal "PowerMode". See PowerMode.</description> </param> </struct> @@ -2317,7 +2317,7 @@ </function> <function name="DialNumber" messagetype="request"> <description>Request from SDL to call a specific number.</description> - <param name="number" type="String" maxlength="40"> + <param name="number" type="String" maxlength="40" mandatory="true"> <description>The number to dial. Only the character + and numbers are allowed.</description> </param> <param name="appID" type="Integer" mandatory="true"> diff --git a/src/components/interfaces/MOBILE_API.xml b/src/components/interfaces/MOBILE_API.xml index 953f270741..40c4db62cc 100644 --- a/src/components/interfaces/MOBILE_API.xml +++ b/src/components/interfaces/MOBILE_API.xml @@ -449,9 +449,9 @@ Describes different audio type configurations for PerformAudioPassThru.
e.g. {8kHz,8-bit,PCM}
</description>
- <param name="samplingRate" type="SamplingRate"/>
- <param name="bitsPerSample" type="BitsPerSample"/>
- <param name="audioType" type="AudioType"/>
+ <param name="samplingRate" type="SamplingRate" mandatory="true"/>
+ <param name="bitsPerSample" type="BitsPerSample" mandatory="true"/>
+ <param name="audioType" type="AudioType" mandatory="true"/>
</struct>
<enum name="VehicleDataType">
@@ -806,16 +806,16 @@ </enum>
<struct name="Image">
- <param name="value" minlength="0" maxlength="65535" type="String">
+ <param name="value" minlength="0" maxlength="65535" type="String" mandatory="true">
<description>Either the static hex icon value or the binary image file name identifier (sent by PutFile).</description>
</param>
- <param name="imageType" type="ImageType">
+ <param name="imageType" type="ImageType" mandatory="true">
<description>Describes, whether it is a static or dynamic image.</description>
</param>
</struct>
<struct name="SoftButton">
- <param name="type" type="SoftButtonType">
+ <param name="type" type="SoftButtonType" mandatory="true">
<description>Describes, whether it is text, highlighted text, icon, or dynamic image. See softButtonType</description>
</param>
<param name="text" minlength="0" maxlength="500" type="String" mandatory="false">
@@ -830,7 +830,7 @@ False, if not highlighted
</description>
</param>
- <param name="softButtonID" type="Integer" minvalue="0" maxvalue="65535">
+ <param name="softButtonID" type="Integer" minvalue="0" maxvalue="65535" mandatory="true">
<description>Value which is returned via OnButtonPress / OnButtonEvent</description>
</param>
<param name="systemAction" type="SystemAction" defvalue="DEFAULT_ACTION" mandatory="false">
@@ -840,9 +840,9 @@ <struct name="Choice">
<description>A choice is an option given to the user, which can be selected either by menu, or through voice recognition system.</description>
- <param name="choiceID" type="Integer" minvalue="0" maxvalue="65535" />
- <param name="menuName" type="String" maxlength="500" />
- <param name="vrCommands" type="String" minsize="1" maxsize="100" maxlength="99" array="true" />
+ <param name="choiceID" type="Integer" minvalue="0" maxvalue="65535" mandatory="true"/>
+ <param name="menuName" type="String" maxlength="500" mandatory="true"/>
+ <param name="vrCommands" type="String" minsize="1" maxsize="100" maxlength="99" array="true" mandatory="true"/>
<param name="image" type="Image" mandatory="false"/>
<param name="secondaryText" maxlength="500" type="String" mandatory="false">
<description>Optional secondary text to display; e.g. address of POI in a search result entry</description>
@@ -856,13 +856,13 @@ </struct>
<struct name="VrHelpItem">
- <param name="text" maxlength="500" type="String">
+ <param name="text" maxlength="500" type="String" mandatory="true">
<description>Text to display for VR Help item</description>
</param>
<param name="image" type="Image" mandatory="false">
<description>Image struct for VR Help item</description>
</param>
- <param name="position" type="Integer" minvalue="1" maxvalue="100">
+ <param name="position" type="Integer" minvalue="1" maxvalue="100" mandatory="true">
<description>Position to display item in VR Help list</description>
</param>
</struct>
@@ -870,10 +870,10 @@ <struct name="SyncMsgVersion">
<description>Specifies the version number of the SYNC V4 protocol, that is supported by the mobile application</description>
- <param name="majorVersion" type="Integer" minvalue="1" maxvalue="10">
+ <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>
- <param name="minorVersion" type="Integer" minvalue="0" maxvalue="1000">
+ <param name="minorVersion" type="Integer" minvalue="0" maxvalue="1000" mandatory="true">
<description>The minor version indicates a change to a previous version that should still allow to be run on an older version (with limited functionality)</description>
</param>
<param name="patchVersion" type="Integer" minvalue="0" maxvalue="1000" mandatory="false">
@@ -997,7 +997,7 @@ </enum>
<struct name="SingleTireStatus">
- <param name="status" type="ComponentVolumeStatus">
+ <param name="status" type="ComponentVolumeStatus" mandatory="true">
<description>See ComponentVolumeStatus.</description>
</param>
</struct>
@@ -1168,61 +1168,61 @@ </enum>
<struct name="BeltStatus">
- <param name="driverBeltDeployed" type="VehicleDataEventStatus">
+ <param name="driverBeltDeployed" type="VehicleDataEventStatus" mandatory="true">
<description>References signal "VedsDrvBelt_D_Ltchd". See VehicleDataEventStatus.</description>
</param>
- <param name="passengerBeltDeployed" type="VehicleDataEventStatus">
+ <param name="passengerBeltDeployed" type="VehicleDataEventStatus" mandatory="true">
<description>References signal "VedsPasBelt_D_Ltchd". See VehicleDataEventStatus.</description>
</param>
- <param name="passengerBuckleBelted" type="VehicleDataEventStatus">
+ <param name="passengerBuckleBelted" type="VehicleDataEventStatus" mandatory="true">
<description>References signal "VedsRw1PasBckl_D_Ltchd". See VehicleDataEventStatus.</description>
</param>
- <param name="driverBuckleBelted" type="VehicleDataEventStatus">
+ <param name="driverBuckleBelted" type="VehicleDataEventStatus" mandatory="true">
<description>References signal "VedsRw1DrvBckl_D_Ltchd". See VehicleDataEventStatus.</description>
</param>
- <param name="leftRow2BuckleBelted" type="VehicleDataEventStatus">
+ <param name="leftRow2BuckleBelted" type="VehicleDataEventStatus" mandatory="true">
<description>References signal "VedsRw2lBckl_D_Ltchd". See VehicleDataEventStatus.</description>
</param>
- <param name="passengerChildDetected" type="VehicleDataEventStatus">
+ <param name="passengerChildDetected" type="VehicleDataEventStatus" mandatory="true">
<description>References signal "VedsRw1PasChld_D_Ltchd". See VehicleDataEventStatus.</description>
</param>
- <param name="rightRow2BuckleBelted" type="VehicleDataEventStatus">
+ <param name="rightRow2BuckleBelted" type="VehicleDataEventStatus" mandatory="true">
<description>References signal "VedsRw2rBckl_D_Ltchd". See VehicleDataEventStatus.</description>
</param>
- <param name="middleRow2BuckleBelted" type="VehicleDataEventStatus">
+ <param name="middleRow2BuckleBelted" type="VehicleDataEventStatus" mandatory="true">
<description>References signal "VedsRw2mBckl_D_Ltchd". See VehicleDataEventStatus.</description>
</param>
- <param name="middleRow3BuckleBelted" type="VehicleDataEventStatus">
+ <param name="middleRow3BuckleBelted" type="VehicleDataEventStatus" mandatory="true">
<description>References signal "VedsRw3mBckl_D_Ltchd". See VehicleDataEventStatus.</description>
</param>
- <param name="leftRow3BuckleBelted" type="VehicleDataEventStatus">
+ <param name="leftRow3BuckleBelted" type="VehicleDataEventStatus" mandatory="true">
<description>References signal "VedsRw3lBckl_D_Ltchd". See VehicleDataEventStatus.</description>
</param>
- <param name="rightRow3BuckleBelted" type="VehicleDataEventStatus">
+ <param name="rightRow3BuckleBelted" type="VehicleDataEventStatus" mandatory="true">
<description>References signal "VedsRw3rBckl_D_Ltchd". See VehicleDataEventStatus.</description>
</param>
- <param name="leftRearInflatableBelted" type="VehicleDataEventStatus">
+ <param name="leftRearInflatableBelted" type="VehicleDataEventStatus" mandatory="true">
<description>References signal "VedsRw2lRib_D_Ltchd". See VehicleDataEventStatus.</description>
</param>
- <param name="rightRearInflatableBelted" type="VehicleDataEventStatus">
+ <param name="rightRearInflatableBelted" type="VehicleDataEventStatus" mandatory="true">
<description>References signal "VedsRw2rRib_D_Ltchd". See VehicleDataEventStatus.</description>
</param>
- <param name="middleRow1BeltDeployed" type="VehicleDataEventStatus">
+ <param name="middleRow1BeltDeployed" type="VehicleDataEventStatus" mandatory="true">
<description>References signal "VedsRw1mBelt_D_Ltchd". See VehicleDataEventStatus.</description>
</param>
- <param name="middleRow1BuckleBelted" type="VehicleDataEventStatus">
+ <param name="middleRow1BuckleBelted" type="VehicleDataEventStatus" mandatory="true">
<description>References signal "VedsRw1mBckl_D_Ltchd". See VehicleDataEventStatus.</description>
</param>
</struct>
<struct name="BodyInformation">
- <param name="parkBrakeActive" type="Boolean">
+ <param name="parkBrakeActive" type="Boolean" mandatory="true">
<description>References signal "PrkBrkActv_B_Actl".</description>
</param>
- <param name="ignitionStableStatus" type="IgnitionStableStatus">
+ <param name="ignitionStableStatus" type="IgnitionStableStatus" mandatory="true">
<description>References signal "Ignition_Switch_Stable". See IgnitionStableStatus.</description>
</param>
- <param name="ignitionStatus" type="IgnitionStatus">
+ <param name="ignitionStatus" type="IgnitionStatus" mandatory="true">
<description>References signal "Ignition_status". See IgnitionStatus.</description>
</param>
<param name="driverDoorAjar" type="Boolean" mandatory="false">
@@ -1240,46 +1240,46 @@ </struct>
<struct name="DeviceStatus">
- <param name="voiceRecOn" type="Boolean">
+ <param name="voiceRecOn" type="Boolean" mandatory="true">
<description>References signal "CPM_VoiceRec_STAT".</description>
</param>
- <param name="btIconOn" type="Boolean">
+ <param name="btIconOn" type="Boolean" mandatory="true">
<description>References signal "BT_ICON".</description>
</param>
- <param name="callActive" type="Boolean">
+ <param name="callActive" type="Boolean" mandatory="true">
<description>References signal "CPM_Call_Active_STAT".</description>
</param>
- <param name="phoneRoaming" type="Boolean">
+ <param name="phoneRoaming" type="Boolean" mandatory="true">
<description>References signal "CPM_Phone_Roaming_STAT".</description>
</param>
- <param name="textMsgAvailable" type="Boolean">
+ <param name="textMsgAvailable" type="Boolean" mandatory="true">
<description>References signal "CPM_TextMsg_AVAL".</description>
</param>
- <param name="battLevelStatus" type="DeviceLevelStatus">
+ <param name="battLevelStatus" type="DeviceLevelStatus" mandatory="true">
<description>Device battery level status. References signal "CPM_Batt_Level_STAT". See DeviceLevelStatus.</description>
</param>
- <param name="stereoAudioOutputMuted" type="Boolean">
+ <param name="stereoAudioOutputMuted" type="Boolean" mandatory="true">
<description>References signal "CPM_Stereo_Audio_Output".</description>
</param>
- <param name="monoAudioOutputMuted" type="Boolean">
+ <param name="monoAudioOutputMuted" type="Boolean" mandatory="true">
<description>References signal "CPM_Mono_Audio_Output".</description>
</param>
- <param name="signalLevelStatus" type="DeviceLevelStatus">
+ <param name="signalLevelStatus" type="DeviceLevelStatus" mandatory="true">
<description>Device signal level status. References signal "CPM_Signal_Strength_STAT". See DeviceLevelStatus.</description>
</param>
- <param name="primaryAudioSource" type="PrimaryAudioSource">
+ <param name="primaryAudioSource" type="PrimaryAudioSource" mandatory="true">
<description>References signal "CPM_Stereo_PAS_Source". See PrimaryAudioSource.</description>
</param>
- <param name="eCallEventActive" type="Boolean">
+ <param name="eCallEventActive" type="Boolean" mandatory="true">
<description>References signal "eCall_Event".</description>
</param>
</struct>
<struct name="HeadLampStatus">
- <param name="lowBeamsOn" type="Boolean">
+ <param name="lowBeamsOn" type="Boolean" mandatory="true">
<description>Status of the low beam lamps. References signal "HeadLampLoActv_B_Stat".</description>
</param>
- <param name="highBeamsOn" type="Boolean">
+ <param name="highBeamsOn" type="Boolean" mandatory="true">
<description>Status of the high beam lamps. References signal "HeadLghtHiOn_B_Stat".</description>
</param>
<param name="ambientLightSensorStatus" type="AmbientLightStatus" mandatory="false">
@@ -1415,84 +1415,84 @@ </enum>
<struct name="ECallInfo">
- <param name="eCallNotificationStatus" type="VehicleDataNotificationStatus">
+ <param name="eCallNotificationStatus" type="VehicleDataNotificationStatus" mandatory="true">
<description>References signal "eCallNotification_4A". See VehicleDataNotificationStatus.</description>
</param>
- <param name="auxECallNotificationStatus" type="VehicleDataNotificationStatus">
+ <param name="auxECallNotificationStatus" type="VehicleDataNotificationStatus" mandatory="true">
<description>References signal "eCallNotification". See VehicleDataNotificationStatus.</description>
</param>
- <param name="eCallConfirmationStatus" type="ECallConfirmationStatus">
+ <param name="eCallConfirmationStatus" type="ECallConfirmationStatus" mandatory="true">
<description>References signal "eCallConfirmation". See ECallConfirmationStatus.</description>
</param>
</struct>
<struct name="AirbagStatus">
- <param name="driverAirbagDeployed" type="VehicleDataEventStatus">
+ <param name="driverAirbagDeployed" type="VehicleDataEventStatus" mandatory="true">
<description>References signal "VedsDrvBag_D_Ltchd". See VehicleDataEventStatus.</description>
</param>
- <param name="driverSideAirbagDeployed" type="VehicleDataEventStatus">
+ <param name="driverSideAirbagDeployed" type="VehicleDataEventStatus" mandatory="true">
<description>References signal "VedsDrvSideBag_D_Ltchd". See VehicleDataEventStatus.</description>
</param>
- <param name="driverCurtainAirbagDeployed" type="VehicleDataEventStatus">
+ <param name="driverCurtainAirbagDeployed" type="VehicleDataEventStatus" mandatory="true">
<description>References signal "VedsDrvCrtnBag_D_Ltchd". See VehicleDataEventStatus.</description>
</param>
- <param name="passengerAirbagDeployed" type="VehicleDataEventStatus">
+ <param name="passengerAirbagDeployed" type="VehicleDataEventStatus" mandatory="true">
<description>References signal "VedsPasBag_D_Ltchd". See VehicleDataEventStatus.</description>
</param>
- <param name="passengerCurtainAirbagDeployed" type="VehicleDataEventStatus">
+ <param name="passengerCurtainAirbagDeployed" type="VehicleDataEventStatus" mandatory="true">
<description>References signal "VedsPasCrtnBag_D_Ltchd". See VehicleDataEventStatus.</description>
</param>
- <param name="driverKneeAirbagDeployed" type="VehicleDataEventStatus">
+ <param name="driverKneeAirbagDeployed" type="VehicleDataEventStatus" mandatory="true">
<description>References signal "VedsKneeDrvBag_D_Ltchd". See VehicleDataEventStatus.</description>
</param>
- <param name="passengerSideAirbagDeployed" type="VehicleDataEventStatus">
+ <param name="passengerSideAirbagDeployed" type="VehicleDataEventStatus" mandatory="true">
<description>References signal "VedsPasSideBag_D_Ltchd". See VehicleDataEventStatus.</description>
</param>
- <param name="passengerKneeAirbagDeployed" type="VehicleDataEventStatus">
+ <param name="passengerKneeAirbagDeployed" type="VehicleDataEventStatus" mandatory="true">
<description>References signal "VedsKneePasBag_D_Ltchd". See VehicleDataEventStatus.</description>
</param>
</struct>
<struct name="EmergencyEvent">
- <param name="emergencyEventType" type="EmergencyEventType">
+ <param name="emergencyEventType" type="EmergencyEventType" mandatory="true">
<description>References signal "VedsEvntType_D_Ltchd". See EmergencyEventType.</description>
</param>
- <param name="fuelCutoffStatus" type="FuelCutoffStatus">
+ <param name="fuelCutoffStatus" type="FuelCutoffStatus" mandatory="true">
<description>References signal "RCM_FuelCutoff". See FuelCutoffStatus.</description>
</param>
- <param name="rolloverEvent" type="VehicleDataEventStatus">
+ <param name="rolloverEvent" type="VehicleDataEventStatus" mandatory="true">
<description>References signal "VedsEvntRoll_D_Ltchd". See VehicleDataEventStatus.</description>
</param>
- <param name="maximumChangeVelocity" type="Integer" minvalue="0" maxvalue="255">
+ <param name="maximumChangeVelocity" type="Integer" minvalue="0" maxvalue="255" mandatory="true">
<description>References signal "VedsMaxDeltaV_D_Ltchd". Change in velocity in KPH. Additional reserved values:
0x00 No event
0xFE Not supported
0xFF Fault
</description>
</param>
- <param name="multipleEvents" type="VehicleDataEventStatus">
+ <param name="multipleEvents" type="VehicleDataEventStatus" mandatory="true">
<description>References signal "VedsMultiEvnt_D_Ltchd". See VehicleDataEventStatus.</description>
</param>
</struct>
<struct name="ClusterModeStatus">
- <param name="powerModeActive" type="Boolean">
+ <param name="powerModeActive" type="Boolean" mandatory="true">
<description>References signal "PowerMode_UB".</description>
</param>
- <param name="powerModeQualificationStatus" type="PowerModeQualificationStatus">
+ <param name="powerModeQualificationStatus" type="PowerModeQualificationStatus" mandatory="true">
<description>References signal "PowerModeQF". See PowerModeQualificationStatus.</description>
</param>
- <param name="carModeStatus" type="CarModeStatus">
+ <param name="carModeStatus" type="CarModeStatus" mandatory="true">
<description>References signal "CarMode". See CarMode.</description>
</param>
- <param name="powerModeStatus" type="PowerModeStatus">
+ <param name="powerModeStatus" type="PowerModeStatus" mandatory="true">
<description>References signal "PowerMode". See PowerMode.</description>
</param>
</struct>
<struct name="MyKey">
- <param name="e911Override" type="VehicleDataStatus">
+ <param name="e911Override" type="VehicleDataStatus" mandatory="true">
<description>Indicates whether e911 override is on. References signal "MyKey_e911Override_St". See VehicleDataStatus.</description>
</param>
</struct>
@@ -1535,101 +1535,101 @@ <struct name="TireStatus">
<description>The status and pressure of the tires.</description>
- <param name="pressureTelltale" type="WarningLightStatus">
+ <param name="pressureTelltale" type="WarningLightStatus" mandatory="true">
<description>Status of the Tire Pressure Telltale. See WarningLightStatus.</description>
</param>
- <param name="leftFront" type="SingleTireStatus">
+ <param name="leftFront" type="SingleTireStatus" mandatory="true">
<description>The status of the left front tire.</description>
</param>
- <param name="rightFront" type="SingleTireStatus">
+ <param name="rightFront" type="SingleTireStatus" mandatory="true">
<description>The status of the right front tire.</description>
</param>
- <param name="leftRear" type="SingleTireStatus">
+ <param name="leftRear" type="SingleTireStatus" mandatory="true">
<description>The status of the left rear tire.</description>
</param>
- <param name="rightRear" type="SingleTireStatus">
+ <param name="rightRear" type="SingleTireStatus" mandatory="true">
<description>The status of the right rear tire.</description>
</param>
- <param name="innerLeftRear" type="SingleTireStatus">
+ <param name="innerLeftRear" type="SingleTireStatus" mandatory="true">
<description>The status of the inner left rear.</description>
</param>
- <param name="innerRightRear" type="SingleTireStatus">
+ <param name="innerRightRear" type="SingleTireStatus" mandatory="true">
<description>The status of the inner right rear.</description>
</param>
</struct>
<struct name="GPSData">
<description>Struct with the GPS data.</description>
- <param name="longitudeDegrees" type="Float" minvalue="-180" maxvalue="180">
+ <param name="longitudeDegrees" type="Float" minvalue="-180" maxvalue="180" mandatory="true">
</param>
- <param name="latitudeDegrees" type="Float" minvalue="-90" maxvalue="90">
+ <param name="latitudeDegrees" type="Float" minvalue="-90" maxvalue="90" mandatory="true">
</param>
- <param name="utcYear" type="Integer" minvalue="2010" maxvalue="2100">
+ <param name="utcYear" type="Integer" minvalue="2010" maxvalue="2100" mandatory="true">
<description>The current UTC year.</description>
</param>
- <param name="utcMonth" type="Integer" minvalue="1" maxvalue="12">
+ <param name="utcMonth" type="Integer" minvalue="1" maxvalue="12" mandatory="true">
<description>The current UTC month.</description>
</param>
- <param name="utcDay" type="Integer" minvalue="1" maxvalue="31">
+ <param name="utcDay" type="Integer" minvalue="1" maxvalue="31" mandatory="true">
<description>The current UTC day.</description>
</param>
- <param name="utcHours" type="Integer" minvalue="0" maxvalue="23">
+ <param name="utcHours" type="Integer" minvalue="0" maxvalue="23" mandatory="true">
<description>The current UTC hour.</description>
</param>
- <param name="utcMinutes" type="Integer" minvalue="0" maxvalue="59">
+ <param name="utcMinutes" type="Integer" minvalue="0" maxvalue="59" mandatory="true">
<description>The current UTC minute.</description>
</param>
- <param name="utcSeconds" type="Integer" minvalue="0" maxvalue="59">
+ <param name="utcSeconds" type="Integer" minvalue="0" maxvalue="59" mandatory="true">
<description>The current UTC second.</description>
</param>
- <param name="compassDirection" type="CompassDirection">
+ <param name="compassDirection" type="CompassDirection" mandatory="true">
<description>See CompassDirection.</description>
</param>
- <param name="pdop" type="Float" minvalue="0" maxvalue="10" defvalue="0">
+ <param name="pdop" type="Float" minvalue="0" maxvalue="10" defvalue="0" mandatory="true">
<description>PDOP. If undefined or unavailable, then value shall be set to 0.</description>
</param>
- <param name="hdop" type="Float" minvalue="0" maxvalue="10" defvalue="0">
+ <param name="hdop" type="Float" minvalue="0" maxvalue="10" defvalue="0" mandatory="true">
<description>HDOP. If value is unknown, value shall be set to 0.</description>
</param>
- <param name="vdop" type="Float" minvalue="0" maxvalue="10" defvalue="0">
+ <param name="vdop" type="Float" minvalue="0" maxvalue="10" defvalue="0" mandatory="true">
<description>VDOP. If value is unknown, value shall be set to 0.</description>
</param>
- <param name="actual" type="Boolean">
+ <param name="actual" type="Boolean" mandatory="true">
<description>
True, if actual.
False, if infered.
</description>
</param>
- <param name="satellites" type="Integer" minvalue="0" maxvalue="31">
+ <param name="satellites" type="Integer" minvalue="0" maxvalue="31" mandatory="true">
<description>Number of satellites in view</description>
</param>
- <param name="dimension" type="Dimension">
+ <param name="dimension" type="Dimension" mandatory="true">
<description>See Dimension</description>
</param>
- <param name="altitude" type="Float" minvalue="-10000" maxvalue="10000">
+ <param name="altitude" type="Float" minvalue="-10000" maxvalue="10000" mandatory="true">
<description>Altitude in meters</description>
</param>
- <param name="heading" type="Float" minvalue="0" maxvalue="359.99">
+ <param name="heading" type="Float" minvalue="0" maxvalue="359.99" mandatory="true">
<description>The heading. North is 0. Resolution is 0.01</description>
</param>
- <param name="speed" type="Float" minvalue="0" maxvalue="500">
+ <param name="speed" type="Float" minvalue="0" maxvalue="500" mandatory="true">
<description>The speed in KPH</description>
</param>
</struct>
<struct name="VehicleDataResult">
<description>Individual published data request result</description>
- <param name="dataType" type="VehicleDataType">
+ <param name="dataType" type="VehicleDataType" mandatory="true">
<description>Defined published data element type.</description>
</param>
- <param name="resultCode" type="VehicleDataResultCode">
+ <param name="resultCode" type="VehicleDataResultCode" mandatory="true">
<description>Published data result code.</description>
</param>
</struct>
<struct name="DIDResult">
<description>Individual requested DID result and data</description>
- <param name="resultCode" type="VehicleDataResultCode">
+ <param name="resultCode" type="VehicleDataResultCode" mandatory="true">
<description>Individual DID result code.</description>
</param>
<param name="didLocation" type="Integer" minvalue="0" maxvalue="65535" mandatory="true">
@@ -1641,45 +1641,45 @@ </struct>
<struct name="StartTime">
- <param name="hours" type="Integer" minvalue="0" maxvalue="59">
+ <param name="hours" type="Integer" minvalue="0" maxvalue="59" mandatory="true">
<description>
The hour of the media clock.
Some radios only support a max of 19 hours. If out of range, it will be rejected.
</description>
</param>
- <param name="minutes" type="Integer" minvalue="0" maxvalue="59" />
- <param name="seconds" type="Integer" minvalue="0" maxvalue="59" />
+ <param name="minutes" type="Integer" minvalue="0" maxvalue="59" mandatory="true"/>
+ <param name="seconds" type="Integer" minvalue="0" maxvalue="59" mandatory="true"/>
</struct>
<struct name="TextField">
- <param name="name" type="TextFieldName">
+ <param name="name" type="TextFieldName" mandatory="true">
<description>The name that identifies the field. See TextFieldName.</description>
</param>
- <param name="characterSet" type="CharacterSet">
+ <param name="characterSet" type="CharacterSet" mandatory="true">
<description>The character set that is supported in this field. See CharacterSet.</description>
</param>
- <param name="width" type="Integer" minvalue="1" maxvalue="500">
+ <param name="width" type="Integer" minvalue="1" maxvalue="500" mandatory="true">
<description>The number of characters in one row of this field.</description>
</param>
- <param name="rows" type="Integer" minvalue="1" maxvalue="8">
+ <param name="rows" type="Integer" minvalue="1" maxvalue="8" mandatory="true">
<description>The number of rows of this field.</description>
</param>
</struct>
<struct name="ImageResolution">
- <param name="resolutionWidth" type="Integer" minvalue="1" maxvalue="10000">
+ <param name="resolutionWidth" type="Integer" minvalue="1" maxvalue="10000" mandatory="true">
<description>The image resolution width.</description>
</param>
- <param name="resolutionHeight" type="Integer" minvalue="1" maxvalue="10000">
+ <param name="resolutionHeight" type="Integer" minvalue="1" maxvalue="10000" mandatory="true">
<description>The image resolution height.</description>
</param>
</struct>
<struct name="ImageField">
- <param name="name" type="ImageFieldName">
+ <param name="name" type="ImageFieldName" mandatory="true">
<description>The name that identifies the field. See ImageFieldName.</description>
</param>
- <param name="imageTypeSupported" type="FileType" minsize="1" maxsize="100" array="true">
+ <param name="imageTypeSupported" type="FileType" minsize="1" maxsize="100" array="true" mandatory="true">
<description>The image types that are supported in this field. See FileType.</description>
</param>
<param name="imageResolution" type="ImageResolution" mandatory="false">
@@ -1749,46 +1749,46 @@ </enum>
<struct name="HMIPermissions">
- <param name="allowed" type="HMILevel" minsize="0" maxsize="100" array="true">
+ <param name="allowed" type="HMILevel" minsize="0" maxsize="100" array="true" mandatory="true">
<description>A set of all HMI levels that are permitted for this given RPC.</description>
</param>
- <param name="userDisallowed" type="HMILevel" minsize="0" maxsize="100" array="true">
+ <param name="userDisallowed" type="HMILevel" minsize="0" maxsize="100" array="true" mandatory="true">
<description>A set of all HMI levels that are prohibited for this given RPC.</description>
</param>
</struct>
<struct name="ParameterPermissions">
- <param name="allowed" type="String" minsize="0" maxsize="100" maxlength = "100" array="true">
+ <param name="allowed" type="String" minsize="0" maxsize="100" maxlength = "100" array="true" mandatory="true">
<description>A set of all parameters that are permitted for this given RPC.</description>
</param>
- <param name="userDisallowed" type="String" minsize="0" maxsize="100" maxlength = "100" array="true">
+ <param name="userDisallowed" type="String" minsize="0" maxsize="100" maxlength = "100" array="true" mandatory="true">
<description>A set of all parameters that are prohibited for this given RPC.</description>
</param>
</struct>
<struct name="PermissionItem">
- <param name="rpcName" type="String" maxlength="100">
+ <param name="rpcName" type="String" maxlength="100" mandatory="true">
<description>Name of the individual RPC in the policy table.</description>
</param>
- <param name="hmiPermissions" type="HMIPermissions" />
- <param name="parameterPermissions" type="ParameterPermissions" />
+ <param name="hmiPermissions" type="HMIPermissions" mandatory="true"/>
+ <param name="parameterPermissions" type="ParameterPermissions" mandatory="true"/>
</struct>
<struct name="DisplayCapabilities">
<description>Contains information about the display capabilities.</description>
- <param name="displayType" type="DisplayType">
+ <param name="displayType" type="DisplayType" mandatory="true">
<description>The type of the display. See DisplayType</description>
</param>
- <param name="textFields" type="TextField" minsize="1" maxsize="100" array="true">
+ <param name="textFields" type="TextField" minsize="1" maxsize="100" array="true" mandatory="true">
<description>A set of all fields that support text data. See TextField</description>
</param>
<param name="imageFields" type="ImageField" minsize="1" maxsize="100" array="true" mandatory="false">
<description>A set of all fields that support images. See ImageField</description>
</param>
- <param name="mediaClockFormats" type="MediaClockFormat" minsize="0" maxsize="100" array="true">
+ <param name="mediaClockFormats" type="MediaClockFormat" minsize="0" maxsize="100" array="true" mandatory="true">
<description>A set of all supported formats of the media clock. See MediaClockFormat</description>
</param>
- <param name="graphicSupported" type="Boolean">
+ <param name="graphicSupported" type="Boolean" mandatory="true">
<description>The display's persistent screen supports referencing a static or dynamic image.</description>
</param>
<param name="templatesAvailable" type="String" minsize="0" maxsize="100" maxlength="100" array="true" mandatory="false">
@@ -1806,22 +1806,22 @@ <struct name="ButtonCapabilities">
<description>Contains information about a button's capabilities.</description>
- <param name="name" type="ButtonName">
+ <param name="name" type="ButtonName" mandatory="true">
<description>The name of the button. See ButtonName.</description>
</param>
- <param name="shortPressAvailable" type="Boolean">
+ <param name="shortPressAvailable" type="Boolean" mandatory="true">
<description>
The button supports a short press.
Whenever the button is pressed short, onButtonPressed( SHORT) will be invoked.
</description>
</param>
- <param name="longPressAvailable" type="Boolean">
+ <param name="longPressAvailable" type="Boolean" mandatory="true">
<description>
The button supports a LONG press.
Whenever the button is pressed long, onButtonPressed( LONG) will be invoked.
</description>
</param>
- <param name="upDownAvailable" type="Boolean">
+ <param name="upDownAvailable" type="Boolean" mandatory="true">
<description>
The button supports "button down" and "button up".
Whenever the button is pressed, onButtonEvent( DOWN) will be invoked.
@@ -1832,33 +1832,33 @@ <struct name="SoftButtonCapabilities">
<description>Contains information about a SoftButton's capabilities.</description>
- <param name="shortPressAvailable" type="Boolean">
+ <param name="shortPressAvailable" type="Boolean" mandatory="true">
<description>
The button supports a short press.
Whenever the button is pressed short, onButtonPressed( SHORT) will be invoked.
</description>
</param>
- <param name="longPressAvailable" type="Boolean">
+ <param name="longPressAvailable" type="Boolean" mandatory="true">
<description>
The button supports a LONG press.
Whenever the button is pressed long, onButtonPressed( LONG) will be invoked.
</description>
</param>
- <param name="upDownAvailable" type="Boolean">
+ <param name="upDownAvailable" type="Boolean" mandatory="true">
<description>
The button supports "button down" and "button up".
Whenever the button is pressed, onButtonEvent( DOWN) will be invoked.
Whenever the button is released, onButtonEvent( UP) will be invoked.
</description>
</param>
- <param name="imageSupported" type="Boolean">
+ <param name="imageSupported" type="Boolean" mandatory="true">
<description>The button supports referencing a static or dynamic image.</description>
</param>
</struct>
<struct name="PresetBankCapabilities">
<description>Contains information about on-screen preset capabilities.</description>
- <param name="onScreenPresetsAvailable" type="Boolean">
+ <param name="onScreenPresetsAvailable" type="Boolean" mandatory="true">
<description>Onscreen custom presets are available.</description>
</param>
</struct>
@@ -1890,20 +1890,20 @@ </description>
</param>
- <param name="menuName" type="String" maxlength="500">
+ <param name="menuName" type="String" maxlength="500" mandatory="true">
<description>Text to show in the menu for this sub menu.</description>
</param>
</struct>
<struct name="TTSChunk">
<description>A TTS chunk, that consists of the text/phonemes to speak and the type (like text or SAPI)</description>
- <param name="text" minlength="0" maxlength="500" type="String">
+ <param name="text" minlength="0" maxlength="500" type="String" mandatory="true">
<description>
The text or phonemes to speak.
May not be empty.
</description>
</param>
- <param name="type" type="SpeechCapabilities">
+ <param name="type" type="SpeechCapabilities" mandatory="true">
<description>Describes, whether it is text or a specific phoneme set. See SpeechCapabilities</description>
</param>
</struct>
@@ -2386,11 +2386,11 @@ Before registerAppInterface no other commands will be accepted/executed.
</description>
- <param name="syncMsgVersion" type="SyncMsgVersion">
+ <param name="syncMsgVersion" type="SyncMsgVersion" mandatory="true">
<description>See SyncMsgVersion</description>
</param>
- <param name="appName" type="String" maxlength="100">
+ <param name="appName" type="String" maxlength="100" mandatory="true">
<description>
The mobile application name, e.g. "Ford Drive Green".
Needs to be unique over all applications.
@@ -2429,7 +2429,7 @@ </description>
</param>
- <param name="isMediaApplication" type="Boolean">
+ <param name="isMediaApplication" type="Boolean" mandatory="true">
<description>
Indicates if the application is a media or a non-media application.
Only media applications will be able to stream audio to Sync that is audible outside of the BT media source.
@@ -2483,11 +2483,11 @@ <function name="RegisterAppInterface" functionID="RegisterAppInterfaceID" messagetype="response">
<description>The response to registerAppInterface</description>
- <param name="success" type="Boolean" platform="documentation">
+ <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">
+ <param name="resultCode" type="Result" platform="documentation" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -2596,11 +2596,11 @@ <function name="UnregisterAppInterface" functionID="UnregisterAppInterfaceID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation">
+ <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">
+ <param name="resultCode" type="Result" platform="documentation" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -2666,11 +2666,11 @@ <function name="SetGlobalProperties" functionID="SetGlobalPropertiesID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation">
+ <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">
+ <param name="resultCode" type="Result" platform="documentation" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -2693,18 +2693,18 @@ <function name="ResetGlobalProperties" functionID="ResetGlobalPropertiesID" messagetype="request">
<description>Allows resetting global properties.</description>
- <param name="properties" type="GlobalProperty" minsize="1" maxsize="100" array="true" >
+ <param name="properties" type="GlobalProperty" minsize="1" maxsize="100" array="true" mandatory="true">
<description>Contains the names of all global properties (like timeoutPrompt) that should be unset. Resetting means, that they have the same value as at start up (default)</description>
</param>
</function>
<function name="ResetGlobalProperties" functionID="ResetGlobalPropertiesID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation">
+ <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">
+ <param name="resultCode" type="Result" platform="documentation" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -2753,11 +2753,11 @@ <function name="AddCommand" functionID="AddCommandID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation">
+ <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">
+ <param name="resultCode" type="Result" platform="documentation" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -2782,18 +2782,18 @@ <function name="DeleteCommand" functionID="DeleteCommandID" messagetype="request">
<description>Deletes all commands from the in-application menu with the specified command id.</description>
- <param name="cmdID" type="Integer" minvalue="0" maxvalue="2000000000">
+ <param name="cmdID" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true">
<description>ID of the command(s) to delete.</description>
</param>
</function>
<function name="DeleteCommand" functionID="DeleteCommandID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation">
+ <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">
+ <param name="resultCode" type="Result" platform="documentation" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -2815,7 +2815,7 @@ <function name="AddSubMenu" functionID="AddSubMenuID" messagetype="request">
<description>Adds a sub menu to the in-application menu.</description>
- <param name="menuID" type="Integer" minvalue="1" maxvalue="2000000000">
+ <param name="menuID" type="Integer" minvalue="1" maxvalue="2000000000" mandatory="true">
<description>unique ID of the sub menu to add.</description>
</param>
@@ -2830,17 +2830,17 @@ </description>
</param>
- <param name="menuName" maxlength="500" type="String">
+ <param name="menuName" maxlength="500" type="String" mandatory="true">
<description>Text to show in the menu for this sub menu.</description>
</param>
</function>
<function name="AddSubMenu" functionID="AddSubMenuID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation">
+ <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">
+ <param name="resultCode" type="Result" platform="documentation" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -2861,7 +2861,7 @@ <function name="DeleteSubMenu" functionID="DeleteSubMenuID" messagetype="request">
<description>Deletes a submenu from the in-application menu.</description>
- <param name="menuID" type="Integer" minvalue="1" maxvalue="2000000000">
+ <param name="menuID" type="Integer" minvalue="1" maxvalue="2000000000" mandatory="true">
<description>The "menuID" of the submenu to delete. (See addSubMenu.menuID)</description>
</param>
@@ -2869,11 +2869,11 @@ <function name="DeleteSubMenu" functionID="DeleteSubMenuID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation">
+ <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">
+ <param name="resultCode" type="Result" platform="documentation" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -2895,19 +2895,19 @@ <function name="CreateInteractionChoiceSet" functionID="CreateInteractionChoiceSetID" messagetype="request">
<description>creates interaction choice set to be used later by performInteraction</description>
- <param name="interactionChoiceSetID" type="Integer" minvalue="0" maxvalue="2000000000">
+ <param name="interactionChoiceSetID" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true">
<description>Unique ID used for this interaction choice set.</description>
</param>
- <param name="choiceSet" type="Choice" minsize="1" maxsize="100" array="true" />
+ <param name="choiceSet" type="Choice" minsize="1" maxsize="100" array="true" mandatory="true"/>
</function>
<function name="CreateInteractionChoiceSet" functionID="CreateInteractionChoiceSetID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation">
+ <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">
+ <param name="resultCode" type="Result" platform="documentation" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -2929,7 +2929,7 @@ <function name="PerformInteraction" functionID="PerformInteractionID" messagetype="request">
<description>Triggers an interaction (e.g. "Permit GPS?" - Yes, no, Always Allow).</description>
- <param name="initialText" type="String" maxlength="500" >
+ <param name="initialText" type="String" maxlength="500" mandatory="true">
<description>
Text to be displayed first.
</description>
@@ -2943,11 +2943,11 @@ </description>
</param>
- <param name="interactionMode" type="InteractionMode">
+ <param name="interactionMode" type="InteractionMode" mandatory="true">
<description>See InteractionMode.</description>
</param>
- <param name="interactionChoiceSetIDList" type="Integer" minsize="0" maxsize="100" minvalue="0" maxvalue="2000000000" array="true">
+ <param name="interactionChoiceSetIDList" type="Integer" minsize="0" maxsize="100" minvalue="0" maxvalue="2000000000" array="true" mandatory="true">
<description>List of interaction choice set IDs to use with an interaction.</description>
</param>
@@ -2990,11 +2990,11 @@ <function name="PerformInteraction" functionID="PerformInteractionID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation">
+ <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">
+ <param name="resultCode" type="Result" platform="documentation" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -3042,17 +3042,17 @@ <description>Deletes interaction choice set that has been created with "CreateInteractionChoiceSet".</description>
<description>The interaction may only be deleted when not currently in use by a "performInteraction".</description>
- <param name="interactionChoiceSetID" type="Integer" minvalue="0" maxvalue="2000000000">
+ <param name="interactionChoiceSetID" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true">
<description>ID of the interaction choice set to delete.</description>
</param>
</function>
<function name="DeleteInteractionChoiceSet" functionID="DeleteInteractionChoiceSetID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation">
+ <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">
+ <param name="resultCode" type="Result" platform="documentation" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -3124,11 +3124,11 @@ <function name="Alert" functionID="AlertID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation">
+ <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">
+ <param name="resultCode" type="Result" platform="documentation" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -3252,11 +3252,11 @@ <function name="Show" functionID="ShowID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation">
+ <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">
+ <param name="resultCode" type="Result" platform="documentation" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -3279,7 +3279,7 @@ <function name="Speak" functionID="SpeakID" messagetype="request">
<description>Speaks a text.</description>
- <param name="ttsChunks" type="TTSChunk" minsize="1" maxsize="100" array="true">
+ <param name="ttsChunks" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="true">
<description>
An array of text chunks of type TTSChunk. See TTSChunk.
The array must have at least one item.
@@ -3290,11 +3290,11 @@ <function name="Speak" functionID="SpeakID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation">
+ <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">
+ <param name="resultCode" type="Result" platform="documentation" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -3345,11 +3345,11 @@ </function>
<function name="SetMediaClockTimer" functionID="SetMediaClockTimerID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation">
+ <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">
+ <param name="resultCode" type="Result" platform="documentation" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -3403,11 +3403,11 @@ </function>
<function name="PerformAudioPassThru" functionID="PerformAudioPassThruID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation">
+ <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">
+ <param name="resultCode" type="Result" platform="documentation" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -3432,11 +3432,11 @@ </function>
<function name="EndAudioPassThru" functionID="EndAudioPassThruID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation">
+ <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">
+ <param name="resultCode" type="Result" platform="documentation" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -3460,17 +3460,17 @@ To unsubscribe the notifications, use unsubscribeButton.
</description>
- <param name="buttonName" type="ButtonName">
+ <param name="buttonName" type="ButtonName" mandatory="true">
<description>Name of the button to subscribe.</description>
</param>
</function>
<function name="SubscribeButton" functionID="SubscribeButtonID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation">
+ <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">
+ <param name="resultCode" type="Result" platform="documentation" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -3491,17 +3491,17 @@ <function name="UnsubscribeButton" functionID="UnsubscribeButtonID" messagetype="request">
<description>Unsubscribes from built-in HMI buttons.</description>
- <param name="buttonName" type="ButtonName">
+ <param name="buttonName" type="ButtonName" mandatory="true">
<description>Name of the button to unsubscribe.</description>
</param>
</function>
<function name="UnsubscribeButton" functionID="UnsubscribeButtonID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation">
+ <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">
+ <param name="resultCode" type="Result" platform="documentation" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -3607,11 +3607,11 @@ </function>
<function name="SubscribeVehicleData" functionID="SubscribeVehicleDataID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation">
+ <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">
+ <param name="resultCode" type="Result" platform="documentation" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="WARNINGS"/>
@@ -3790,11 +3790,11 @@ </function>
<function name="UnsubscribeVehicleData" functionID="UnsubscribeVehicleDataID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation">
+ <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">
+ <param name="resultCode" type="Result" platform="documentation" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="WARNINGS"/>
@@ -3976,11 +3976,11 @@ <function name="GetVehicleData" functionID="GetVehicleDataID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation">
+ <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">
+ <param name="resultCode" type="Result" platform="documentation" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -4092,11 +4092,11 @@ <function name="ReadDID" functionID="ReadDIDID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation">
+ <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">
+ <param name="resultCode" type="Result" platform="documentation" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -4135,11 +4135,11 @@ <function name="GetDTCs" functionID="GetDTCsID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation">
+ <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">
+ <param name="resultCode" type="Result" platform="documentation" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -4190,11 +4190,11 @@ <function name="DiagnosticMessage" functionID="DiagnosticMessageID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation">
+ <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">
+ <param name="resultCode" type="Result" platform="documentation" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -4222,7 +4222,7 @@ <function name="ScrollableMessage" functionID="ScrollableMessageID" messagetype="request">
<description>Creates a full screen overlay containing a large block of formatted text that can be scrolled with up to 8 SoftButtons defined</description>
- <param name="scrollableMessageBody" type="String" maxlength="500">
+ <param name="scrollableMessageBody" type="String" maxlength="500" mandatory="true">
<description>Body of text that can include newlines and tabs.</description>
</param>
<param name="timeout" type="Integer" minvalue="1000" maxvalue="65535" defvalue="30000" mandatory="false">
@@ -4237,11 +4237,11 @@ </function>
<function name="ScrollableMessage" functionID="ScrollableMessageID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation">
+ <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">
+ <param name="resultCode" type="Result" platform="documentation" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -4291,11 +4291,11 @@ </function>
<function name="Slider" functionID="SliderID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation">
+ <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">
+ <param name="resultCode" type="Result" platform="documentation" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="SAVED"/>
@@ -4365,10 +4365,10 @@ </function>
<function name="ShowConstantTBT" functionID="ShowConstantTBTID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation">
+ <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">
+ <param name="resultCode" type="Result" platform="documentation" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -4396,10 +4396,10 @@ </function>
<function name="AlertManeuver" functionID="AlertManeuverID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation">
+ <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">
+ <param name="resultCode" type="Result" platform="documentation" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -4429,10 +4429,10 @@ </function>
<function name="UpdateTurnList" functionID="UpdateTurnListID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation">
+ <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">
+ <param name="resultCode" type="Result" platform="documentation" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -4476,14 +4476,14 @@ <function name="ChangeRegistration" functionID="ChangeRegistrationID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation">
+ <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">
+ <param name="resultCode" type="Result" platform="documentation" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -4506,11 +4506,11 @@ Generic Response is sent, when the name of a received msg cannot be retrieved. Only used in case of an error.
Currently, only resultCode INVALID_DATA is used.
</description>
- <param name="success" type="Boolean" platform="documentation">
+ <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">
+ <param name="resultCode" type="Result" platform="documentation" mandatory="true">
<description>See Result</description>
<element name="INVALID_DATA"/>
</param>
@@ -4568,11 +4568,11 @@ <function name="PutFile" functionID="PutFileID" messagetype="response">
<description>Response is sent, when the file data was copied (success case). Or when an error occured.</description>
<description>Not supported on First generation SYNC vehicles. </description>
- <param name="success" type="Boolean" platform="documentation">
+ <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">
+ <param name="resultCode" type="Result" platform="documentation" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -4584,7 +4584,7 @@ <element name="UNSUPPORTED_REQUEST"/>
</param>
- <param name="spaceAvailable" type="Integer" minvalue="0" maxvalue="2000000000">
+ <param name="spaceAvailable" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true">
<description>
Provides the total local space available in SDL Core for the registered app.
If the transfer has systemFile enabled, then the value will be set to 0 automatically.
@@ -4613,11 +4613,11 @@ Response is sent, when the file data was deleted (success case). Or when an error occured.
Not supported on First generation SYNC vehicles.
</description>
- <param name="success" type="Boolean" platform="documentation">
+ <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">
+ <param name="resultCode" type="Result" platform="documentation" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -4629,7 +4629,7 @@ <element name="UNSUPPORTED_REQUEST"/>
</param>
- <param name="spaceAvailable" type="Integer" minvalue="0" maxvalue="2000000000">
+ <param name="spaceAvailable" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true">
<description>Provides the total local space available on SYNC for the registered app.</description>
</param>
@@ -4650,11 +4650,11 @@ Returns the current list of resident filenames for the registered app along with the current space available
Not supported on First generation SYNC vehicles.
</description>
- <param name="success" type="Boolean" platform="documentation">
+ <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">
+ <param name="resultCode" type="Result" platform="documentation" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -4673,7 +4673,7 @@ </description>
</param>
- <param name="spaceAvailable" type="Integer" minvalue="0" maxvalue="2000000000">
+ <param name="spaceAvailable" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true">
<description>Provides the total local space available on SYNC for the registered app.</description>
</param>
@@ -4700,11 +4700,11 @@ Not supported on First generation SYNC vehicles.
</description>
- <param name="success" type="Boolean" platform="documentation">
+ <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">
+ <param name="resultCode" type="Result" platform="documentation" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -4739,11 +4739,11 @@ <function name="SetDisplayLayout" functionID="SetDisplayLayoutID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation">
+ <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">
+ <param name="resultCode" type="Result" platform="documentation" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -4795,11 +4795,11 @@ </function>
<function name="SystemRequest" functionID="SystemRequestID" messagetype="response" >
- <param name="success" type="Boolean" platform="documentation">
+ <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">
+ <param name="resultCode" type="Result" platform="documentation" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -4866,11 +4866,11 @@ </function>
<function name="SendLocation" functionID="SendLocationID" messagetype="response" >
- <param name="success" type="Boolean" platform="documentation">
+ <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">
+ <param name="resultCode" type="Result" platform="documentation" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -4891,7 +4891,7 @@ <function name="DialNumber" functionID="DialNumberID" messagetype="request">
<description>Dials a phone number and switches to phone application.</description>
- <param name="number" type="String" maxlength="40">
+ <param name="number" type="String" maxlength="40" mandatory="true">
<description>
Phone number is a string, which can be up to 40 chars.
All characters shall be stripped from string except digits 0-9 and * # , ; +
@@ -4900,12 +4900,12 @@ </function>
<function name="DialNumber" functionID="DialNumberID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation">
+ <param name="success" type="Boolean" platform="documentation" mandatory="true">
<description>true, if successful</description>
<description>false, if failed</description>
</param>
- <param name="resultCode" type="Result" platform="documentation">
+ <param name="resultCode" type="Result" platform="documentation" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -4926,10 +4926,10 @@ </function>
<function name="SubscribeWayPoints" functionID="SubscribeWayPointsID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation">
+ <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">
+ <param name="resultCode" type="Result" platform="documentation" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -4952,10 +4952,10 @@ </function>
<function name="GetWayPoints" functionID="GetWayPointsID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation">
+ <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">
+ <param name="resultCode" type="Result" platform="documentation" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -4980,10 +4980,10 @@ </function>
<function name="UnsubscribeWayPoints" functionID="UnsubscribeWayPointsID" messagetype="response">
- <param name="success" type="Boolean" platform="documentation">
+ <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">
+ <param name="resultCode" type="Result" platform="documentation" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -5004,29 +5004,29 @@ <!-- Notifications -->
<function name="OnHMIStatus" functionID="OnHMIStatusID" messagetype="notification">
- <param name="hmiLevel" type="HMILevel">
+ <param name="hmiLevel" type="HMILevel" mandatory="true">
<description>See HMILevel</description>
</param>
- <param name="audioStreamingState" type="AudioStreamingState">
+ <param name="audioStreamingState" type="AudioStreamingState" mandatory="true">
<description>See AudioStreamingState</description>
</param>
- <param name="systemContext" type="SystemContext">
+ <param name="systemContext" type="SystemContext" mandatory="true">
<description>See SystemContext</description>
</param>
</function>
<function name="OnAppInterfaceUnregistered" functionID="OnAppInterfaceUnregisteredID" messagetype="notification">
- <param name="reason" type="AppInterfaceUnregisteredReason">
+ <param name="reason" type="AppInterfaceUnregisteredReason" mandatory="true">
<description>See AppInterfaceUnregisteredReason</description>
</param>
</function>
<function name="OnButtonEvent" functionID="OnButtonEventID" messagetype="notification">
<description>Notifies application of UP/DOWN events for buttons to which the application is subscribed.</description>
- <param name="buttonName" type="ButtonName"/>
- <param name="buttonEventMode" type="ButtonEventMode">
+ <param name="buttonName" type="ButtonName" mandatory="true"/>
+ <param name="buttonEventMode" type="ButtonEventMode" mandatory="true">
<description>Indicates whether this is an UP or DOWN event.</description>
</param>
<param name="customButtonID" type="Integer" minvalue="0" maxvalue="65536" mandatory="false">
@@ -5036,8 +5036,8 @@ <function name="OnButtonPress" functionID="OnButtonPressID" messagetype="notification">
<description>Notifies application of LONG/SHORT press events for buttons to which the application is subscribed.</description>
- <param name="buttonName" type="ButtonName"/>
- <param name="buttonPressMode" type="ButtonPressMode">
+ <param name="buttonName" type="ButtonName" mandatory="true"/>
+ <param name="buttonPressMode" type="ButtonPressMode" mandatory="true">
<description>Indicates whether this is a LONG or SHORT button press event.</description>
</param>
<param name="customButtonID" type="Integer" minvalue="0" maxvalue="65536" mandatory="false">
@@ -5129,32 +5129,32 @@ </function>
<function name="OnCommand" functionID="OnCommandID" messagetype="notification">
- <param name="cmdID" type="Integer" minvalue="0" maxvalue="2000000000">
+ <param name="cmdID" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true">
<description>Command ID, which is related to a specific menu entry</description>
</param>
- <param name="triggerSource" type="TriggerSource">
+ <param name="triggerSource" type="TriggerSource" mandatory="true">
<description>See TriggerSource</description>
</param>
</function>
<function name="OnTBTClientState" functionID="OnTBTClientStateID" messagetype="notification" >
<description>Provides applications with notifications specific to the current TBT client status on the module</description>
- <param name="state" type="TBTState">
+ <param name="state" type="TBTState" mandatory="true">
<description>Current State of TBT client</description>
</param>
</function>
<function name="OnDriverDistraction" functionID="OnDriverDistractionID" messagetype="notification" >
<description>Provides driver distraction state to mobile applications</description>
- <param name="state" type="DriverDistractionState">
+ <param name="state" type="DriverDistractionState" mandatory="true">
<description>Current State of Driver Distraction</description>
</param>
</function>
<function name="OnPermissionsChange" functionID="OnPermissionsChangeID" messagetype="notification" >
<description>Provides update to app of which policy-table-enabled functions are available</description>
- <param name="permissionItem" type="PermissionItem" minsize="0" maxsize="500" array="true">
+ <param name="permissionItem" type="PermissionItem" minsize="0" maxsize="500" array="true" mandatory="true">
<description>Change in permissions for a given set of RPCs</description>
</param>
</function>
@@ -5164,10 +5164,10 @@ </function>
<function name="OnLanguageChange" functionID="OnLanguageChangeID" messagetype="notification">
- <param name="language" type="Language">
+ <param name="language" type="Language" mandatory="true">
<description>Current SYNC voice engine (VR+TTS) language</description>
</param>
- <param name="hmiDisplayLanguage" type="Language">
+ <param name="hmiDisplayLanguage" type="Language" mandatory="true">
<description>Current display language</description>
</param>
</function>
@@ -5267,11 +5267,11 @@ </function>
<function name="EncodedSyncPData" functionID="EncodedSyncPDataID" messagetype="response" >
- <param name="success" type="Boolean" platform="documentation">
+ <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">
+ <param name="resultCode" type="Result" platform="documentation" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -5296,11 +5296,11 @@ </function>
<function name="SyncPData" functionID="SyncPDataID" messagetype="response" >
- <param name="success" type="Boolean" platform="documentation">
+ <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">
+ <param name="resultCode" type="Result" platform="documentation" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
diff --git a/src/components/interfaces/v4_protocol_v1_2_no_extra.xml b/src/components/interfaces/v4_protocol_v1_2_no_extra.xml index ead8596ee6..cc522d9f1c 100644 --- a/src/components/interfaces/v4_protocol_v1_2_no_extra.xml +++ b/src/components/interfaces/v4_protocol_v1_2_no_extra.xml @@ -326,16 +326,16 @@ </enum>
<struct name="Choice">
<description>A choice is an option given to the user, which can be selected either by menu, or through voice recognition system.</description>
- <param name="choiceID" type="Integer" minvalue="0" maxvalue="65535"/>
- <param name="menuName" type="String" maxlength="500"/>
- <param name="vrCommands" type="String" minsize="1" maxsize="100" maxlength="99" array="true"/>
+ <param name="choiceID" type="Integer" minvalue="0" maxvalue="65535" mandatory="true"/>
+ <param name="menuName" type="String" maxlength="500" mandatory="true"/>
+ <param name="vrCommands" type="String" minsize="1" maxsize="100" maxlength="99" array="true" mandatory="true"/>
</struct>
<struct name="SyncMsgVersion">
<description>Specifies the version number of the SYNC V4 protocol, that is supported by the mobile application</description>
- <param name="majorVersion" type="Integer" minvalue="1" maxvalue="1">
+ <param name="majorVersion" type="Integer" minvalue="1" maxvalue="1" mandatory="true">
<description>The major version indicates versions that is not-compatible to previous versions.</description>
</param>
- <param name="minorVersion" type="Integer" minvalue="0" maxvalue="1000">
+ <param name="minorVersion" type="Integer" minvalue="0" maxvalue="1000" mandatory="true">
<description>The minor version indicates a change to a previous version that should still allow to be run on an older version (with limited functionality)</description>
</param>
</struct>
@@ -349,53 +349,53 @@ </element>
</enum>
<struct name="StartTime">
- <param name="hours" type="Integer" minvalue="0" maxvalue="59">
+ <param name="hours" type="Integer" minvalue="0" maxvalue="59" mandatory="true">
<description>The hour of the media clock.</description>
<description>Some radios only support a max of 19 hours. If out of range, it will be rejected.</description>
</param>
- <param name="minutes" type="Integer" minvalue="0" maxvalue="59"/>
- <param name="seconds" type="Integer" minvalue="0" maxvalue="59"/>
+ <param name="minutes" type="Integer" minvalue="0" maxvalue="59" mandatory="true"/>
+ <param name="seconds" type="Integer" minvalue="0" maxvalue="59" mandatory="true"/>
</struct>
<struct name="TextField">
- <param name="name" type="TextFieldName">
+ <param name="name" type="TextFieldName" mandatory="true">
<description>The name that identifies the field. See TextFieldName.</description>
</param>
- <param name="characterSet" type="CharacterSet">
+ <param name="characterSet" type="CharacterSet" mandatory="true">
<description>The character set that is supported in this field. See CharacterSet.</description>
</param>
- <param name="width" type="Integer" minvalue="1" maxvalue="40">
+ <param name="width" type="Integer" minvalue="1" maxvalue="40" mandatory="true">
<description>The number of characters in one row of this field.</description>
</param>
- <param name="rows" type="Integer" minvalue="1" maxvalue="3">
+ <param name="rows" type="Integer" minvalue="1" maxvalue="3" mandatory="true">
<description>The number of rows of this field.</description>
</param>
</struct>
<struct name="DisplayCapabilities">
<description>Contains information about the display capabilities.</description>
- <param name="displayType" type="DisplayType">
+ <param name="displayType" type="DisplayType" mandatory="true">
<description>The type of the display. See DisplayType</description>
</param>
- <param name="textFields" type="TextField" minsize="1" maxsize="100" array="true">
+ <param name="textFields" type="TextField" minsize="1" maxsize="100" array="true" mandatory="true">
<description>A set of all fields that support text data. See TextField</description>
</param>
- <param name="mediaClockFormats" type="MediaClockFormat" minsize="1" maxsize="100" array="true">
+ <param name="mediaClockFormats" type="MediaClockFormat" minsize="1" maxsize="100" array="true" mandatory="true">
<description>A set of all supported formats of the media clock. See MediaClockFormat</description>
</param>
</struct>
<struct name="ButtonCapabilities">
<description>Contains information about a buttons capabilities.</description>
- <param name="name" type="ButtonName">
+ <param name="name" type="ButtonName" mandatory="true">
<description>The name of the button. See ButtonName.</description>
</param>
- <param name="shortPressAvailable" type="Boolean">
+ <param name="shortPressAvailable" type="Boolean" mandatory="true">
<description>The button supports a short press.</description>
<description>Whenever the button is pressed short, onButtonPressed( SHORT) will be invoked.</description>
</param>
- <param name="longPressAvailable" type="Boolean">
+ <param name="longPressAvailable" type="Boolean" mandatory="true">
<description>The button supports a LONG press.</description>
<description>Whenever the button is pressed long, onButtonPressed( LONG) will be invoked.</description>
</param>
- <param name="upDownAvailable" type="Boolean">
+ <param name="upDownAvailable" type="Boolean" mandatory="true">
<description>The button supports "button down" and "button up".</description>
<description>Whenever the button is pressed, onButtonEvent( DOWN) will be invoked.</description>
<description>Whenever the button is released, onButtonEvent( UP) will be invoked.</description>
@@ -413,17 +413,17 @@ <description>if position is greater or equal than the number of items on top level, the sub menu will be appended to the end.</description>
<description>If this param was omitted the entry will be added at the end.</description>
</param>
- <param name="menuName" type="String" maxlength="500">
+ <param name="menuName" type="String" maxlength="500" mandatory="true">
<description>Text to show in the menu for this sub menu.</description>
</param>
</struct>
<struct name="TTSChunk">
<description>A TTS chunk, that consists of the text/phonemes to speak and the type (like text or SAPI)</description>
- <param name="text" maxlength="500" type="String">
+ <param name="text" maxlength="500" type="String" mandatory="true">
<description>The text or phonemes to speak.</description>
<description>May not be empty.</description>
</param>
- <param name="type" type="SpeechCapabilities">
+ <param name="type" type="SpeechCapabilities" mandatory="true">
<description>Describes, whether it is text or a specific phoneme set. See SpeechCapabilities</description>
</param>
</struct>
@@ -431,10 +431,10 @@ <function name="RegisterAppInterface" messagetype="request">
<description>Establishes an interface with a mobile application.</description>
<description>Before registerAppInterface no other commands will be accepted/executed.</description>
- <param name="syncMsgVersion" type="SyncMsgVersion">
+ <param name="syncMsgVersion" type="SyncMsgVersion" mandatory="true">
<description>See SyncMsgVersion</description>
</param>
- <param name="appName" type="String" maxlength="100">
+ <param name="appName" type="String" maxlength="100" mandatory="true">
<description>The mobile application name, e.g. "Ford Drive Green".</description>
<description>Needs to be unique over all applications.</description>
<description>May not be empty.</description>
@@ -457,11 +457,11 @@ <description>If not provided, the default is equal to False"</description>
<description>Indicates if the mobile application wants to use vehicle data like GPS or speed.</description>
</param>
- <param name="isMediaApplication" type="Boolean">
+ <param name="isMediaApplication" type="Boolean" mandatory="true">
<description>Indicates if the application is a media or a non-media application.</description>
<description>Only media applications will be able to stream audio to Sync that is audible outside of the BT media source.</description>
</param>
- <param name="languageDesired" type="Language">
+ <param name="languageDesired" type="Language" mandatory="true">
<description>See Language</description>
<description>If the language doesn't match the active language on Sync, it will be rejected.</description>
<description>If the language is changed, while an app is registered, it will get disconnected.</description>
@@ -475,11 +475,11 @@ </function>
<function name="RegisterAppInterface" messagetype="response">
<description>The response to registerAppInterface</description>
- <param name="success" type="Boolean">
+ <param name="success" type="Boolean" mandatory="true">
<description>true, if successful</description>
<description>false, if failed</description>
</param>
- <param name="resultCode" type="Result">
+ <param name="resultCode" type="Result" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -527,11 +527,11 @@ <description>Will fail, if no registerAppInterface was completed successfully before.</description>
</function>
<function name="UnregisterAppInterface" messagetype="response">
- <param name="success" type="Boolean">
+ <param name="success" type="Boolean" mandatory="true">
<description>true, if successful</description>
<description>false, if failed</description>
</param>
- <param name="resultCode" type="Result">
+ <param name="resultCode" type="Result" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -559,11 +559,11 @@ <issue creator="rs">Do we want to add VR threshold params?</issue>
</function>
<function name="SetGlobalProperties" messagetype="response">
- <param name="success" type="Boolean">
+ <param name="success" type="Boolean" mandatory="true">
<description>true, if successful</description>
<description>false, if failed</description>
</param>
- <param name="resultCode" type="Result">
+ <param name="resultCode" type="Result" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -579,16 +579,16 @@ </function>
<function name="ResetGlobalProperties" messagetype="request">
<description>Allows resetting global properties.</description>
- <param name="properties" type="GlobalProperty" minsize="1" maxsize="100" array="true">
+ <param name="properties" type="GlobalProperty" minsize="1" maxsize="100" array="true" mandatory="true">
<description>Contains the names of all global properties (like timeoutPrompt) that should be unset. Resetting means, that they have the same value as at start up (default)</description>
</param>
</function>
<function name="ResetGlobalProperties" messagetype="response">
- <param name="success" type="Boolean">
+ <param name="success" type="Boolean" mandatory="true">
<description>true, if successful</description>
<description>false, if failed</description>
</param>
- <param name="resultCode" type="Result">
+ <param name="resultCode" type="Result" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -605,7 +605,7 @@ <function name="AddCommand" messagetype="request">
<description>Adds a command to the in application menu.</description>
<description>Either menuParams or vrCommands must be provided.</description>
- <param name="cmdID" type="Integer" minvalue="0" maxvalue="2000000000">
+ <param name="cmdID" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true">
<description>unique ID of the command to add.</description>
</param>
<param name="menuParams" type="MenuParams" mandatory="false">
@@ -617,11 +617,11 @@ </param>
</function>
<function name="AddCommand" messagetype="response">
- <param name="success" type="Boolean">
+ <param name="success" type="Boolean" mandatory="true">
<description>true, if successful</description>
<description>false, if failed</description>
</param>
- <param name="resultCode" type="Result">
+ <param name="resultCode" type="Result" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -639,16 +639,16 @@ </function>
<function name="DeleteCommand" messagetype="request">
<description>Deletes all commands from the in-application menu with the specified command id.</description>
- <param name="cmdID" type="Integer" minvalue="0" maxvalue="2000000000">
+ <param name="cmdID" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true">
<description>ID of the command(s) to delete.</description>
</param>
</function>
<function name="DeleteCommand" messagetype="response">
- <param name="success" type="Boolean">
+ <param name="success" type="Boolean" mandatory="true">
<description>true, if successful</description>
<description>false, if failed</description>
</param>
- <param name="resultCode" type="Result">
+ <param name="resultCode" type="Result" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -666,7 +666,7 @@ </function>
<function name="AddSubMenu" messagetype="request">
<description>Adds a sub menu to the in-application menu.</description>
- <param name="menuID" type="Integer" minvalue="0" maxvalue="2000000000">
+ <param name="menuID" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true">
<description>unique ID of the sub menu to add.</description>
</param>
<param name="position" type="Integer" minvalue="0" maxvalue="1000" mandatory="false">
@@ -677,16 +677,16 @@ <description>Position of any submenu will always be located before the return and exit options</description>
<description>If this param was omitted the entry will be added at the end.</description>
</param>
- <param name="menuName" maxlength="500" type="String">
+ <param name="menuName" maxlength="500" type="String" mandatory="true">
<description>Text to show in the menu for this sub menu.</description>
</param>
</function>
<function name="AddSubMenu" messagetype="response">
- <param name="success" type="Boolean">
+ <param name="success" type="Boolean" mandatory="true">
<description>true, if successful</description>
<description>false, if failed</description>
</param>
- <param name="resultCode" type="Result">
+ <param name="resultCode" type="Result" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -704,16 +704,16 @@ </function>
<function name="DeleteSubMenu" messagetype="request">
<description>Deletes a submenu from the in-application menu.</description>
- <param name="menuID" type="Integer" minvalue="0" maxvalue="2000000000">
+ <param name="menuID" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true">
<description>The "menuID" of the submenu to delete. (See addSubMenu.menuID)</description>
</param>
</function>
<function name="DeleteSubMenu" messagetype="response">
- <param name="success" type="Boolean">
+ <param name="success" type="Boolean" mandatory="true">
<description>true, if successful</description>
<description>false, if failed</description>
</param>
- <param name="resultCode" type="Result">
+ <param name="resultCode" type="Result" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -731,17 +731,17 @@ </function>
<function name="CreateInteractionChoiceSet" messagetype="request">
<description>creates interaction choice set to be used later by performInteraction</description>
- <param name="interactionChoiceSetID" type="Integer" minvalue="0" maxvalue="2000000000">
+ <param name="interactionChoiceSetID" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true">
<description>Unique ID used for this interaction choice set.</description>
</param>
- <param name="choiceSet" type="Choice" minsize="1" maxsize="100" array="true"/>
+ <param name="choiceSet" type="Choice" minsize="1" maxsize="100" array="true" mandatory="true"/>
</function>
<function name="CreateInteractionChoiceSet" messagetype="response">
- <param name="success" type="Boolean">
+ <param name="success" type="Boolean" mandatory="true">
<description>true, if successful</description>
<description>false, if failed</description>
</param>
- <param name="resultCode" type="Result">
+ <param name="resultCode" type="Result" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -759,18 +759,18 @@ </function>
<function name="PerformInteraction" messagetype="request">
<description>Triggers an interaction (e.g. "Permit GPS?" - Yes, no, Always Allow).</description>
- <param name="initialText" type="String" maxlength="500">
+ <param name="initialText" type="String" maxlength="500" mandatory="true">
<description>Text to be displayed first.</description>
</param>
- <param name="initialPrompt" type="TTSChunk" minsize="1" maxsize="100" array="true">
+ <param name="initialPrompt" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="true">
<description>This is the intial prompt spoken to the user at the start of an interaction</description>
<description>An array of text chunks of type TTSChunk. See TTSChunk</description>
<description>The array must have at least one item</description>
</param>
- <param name="interactionMode" type="InteractionMode">
+ <param name="interactionMode" type="InteractionMode" mandatory="true">
<description>See InteractionMode.</description>
</param>
- <param name="interactionChoiceSetIDList" type="Integer" minsize="1" maxsize="100" minvalue="0" maxvalue="2000000000" array="true">
+ <param name="interactionChoiceSetIDList" type="Integer" minsize="1" maxsize="100" minvalue="0" maxvalue="2000000000" array="true" mandatory="true">
<description>List of interaction choice set IDs to use with an interaction.</description>
</param>
<param name="helpPrompt" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false">
@@ -789,11 +789,11 @@ </param>
</function>
<function name="PerformInteraction" messagetype="response">
- <param name="success" type="Boolean">
+ <param name="success" type="Boolean" mandatory="true">
<description>true, if successful</description>
<description>false, if failed</description>
</param>
- <param name="resultCode" type="Result">
+ <param name="resultCode" type="Result" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -819,16 +819,16 @@ <function name="DeleteInteractionChoiceSet" messagetype="request">
<description>Deletes interaction choice set that has been created with "CreateInteractionChoiceSet".</description>
<description>The interaction may only be deleted when not currently in use by a "performInteraction".</description>
- <param name="interactionChoiceSetID" type="Integer" minvalue="0" maxvalue="2000000000">
+ <param name="interactionChoiceSetID" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true">
<description>ID of the interaction choice set to delete.</description>
</param>
</function>
<function name="DeleteInteractionChoiceSet" messagetype="response">
- <param name="success" type="Boolean">
+ <param name="success" type="Boolean" mandatory="true">
<description>true, if successful</description>
<description>false, if failed</description>
</param>
- <param name="resultCode" type="Result">
+ <param name="resultCode" type="Result" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -867,11 +867,11 @@ </param>
</function>
<function name="Alert" messagetype="response">
- <param name="success" type="Boolean">
+ <param name="success" type="Boolean" mandatory="true">
<description>true, if successful</description>
<description>false, if failed</description>
</param>
- <param name="resultCode" type="Result">
+ <param name="resultCode" type="Result" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -917,11 +917,11 @@ </param>
</function>
<function name="Show" messagetype="response">
- <param name="success" type="Boolean">
+ <param name="success" type="Boolean" mandatory="true">
<description>true, if successful</description>
<description>false, if failed</description>
</param>
- <param name="resultCode" type="Result">
+ <param name="resultCode" type="Result" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -937,17 +937,17 @@ </function>
<function name="Speak" messagetype="request">
<description>Speaks a text.</description>
- <param name="ttsChunks" type="TTSChunk" minsize="1" maxsize="100" array="true">
+ <param name="ttsChunks" type="TTSChunk" minsize="1" maxsize="100" array="true" mandatory="true">
<description>An array of text chunks of type TTSChunk. See TTSChunk</description>
<description>The array must have at least one item</description>
</param>
</function>
<function name="Speak" messagetype="response">
- <param name="success" type="Boolean">
+ <param name="success" type="Boolean" mandatory="true">
<description>true, if successful</description>
<description>false, if failed</description>
</param>
- <param name="resultCode" type="Result">
+ <param name="resultCode" type="Result" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -969,17 +969,17 @@ <description>startTime must be provided for "run"</description>
<description>startTime will be ignored for "pause" and "resum"</description>
</param>
- <param name="updateMode" type="UpdateMode">
+ <param name="updateMode" type="UpdateMode" mandatory="true">
<description>Enumeration to control the media clock.</description>
<description>In case of pause or resume, the start time value is ignored and shall be left out. For resume, the time continues with the same value as it was when paused.</description>
</param>
</function>
<function name="SetMediaClockTimer" messagetype="response">
- <param name="success" type="Boolean">
+ <param name="success" type="Boolean" mandatory="true">
<description>true, if successful</description>
<description>false, if failed</description>
</param>
- <param name="resultCode" type="Result">
+ <param name="resultCode" type="Result" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -1002,11 +1002,11 @@ </param>
</function>
<function name="EncodedSyncPData" messagetype="response">
- <param name="success" type="Boolean">
+ <param name="success" type="Boolean" mandatory="true">
<description>true, if successful</description>
<description>false, if failed</description>
</param>
- <param name="resultCode" type="Result">
+ <param name="resultCode" type="Result" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -1024,16 +1024,16 @@ <description>Subscribes to built-in HMI buttons.</description>
<description>The application will be notified by the OnButtonEvent and OnButtonPress.</description>
<description>To unsubscribe the notifications, use unsubscribeButton.</description>
- <param name="buttonName" type="ButtonName">
+ <param name="buttonName" type="ButtonName" mandatory="true">
<description>Name of the button to subscribe.</description>
</param>
</function>
<function name="SubscribeButton" messagetype="response">
- <param name="success" type="Boolean">
+ <param name="success" type="Boolean" mandatory="true">
<description>true, if successful</description>
<description>false, if failed</description>
</param>
- <param name="resultCode" type="Result">
+ <param name="resultCode" type="Result" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -1051,16 +1051,16 @@ </function>
<function name="UnsubscribeButton" messagetype="request">
<description>Unsubscribes from built-in HMI buttons.</description>
- <param name="buttonName" type="ButtonName">
+ <param name="buttonName" type="ButtonName" mandatory="true">
<description>Name of the button to unsubscribe.</description>
</param>
</function>
<function name="UnsubscribeButton" messagetype="response">
- <param name="success" type="Boolean">
+ <param name="success" type="Boolean" mandatory="true">
<description>true, if successful</description>
<description>false, if failed</description>
</param>
- <param name="resultCode" type="Result">
+ <param name="resultCode" type="Result" mandatory="true">
<description>See Result</description>
<element name="SUCCESS"/>
<element name="INVALID_DATA"/>
@@ -1079,11 +1079,11 @@ <function name="GenericResponse" messagetype="response">
<description>Generic Response is sent, when the name of a received msg cannot be retrieved. Only used in case of an error.</description>
<description>Currently, only resultCode INVALID_DATA is used.</description>
- <param name="success" type="Boolean">
+ <param name="success" type="Boolean" mandatory="true">
<description>true, if successful</description>
<description>false, if failed</description>
</param>
- <param name="resultCode" type="Result">
+ <param name="resultCode" type="Result" mandatory="true">
<description>See Result</description>
<element name="INVALID_DATA"/>
</param>
@@ -1093,40 +1093,40 @@ </function>
<!-- Notifications -->
<function name="OnHMIStatus" messagetype="notification">
- <param name="hmiLevel" type="HMILevel">
+ <param name="hmiLevel" type="HMILevel" mandatory="true">
<description>See HMILevel</description>
</param>
- <param name="audioStreamingState" type="AudioStreamingState">
+ <param name="audioStreamingState" type="AudioStreamingState" mandatory="true">
<description>See AudioStreamingState</description>
</param>
- <param name="systemContext" type="SystemContext">
+ <param name="systemContext" type="SystemContext" mandatory="true">
<description>See SystemContext</description>
</param>
</function>
<function name="OnAppInterfaceUnregistered" messagetype="notification">
- <param name="reason" type="AppInterfaceUnregisteredReason">
+ <param name="reason" type="AppInterfaceUnregisteredReason" mandatory="true">
<description>See AppInterfaceUnregisteredReason</description>
</param>
</function>
<function name="OnButtonEvent" messagetype="notification">
<description>Notifies application of UP/DOWN events for buttons to which the application is subscribed.</description>
- <param name="buttonName" type="ButtonName"/>
- <param name="buttonEventMode" type="ButtonEventMode">
+ <param name="buttonName" type="ButtonName" mandatory="true"/>
+ <param name="buttonEventMode" type="ButtonEventMode" mandatory="true">
<description>Indicates whether this is an UP or DOWN event.</description>
</param>
</function>
<function name="OnButtonPress" messagetype="notification">
<description>Notifies application of LONG/SHORT press events for buttons to which the application is subscribed.</description>
- <param name="buttonName" type="ButtonName"/>
- <param name="buttonPressMode" type="ButtonPressMode">
+ <param name="buttonName" type="ButtonName" mandatory="true"/>
+ <param name="buttonPressMode" type="ButtonPressMode" mandatory="true">
<description>Indicates whether this is a LONG or SHORT button press event.</description>
</param>
</function>
<function name="OnCommand" messagetype="notification">
- <param name="cmdID" type="Integer" minvalue="0" maxvalue="2000000000">
+ <param name="cmdID" type="Integer" minvalue="0" maxvalue="2000000000" mandatory="true">
<description>Command ID, which is related to a specific menu entry.</description>
</param>
- <param name="triggerSource" type="TriggerSource">
+ <param name="triggerSource" type="TriggerSource" mandatory="true">
<description>See TriggerSource</description>
</param>
</function>
@@ -1138,13 +1138,13 @@ </function>
<function name="OnTBTClientState" messagetype="notification">
<description>Provides applications with notifications specific to the current TBT client status on the module</description>
- <param name="state" type="TBTState">
+ <param name="state" type="TBTState" mandatory="true">
<description>Current State of TBT client</description>
</param>
</function>
<function name="OnDriverDistraction" messagetype="notification">
<description>Provides driver distraction state to mobile applications</description>
- <param name="state" type="DriverDistractionState">
+ <param name="state" type="DriverDistractionState" mandatory="true">
<description>Current State of Driver Distraction</description>
</param>
</function>
diff --git a/tools/InterfaceGenerator/generator/parsers/RPCBase.py b/tools/InterfaceGenerator/generator/parsers/RPCBase.py index 22f3fd2c2d..59edf4a9b3 100755 --- a/tools/InterfaceGenerator/generator/parsers/RPCBase.py +++ b/tools/InterfaceGenerator/generator/parsers/RPCBase.py @@ -548,8 +548,12 @@ class Parser(object): """ params, subelements, attrib = self._parse_base_item(element, "") - params["is_mandatory"] = self._extract_optional_bool_attrib( - attrib, "mandatory", True) + is_mandatory = self._extract_attrib(attrib, "mandatory") + if is_mandatory is None: + raise ParseError("'mandatory' is not specified for parameter '" + + params["name"] + "'") + + params["is_mandatory"] = self._get_bool_from_string(is_mandatory) scope = self._extract_attrib(attrib, "scope") if scope is not None: |