HS_Client Class Reference

#include <hs-client.h>

Public Member Functions
	HS_Client (afb_req_t request, const char *id)
	HS_Client (afb_req_t request, std::string id)
	HS_Client (HS_Client &)=delete
HS_Client &	operator= (HS_Client &)=delete
	~HS_Client ()
int	tap_shortcut (const char *appid)
int	showWindow (afb_req_t request, const char *appid)
int	hideWindow (afb_req_t request)
int	replyShowWindow (afb_req_t request, const char *appid)
int	on_screen_message (afb_req_t request, const char *message)
int	on_screen_reply (afb_req_t request, const char *message)
int	subscribe (afb_req_t request, const char *event)
int	unsubscribe (afb_req_t request, const char *event)
int	showNotification (afb_req_t request)
int	showInformation (afb_req_t request)

Detailed Description

Definition at line 25 of file hs-client.h.

Constructor & Destructor Documentation

HS_Client::HS_Client ( afb_req_t  request, const char *  id  )

inline

Definition at line 27 of file hs-client.h.

: HS_Client(request, std::string(id)){}

HS_Client::HS_Client	(	afb_req_t	request,
		std::string	id
	)

HS_Client construction function

Parameters

• id: app's id

Return

None

Definition at line 38 of file hs-client.cpp.

                                                    : my_id(id)
{
    HMI_NOTICE("homescreen-service","called.");
    my_event = afb_api_make_event(request->api, id.c_str());
}

HS_Client::HS_Client ( HS_Client &  )

delete

HS_Client::~HS_Client

(

)

HS_Client destruction function

Parameters

• null

Return

None

Definition at line 54 of file hs-client.cpp.

{
    HMI_NOTICE("homescreen-service","called.");
    afb_event_unref(my_event);
}

Member Function Documentation

int HS_Client::hideWindow

(

afb_req_t

request

)

hideWindow event

input contents : {"application_id":"the appid that want to hide"}

Parameters

• request : the request

Return

0 : success others : fail

Definition at line 245 of file hs-client.cpp.

{
    if(!checkEvent(__FUNCTION__))
        return 0;

    HMI_NOTICE("homescreen-service","%s application_id = %s.", __FUNCTION__);
    const char* req_appid = afb_req_get_application_id(request);
    struct json_object* push_obj = json_object_new_object();
    hs_add_object_to_json_object_str( push_obj, 4, _application_id, req_appid,
    _type, __FUNCTION__);
    afb_event_push(my_event, push_obj);
    return 0;
}

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.

{
    if(!checkEvent(__FUNCTION__))
        return 0;

    HMI_NOTICE("homescreen-service","push %s event message [%s].", __FUNCTION__, message);
    struct json_object* push_obj = json_object_new_object();
    hs_add_object_to_json_object_str( push_obj, 4, _display_message, message,
    _type, __FUNCTION__);
    afb_event_push(my_event, push_obj);
    return 0;
}

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.

{
    if(!checkEvent(__FUNCTION__))
        return 0;

    HMI_NOTICE("homescreen-service","push %s event message [%s].", __FUNCTION__, message);
    struct json_object* push_obj = json_object_new_object();
    hs_add_object_to_json_object_str( push_obj, 4, _reply_message, message,
    _type, __FUNCTION__);
    afb_event_push(my_event, push_obj);
    return 0;
}

HS_Client& HS_Client::operator= ( HS_Client &  )

delete

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.

{
    if(!checkEvent(__FUNCTION__))
        return 0;

    HMI_NOTICE("homescreen-service","%s application_id = %s.", __FUNCTION__, appid);
    struct json_object* push_obj = json_object_new_object();
    hs_add_object_to_json_object_str( push_obj, 4, _application_id, appid, _type, __FUNCTION__);
    const char* param = afb_req_value(request, _parameter);
    if(param) {
        json_object_object_add(push_obj, _parameter, json_tokener_parse(param));
    }
    else {
        HMI_ERROR("homescreen-service","please input correct parameter.");
        return AFB_EVENT_BAD_REQUEST;
    }

    afb_event_push(my_event, push_obj);
    return 0;
}

int HS_Client::showInformation

(

afb_req_t

request

)

showInformation event

input contents : {"info": "information contents"}

Parameters

• request : the request

Return

0 : success others : fail

