From 2b02a8e3409b70964a8e44aac6c78ae07d1b0a51 Mon Sep 17 00:00:00 2001 From: JackLivio Date: Mon, 14 Mar 2016 11:20:38 -0400 Subject: Changed mobile api result code to better match hmi api --- src/components/interfaces/MOBILE_API.xml | 144 +++++++++++++++---------------- 1 file changed, 72 insertions(+), 72 deletions(-) diff --git a/src/components/interfaces/MOBILE_API.xml b/src/components/interfaces/MOBILE_API.xml index 2c0dc06679..5430aedbf1 100644 --- a/src/components/interfaces/MOBILE_API.xml +++ b/src/components/interfaces/MOBILE_API.xml @@ -7,118 +7,119 @@ The request succeeded - - - The data sent is invalid. For example: - Invalid Json syntax - Parameters out of bounds (number or enum range) - Mandatory parameters not provided - Parameter provided with wrong type - Invalid characters - Empty string - - The request is not supported by Sync - - The system could not process the request because the necessary memory couldn't be allocated - - - There are too many requests pending (means, that the response has not been delivered, yet). - There may be a maximum of 1000 pending requests at a time. - - + - One of the provided IDs is not valid. For example - This applies to CorrelationID, SubscriptionID, CommandID, MenuID, etc. + A button that was requested for subscription is not supported under the current system. + NOTE: could become a more generic UNSUPPORTED_RESOURCE by merging with VEHICLE_DATA_NOT_AVAILABLE. - - There was a conflict with an registered name (application or menu item) or vr command - - - There are already too many registered applications + + RPC is not authorized in local policy table. - - RegisterApplication has been called again, after a RegisterApplication was successful before. + + + The requested command was rejected, e.g. because mobile app is in background and cannot perform any HMI commands. + Or an HMI command (e.g. Speak) is rejected because a higher priority HMI command (e.g. Alert) is playing. + - - Sync doesn't support the protocol that is requested by the mobile application + + + A command was aborted, for example due to user interaction (e.g. user pressed button). + Or an HMI command (e.g. Speak) is aborted because a higher priority HMI command (e.g. Alert) was requested. + - + - The requested language is currently not supported. - Might be because of a mismatch of the currently active language on Sync and the requested language + A command was ignored, because the intended result is already in effect. + For example, SetMediaClockTimer was used to pause the media clock although the clock is paused already. + NOTE: potentially replaces SUBSCRIBED_ALREADY - - An command can not be executed because no application has been registered with RegisterApplication. + + The user interrupted the RPC (e.g. PerformAudioPassThru) and indicated to start over. Note, the app must issue the new RPC. - The data may not be changed, because it is currently in use. - For example when trying to delete a command set that is currently involved in an interaction. + The data may not be changed, because it is currently in use. + For example when trying to delete a command set that is currently involved in an interaction. - - The user has turned off access to vehicle data, and it is globally unavailable to mobile applications. - The requested vehicle data is not available on this vehicle or is not published. - + + Overlay reached the maximum timeout and closed. + + - The requested command was rejected, e.g. because mobile app is in background and cannot perform any HMI commands. - Or an HMI command (e.g. Speak) is rejected because a higher priority HMI command (e.g. Alert) is playing. + The data sent is invalid. For example: + Invalid Json syntax + Parameters out of bounds (number or enum range) + Mandatory parameters not provided + Parameter provided with wrong type + Invalid characters + Empty string - + + - A command was aborted, for example due to user interaction (e.g. user pressed button). - Or an HMI command (e.g. Speak) is aborted because a higher priority HMI command (e.g. Alert) was requested. + One of the provided IDs is not valid. For example + This applies to CorrelationID, SubscriptionID, CommandID, MenuID, etc. - - - A command was ignored, because the intended result is already in effect. - For example, SetMediaClockTimer was used to pause the media clock although the clock is paused already. - NOTE: potentially replaces SUBSCRIBED_ALREADY - + + There was a conflict with an registered name (application or menu item) or vr command - + + An command can not be executed because no application has been registered with RegisterApplication. + + - A button that was requested for subscription is not supported under the current system. - NOTE: could become a more generic UNSUPPORTED_RESOURCE by merging with VEHICLE_DATA_NOT_AVAILABLE. + The requested language is currently not supported. + Might be because of a mismatch of the currently active language on Sync and the requested language + + + The system could not process the request because the necessary memory couldn't be allocated - - A specified file could not be found on Sync. + + There are too many requests pending (means, that the response has not been delivered, yet). + There may be a maximum of 1000 pending requests at a time. + + + There are already too many registered applications + + + RegisterApplication has been called again, after a RegisterApplication was successful before. + + + The RPC (e.g. SubscribeVehicleData) executed successfully but one or more items have a warning or failure. Provided data is valid but something went wrong in the lower layers. - - RPC is not authorized in local policy table. - RPC is included in a functional group explicitly blocked by the user. - - Overlay reached the maximum timeout and closed. + + The RPC (e.g. ReadDID) executed successfully but the data exceeded the platform maximum threshold and thus, only part of the data is available. + + + Sync doesn't support the protocol that is requested by the mobile application + + + The user has turned off access to vehicle data, and it is globally unavailable to mobile applications. + + + A specified file could not be found on Sync. User selected to Cancel Route. - - - The RPC (e.g. ReadDID) executed successfully but the data exceeded the platform maximum threshold and thus, only part of the data is available. - - The user interrupted the RPC (e.g. PerformAudioPassThru) and indicated to start over. Note, the app must issue the new RPC. - - - The RPC (e.g. SubscribeVehicleData) executed successfully but one or more items have a warning or failure. - The RPC (e.g. Slider) executed successfully and the user elected to save the current position / value. @@ -131,7 +132,6 @@ The provided hash ID does not match the hash of the current set of registered data or the core could not resume the previous data. - -- cgit v1.2.1