update doc
[apps/agl-service-homescreen.git] / doc / api-ref / html / da / dd3 / hs-client_8h_source.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <meta name="generator" content="Doxygen 1.8.11"/>
7 <title>HomeScreenBinding: src/hs-client.h Source File</title>
8 <link href="../../tabs.css" rel="stylesheet" type="text/css"/>
9 <script type="text/javascript" src="../../jquery.js"></script>
10 <script type="text/javascript" src="../../dynsections.js"></script>
11 <link href="../../search/search.css" rel="stylesheet" type="text/css"/>
12 <script type="text/javascript" src="../../search/searchdata.js"></script>
13 <script type="text/javascript" src="../../search/search.js"></script>
14 <script type="text/javascript">
15   $(document).ready(function() { init_search(); });
16 </script>
17 <link href="../../doxygen.css" rel="stylesheet" type="text/css" />
18 </head>
19 <body>
20 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
21 <div id="titlearea">
22 <table cellspacing="0" cellpadding="0">
23  <tbody>
24  <tr style="height: 56px;">
25   <td id="projectalign" style="padding-left: 0.5em;">
26    <div id="projectname">HomeScreenBinding
27    </div>
28   </td>
29  </tr>
30  </tbody>
31 </table>
32 </div>
33 <!-- end header part -->
34 <!-- Generated by Doxygen 1.8.11 -->
35 <script type="text/javascript">
36 var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
37 </script>
38   <div id="navrow1" class="tabs">
39     <ul class="tablist">
40       <li><a href="../../index.html"><span>Main&#160;Page</span></a></li>
41       <li><a href="../../annotated.html"><span>Classes</span></a></li>
42       <li class="current"><a href="../../files.html"><span>Files</span></a></li>
43       <li>
44         <div id="MSearchBox" class="MSearchBoxInactive">
45         <span class="left">
46           <img id="MSearchSelect" src="../../search/mag_sel.png"
47                onmouseover="return searchBox.OnSearchSelectShow()"
48                onmouseout="return searchBox.OnSearchSelectHide()"
49                alt=""/>
50           <input type="text" id="MSearchField" value="Search" accesskey="S"
51                onfocus="searchBox.OnSearchFieldFocus(true)" 
52                onblur="searchBox.OnSearchFieldFocus(false)" 
53                onkeyup="searchBox.OnSearchFieldChange(event)"/>
54           </span><span class="right">
55             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="../../search/close.png" alt=""/></a>
56           </span>
57         </div>
58       </li>
59     </ul>
60   </div>
61   <div id="navrow2" class="tabs2">
62     <ul class="tablist">
63       <li><a href="../../files.html"><span>File&#160;List</span></a></li>
64       <li><a href="../../globals.html"><span>File&#160;Members</span></a></li>
65     </ul>
66   </div>
67 <!-- window showing the filter options -->
68 <div id="MSearchSelectWindow"
69      onmouseover="return searchBox.OnSearchSelectShow()"
70      onmouseout="return searchBox.OnSearchSelectHide()"
71      onkeydown="return searchBox.OnSearchSelectKey(event)">
72 </div>
73
74 <!-- iframe showing the search results (closed by default) -->
75 <div id="MSearchResultsWindow">
76 <iframe src="javascript:void(0)" frameborder="0" 
77         name="MSearchResults" id="MSearchResults">
78 </iframe>
79 </div>
80
81 <div id="nav-path" class="navpath">
82   <ul>
83 <li class="navelem"><a class="el" href="../../dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li>  </ul>
84 </div>
85 </div><!-- top -->
86 <div class="header">
87   <div class="headertitle">
88 <div class="title">hs-client.h</div>  </div>
89 </div><!--header-->
90 <div class="contents">
91 <a href="../../da/dd3/hs-client_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * Copyright (c) 2018 TOYOTA MOTOR CORPORATION</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> * Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * you may not use this file except in compliance with the License.</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * You may obtain a copy of the License at</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> *      http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> * distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> * See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> * limitations under the License.</span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;</div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="preprocessor">#ifndef HOMESCREEN_CLIENT_H</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="preprocessor">#define HOMESCREEN_CLIENT_H</span></div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;</div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="preprocessor">#include &lt;unordered_map&gt;</span></div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="../../d3/d3d/hs-helper_8h.html">hs-helper.h</a>&quot;</span></div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;</div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="../../d5/d20/class_h_s___client.html">   25</a></span>&#160;<span class="keyword">class </span><a class="code" href="../../d5/d20/class_h_s___client.html">HS_Client</a> {</div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="../../d5/d20/class_h_s___client.html#a0afac6b86b9a72e74846e47e435f5f90">   27</a></span>&#160;    <a class="code" href="../../d5/d20/class_h_s___client.html#a0afac6b86b9a72e74846e47e435f5f90">HS_Client</a>(afb_req_t request, <span class="keyword">const</span> <span class="keywordtype">char</span>* <span class="keywordtype">id</span>) : <a class="code" href="../../d5/d20/class_h_s___client.html">HS_Client</a>(request, <a class="code" href="../../d8/dcc/namespacestd.html">std</a>::string(id)){}</div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;    <a class="code" href="../../d5/d20/class_h_s___client.html#a0afac6b86b9a72e74846e47e435f5f90">HS_Client</a>(afb_req_t request, std::string <span class="keywordtype">id</span>);</div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;    <a class="code" href="../../d5/d20/class_h_s___client.html#a0afac6b86b9a72e74846e47e435f5f90">HS_Client</a>(<a class="code" href="../../d5/d20/class_h_s___client.html">HS_Client</a>&amp;) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;    <a class="code" href="../../d5/d20/class_h_s___client.html">HS_Client</a> &amp;<a class="code" href="../../d5/d20/class_h_s___client.html#a3e3d8fa1c8746d6d1b1650fe1fcc56a8">operator=</a>(<a class="code" href="../../d5/d20/class_h_s___client.html">HS_Client</a>&amp;) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;    <a class="code" href="../../d5/d20/class_h_s___client.html#ab29a9e899aaec3c21983c24ec6e5ee70">~HS_Client</a>();</div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;</div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;    <span class="keywordtype">int</span> <a class="code" href="../../d5/d20/class_h_s___client.html#a0d7fb8316248e8946dcb73a6612f21bb">tap_shortcut</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* appid);</div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;    <span class="keywordtype">int</span> <a class="code" href="../../d5/d20/class_h_s___client.html#af0f2be967a5b6ee81932c73b101184f7">showWindow</a>(afb_req_t request, <span class="keyword">const</span> <span class="keywordtype">char</span>* appid);</div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;    <span class="keywordtype">int</span> <a class="code" href="../../d5/d20/class_h_s___client.html#ac29482ffdf1b27733247ba0ffcc28b76">hideWindow</a>(afb_req_t request);</div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;    <span class="keywordtype">int</span> <a class="code" href="../../d5/d20/class_h_s___client.html#a294e461500ef02aed17ed5d91479f6b9">replyShowWindow</a>(afb_req_t request, <span class="keyword">const</span> <span class="keywordtype">char</span>* appid);</div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;    <span class="keywordtype">int</span> <a class="code" href="../../d5/d20/class_h_s___client.html#a274301617c9ab629d6916c0dde8c40b9">on_screen_message</a> (afb_req_t request, <span class="keyword">const</span> <span class="keywordtype">char</span>* message);</div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;    <span class="keywordtype">int</span> <a class="code" href="../../d5/d20/class_h_s___client.html#a9f7a30840c95b1348bcce4cd4626b2ae">on_screen_reply</a> (afb_req_t request, <span class="keyword">const</span> <span class="keywordtype">char</span>* message);</div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;    <span class="keywordtype">int</span> <a class="code" href="../../d5/d20/class_h_s___client.html#a3d000ca70bd4a8af7c4895d95bc7d0d0">subscribe</a>(afb_req_t request, <span class="keyword">const</span> <span class="keywordtype">char</span>* event);</div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;    <span class="keywordtype">int</span> <a class="code" href="../../d5/d20/class_h_s___client.html#a3da3b5662f918e11773da75f8f971d9c">unsubscribe</a>(afb_req_t request, <span class="keyword">const</span> <span class="keywordtype">char</span>* event);</div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;    <span class="keywordtype">int</span> <a class="code" href="../../d5/d20/class_h_s___client.html#a77b41c1bc6f2c939410108d821a0b456">showNotification</a>(afb_req_t request);</div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;    <span class="keywordtype">int</span> <a class="code" href="../../d5/d20/class_h_s___client.html#a7145c14a7a971b45f647a82e3390ce9c">showInformation</a>(afb_req_t request);</div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;</div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;    <span class="keywordtype">bool</span> checkEvent(<span class="keyword">const</span> <span class="keywordtype">char</span>* event);</div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;</div><div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;    std::string my_id;</div><div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;    afb_event_t my_event;</div><div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;    <span class="keywordtype">bool</span> subscription = <span class="keyword">false</span>;</div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;    std::unordered_map&lt;std::string, int&gt; event_list;</div><div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;</div><div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;};</div><div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;</div><div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;<span class="preprocessor">#endif // HOMESCREEN_CLIENT_H</span></div><div class="ttc" id="class_h_s___client_html_a3d000ca70bd4a8af7c4895d95bc7d0d0"><div class="ttname"><a href="../../d5/d20/class_h_s___client.html#a3d000ca70bd4a8af7c4895d95bc7d0d0">HS_Client::subscribe</a></div><div class="ttdeci">int subscribe(afb_req_t request, const char *event)</div><div class="ttdef"><b>Definition:</b> <a href="../../d8/d55/hs-client_8cpp_source.html#l00139">hs-client.cpp:139</a></div></div>
92 <div class="ttc" id="class_h_s___client_html_a3e3d8fa1c8746d6d1b1650fe1fcc56a8"><div class="ttname"><a href="../../d5/d20/class_h_s___client.html#a3e3d8fa1c8746d6d1b1650fe1fcc56a8">HS_Client::operator=</a></div><div class="ttdeci">HS_Client &amp; operator=(HS_Client &amp;)=delete</div></div>
93 <div class="ttc" id="class_h_s___client_html_a0afac6b86b9a72e74846e47e435f5f90"><div class="ttname"><a href="../../d5/d20/class_h_s___client.html#a0afac6b86b9a72e74846e47e435f5f90">HS_Client::HS_Client</a></div><div class="ttdeci">HS_Client(afb_req_t request, const char *id)</div><div class="ttdef"><b>Definition:</b> <a href="../../da/dd3/hs-client_8h_source.html#l00027">hs-client.h:27</a></div></div>
94 <div class="ttc" id="hs-helper_8h_html"><div class="ttname"><a href="../../d3/d3d/hs-helper_8h.html">hs-helper.h</a></div></div>
95 <div class="ttc" id="class_h_s___client_html"><div class="ttname"><a href="../../d5/d20/class_h_s___client.html">HS_Client</a></div><div class="ttdef"><b>Definition:</b> <a href="../../da/dd3/hs-client_8h_source.html#l00025">hs-client.h:25</a></div></div>
96 <div class="ttc" id="namespacestd_html"><div class="ttname"><a href="../../d8/dcc/namespacestd.html">std</a></div></div>
97 <div class="ttc" id="class_h_s___client_html_a294e461500ef02aed17ed5d91479f6b9"><div class="ttname"><a href="../../d5/d20/class_h_s___client.html#a294e461500ef02aed17ed5d91479f6b9">HS_Client::replyShowWindow</a></div><div class="ttdeci">int replyShowWindow(afb_req_t request, const char *appid)</div><div class="ttdef"><b>Definition:</b> <a href="../../d8/d55/hs-client_8cpp_source.html#l00273">hs-client.cpp:273</a></div></div>
98 <div class="ttc" id="class_h_s___client_html_a274301617c9ab629d6916c0dde8c40b9"><div class="ttname"><a href="../../d5/d20/class_h_s___client.html#a274301617c9ab629d6916c0dde8c40b9">HS_Client::on_screen_message</a></div><div class="ttdeci">int on_screen_message(afb_req_t request, const char *message)</div><div class="ttdef"><b>Definition:</b> <a href="../../d8/d55/hs-client_8cpp_source.html#l00093">hs-client.cpp:93</a></div></div>
99 <div class="ttc" id="class_h_s___client_html_a7145c14a7a971b45f647a82e3390ce9c"><div class="ttname"><a href="../../d5/d20/class_h_s___client.html#a7145c14a7a971b45f647a82e3390ce9c">HS_Client::showInformation</a></div><div class="ttdeci">int showInformation(afb_req_t request)</div><div class="ttdef"><b>Definition:</b> <a href="../../d8/d55/hs-client_8cpp_source.html#l00350">hs-client.cpp:350</a></div></div>
100 <div class="ttc" id="class_h_s___client_html_a9f7a30840c95b1348bcce4cd4626b2ae"><div class="ttname"><a href="../../d5/d20/class_h_s___client.html#a9f7a30840c95b1348bcce4cd4626b2ae">HS_Client::on_screen_reply</a></div><div class="ttdeci">int on_screen_reply(afb_req_t request, const char *message)</div><div class="ttdef"><b>Definition:</b> <a href="../../d8/d55/hs-client_8cpp_source.html#l00116">hs-client.cpp:116</a></div></div>
101 <div class="ttc" id="class_h_s___client_html_a3da3b5662f918e11773da75f8f971d9c"><div class="ttname"><a href="../../d5/d20/class_h_s___client.html#a3da3b5662f918e11773da75f8f971d9c">HS_Client::unsubscribe</a></div><div class="ttdeci">int unsubscribe(afb_req_t request, const char *event)</div><div class="ttdef"><b>Definition:</b> <a href="../../d8/d55/hs-client_8cpp_source.html#l00165">hs-client.cpp:165</a></div></div>
102 <div class="ttc" id="class_h_s___client_html_a77b41c1bc6f2c939410108d821a0b456"><div class="ttname"><a href="../../d5/d20/class_h_s___client.html#a77b41c1bc6f2c939410108d821a0b456">HS_Client::showNotification</a></div><div class="ttdeci">int showNotification(afb_req_t request)</div><div class="ttdef"><b>Definition:</b> <a href="../../d8/d55/hs-client_8cpp_source.html#l00307">hs-client.cpp:307</a></div></div>
103 <div class="ttc" id="class_h_s___client_html_ab29a9e899aaec3c21983c24ec6e5ee70"><div class="ttname"><a href="../../d5/d20/class_h_s___client.html#ab29a9e899aaec3c21983c24ec6e5ee70">HS_Client::~HS_Client</a></div><div class="ttdeci">~HS_Client()</div><div class="ttdef"><b>Definition:</b> <a href="../../d8/d55/hs-client_8cpp_source.html#l00054">hs-client.cpp:54</a></div></div>
104 <div class="ttc" id="class_h_s___client_html_af0f2be967a5b6ee81932c73b101184f7"><div class="ttname"><a href="../../d5/d20/class_h_s___client.html#af0f2be967a5b6ee81932c73b101184f7">HS_Client::showWindow</a></div><div class="ttdeci">int showWindow(afb_req_t request, const char *appid)</div><div class="ttdef"><b>Definition:</b> <a href="../../d8/d55/hs-client_8cpp_source.html#l00209">hs-client.cpp:209</a></div></div>
105 <div class="ttc" id="class_h_s___client_html_ac29482ffdf1b27733247ba0ffcc28b76"><div class="ttname"><a href="../../d5/d20/class_h_s___client.html#ac29482ffdf1b27733247ba0ffcc28b76">HS_Client::hideWindow</a></div><div class="ttdeci">int hideWindow(afb_req_t request)</div><div class="ttdef"><b>Definition:</b> <a href="../../d8/d55/hs-client_8cpp_source.html#l00245">hs-client.cpp:245</a></div></div>
106 <div class="ttc" id="class_h_s___client_html_a0d7fb8316248e8946dcb73a6612f21bb"><div class="ttname"><a href="../../d5/d20/class_h_s___client.html#a0d7fb8316248e8946dcb73a6612f21bb">HS_Client::tap_shortcut</a></div><div class="ttdeci">int tap_shortcut(const char *appid)</div><div class="ttdef"><b>Definition:</b> <a href="../../d8/d55/hs-client_8cpp_source.html#l00070">hs-client.cpp:70</a></div></div>
107 </div><!-- fragment --></div><!-- contents -->
108 <!-- start footer part -->
109 <hr class="footer"/><address class="footer"><small>
110 Generated by &#160;<a href="http://www.doxygen.org/index.html">
111 <img class="footer" src="../../doxygen.png" alt="doxygen"/>
112 </a> 1.8.11
113 </small></address>
114 </body>
115 </html>