diff options
Diffstat (limited to 'docs/html/GTlmNfc.html')
| -rw-r--r-- | docs/html/GTlmNfc.html | 360 |
1 files changed, 360 insertions, 0 deletions
diff --git a/docs/html/GTlmNfc.html b/docs/html/GTlmNfc.html new file mode 100644 index 0000000..b5e2747 --- /dev/null +++ b/docs/html/GTlmNfc.html @@ -0,0 +1,360 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>libtlm-nfc Reference Manual: GTlmNfc</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> +<link rel="home" href="index.html" title="libtlm-nfc Reference Manual"> +<link rel="up" href="ch01.html" title="The library API"> +<link rel="prev" href="ch01.html" title="The library API"> +<link rel="next" href="object-tree.html" title="Object Hierarchy"> +<meta name="generator" content="GTK-Doc V1.20 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"> +<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> + <a href="#GTlmNfc.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#GTlmNfc.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_signals"> <span class="dim">|</span> + <a href="#GTlmNfc.signals" class="shortcut">Signals</a></span> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="ch01.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="object-tree.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="GTlmNfc"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GTlmNfc.top_of_page"></a>GTlmNfc</span></h2> +<p>GTlmNfc — a helper object that provides NFC functionality to user management code</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="GTlmNfc.functions"></a><h2>Functions</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_return"> +<col class="functions_name"> +</colgroup> +<tbody><tr> +<td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="GTlmNfc.html#gtlm-nfc-write-username-password" title="gtlm_nfc_write_username_password ()">gtlm_nfc_write_username_password</a> <span class="c_punctuation">()</span> +</td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GTlmNfc.signals"></a><h2>Signals</h2> +<div class="informaltable"><table border="0"> +<colgroup> +<col width="150px" class="signals_return"> +<col width="300px" class="signals_name"> +<col width="200px" class="signals_flags"> +</colgroup> +<tbody> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="GTlmNfc.html#GTlmNfc-no-record-found" title="The “no-record-found” signal">no-record-found</a></td> +<td class="signal_flags"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td> +</tr> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="GTlmNfc.html#GTlmNfc-record-found" title="The “record-found” signal">record-found</a></td> +<td class="signal_flags"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td> +</tr> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="GTlmNfc.html#GTlmNfc-tag-found" title="The “tag-found” signal">tag-found</a></td> +<td class="signal_flags"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td> +</tr> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="GTlmNfc.html#GTlmNfc-tag-lost" title="The “tag-lost” signal">tag-lost</a></td> +<td class="signal_flags"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GTlmNfc.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="name"> +<col class="description"> +</colgroup> +<tbody><tr> +<td class="datatype_keyword">enum</td> +<td class="function_name"><a class="link" href="GTlmNfc.html#GTlmNfcError" title="enum GTlmNfcError">GTlmNfcError</a></td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GTlmNfc.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> + <span class="lineart">╰──</span> GTlmNfc +</pre> +</div> +<div class="refsect1"> +<a name="GTlmNfc.includes"></a><h2>Includes</h2> +<pre class="synopsis">#include <gtlm-nfc.h> +</pre> +</div> +<div class="refsect1"> +<a name="GTlmNfc.description"></a><h2>Description</h2> +<p><a class="link" href="GTlmNfc.html" title="GTlmNfc"><span class="type">GTlmNfc</span></a> is used by Tizen user and login management to access NFC tags +and authenticate users through them. It provides signals to listen for tags +appearing and disappearing, and for reading and writing username/password pairs +to tags.</p> +</div> +<div class="refsect1"> +<a name="GTlmNfc.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="gtlm-nfc-write-username-password"></a><h3>gtlm_nfc_write_username_password ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +gtlm_nfc_write_username_password (<em class="parameter"><code><a class="link" href="GTlmNfc.html" title="GTlmNfc"><span class="type">GTlmNfc</span></a> *tlm_nfc</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *nfc_tag_path</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *username</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *password</code></em>, + <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> +<p>This function is used to write a username and password to a tag. The tag path +can be obtained by listening to <a class="link" href="GTlmNfc.html#GTlmNfc-tag-found" title="The “tag-found” signal"><span class="type">“tag-found”</span></a> signals). <em class="parameter"><code>error</code></em> + is set to +<em class="parameter"><code>GTLM_NFC_ERROR_NO_TAG</code></em> + if no such tag exists.</p> +<div class="refsect3"> +<a name="id-1.2.2.9.2.5"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>tlm_nfc</p></td> +<td class="parameter_description"><p>an instance of GTlmNfc object</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>nfc_tag_path</p></td> +<td class="parameter_description"><p>an identificator of the nfc tag (returned by <a class="link" href="GTlmNfc.html#GTlmNfc-tag-found" title="The “tag-found” signal"><span class="type">“tag-found”</span></a>)</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>username</p></td> +<td class="parameter_description"><p>username to write</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>password</p></td> +<td class="parameter_description"><p>password to write</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>if non-NULL, set to an error, if one occurs</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="refsect1"> +<a name="GTlmNfc.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="GTlmNfcError"></a><h3>enum GTlmNfcError</h3> +<p>This enum provides a list of errors that libtlm-nfc returns.</p> +<div class="refsect3"> +<a name="id-1.2.2.10.2.4"></a><h4>Members</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="300px" class="enum_members_name"> +<col class="enum_members_description"> +<col width="200px" class="enum_members_annotations"> +</colgroup> +<tbody> +<tr> +<td class="enum_member_name"><p><a name="GTLM-NFC-ERROR-NONE:CAPS"></a>GTLM_NFC_ERROR_NONE</p></td> +<td class="enum_member_description"> +<p>No error</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="GTLM-NFC-ERROR-NO-TAG:CAPS"></a>GTLM_NFC_ERROR_NO_TAG</p></td> +<td class="enum_member_description"> +<p>Issued when attempting to write to an absent tag</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +</div> +<div class="refsect1"> +<a name="GTlmNfc.signal-details"></a><h2>Signal Details</h2> +<div class="refsect2"> +<a name="GTlmNfc-no-record-found"></a><h3>The <code class="literal">“no-record-found”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="GTlmNfc.html" title="GTlmNfc"><span class="type">GTlmNfc</span></a> *tlm_nfc, + <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>This signal is issued by <a class="link" href="GTlmNfc.html" title="GTlmNfc"><span class="type">GTlmNfc</span></a> object when a username and password pair +has not been found on a tag</p> +<div class="refsect3"> +<a name="id-1.2.2.11.2.5"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>tlm_nfc</p></td> +<td class="parameter_description"><p>the object which emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="GTlmNfc-record-found"></a><h3>The <code class="literal">“record-found”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="GTlmNfc.html" title="GTlmNfc"><span class="type">GTlmNfc</span></a> *tlm_nfc, + <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *username, + <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *password, + <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>This signal is issued by <a class="link" href="GTlmNfc.html" title="GTlmNfc"><span class="type">GTlmNfc</span></a> object when a username and password pair +has been found on a tag.</p> +<div class="refsect3"> +<a name="id-1.2.2.11.3.5"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>tlm_nfc</p></td> +<td class="parameter_description"><p>the object which emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>username</p></td> +<td class="parameter_description"><p>the username on the tag</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>password</p></td> +<td class="parameter_description"><p>the password on the tag</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="GTlmNfc-tag-found"></a><h3>The <code class="literal">“tag-found”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="GTlmNfc.html" title="GTlmNfc"><span class="type">GTlmNfc</span></a> *tlm_nfc, + <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *nfc_tag_path, + <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>This signal is issued by <a class="link" href="GTlmNfc.html" title="GTlmNfc"><span class="type">GTlmNfc</span></a> object when a tag has been found.</p> +<div class="refsect3"> +<a name="id-1.2.2.11.4.5"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>tlm_nfc</p></td> +<td class="parameter_description"><p>the object which emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>nfc_tag_path</p></td> +<td class="parameter_description"><p>an identifier of the tag (use in <a class="link" href="GTlmNfc.html#gtlm-nfc-write-username-password" title="gtlm_nfc_write_username_password ()"><code class="function">gtlm_nfc_write_username_password()</code></a>)</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="GTlmNfc-tag-lost"></a><h3>The <code class="literal">“tag-lost”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="GTlmNfc.html" title="GTlmNfc"><span class="type">GTlmNfc</span></a> *tlm_nfc, + <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *nfc_tag_path, + <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>This signal is issued by <a class="link" href="GTlmNfc.html" title="GTlmNfc"><span class="type">GTlmNfc</span></a> object when a tag has been lost.</p> +<div class="refsect3"> +<a name="id-1.2.2.11.5.5"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>tlm_nfc</p></td> +<td class="parameter_description"><p>the object which emitted the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>nfc_tag_path</p></td> +<td class="parameter_description"><p>an identifier of the tag</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.20</div> +</body> +</html>
\ No newline at end of file |