diff options
author | JackLivio <jack@livio.io> | 2019-07-24 14:04:54 -0400 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-07-24 14:04:54 -0400 |
commit | b20c6990247a0bc88a6c3b86fd1d92530cd141e9 (patch) | |
tree | 56a4596aa567aba2de539f954d9cb3ee266ffa1b /src/components/interfaces/MOBILE_API.xml | |
parent | 25a8ef5d2ec10d88a5eda53af85a2b746f401c05 (diff) | |
parent | 378ded23e69e0964b336e4f65006e1b33bb2cbd3 (diff) | |
download | sdl_core-b20c6990247a0bc88a6c3b86fd1d92530cd141e9.tar.gz |
Merge pull request #2944 from smartdevicelink/feature/update_and_unpublish_app_service
Update and delete published app services
Diffstat (limited to 'src/components/interfaces/MOBILE_API.xml')
-rw-r--r-- | src/components/interfaces/MOBILE_API.xml | 43 |
1 files changed, 41 insertions, 2 deletions
diff --git a/src/components/interfaces/MOBILE_API.xml b/src/components/interfaces/MOBILE_API.xml index 3072b3fb5b..bf8728602d 100644 --- a/src/components/interfaces/MOBILE_API.xml +++ b/src/components/interfaces/MOBILE_API.xml @@ -2672,6 +2672,7 @@ <element name="GetAppServiceDataID" value="53" hexvalue="35" since="5.1" /> <element name="GetFileID" value="54" hexvalue="36" since="5.1" /> <element name="PerformAppServiceInteractionID" value="55" hexvalue="37" since="5.1" /> + <element name="UnpublishAppServiceID" value="56" hexvalue="38" since="6.0" /> <element name="CloseApplicationID" value="58" hexvalue="3A" since="6.0" /> <!-- @@ -7251,10 +7252,16 @@ </function> <function name="PublishAppService" functionID="PublishAppServiceID" messagetype="request" since="5.1"> - <description>Registers a service offered by this app on the module</description> + <description> + Registers a service offered by this app on the module. + Subsequent calls with the same service type will update the manifest for that service. + </description> <param name="appServiceManifest" type="AppServiceManifest" mandatory="true"> - <description> The manifest of the service that wishes to be published.</description> + <description> + The manifest of the service that wishes to be published. + If already published, the updated manifest for this service. + </description> </param> </function> @@ -7286,6 +7293,38 @@ </param> </function> + <function name="UnpublishAppService" functionID="UnpublishAppServiceID" messagetype="request" since="6.0"> + <description> Unpublish an existing service published by this application. </description> + + <param name="serviceID" type="String" mandatory="true"> + <description> The ID of the service to be unpublished. </description> + </param> + </function> + + <function name="UnpublishAppService" functionID="UnpublishAppServiceID" messagetype="response" since="6.0"> + <description> The response to UnpublishAppService </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="INVALID_ID"/> + <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> + </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> |