diff options
Diffstat (limited to 'src/components/interfaces/MOBILE_API.xml')
| -rw-r--r-- | src/components/interfaces/MOBILE_API.xml | 179 |
1 files changed, 153 insertions, 26 deletions
diff --git a/src/components/interfaces/MOBILE_API.xml b/src/components/interfaces/MOBILE_API.xml index 4d9bfbf09d..185b9d8773 100644 --- a/src/components/interfaces/MOBILE_API.xml +++ b/src/components/interfaces/MOBILE_API.xml @@ -2618,6 +2618,8 @@ <element name="SendHapticDataID" value="49" hexvalue="31" since="4.5" /> <element name="SetCloudAppPropertiesID" value="50" hexvalue="32" since="5.1" /> <element name="PublishAppServiceID" value="52" hexvalue="34" since="5.1" /> + <element name="GetAppServiceDataID" value="53" hexvalue="35" since="5.1" /> + <element name="PerformAppServiceInteractionID" value="55" hexvalue="37" since="5.1" /> <!-- Base Notifications @@ -2643,6 +2645,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 +2803,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 +3617,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"> @@ -3787,7 +3773,7 @@ </description> </param> - <param name="queuePlaybackProgess" type="Integer" mandatory="false"> + <param name="queuePlaybackProgress" type="Integer" mandatory="false"> <description> Music: The current progress of the playback queue in seconds Podcast: The current progress of the playback queue in seconds @@ -3905,26 +3891,26 @@ </struct> <struct name="AppServiceManifest" since="5.1"> - <description> This manifest contains all the information necessary for the service to be published, activated, and consumers able to interact with it</description> + <description> This manifest contains all the information necessary for the service to be published, activated, and consumers able to interact with it </description> <param name="serviceName" type="String" mandatory="false"> - <description> Unique name of this service</description> + <description> Unique name of this service </description> </param> <param name="serviceType" type="String" mandatory="true"> - <description>The type of service that is to be offered by this app</description> + <description> The type of service that is to be offered by this app </description> </param> <param name="serviceIcon" type="String" mandatory="false"> - <description> The file name of the icon to be associated with this service. Most likely the same as the appIcon.</description> + <description> The file name of the icon to be associated with this service. Most likely the same as the appIcon. </description> </param> <param name="allowAppConsumers" type="Boolean" mandatory="false" defvalue="false"> - <description>If true, app service consumers beyond the IVI system will be able to access this service. If false, only the IVI system will be able consume the service. If not provided, it is assumed to be false. </description> + <description> If true, app service consumers beyond the IVI system will be able to access this service. If false, only the IVI system will be able consume the service. If not provided, it is assumed to be false. </description> </param> <param name="uriPrefix" type="String" mandatory="false"> - <description> The URI prefix for this service. If provided, all PerformAppServiceInteraction requests must start with it.</description> + <description> The URI prefix for this service. If provided, all PerformAppServiceInteraction requests must start with it. </description> </param> <param name="uriScheme" type="String" mandatory="false"> @@ -3973,8 +3959,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 +6889,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"> @@ -6980,7 +7025,82 @@ <description> If the request was successful, this object will be the current status of the service record for the published service. This will include the Core supplied service ID.</description> </param> </function> - + + <function name="GetAppServiceData" functionID="GetAppServiceDataID" messagetype="request" since="5.1"> + <description> This request asks the module for current data related to the specific service. It also includes an option to subscribe to that service for future updates</description> + + <param name="serviceType" type="String" mandatory="true"> + <description>See AppServiceType</description> + </param> + + <param name="subscribe" type="Boolean" mandatory="false"> + <description> If true, the consumer is requesting to subscribe to all future updates from the service publisher. If false, the consumer doesn't wish to subscribe and should be unsubscribed if it was previously subscribed.</description> + </param> + </function> + + <function name="GetAppServiceData" functionID="GetAppServiceDataID" messagetype="response" since="5.1"> + <description> This response includes the data that is requested from the specific service</description> + + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true, if successful; false, if failed </description> + </param> + + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result</description> + <element name="SUCCESS"/> + <element name="REJECTED"/> + <element name="DISALLOWED"/> + <element name="INVALID_DATA"/> + <element name="OUT_OF_MEMORY"/> + <element name="TOO_MANY_PENDING_REQUESTS"/> + <element name="APPLICATION_NOT_REGISTERED"/> + <element name="GENERIC_ERROR"/> + </param> + + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + + <!-- Specific response data --> + <param name="serviceData" type="AppServiceData" mandatory="false"/> + </function> + + <function name="PerformAppServiceInteraction" functionID="PerformAppServiceInteractionID" messagetype="request"> + <param name="serviceUri" type="String" mandatory="true"> + <description>Fully qualified URI based on the URI prefix and URI scheme the app service provided. SDL makes no gurantee that this URI is correct.</description> + </param> + + <param name="serviceID" type="String" mandatory="true"> + <description>The service ID that the app consumer wishes to send this URI.</description> + </param> + + <param name="originApp" type="String" mandatory="true"> + <description>This string is the appID of the app requesting the app service provider take the specific action.</description> + </param> + + <param name="requestServiceActive" type="Boolean" mandatory="false"> + <description>This flag signals the requesting consumer would like this service to become the active primary service of the destination's type.</description> + </param> + </function> + + <function name="PerformAppServiceInteraction" functionID="PerformAppServiceInteractionID" messagetype="response"> + <param name="success" type="Boolean" platform="documentation" mandatory="true"> + <description> true, if successful; false, if failed </description> + </param> + + <param name="resultCode" type="Result" platform="documentation" mandatory="true"> + <description>See Result. All results will be available for this response.</description> + </param> + + <param name="info" type="String" maxlength="1000" mandatory="false" platform="documentation"> + <description>Provides additional human readable info regarding the result.</description> + </param> + + <param name="serviceSpecificResult" type="String" mandatory="false"> + <description>The service can provide specific result strings to the consumer through this param. These results should be described in the URI schema set in the Service Manifest</description> + </param> + </function> + <!-- Notifications --> <function name="OnHMIStatus" functionID="OnHMIStatusID" messagetype="notification" since="1.0"> @@ -7280,6 +7400,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 --> <!-- ~~~~~~~~~~~~~~~~~~ --> |