Skip to content

Commit 0bc01c5

Browse files
Merge pull request #9 from GallagherSecurity/16.1-update-docs
Update SDK Documents
2 parents 92fdef0 + fa40a17 commit 0bc01c5

File tree

416 files changed

+10488
-6174
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

416 files changed

+10488
-6174
lines changed

docs/android/sdk-docs/annotated.html

Lines changed: 59 additions & 57 deletions
Large diffs are not rendered by default.

docs/android/sdk-docs/classcom_1_1gallagher_1_1security_1_1mobileaccess_1_1_access_result-members.html

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
<html xmlns="http://www.w3.org/1999/xhtml">
33
<head>
44
<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.9.1"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6+
<meta name="generator" content="Doxygen 1.9.4"/>
77
<meta name="viewport" content="width=device-width, initial-scale=1"/>
88
<title>Gallagher Mobile Connect SDK: Member List</title>
99
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -20,8 +20,8 @@
2020
<div id="titlearea">
2121
<table cellspacing="0" cellpadding="0">
2222
<tbody>
23-
<tr style="height: 56px;">
24-
<td id="projectalign" style="padding-left: 0.5em;">
23+
<tr id="projectrow">
24+
<td id="projectalign">
2525
<div id="projectname">Gallagher Mobile Connect SDK
2626
</div>
2727
</td>
@@ -30,21 +30,22 @@
3030
</table>
3131
</div>
3232
<!-- end header part -->
33-
<!-- Generated by Doxygen 1.9.1 -->
33+
<!-- Generated by Doxygen 1.9.4 -->
3434
<script type="text/javascript">
35-
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
36-
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
35+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
36+
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
3737
/* @license-end */
3838
</script>
3939
<script type="text/javascript" src="menudata.js"></script>
4040
<script type="text/javascript" src="menu.js"></script>
4141
<script type="text/javascript">
42-
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
42+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
4343
$(function() {
4444
initMenu('',true,false,'search.php','Search');
4545
$(document).ready(function() { init_search(); });
4646
});
47-
/* @license-end */</script>
47+
/* @license-end */
48+
</script>
4849
<div id="main-nav"></div>
4950
<!-- window showing the filter options -->
5051
<div id="MSearchSelectWindow"
@@ -66,21 +67,20 @@
6667
</div>
6768
</div><!-- top -->
6869
<div class="header">
69-
<div class="headertitle">
70-
<div class="title">com.gallagher.security.mobileaccess.AccessResult Member List</div> </div>
70+
<div class="headertitle"><div class="title">com.gallagher.security.mobileaccess.AccessResult Member List</div></div>
7171
</div><!--header-->
7272
<div class="contents">
7373

7474
<p>This is the complete list of members for <a class="el" href="classcom_1_1gallagher_1_1security_1_1mobileaccess_1_1_access_result.html">com.gallagher.security.mobileaccess.AccessResult</a>, including all inherited members.</p>
7575
<table class="directory">
7676
<tr class="even"><td class="entry"><a class="el" href="classcom_1_1gallagher_1_1security_1_1mobileaccess_1_1_access_result.html#acdab9fa25743f10d5b8fb000d1930b13">getAccessDecision</a>()</td><td class="entry"><a class="el" href="classcom_1_1gallagher_1_1security_1_1mobileaccess_1_1_access_result.html">com.gallagher.security.mobileaccess.AccessResult</a></td><td class="entry"></td></tr>
77-
<tr><td class="entry"><a class="el" href="classcom_1_1gallagher_1_1security_1_1mobileaccess_1_1_access_result.html#aa95238e6e707b26b143980125cfd5f2b">getAccessMode</a>()</td><td class="entry"><a class="el" href="classcom_1_1gallagher_1_1security_1_1mobileaccess_1_1_access_result.html">com.gallagher.security.mobileaccess.AccessResult</a></td><td class="entry"></td></tr>
77+
<tr class="odd"><td class="entry"><a class="el" href="classcom_1_1gallagher_1_1security_1_1mobileaccess_1_1_access_result.html#aa95238e6e707b26b143980125cfd5f2b">getAccessMode</a>()</td><td class="entry"><a class="el" href="classcom_1_1gallagher_1_1security_1_1mobileaccess_1_1_access_result.html">com.gallagher.security.mobileaccess.AccessResult</a></td><td class="entry"></td></tr>
7878
<tr class="even"><td class="entry"><a class="el" href="classcom_1_1gallagher_1_1security_1_1mobileaccess_1_1_access_result.html#a6ee40f118ad20a9430ef2501004508d7">isAccessGranted</a>()</td><td class="entry"><a class="el" href="classcom_1_1gallagher_1_1security_1_1mobileaccess_1_1_access_result.html">com.gallagher.security.mobileaccess.AccessResult</a></td><td class="entry"></td></tr>
79-
<tr bgcolor="#f0f0f0"><td class="entry"><b>toString</b>() (defined in <a class="el" href="classcom_1_1gallagher_1_1security_1_1mobileaccess_1_1_access_result.html">com.gallagher.security.mobileaccess.AccessResult</a>)</td><td class="entry"><a class="el" href="classcom_1_1gallagher_1_1security_1_1mobileaccess_1_1_access_result.html">com.gallagher.security.mobileaccess.AccessResult</a></td><td class="entry"></td></tr>
79+
<tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>toString</b>() (defined in <a class="el" href="classcom_1_1gallagher_1_1security_1_1mobileaccess_1_1_access_result.html">com.gallagher.security.mobileaccess.AccessResult</a>)</td><td class="entry"><a class="el" href="classcom_1_1gallagher_1_1security_1_1mobileaccess_1_1_access_result.html">com.gallagher.security.mobileaccess.AccessResult</a></td><td class="entry"></td></tr>
8080
</table></div><!-- contents -->
8181
<!-- start footer part -->
8282
<hr class="footer"/><address class="footer"><small>
83-
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
83+
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
8484
</small></address>
8585
</body>
8686
</html>

