diff options
Diffstat (limited to 'src/components/interfaces/MOBILE_API.xml')
| -rw-r--r-- | src/components/interfaces/MOBILE_API.xml | 86 |
1 files changed, 68 insertions, 18 deletions
diff --git a/src/components/interfaces/MOBILE_API.xml b/src/components/interfaces/MOBILE_API.xml index 4d9bfbf09d..01f0485323 100644 --- a/src/components/interfaces/MOBILE_API.xml +++ b/src/components/interfaces/MOBILE_API.xml @@ -2643,6 +2643,7 @@ <element name="OnWayPointChangeID" value="32784" hexvalue="8010" since="4.1" /> <element name="OnRCStatusID" value="32785" hexvalue="8011" since="5.0" /> <element name="OnAppServiceDataID" value="32786" hexvalue="8012" since="5.1" /> + <element name="OnSystemCapabilityUpdatedID" value="32787" hexvalue="8013" since="5.1" /> <!-- Ford Specific Request / Response RPCs @@ -2800,6 +2801,7 @@ <element name="PHONE_CALL"/> <element name="VIDEO_STREAMING"/> <element name="REMOTE_CONTROL"/> + <element name="APP_SERVICES" /> </enum> <struct name="NavigationCapability" since="4.5"> @@ -3613,24 +3615,6 @@ </struct> <!-- End of RC --> - <struct name="SystemCapability" since="4.5"> - <description>The systemCapabilityType indicates which type of data should be changed and identifies which data object exists in this struct. For example, if the SystemCapability Type is NAVIGATION then a "navigationCapability" should exist</description> - <param name="systemCapabilityType" type="SystemCapabilityType" mandatory="true"> - <description>Used as a descriptor of what data to expect in this struct. The corresponding param to this enum should be included and the only other para included.</description> - </param> - <param name="navigationCapability" type="NavigationCapability" mandatory="false"> - <description>Describes extended capabilities for onboard navigation system </description> - </param> - <param name="phoneCapability" type="PhoneCapability" mandatory="false"> - <description>Describes extended capabilities of the module's phone feature</description> - </param> - <param name="videoStreamingCapability" type="VideoStreamingCapability" mandatory="false"> - <description>Describes extended capabilities of the module's phone feature</description> - </param> - <param name="remoteControlCapability" type="RemoteControlCapabilities" mandatory="false"> - <description>Describes extended capabilities of the module's phone feature</description> - </param> - </struct> <enum name="MetadataType" since="4.5"> <element name="mediaTitle"> @@ -3973,8 +3957,64 @@ <param name="weatherServiceData" type="WeatherServiceData" mandatory="false"/> </struct> + <enum name="ServiceUpdateReason" since="5.1"> + <element name="PUBLISHED"> + <description> The service has just been published with the module and once activated to the primary service of its type, it will be ready for possible consumption.</description> + </element> + <element name="REMOVED"> + <description> The service has just been unpublished with the module and is no longer accessible</description> + </element> + <element name="ACTIVATED"> + <description> The service is activated as the primary service of this type. All requests dealing with this service type will be handled by this service.</description> + </element> + <element name="DEACTIVATED"> + <description> The service has been deactivated as the primary service of its type</description> + </element> + <element name="MANIFEST_UPDATE"> + <description> The service has updated its manifest. This could imply updated capabilities</description> + </element> + </enum> + + <struct name="AppServiceCapability" since="5.1"> + <param name="updateReason" type="ServiceUpdateReason" mandatory="false"> + <description> Only included in OnSystemCapabilityUpdated. Update reason for service record.</description> + </param> + <param name="updatedAppServiceRecord" type="AppServiceRecord" mandatory="true"> + <description>Service record for a specific app service provider</description> + </param> + </struct> + + <struct name="AppServicesCapabilities" since="5.1"> + <description>Capabilities of app services including what service types are supported and the current state of services.</description> + <param name="appServices" type="AppServiceCapability" array="true" mandatory="false"> + <description>An array of currently available services. If this is an update to the capability the affected services will include an update reason in that item</description> + </param> + </struct> + <!-- End App Services --> + <struct name="SystemCapability" since="4.5"> + <description>The systemCapabilityType identifies which data object exists in this struct. For example, if the SystemCapability Type is NAVIGATION then a "navigationCapability" should exist</description> + <param name="systemCapabilityType" type="SystemCapabilityType" mandatory="true"> + <description>Used as a descriptor of what data to expect in this struct. The corresponding param to this enum should be included and the only other para included.</description> + </param> + <param name="navigationCapability" type="NavigationCapability" mandatory="false"> + <description>Describes extended capabilities for onboard navigation system </description> + </param> + <param name="phoneCapability" type="PhoneCapability" mandatory="false"> + <description>Describes extended capabilities of the module's phone feature</description> + </param> + <param name="videoStreamingCapability" type="VideoStreamingCapability" mandatory="false"> + <description>Describes extended capabilities of the module's phone feature</description> + </param> + <param name="remoteControlCapability" type="RemoteControlCapabilities" mandatory="false"> + <description>Describes extended capabilities of the module's phone feature</description> + </param> + <param name="appServicesCapabilities" type="AppServicesCapabilities" mandatory="false"> + <description>An array of currently available services. If this is an update to the capability the affected services will include an update reason in that item</description> + </param> + </struct> + <!-- Requests/Responses --> <function name="RegisterAppInterface" functionID="RegisterAppInterfaceID" messagetype="request" since="1.0"> @@ -6847,6 +6887,9 @@ <param name="systemCapabilityType" type="SystemCapabilityType" mandatory="true"> <description>The type of system capability to get more information on</description> </param> + <param name="subscribe" type="Boolean" mandatory="false" since="5.1"> + <description>Flag to subscribe to updates of the supplied service capability type. If true, then requester will be subscribed</description> + </param> </function> <function name="GetSystemCapability" functionID="GetSystemCapabilityID" messagetype="response" since="4.5"> @@ -7280,6 +7323,13 @@ <param name="serviceData" type="AppServiceData" mandatory="true"/> </function> + <function name="OnSystemCapabilityUpdated" functionID="OnSystemCapabilityUpdatedID" messagetype="notification" since="5.1"> + <description>A notification to inform the connected device that a specific system capability has changed.</description> + <param name="systemCapability" type="SystemCapability" mandatory="true"> + <description>The system capability that has been updated</description> + </param> + </function> + <!-- ~~~~~~~~~~~~~~~~~~ --> <!-- Ford Specific APIs --> <!-- ~~~~~~~~~~~~~~~~~~ --> |