Definition at line 350 of file hs-client.cpp.

{
    int ret = 0;
    const char *value = afb_req_value(request, _info);
    if(value) {
        HMI_NOTICE("homescreen-service","info is %s", value);
        const char* appid = afb_req_get_application_id(request);
        struct json_object* param_obj = json_object_new_object();
        json_object_object_add(param_obj, _info, json_object_new_string(value));
        struct json_object* push_obj = json_object_new_object();
        hs_add_object_to_json_object_str( push_obj, 4, _application_id, appid, _type, __FUNCTION__);
        json_object_object_add(push_obj, _parameter, param_obj);
        afb_event_push(my_event, push_obj);
    }
    else {
        HMI_NOTICE("homescreen-service","please input information.");
        ret = AFB_REQ_SHOWINFORMATION_ERROR;
    }

    return ret;
}

int HS_Client::showNotification

(

afb_req_t

request

)

showNotification event

input contents : {"icon": "icon path", "text": "message contents"}

Parameters

• request : the request

Return

0 : success others : fail

Definition at line 307 of file hs-client.cpp.

{
    int ret = 0;
    const char *value = afb_req_value(request, _text);
    if(value) {
        HMI_NOTICE("homescreen-service","text is %s", value);
        const char* appid = afb_req_get_application_id(request);
        struct json_object* param_obj = json_object_new_object();
        const char *icon = afb_req_value(request, _icon);
        if(icon) {
            json_object_object_add(param_obj, _icon, json_object_new_string(icon));
            json_object_object_add(param_obj, _text, json_object_new_string(value));
            struct json_object* push_obj = json_object_new_object();
            hs_add_object_to_json_object_str( push_obj, 4, _application_id, appid, _type, __FUNCTION__);
            json_object_object_add(push_obj, _parameter, param_obj);
            afb_event_push(my_event, push_obj);
        }
        else {
            HMI_NOTICE("homescreen-service","please input icon.");
            ret = AFB_REQ_SHOWNOTIFICATION_ERROR;
        }
    }
    else {
        HMI_NOTICE("homescreen-service","please input text.");
        ret = AFB_REQ_SHOWNOTIFICATION_ERROR;
    }

    return ret;
}

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.

{
    if(!checkEvent(__FUNCTION__))
        return 0;

    HMI_NOTICE("homescreen-service","%s application_id = %s.", __FUNCTION__, appid);
    struct json_object* push_obj = json_object_new_object();
    hs_add_object_to_json_object_str( push_obj, 4, _application_id, appid, _type, __FUNCTION__);
    const char* param = afb_req_value(request, _parameter);
    if(param) {
        const char* req_appid = afb_req_get_application_id(request);
        struct json_object* param_obj = json_tokener_parse(param);
        json_object_object_add(param_obj, _replyto, json_object_new_string(req_appid));
        json_object_object_add(push_obj, _parameter, param_obj);
    }
    else {
        HMI_ERROR("homescreen-service","please input correct parameter.");
        return AFB_EVENT_BAD_REQUEST;
    }
    afb_event_push(my_event, push_obj);
    return 0;
}

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.

{
    int ret = 0;
    auto ip = event_list.find(std::string(event));
    if(ip == event_list.end()) {
        event_list[std::string(event)] = 0;
    }
    if(!subscription) {
        ret = afb_req_subscribe(request, my_event);
        if(ret == 0) {
            subscription = true;
        }
    }
    return ret;
}

int HS_Client::tap_shortcut

(

const char *

appid

)

push tap_shortcut event

Parameters

• appid: app's id.

Return

result

Definition at line 70 of file hs-client.cpp.

{
    if(!checkEvent(__FUNCTION__))
        return 0;

    HMI_NOTICE("homescreen-service","%s application_id = %s.", __FUNCTION__, appid);
    struct json_object* push_obj = json_object_new_object();
    hs_add_object_to_json_object_str( push_obj, 4, _application_id, appid,
    _type, __FUNCTION__);
    afb_event_push(my_event, push_obj);
    return 0;
}

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.

{
    int ret = 0;
    event_list.erase(std::string(event));
    if(event_list.empty()) {
        ret = afb_req_unsubscribe(request, my_event);
    }
    return ret;
}

---

The documentation for this class was generated from the following files:

• src/hs-client.h
• src/hs-client.cpp