summaryrefslogtreecommitdiff
path: root/src/components/application_manager/include/application_manager
diff options
context:
space:
mode:
authorAndrey Oleynik (GitHub) <aoleynik@luxoft.com>2017-10-04 13:20:23 +0300
committerAndriy Byzhynar <AByzhynar@luxoft.com>2018-01-18 12:03:50 +0200
commit764ff67916a0832a31b38a58f4877ecb48e1d301 (patch)
tree9c42bb92e1906436bbe38edf390086b45245895c /src/components/application_manager/include/application_manager
parente10f6296b5050f7b56076bfecdb15be0b955cc3c (diff)
downloadsdl_core-764ff67916a0832a31b38a58f4877ecb48e1d301.tar.gz
Adds descriptions and removes obsolete implementations
Diffstat (limited to 'src/components/application_manager/include/application_manager')
-rw-r--r--src/components/application_manager/include/application_manager/message_helper.h56
1 files changed, 48 insertions, 8 deletions
diff --git a/src/components/application_manager/include/application_manager/message_helper.h b/src/components/application_manager/include/application_manager/message_helper.h
index 15cd5846ca..ca0bb51b31 100644
--- a/src/components/application_manager/include/application_manager/message_helper.h
+++ b/src/components/application_manager/include/application_manager/message_helper.h
@@ -701,26 +701,67 @@ class MessageHelper {
int32_t connection_key,
mobile_api::AppInterfaceUnregisteredReason::eType reason);
+ /**
+ * @brief SendDeleteCommandRequest sends requests to HMI to remove UI/VR
+ * command data depending on command parameters
+ * @param cmd Command data
+ * @param application Application owning the command data
+ * @param app_mngr Application manager
+ */
static void SendDeleteCommandRequest(smart_objects::SmartObject* cmd,
ApplicationSharedPtr application,
ApplicationManager& app_mngr);
+ /**
+ * @brief SendDeleteSubmenuRequest sends UI/VR requests to HMI to remove
+ * submenues-related data depending on command parameters
+ * @param cmd Command data
+ * @param application Application owning the commmand data
+ * @param app_mngr Application manager
+ */
static void SendDeleteSubmenuRequest(smart_objects::SmartObject* cmd,
ApplicationSharedPtr application,
ApplicationManager& app_mngr);
+ /**
+ * @brief SendDeleteChoiceSetRequest sends requests to HMI to remove
+ * choice sets - related data depending on command parameters
+ * @param cmd Command data
+ * @param application Application owning command data
+ * @param app_mngr Application manager
+ */
static void SendDeleteChoiceSetRequest(smart_objects::SmartObject* cmd,
ApplicationSharedPtr application,
ApplicationManager& app_mngr);
+ /**
+ * @brief SendResetPropertiesRequest sends requests to HMI to remove/reset
+ * global properties for application
+ * @param application Application to remove/reset global properties for
+ * @param app_mngr Application manager
+ */
static void SendResetPropertiesRequest(ApplicationSharedPtr application,
ApplicationManager& app_mngr);
+ /**
+ * @brief SendUnsubscribeButtonNotification sends notification to HMI to
+ * remove button subscription for application
+ * @param button Button type
+ * @param application Application to unsubscribe
+ * @param app_mngr Application manager
+ */
static void SendUnsubscribeButtonNotification(
mobile_apis::ButtonName::eType button,
ApplicationSharedPtr application,
ApplicationManager& app_mngr);
+ /**
+ * @brief SendUnsubscribeIVIRequest sends request to HMI to remove vehicle
+ * data subscription for application
+ * @param ivi_id Vehicle data item id
+ * @param application Application to unsubscribe
+ * @param app_mngr Application manager
+ */
static void SendUnsubscribeIVIRequest(uint32_t ivi_id,
ApplicationSharedPtr application,
ApplicationManager& app_mngr);
@@ -752,15 +793,14 @@ class MessageHelper {
private:
/**
- * @brief Creates new request object and fill its header
- * @return New request object
+ * @brief CreateMessageForHMI Creates HMI message with prepared header
+ * acccoring to message type
+ * @param message_type Message type
+ * @param correlation_id Correlation id
+ * @return HMI message object with filled header
*/
- static smart_objects::SmartObjectSPtr CreateRequestObject(
- const uint32_t correlation_id);
-
- // To merge with prior method
- static smart_objects::SmartObjectSPtr CreateNotificationObject(
- const uint32_t correlation_id);
+ static smart_objects::SmartObjectSPtr CreateMessageForHMI(
+ hmi_apis::messageType::eType message_type, const uint32_t correlation_id);
/**
* @brief Allows to fill SO according to the current permissions.