docs/android/sdk-docs/classcom_1_1gallagher_1_1security_1_1mobileaccess_1_1_access_result.html

Lines changed: 50 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
<html xmlns="http://www.w3.org/1999/xhtml">
33
<head>
44
<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.9.1"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6+
<meta name="generator" content="Doxygen 1.9.4"/>
77
<meta name="viewport" content="width=device-width, initial-scale=1"/>
88
<title>Gallagher Mobile Connect SDK: com.gallagher.security.mobileaccess.AccessResult Class Reference</title>
99
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -20,8 +20,8 @@
2020
<div id="titlearea">
2121
<table cellspacing="0" cellpadding="0">
2222
<tbody>
23-
<tr style="height: 56px;">
24-
<td id="projectalign" style="padding-left: 0.5em;">
23+
<tr id="projectrow">
24+
<td id="projectalign">
2525
<div id="projectname">Gallagher Mobile Connect SDK
2626
</div>
2727
</td>
@@ -30,21 +30,22 @@
3030
</table>
3131
</div>
3232
<!-- end header part -->
33-
<!-- Generated by Doxygen 1.9.1 -->
33+
<!-- Generated by Doxygen 1.9.4 -->
3434
<script type="text/javascript">
35-
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
36-
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
35+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
36+
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
3737
/* @license-end */
3838
</script>
3939
<script type="text/javascript" src="menudata.js"></script>
4040
<script type="text/javascript" src="menu.js"></script>
4141
<script type="text/javascript">
42-
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
42+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
4343
$(function() {
4444
initMenu('',true,false,'search.php','Search');
4545
$(document).ready(function() { init_search(); });
4646
});
47-
/* @license-end */</script>
47+
/* @license-end */
48+
</script>
4849
<div id="main-nav"></div>
4950
<!-- window showing the filter options -->
5051
<div id="MSearchSelectWindow"
@@ -69,27 +70,25 @@
6970
<div class="summary">
7071
<a href="#pub-methods">Public Member Functions</a> &#124;
7172
<a href="classcom_1_1gallagher_1_1security_1_1mobileaccess_1_1_access_result-members.html">List of all members</a> </div>
72-
<div class="headertitle">
73-
<div class="title">com.gallagher.security.mobileaccess.AccessResult Class Reference</div> </div>
73+
<div class="headertitle"><div class="title">com.gallagher.security.mobileaccess.AccessResult Class Reference</div></div>
7474
</div><!--header-->
7575
<div class="contents">
7676
<table class="memberdecls">
77-
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
77+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
7878
Public Member Functions</h2></td></tr>
7979
<tr class="memitem:acdab9fa25743f10d5b8fb000d1930b13"><td class="memItemLeft" align="right" valign="top"><a class="el" href="enumcom_1_1gallagher_1_1security_1_1mobileaccess_1_1_access_decision.html">AccessDecision</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1gallagher_1_1security_1_1mobileaccess_1_1_access_result.html#acdab9fa25743f10d5b8fb000d1930b13">getAccessDecision</a> ()</td></tr>
8080
<tr class="separator:acdab9fa25743f10d5b8fb000d1930b13"><td class="memSeparator" colspan="2">&#160;</td></tr>
8181
<tr class="memitem:aa95238e6e707b26b143980125cfd5f2b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="enumcom_1_1gallagher_1_1security_1_1mobileaccess_1_1_access_mode.html">AccessMode</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1gallagher_1_1security_1_1mobileaccess_1_1_access_result.html#aa95238e6e707b26b143980125cfd5f2b">getAccessMode</a> ()</td></tr>
8282
<tr class="separator:aa95238e6e707b26b143980125cfd5f2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
8383
<tr class="memitem:a6ee40f118ad20a9430ef2501004508d7"><td class="memItemLeft" align="right" valign="top">boolean&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1gallagher_1_1security_1_1mobileaccess_1_1_access_result.html#a6ee40f118ad20a9430ef2501004508d7">isAccessGranted</a> ()</td></tr>
8484
<tr class="separator:a6ee40f118ad20a9430ef2501004508d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
85-
<tr class="memitem:a7dce9e2070e4e6a568ba7c8846aec56c"><td class="memItemLeft" align="right" valign="top"><a id="a7dce9e2070e4e6a568ba7c8846aec56c"></a>
86-
String&#160;</td><td class="memItemRight" valign="bottom"><b>toString</b> ()</td></tr>
85+
<tr class="memitem:a7dce9e2070e4e6a568ba7c8846aec56c"><td class="memItemLeft" align="right" valign="top">String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1gallagher_1_1security_1_1mobileaccess_1_1_access_result.html#a7dce9e2070e4e6a568ba7c8846aec56c">toString</a> ()</td></tr>
8786
<tr class="separator:a7dce9e2070e4e6a568ba7c8846aec56c"><td class="memSeparator" colspan="2">&#160;</td></tr>
8887
</table>
8988
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
90-
<div class="textblock"><p>This object represents the result of an access attempt (e.g. attempt to open a door) </p>
89+
<div class="textblock"><p >This object represents the result of an access attempt (e.g. attempt to open a door) </p>
9190
</div><h2 class="groupheader">Member Function Documentation</h2>
92-
<a id="acdab9fa25743f10d5b8fb000d1930b13"></a>
91+
<a id="acdab9fa25743f10d5b8fb000d1930b13" name="acdab9fa25743f10d5b8fb000d1930b13"></a>
9392
<h2 class="memtitle"><span class="permalink"><a href="#acdab9fa25743f10d5b8fb000d1930b13">&#9670;&nbsp;</a></span>getAccessDecision()</h2>
9493

