summaryrefslogtreecommitdiff
path: root/src/net.reactivated.Fprint.Manager.xml
blob: 2d0ba286559e7d836a18487675119b5e5da93b78 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
<!DOCTYPE node PUBLIC
"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd" [
<!ENTITY ERROR_NO_SUCH_DEVICE "net.reactivated.Fprint.Error.NoSuchDevice">
]>
<node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
	<interface name="net.reactivated.Fprint.Manager">

		<!-- ************************************************************ -->

		<method name="GetDevices">
			<arg type="ao" name="devices" direction="out">
				<doc:doc><doc:summary>An array of object paths for devices.</doc:summary></doc:doc>
			</arg>

			<doc:doc>
				<doc:description>
					<doc:para>
						Enumerate all the fingerprint readers attached to the system. If there are
						no devices available, an empty array is returned.
					</doc:para>
				</doc:description>
			</doc:doc>
		</method>

		<!-- ************************************************************ -->

		<method name="GetDefaultDevice">
			<arg type="o" name="device" direction="out">
				<doc:doc><doc:summary>The object path for the default device.</doc:summary></doc:doc>
			</arg>

			<doc:doc>
				<doc:description>
					<doc:para>
						Returns the default fingerprint reader device.
					</doc:para>
				</doc:description>

				<doc:errors>
					<doc:error name="&ERROR_NO_SUCH_DEVICE;">if the device does not exist</doc:error>
				</doc:errors>
			</doc:doc>
		</method>

	</interface>
</node>