X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=doc%2Fapi-ref%2Fhtml%2Fd5%2Fd20%2Fclass_h_s___client.html;fp=doc%2Fapi-ref%2Fhtml%2Fd5%2Fd20%2Fclass_h_s___client.html;h=e9d7ff82b4e58817fca6d54c89aa50dd606b78e9;hb=31ff5ce755d00cf12ea2ffc96c33ed9acd36358f;hp=0000000000000000000000000000000000000000;hpb=bbb4ee8e9974c4b008da84a1e504120f70606c92;p=apps%2Fagl-service-homescreen.git
diff --git a/doc/api-ref/html/d5/d20/class_h_s___client.html b/doc/api-ref/html/d5/d20/class_h_s___client.html
new file mode 100644
index 0000000..e9d7ff8
--- /dev/null
+++ b/doc/api-ref/html/d5/d20/class_h_s___client.html
@@ -0,0 +1,653 @@
+
+
+
+
+
+
#include <hs-client.h>
+
+
+
+
Definition at line 25 of file hs-client.h.
+
+
+
+
+
+
+
+
+
+ HS_Client::HS_Client |
+ ( |
+ afb_req_t |
+ request, |
+
+
+ |
+ |
+ const char * |
+ id |
+
+
+ |
+ ) |
+ | |
+
+
+ |
+
+inline |
+
+
+
+
+
Definition at line 27 of file hs-client.h.
+
HS_Client(afb_req_t request, const char *id)
+
+
+
+
+
+
+
+
+ HS_Client::HS_Client |
+ ( |
+ afb_req_t |
+ request, |
+
+
+ |
+ |
+ std::string |
+ id |
+
+
+ |
+ ) |
+ | |
+
+
+
+
HS_Client construction function
+
Parameters
+
+
Return
+
None
+
+
Definition at line 38 of file hs-client.cpp.
+
41 my_event = afb_api_make_event(request->api,
id.c_str());
#define HMI_NOTICE(prefix, args,...)
+
+
+
+
+
+
+
+
+
+
+
+ HS_Client::HS_Client |
+ ( |
+ HS_Client & |
+ | ) |
+ |
+
+
+ |
+
+delete |
+
+
+
+
+
+
+
+
+
+
+
+ HS_Client::~HS_Client |
+ ( |
+ | ) |
+ |
+
+
+
+
HS_Client destruction function
+
Parameters
+
+
Return
+
None
+
+
Definition at line 54 of file hs-client.cpp.
+
57 afb_event_unref(my_event);
#define HMI_NOTICE(prefix, args,...)
+
+
+
+
+
+
+
+
+
+ int HS_Client::hideWindow |
+ ( |
+ afb_req_t |
+ request | ) |
+ |
+
+
+
+
hideWindow event
+
input contents : {"application_id":"the appid that want to hide"}
+
Parameters
+
+
Return
+
0 : success others : fail
+
+
Definition at line 245 of file hs-client.cpp.
+
247 if(!checkEvent(__FUNCTION__))
250 HMI_NOTICE(
"homescreen-service",
"%s application_id = %s.", __FUNCTION__);
251 const char* req_appid = afb_req_get_application_id(request);
252 struct json_object* push_obj = json_object_new_object();
254 _type, __FUNCTION__);
255 afb_event_push(my_event, push_obj);
#define HMI_NOTICE(prefix, args,...)
+
static const char _type[]
+
void hs_add_object_to_json_object_str(struct json_object *j_obj, int count,...)
+
const char _application_id[]
+
+
+
+
+
+
+
+
+ int HS_Client::on_screen_message |
+ ( |
+ afb_req_t |
+ request, |
+
+
+ |
+ |
+ const char * |
+ message |
+
+
+ |
+ ) |
+ | |
+
+
+
+
push on_screen_message event
+
Parameters
+
+- message: post message.
+
+
Return
+
result
+
+
Definition at line 93 of file hs-client.cpp.
+
95 if(!checkEvent(__FUNCTION__))
98 HMI_NOTICE(
"homescreen-service",
"push %s event message [%s].", __FUNCTION__, message);
99 struct json_object* push_obj = json_object_new_object();
101 _type, __FUNCTION__);
102 afb_event_push(my_event, push_obj);
#define HMI_NOTICE(prefix, args,...)
+
static const char _type[]
+
void hs_add_object_to_json_object_str(struct json_object *j_obj, int count,...)
+
const char _display_message[]
+
+
+
+
+
+
+
+
+ int HS_Client::on_screen_reply |
+ ( |
+ afb_req_t |
+ request, |
+
+
+ |
+ |
+ const char * |
+ message |
+
+
+ |
+ ) |
+ | |
+
+
+
+
push on_screen_reply event
+
Parameters
+
+- message: reply message.
+
+
Return
+
result
+
+
Definition at line 116 of file hs-client.cpp.
+
118 if(!checkEvent(__FUNCTION__))
121 HMI_NOTICE(
"homescreen-service",
"push %s event message [%s].", __FUNCTION__, message);
122 struct json_object* push_obj = json_object_new_object();
124 _type, __FUNCTION__);
125 afb_event_push(my_event, push_obj);
const char _reply_message[]
+
#define HMI_NOTICE(prefix, args,...)
+
static const char _type[]
+
void hs_add_object_to_json_object_str(struct json_object *j_obj, int count,...)
+
+
+
+
+
+
+
+
+
+
+ int HS_Client::replyShowWindow |
+ ( |
+ afb_req_t |
+ request, |
+
+
+ |
+ |
+ const char * |
+ appid |
+
+
+ |
+ ) |
+ | |
+
+
+
+
replyShowWindow event
+
input contens : {"application_id": "the appid that want to reply", "parameter": {...}}
+
Parameters
+
+- request : the request
+- appid : the appid that want to reply
+
+
Return
+
0 : success others : fail
+
+
Definition at line 273 of file hs-client.cpp.
+
275 if(!checkEvent(__FUNCTION__))
278 HMI_NOTICE(
"homescreen-service",
"%s application_id = %s.", __FUNCTION__, appid);
279 struct json_object* push_obj = json_object_new_object();
281 const char* param = afb_req_value(request,
_parameter);
283 json_object_object_add(push_obj,
_parameter, json_tokener_parse(param));
286 HMI_ERROR(
"homescreen-service",
"please input correct parameter.");
290 afb_event_push(my_event, push_obj);
#define HMI_NOTICE(prefix, args,...)
+
static const char _parameter[]
+
static const char _type[]
+
void hs_add_object_to_json_object_str(struct json_object *j_obj, int count,...)
+
#define HMI_ERROR(prefix, args,...)
+
const char _application_id[]
+
#define AFB_EVENT_BAD_REQUEST
+
+
+
+
+
+
+
+
+ int HS_Client::showInformation |
+ ( |
+ afb_req_t |
+ request | ) |
+ |
+
+
+
+
showInformation event
+
input contents : {"info": "information contents"}
+
Parameters
+
+
Return
+
0 : success others : fail
+
+
Definition at line 350 of file hs-client.cpp.
+
353 const char *value = afb_req_value(request,
_info);
355 HMI_NOTICE(
"homescreen-service",
"info is %s", value);
356 const char* appid = afb_req_get_application_id(request);
357 struct json_object* param_obj = json_object_new_object();
358 json_object_object_add(param_obj,
_info, json_object_new_string(value));
359 struct json_object* push_obj = json_object_new_object();
361 json_object_object_add(push_obj,
_parameter, param_obj);
362 afb_event_push(my_event, push_obj);
365 HMI_NOTICE(
"homescreen-service",
"please input information.");
#define HMI_NOTICE(prefix, args,...)
+
static const char _parameter[]
+
static const char _type[]
+
void hs_add_object_to_json_object_str(struct json_object *j_obj, int count,...)
+
static const char _info[]
+
const char _application_id[]
+
#define AFB_REQ_SHOWINFORMATION_ERROR
+
+
+
+
+
+
+
+
+ int HS_Client::showNotification |
+ ( |
+ afb_req_t |
+ request | ) |
+ |
+
+
+
+
showNotification event
+
input contents : {"icon": "icon path", "text": "message contents"}
+
Parameters
+
+
Return
+
0 : success others : fail
+
+
Definition at line 307 of file hs-client.cpp.
+
310 const char *value = afb_req_value(request,
_text);
312 HMI_NOTICE(
"homescreen-service",
"text is %s", value);
313 const char* appid = afb_req_get_application_id(request);
314 struct json_object* param_obj = json_object_new_object();
315 const char *icon = afb_req_value(request,
_icon);
317 json_object_object_add(param_obj,
_icon, json_object_new_string(icon));
318 json_object_object_add(param_obj,
_text, json_object_new_string(value));
319 struct json_object* push_obj = json_object_new_object();
321 json_object_object_add(push_obj,
_parameter, param_obj);
322 afb_event_push(my_event, push_obj);
325 HMI_NOTICE(
"homescreen-service",
"please input icon.");
330 HMI_NOTICE(
"homescreen-service",
"please input text.");
static const char _text[]
+
#define AFB_REQ_SHOWNOTIFICATION_ERROR
+
#define HMI_NOTICE(prefix, args,...)
+
static const char _parameter[]
+
static const char _type[]
+
void hs_add_object_to_json_object_str(struct json_object *j_obj, int count,...)
+
static const char _icon[]
+
const char _application_id[]
+
+
+
+
+
+
+
+
+ int HS_Client::showWindow |
+ ( |
+ afb_req_t |
+ request, |
+
+
+ |
+ |
+ const char * |
+ appid |
+
+
+ |
+ ) |
+ | |
+
+
+
+
showWindow event
+
input contents : {"application_id":"the appid that want to display", "parameter":{"area": "display area", ...}}
+
Parameters
+
+- request : the request
+- appid : the appid that want to display
+
+
Return
+
0 : success others : fail
+
+
Definition at line 209 of file hs-client.cpp.
+
211 if(!checkEvent(__FUNCTION__))
214 HMI_NOTICE(
"homescreen-service",
"%s application_id = %s.", __FUNCTION__, appid);
215 struct json_object* push_obj = json_object_new_object();
217 const char* param = afb_req_value(request,
_parameter);
219 const char* req_appid = afb_req_get_application_id(request);
220 struct json_object* param_obj = json_tokener_parse(param);
221 json_object_object_add(param_obj,
_replyto, json_object_new_string(req_appid));
222 json_object_object_add(push_obj,
_parameter, param_obj);
225 HMI_ERROR(
"homescreen-service",
"please input correct parameter.");
228 afb_event_push(my_event, push_obj);
#define HMI_NOTICE(prefix, args,...)
+
static const char _parameter[]
+
static const char _type[]
+
void hs_add_object_to_json_object_str(struct json_object *j_obj, int count,...)
+
#define HMI_ERROR(prefix, args,...)
+
static const char _replyto[]
+
const char _application_id[]
+
#define AFB_EVENT_BAD_REQUEST
+
+
+
+
+
+
+
+
+ int HS_Client::subscribe |
+ ( |
+ afb_req_t |
+ request, |
+
+
+ |
+ |
+ const char * |
+ event |
+
+
+ |
+ ) |
+ | |
+
+
+
+
subscribe event
+
Parameters
+
+- event: homescreen event, tap_shortcut etc.
+
+
Return
+
result
+
+
Definition at line 139 of file hs-client.cpp.
+
142 auto ip = event_list.find(std::string(event));
143 if(ip == event_list.end()) {
144 event_list[std::string(event)] = 0;
147 ret = afb_req_subscribe(request, my_event);
+
+
+
+
+
+
+
+ int HS_Client::tap_shortcut |
+ ( |
+ const char * |
+ appid | ) |
+ |
+
+
+
+
push tap_shortcut event
+
Parameters
+
+
Return
+
result
+
+
Definition at line 70 of file hs-client.cpp.
+
72 if(!checkEvent(__FUNCTION__))
75 HMI_NOTICE(
"homescreen-service",
"%s application_id = %s.", __FUNCTION__, appid);
76 struct json_object* push_obj = json_object_new_object();
79 afb_event_push(my_event, push_obj);
#define HMI_NOTICE(prefix, args,...)
+
static const char _type[]
+
void hs_add_object_to_json_object_str(struct json_object *j_obj, int count,...)
+
const char _application_id[]
+
+
+
+
+
+
+
+
+ int HS_Client::unsubscribe |
+ ( |
+ afb_req_t |
+ request, |
+
+
+ |
+ |
+ const char * |
+ event |
+
+
+ |
+ ) |
+ | |
+
+
+
+
unsubscribe event
+
Parameters
+
+- event: homescreen event, tap_shortcut etc.
+
+
Return
+
result
+
+
Definition at line 165 of file hs-client.cpp.
+
168 event_list.erase(std::string(event));
169 if(event_list.empty()) {
170 ret = afb_req_unsubscribe(request, my_event);
+
+
+
The documentation for this class was generated from the following files:
+
+
+
+
+