9594
<div class="memitem">
@@ -103,14 +102,14 @@ <h2 class="memtitle"><span class="permalink"><a href="#acdab9fa25743f10d5b8fb000
103102
</tr>
104103
</table>
105104
</div><div class="memdoc">
106-
<p>The access decision made by the controller on an access attempt </p>
107-
<div class="fragment"><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; {</div>
108-
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keywordflow">return</span> mAccessDecision;</div>
109-
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; }</div>
105+
<p >The access decision made by the controller on an access attempt </p>
106+
<div class="fragment"><div class="line"><span class="lineno"> 50</span> {</div>
107+
<div class="line"><span class="lineno"> 51</span> <span class="keywordflow">return</span> mAccessDecision;</div>
108+
<div class="line"><span class="lineno"> 52</span> }</div>
110109
</div><!-- fragment -->
111110
</div>
112111
</div>
113-
<a id="aa95238e6e707b26b143980125cfd5f2b"></a>
112+
<a id="aa95238e6e707b26b143980125cfd5f2b" name="aa95238e6e707b26b143980125cfd5f2b"></a>
114113
<h2 class="memtitle"><span class="permalink"><a href="#aa95238e6e707b26b143980125cfd5f2b">&#9670;&nbsp;</a></span>getAccessMode()</h2>
115114

