HMI_API.md

<struct name="HMIApplication">
    <description>Data type containing information about application needed by HMI.</description>
    <param name="appName" type="String" maxlength="100" mandatory="true">
      <description>The mobile application name, e.g. "Ford Drive Green".</description>
    </param>
    <param name="ngnMediaScreenAppName" type="String" maxlength="100" mandatory="false">
      <description>Provides an abbreviated version of the app name (if needed), that may be displayed on the NGN media screen.</description>
      <description>If not provided, the appName should be used instead (and may be truncated if too long)</description>
    </param>
    <param name="icon" type="String" mandatory="false">
      <description>Path to application icon stored on HU.</description>
    </param>
    <param name="deviceInfo" type="Common.DeviceInfo" mandatory="true">
       <description>The ID, serial number, transport type the named-app's-device is connected over to HU.</description>
    </param>
    <param name="secondaryDeviceInfo" type="Common.DeviceInfo" mandatory="false">
       <description>The ID, serial number, transport type that are acquired through Secondary Transport.</description>
    </param>
    <param name="policyAppID" type="String" maxlength="50" minlength="1" mandatory="true">
      <description>Policy ID(=the appID the application registers with) of registered application.</description>
    </param>
    <param name="ttsName" type="Common.TTSChunk" minsize="1" maxsize="100" array="true" mandatory="false" >
      <description>
        TTS string for VR recognition of the mobile application name, e.g. "Ford Drive Green".
        Meant to overcome any failing on speech engine in properly pronouncing / understanding app name.
        May not be empty.
        May not start with a new line character.
        Not unique value
      </description>
    </param>
    <param name="vrSynonyms" type="String" maxlength="40" minsize="1" maxsize="100" array="true" mandatory="false">
      <description>
        Defines an additional voice recognition command.
        Must not interfere with any name of previously registered applications from the same device.
      </description>
    </param>
    <param name="appID" type="Integer" mandatory="true">
      <description>Unique (during ignition cycle) id of the application. To be used in all RPCs sent by both HU system and SDL</description>
    </param>
    <param name="hmiDisplayLanguageDesired" type="Common.Language" mandatory="false">
      <description>The language the application intends to use on HU  </description>
    </param>
    <param name="isMediaApplication" type="Boolean" mandatory="false">
      <description>Indicates whether it is a media or a non-media application.</description>
    </param>
    <param name="appType" type="Common.AppHMIType" minsize="1" maxsize="100" array="true" mandatory="false">
      <description>List of all applicable app types stating which classifications to be given to the app.</description>
      <description>e.g. for platforms like GEN2, this determines which "corner(s)" the app can populate.</description>
    </param>
    <param name="greyOut" type="Boolean" mandatory="false">
      <description>Indicates whether application should be dimmed on the screen.</description>
      <description>Applicable only for apps received through QueryApps and still not registered.</description>
    </param>
    <param name="requestType" type="Common.RequestType" minsize="0" maxsize="100" array="true" mandatory="false">
      <description>The list of SystemRequest's RequestTypes allowed by policies for the named application</description>
      <description>(the app's SystemRequest sent with RequestType out of this list will get 'disallowed' response from SDL).</description>
      <description>If SDL sends an empty array - any RequestType is allowed for this app.</description>
      <description>If SDL omits this parameter - none RequestType is allowed for this app</description>
      <description>(either this is a pre-registered app or such is dictated by policies).</description>
    </param>
    <param name="requestSubType" type="String" maxlength="100" minsize="0" maxsize="100" array="true" mandatory="false">
      <description>
        The list of SystemRequest's requestSubTypes allowed by policies for the named application.
        If the app sends a requestSubType which is not specified in this list, then that request should be rejected.
        An empty array signifies that any value of requestSubType is allowed for this app.
        If this parameter is omitted, then a request with any value of requestSubType is now allowed for this app
      </description>
    </param>
    <param name="dayColorScheme" type="Common.TemplateColorScheme" mandatory="false"></param>
    <param name="nightColorScheme" type="Common.TemplateColorScheme" mandatory="false"></param>
    <param name="isCloudApplication" type="Boolean" mandatory="false"></param>
    <param name="cloudConnectionStatus" type="Common.CloudConnectionStatus" mandatory="false"></param>
</struct>