116115
<div class="memitem">
@@ -124,14 +123,14 @@ <h2 class="memtitle"><span class="permalink"><a href="#aa95238e6e707b26b14398012
124123
</tr>
125124
</table>
126125
</div><div class="memdoc">
127-
<p>The access mode the Mobile <a class="el" href="interfacecom_1_1gallagher_1_1security_1_1mobileaccess_1_1_reader.html">Reader</a> is operating in when making the access decision </p>
128-
<div class="fragment"><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; {</div>
129-
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="keywordflow">return</span> mAccessMode;</div>
130-
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; }</div>
126+
<p >The access mode the Mobile <a class="el" href="interfacecom_1_1gallagher_1_1security_1_1mobileaccess_1_1_reader.html">Reader</a> is operating in when making the access decision </p>
127+
<div class="fragment"><div class="line"><span class="lineno"> 55</span> {</div>
128+
<div class="line"><span class="lineno"> 56</span> <span class="keywordflow">return</span> mAccessMode;</div>
129+
<div class="line"><span class="lineno"> 57</span> }</div>
131130
</div><!-- fragment -->
132131
</div>
133132
</div>
134-
<a id="a6ee40f118ad20a9430ef2501004508d7"></a>
133+
<a id="a6ee40f118ad20a9430ef2501004508d7" name="a6ee40f118ad20a9430ef2501004508d7"></a>
135134
<h2 class="memtitle"><span class="permalink"><a href="#a6ee40f118ad20a9430ef2501004508d7">&#9670;&nbsp;</a></span>isAccessGranted()</h2>
136135

137136
<div class="memitem">
@@ -145,10 +144,30 @@ <h2 class="memtitle"><span class="permalink"><a href="#a6ee40f118ad20a9430ef2501
145144
</tr>
146145
</table>
147146
</div><div class="memdoc">
148-
<p>Convenience method which returns true if the <a class="el" href="enumcom_1_1gallagher_1_1security_1_1mobileaccess_1_1_access_decision.html">AccessDecision</a> is one of the granted results, else false </p>
149-
<div class="fragment"><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; {</div>
150-
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keywordflow">return</span> mAccessDecision.getValue() &gt; 0;</div>
151-
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; }</div>
147+
<p >Convenience method which returns true if the <a class="el" href="enumcom_1_1gallagher_1_1security_1_1mobileaccess_1_1_access_decision.html">AccessDecision</a> is one of the granted results, else false </p>
148+
<div class="fragment"><div class="line"><span class="lineno"> 60</span> {</div>
149+
<div class="line"><span class="lineno"> 61</span> <span class="keywordflow">return</span> mAccessDecision.getValue() &gt; 0;</div>
150+
<div class="line"><span class="lineno"> 62</span> }</div>
151+
</div><!-- fragment -->
152+
</div>
153+
</div>
154+
<a id="a7dce9e2070e4e6a568ba7c8846aec56c" name="a7dce9e2070e4e6a568ba7c8846aec56c"></a>
155+
<h2 class="memtitle"><span class="permalink"><a href="#a7dce9e2070e4e6a568ba7c8846aec56c">&#9670;&nbsp;</a></span>toString()</h2>
156+
157+
<div class="memitem">
158+
<div class="memproto">
159+
<table class="memname">
160+
<tr>
161+
<td class="memname">String com.gallagher.security.mobileaccess.AccessResult.toString </td>
162+
<td>(</td>
163+
<td class="paramname"></td><td>)</td>
164+
<td></td>
165+
</tr>
166+
</table>
167+
</div><div class="memdoc">
168+
<div class="fragment"><div class="line"><span class="lineno"> 66</span> { <span class="comment">// for debugging/logging only</span></div>
169+
<div class="line"><span class="lineno"> 67</span> <span class="keywordflow">return</span> String.format(Locale.US, <span class="stringliteral">&quot;&lt;AccessResult decision=&#39;%1$s&#39;, mode = &#39;%2$s&#39;&gt;&quot;</span>, mAccessDecision, mAccessMode);</div>
170+
<div class="line"><span class="lineno"> 68</span> }</div>
152171
</div><!-- fragment -->
153172
</div>
154173
</div>
@@ -158,7 +177,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a6ee40f118ad20a9430ef2501
158177
</div><!-- contents -->
159178
<!-- start footer part -->
160179
<hr class="footer"/><address class="footer"><small>
161-
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
180+
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
162181
</small></address>
163182
</body>
164183
</html>

0 commit comments

Comments
 (0)