| 1 |
<!DOCTYPE node PUBLIC |
| 2 |
"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" |
| 3 |
"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd" [ |
| 4 |
<!ENTITY ERROR_CLAIM_DEVICE "net.reactivated.Fprint.Error.ClaimDevice"> |
| 5 |
<!ENTITY ERROR_ALREADY_IN_USE "net.reactivated.Fprint.Error.AlreadyInUse"> |
| 6 |
<!ENTITY ERROR_INTERNAL "net.reactivated.Fprint.Error.Internal"> |
| 7 |
<!ENTITY ERROR_PERMISSION_DENIED "net.reactivated.Fprint.Error.PermissionDenied"> |
| 8 |
<!ENTITY ERROR_NO_ENROLLED_PRINTS "net.reactivated.Fprint.Error.NoEnrolledPrints"> |
| 9 |
<!ENTITY ERROR_NO_ACTION_IN_PROGRESS "net.reactivated.Fprint.Error.NoActionInProgress"> |
| 10 |
<!ENTITY ERROR_INVALID_FINGERNAME "net.reactivated.Fprint.Error.InvalidFingername"> |
| 11 |
<!ENTITY ERROR_PRINTS_NOT_DELETED "net.reactivated.Fprint.Error.PrintsNotDeleted"> |
| 12 |
<!ENTITY ERROR_PRINTS_NOT_DELETED_FROM_DEVICE "net.reactivated.Fprint.Error.PrintsNotDeletedFromDevice"> |
| 13 |
]> |
| 14 |
|
| 15 |
<node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd"> |
| 16 |
<interface name="net.reactivated.Fprint.Device"> |
| 17 |
<doc:doc> |
| 18 |
<doc:title id="polkit-integration"> |
| 19 |
PolicyKit integration |
| 20 |
</doc:title> |
| 21 |
<doc:para> |
| 22 |
fprintd uses PolicyKit to check whether users are allowed to access fingerprint data, or the |
| 23 |
fingerprint readers itself. |
| 24 |
<doc:list> |
| 25 |
<doc:item> |
| 26 |
<doc:term>net.reactivated.fprint.device.verify</doc:term> |
| 27 |
<doc:definition> |
| 28 |
Whether the user is allowed to verify fingers against saved fingerprints. |
| 29 |
</doc:definition> |
| 30 |
</doc:item> |
| 31 |
<doc:item> |
| 32 |
<doc:term>net.reactivated.fprint.device.enroll</doc:term> |
| 33 |
<doc:definition> |
| 34 |
Whether the user is allowed to enroll new fingerprints. |
| 35 |
</doc:definition> |
| 36 |
</doc:item> |
| 37 |
<doc:item> |
| 38 |
<doc:term>net.reactivated.fprint.device.setusername</doc:term> |
| 39 |
<doc:definition> |
| 40 |
Whether the user is allowed to query, verify, or enroll fingerprints for users other than itself. |
| 41 |
</doc:definition> |
| 42 |
</doc:item> |
| 43 |
</doc:list> |
| 44 |
</doc:para> |
| 45 |
|
| 46 |
<doc:title id="usernames"> |
| 47 |
Usernames |
| 48 |
</doc:title> |
| 49 |
<doc:para> |
| 50 |
When a username argument is used for a method, a PolicyKit check is done on the |
| 51 |
<doc:tt>net.reactivated.fprint.device.setusername</doc:tt> PolicyKit |
| 52 |
action to see whether the user the client is running as is allowed to access data from other users. |
| 53 |
</doc:para> |
| 54 |
<doc:para> |
| 55 |
By default, only root is allowed to access fingerprint data for users other than itself. For a normal user, |
| 56 |
it is recommended that you use an empty string for the username, which will mean "the client the user is |
| 57 |
running as". |
| 58 |
</doc:para> |
| 59 |
<doc:para> |
| 60 |
See <doc:ref type="description" to="polkit-integration">PolicyKit integration</doc:ref>. |
| 61 |
</doc:para> |
| 62 |
|
| 63 |
<doc:title id="fingerprint-names"> |
| 64 |
Fingerprint names |
| 65 |
</doc:title> |
| 66 |
<doc:para> |
| 67 |
When a finger name argument is used for a method, it refers to either a single finger, or |
| 68 |
"any" finger. See the list of possible values below: |
| 69 |
<doc:list> |
| 70 |
<doc:item> |
| 71 |
<doc:term>left-thumb</doc:term> |
| 72 |
<doc:definition> |
| 73 |
Left thumb |
| 74 |
</doc:definition> |
| 75 |
</doc:item> |
| 76 |
<doc:item> |
| 77 |
<doc:term>left-index-finger</doc:term> |
| 78 |
<doc:definition> |
| 79 |
Left index finger |
| 80 |
</doc:definition> |
| 81 |
</doc:item> |
| 82 |
<doc:item> |
| 83 |
<doc:term>left-middle-finger</doc:term> |
| 84 |
<doc:definition> |
| 85 |
Left middle finger |
| 86 |
</doc:definition> |
| 87 |
</doc:item> |
| 88 |
<doc:item> |
| 89 |
<doc:term>left-ring-finger</doc:term> |
| 90 |
<doc:definition> |
| 91 |
Left ring finger |
| 92 |
</doc:definition> |
| 93 |
</doc:item> |
| 94 |
<doc:item> |
| 95 |
<doc:term>left-little-finger</doc:term> |
| 96 |
<doc:definition> |
| 97 |
Left little finger |
| 98 |
</doc:definition> |
| 99 |
</doc:item> |
| 100 |
<doc:item> |
| 101 |
<doc:term>right-thumb</doc:term> |
| 102 |
<doc:definition> |
| 103 |
Right thumb |
| 104 |
</doc:definition> |
| 105 |
</doc:item> |
| 106 |
<doc:item> |
| 107 |
<doc:term>right-index-finger</doc:term> |
| 108 |
<doc:definition> |
| 109 |
Right index finger |
| 110 |
</doc:definition> |
| 111 |
</doc:item> |
| 112 |
<doc:item> |
| 113 |
<doc:term>right-middle-finger</doc:term> |
| 114 |
<doc:definition> |
| 115 |
Right middle finger |
| 116 |
</doc:definition> |
| 117 |
</doc:item> |
| 118 |
<doc:item> |
| 119 |
<doc:term>right-ring-finger</doc:term> |
| 120 |
<doc:definition> |
| 121 |
Right ring finger |
| 122 |
</doc:definition> |
| 123 |
</doc:item> |
| 124 |
<doc:item> |
| 125 |
<doc:term>right-little-finger</doc:term> |
| 126 |
<doc:definition> |
| 127 |
Right little finger |
| 128 |
</doc:definition> |
| 129 |
</doc:item> |
| 130 |
<doc:item> |
| 131 |
<doc:term>any</doc:term> |
| 132 |
<doc:definition> |
| 133 |
Any finger. This is only used for <doc:ref type="method" to="Device.VerifyStart">Device.VerifyStart</doc:ref> |
| 134 |
(select the first finger with a fingerprint associated, or all the fingerprints available for the user when |
| 135 |
the device supports it) and <doc:ref type="signal" to="Device::VerifyFingerSelected">Device::VerifyFingerSelected</doc:ref> |
| 136 |
(any finger with an associated fingerprint can be used). |
| 137 |
</doc:definition> |
| 138 |
</doc:item> |
| 139 |
</doc:list> |
| 140 |
</doc:para> |
| 141 |
|
| 142 |
<doc:title id="verify-statuses"> |
| 143 |
Verify Statuses |
| 144 |
</doc:title> |
| 145 |
<doc:para> |
| 146 |
<doc:list> |
| 147 |
Possible values for the result passed through <doc:ref type="signal" to="Device::VerifyResult">Device::VerifyResult</doc:ref> are: |
| 148 |
<doc:item> |
| 149 |
<doc:term>verify-no-match</doc:term> |
| 150 |
<doc:definition> |
| 151 |
The verification did not match, <doc:ref type="method" to="Device.VerifyStop">Device.VerifyStop</doc:ref> should now be called. |
| 152 |
</doc:definition> |
| 153 |
</doc:item> |
| 154 |
<doc:item> |
| 155 |
<doc:term>verify-match</doc:term> |
| 156 |
<doc:definition> |
| 157 |
The verification succeeded, <doc:ref type="method" to="Device.VerifyStop">Device.VerifyStop</doc:ref> should now be called. |
| 158 |
</doc:definition> |
| 159 |
</doc:item> |
| 160 |
<doc:item> |
| 161 |
<doc:term>verify-retry-scan</doc:term> |
| 162 |
<doc:definition> |
| 163 |
The user should retry scanning their finger, the verification is still ongoing. |
| 164 |
</doc:definition> |
| 165 |
</doc:item> |
| 166 |
<doc:item> |
| 167 |
<doc:term>verify-swipe-too-short</doc:term> |
| 168 |
<doc:definition> |
| 169 |
The user's swipe was too short. The user should retry scanning their finger, the verification is still ongoing. |
| 170 |
</doc:definition> |
| 171 |
</doc:item> |
| 172 |
<doc:item> |
| 173 |
<doc:term>verify-finger-not-centered</doc:term> |
| 174 |
<doc:definition> |
| 175 |
The user's finger was not centered on the reader. The user should retry scanning their finger, the verification is still ongoing. |
| 176 |
</doc:definition> |
| 177 |
</doc:item> |
| 178 |
<doc:item> |
| 179 |
<doc:term>verify-remove-and-retry</doc:term> |
| 180 |
<doc:definition> |
| 181 |
The user should remove their finger from the reader and retry scanning their finger, the verification is still ongoing. |
| 182 |
</doc:definition> |
| 183 |
</doc:item> |
| 184 |
<doc:item> |
| 185 |
<doc:term>verify-too-fast</doc:term> |
| 186 |
<doc:definition> |
| 187 |
The user's swipe or touch was too fast. The user should retry scanning their finger, the verification is still ongoing. |
| 188 |
</doc:definition> |
| 189 |
</doc:item> |
| 190 |
<doc:item> |
| 191 |
<doc:term>verify-disconnected</doc:term> |
| 192 |
<doc:definition> |
| 193 |
The device was disconnected during the verification, no other actions should be taken, and you shouldn't use the device any more. |
| 194 |
</doc:definition> |
| 195 |
</doc:item> |
| 196 |
<doc:item> |
| 197 |
<doc:term>verify-unknown-error</doc:term> |
| 198 |
<doc:definition> |
| 199 |
An unknown error occurred (usually a driver problem), <doc:ref type="method" to="Device.VerifyStop">Device.VerifyStop</doc:ref> should now be called. |
| 200 |
</doc:definition> |
| 201 |
</doc:item> |
| 202 |
</doc:list> |
| 203 |
</doc:para> |
| 204 |
|
| 205 |
<doc:title id="enroll-statuses"> |
| 206 |
Enroll Statuses |
| 207 |
</doc:title> |
| 208 |
<doc:para> |
| 209 |
<doc:list> |
| 210 |
Possible values for the result passed through <doc:ref type="signal" to="Device::EnrollResult">Device::EnrollResult</doc:ref> are: |
| 211 |
<doc:item> |
| 212 |
<doc:term>enroll-completed</doc:term> |
| 213 |
<doc:definition> |
| 214 |
The enrollment successfully completed, <doc:ref type="method" to="Device.EnrollStop">Device.EnrollStop</doc:ref> should now be called. |
| 215 |
</doc:definition> |
| 216 |
</doc:item> |
| 217 |
<doc:item> |
| 218 |
<doc:term>enroll-failed</doc:term> |
| 219 |
<doc:definition> |
| 220 |
The enrollment failed, <doc:ref type="method" to="Device.EnrollStop">Device.EnrollStop</doc:ref> should now be called. |
| 221 |
</doc:definition> |
| 222 |
</doc:item> |
| 223 |
<doc:item> |
| 224 |
<doc:term>enroll-stage-passed</doc:term> |
| 225 |
<doc:definition> |
| 226 |
One stage of the enrollment passed, the enrollment is still ongoing. |
| 227 |
</doc:definition> |
| 228 |
</doc:item> |
| 229 |
<doc:item> |
| 230 |
<doc:term>enroll-retry-scan</doc:term> |
| 231 |
<doc:definition> |
| 232 |
The user should retry scanning their finger, the enrollment is still ongoing. |
| 233 |
</doc:definition> |
| 234 |
</doc:item> |
| 235 |
<doc:item> |
| 236 |
<doc:term>enroll-swipe-too-short</doc:term> |
| 237 |
<doc:definition> |
| 238 |
The user's swipe was too short. The user should retry scanning their finger, the enrollment is still ongoing. |
| 239 |
</doc:definition> |
| 240 |
</doc:item> |
| 241 |
<doc:item> |
| 242 |
<doc:term>enroll-too-fast</doc:term> |
| 243 |
<doc:definition> |
| 244 |
The user's swipe or touch was too short. The user should retry scanning their finger, the enrollment is still ongoing. |
| 245 |
</doc:definition> |
| 246 |
</doc:item> |
| 247 |
<doc:item> |
| 248 |
<doc:term>enroll-finger-not-centered</doc:term> |
| 249 |
<doc:definition> |
| 250 |
The user's finger was not centered on the reader. The user should retry scanning their finger, the enrollment is still ongoing. |
| 251 |
</doc:definition> |
| 252 |
</doc:item> |
| 253 |
<doc:item> |
| 254 |
<doc:term>enroll-remove-and-retry</doc:term> |
| 255 |
<doc:definition> |
| 256 |
The user should remove their finger from the reader and retry scanning their finger, the enrollment is still ongoing. |
| 257 |
</doc:definition> |
| 258 |
</doc:item> |
| 259 |
<doc:item> |
| 260 |
<doc:term>enroll-data-full</doc:term> |
| 261 |
<doc:definition> |
| 262 |
No further prints can be enrolled on this device, <doc:ref type="method" to="Device.EnrollStop">Device.EnrollStop</doc:ref> should now be called. |
| 263 |
|
| 264 |
<doc:ref type="method" to="DeleteEnrolledFinger">Delete other prints</doc:ref> from the device first to continue |
| 265 |
(e.g. from other users). Note that old prints or prints from other operating systems may be deleted automatically |
| 266 |
to resolve this error without any notification. |
| 267 |
</doc:definition> |
| 268 |
</doc:item> |
| 269 |
<doc:item> |
| 270 |
<doc:term>enroll-duplicate</doc:term> |
| 271 |
<doc:definition> |
| 272 |
The print has already been enrolled, <doc:ref type="method" to="Device.EnrollStop">Device.EnrollStop</doc:ref> should now be called. |
| 273 |
|
| 274 |
The user should enroll a different finger, or delete the print that has been enrolled already. |
| 275 |
This print may be enrolled for a different user. |
| 276 |
Note that an old duplicate (e.g. from a previous install) will be automatically garbage collected and should not cause any issues. |
| 277 |
</doc:definition> |
| 278 |
</doc:item> |
| 279 |
<doc:item> |
| 280 |
<doc:term>enroll-disconnected</doc:term> |
| 281 |
<doc:definition> |
| 282 |
The device was disconnected during the enrollment, no other actions should be taken, and you shouldn't use the device any more. |
| 283 |
|
| 284 |
</doc:definition> |
| 285 |
</doc:item> |
| 286 |
<doc:item> |
| 287 |
<doc:term>enroll-unknown-error</doc:term> |
| 288 |
<doc:definition> |
| 289 |
An unknown error occurred (usually a driver problem), <doc:ref type="method" to="Device.EnrollStop">Device.EnrollStop</doc:ref> should now be called. |
| 290 |
|
| 291 |
</doc:definition> |
| 292 |
</doc:item> |
| 293 |
</doc:list> |
| 294 |
</doc:para> |
| 295 |
</doc:doc> |
| 296 |
|
| 297 |
<!-- ************************************************************ --> |
| 298 |
|
| 299 |
<method name="ListEnrolledFingers"> |
| 300 |
<arg type="s" name="username" direction="in"> |
| 301 |
<doc:doc><doc:summary>The username for whom to list the enrolled fingerprints. See <doc:ref type="description" to="usernames">Usernames</doc:ref>.</doc:summary></doc:doc> |
| 302 |
</arg> |
| 303 |
<arg type="as" name="enrolled_fingers" direction="out"> |
| 304 |
<doc:doc><doc:summary>An array of strings representing the enrolled fingerprints. See <doc:ref type="description" to="fingerprint-names">Fingerprint names</doc:ref>.</doc:summary></doc:doc> |
| 305 |
</arg> |
| 306 |
<doc:doc> |
| 307 |
<doc:description> |
| 308 |
<doc:para> |
| 309 |
List all the enrolled fingerprints for the chosen user. |
| 310 |
</doc:para> |
| 311 |
</doc:description> |
| 312 |
|
| 313 |
<doc:errors> |
| 314 |
<doc:error name="&ERROR_PERMISSION_DENIED;">if the caller lacks the appropriate PolicyKit authorization</doc:error> |
| 315 |
<doc:error name="&ERROR_NO_ENROLLED_PRINTS;">if the chosen user doesn't have any fingerprints enrolled</doc:error> |
| 316 |
</doc:errors> |
| 317 |
</doc:doc> |
| 318 |
</method> |
| 319 |
|
| 320 |
<!-- ************************************************************ --> |
| 321 |
|
| 322 |
<method name="DeleteEnrolledFingers"> |
| 323 |
<arg type="s" name="username" direction="in"> |
| 324 |
<doc:doc><doc:summary>The username for whom to delete the enrolled fingerprints. See <doc:ref type="description" to="usernames">Usernames</doc:ref>.</doc:summary></doc:doc> |
| 325 |
</arg> |
| 326 |
<doc:doc> |
| 327 |
<doc:description> |
| 328 |
<doc:para> |
| 329 |
Delete all the enrolled fingerprints for the chosen user. |
| 330 |
</doc:para> |
| 331 |
<doc:para> |
| 332 |
This call only exists for compatibility reasons, you should instead claim the device using |
| 333 |
<doc:ref type="method" to="Device.Claim">Device.Claim</doc:ref> and then call |
| 334 |
<doc:ref type="method" to="DeleteEnrolledFingers2">DeleteEnrolledFingers2</doc:ref> or |
| 335 |
<doc:ref type="method" to="DeleteEnrolledFinger">DeleteEnrolledFinger</doc:ref>. |
| 336 |
</doc:para> |
| 337 |
</doc:description> |
| 338 |
|
| 339 |
<doc:errors> |
| 340 |
<doc:error name="&ERROR_PERMISSION_DENIED;">if the caller lacks the appropriate PolicyKit authorization</doc:error> |
| 341 |
<doc:error name="&ERROR_PRINTS_NOT_DELETED;">if the fingerprint is not deleted from fprintd storage</doc:error> |
| 342 |
</doc:errors> |
| 343 |
</doc:doc> |
| 344 |
</method> |
| 345 |
|
| 346 |
<!-- ************************************************************ --> |
| 347 |
|
| 348 |
<method name="DeleteEnrolledFingers2"> |
| 349 |
<doc:doc> |
| 350 |
<doc:description> |
| 351 |
<doc:para> |
| 352 |
Delete all the enrolled fingerprints for the user currently claiming the device with <doc:ref type="method" to="Device.Claim">Device.Claim</doc:ref>. |
| 353 |
</doc:para> |
| 354 |
</doc:description> |
| 355 |
|
| 356 |
<doc:errors> |
| 357 |
<doc:error name="&ERROR_PERMISSION_DENIED;">if the caller lacks the appropriate PolicyKit authorization</doc:error> |
| 358 |
<doc:error name="&ERROR_PRINTS_NOT_DELETED;">if the fingerprint is not deleted from fprintd storage</doc:error> |
| 359 |
</doc:errors> |
| 360 |
</doc:doc> |
| 361 |
</method> |
| 362 |
|
| 363 |
<!-- ************************************************************ --> |
| 364 |
|
| 365 |
<method name="DeleteEnrolledFinger"> |
| 366 |
<arg type="s" name="finger_name" direction="in"> |
| 367 |
<doc:doc> |
| 368 |
<doc:summary>A string representing the finger to delete. See |
| 369 |
<doc:ref type="description" to="fingerprint-names">Fingerprint names</doc:ref>. |
| 370 |
Note that "any" is not a valid finger name for this method.</doc:summary> |
| 371 |
</doc:doc> |
| 372 |
</arg> |
| 373 |
<doc:doc> |
| 374 |
<doc:description> |
| 375 |
<doc:para> |
| 376 |
Delete the enrolled fingerprint for the user currently claiming the device with <doc:ref type="method" to="Device.Claim">Device.Claim</doc:ref>. |
| 377 |
</doc:para> |
| 378 |
</doc:description> |
| 379 |
|
| 380 |
<doc:errors> |
| 381 |
<doc:error name="&ERROR_PERMISSION_DENIED;">if the caller lacks the appropriate PolicyKit authorization</doc:error> |
| 382 |
<doc:error name="&ERROR_CLAIM_DEVICE;">if the device was not claimed</doc:error> |
| 383 |
<doc:error name="&ERROR_INVALID_FINGERNAME;">if the finger name passed is invalid</doc:error> |
| 384 |
<doc:error name="&ERROR_NO_ENROLLED_PRINTS;">if the chosen user doesn't have the requsted fingerprint enrolled</doc:error> |
| 385 |
<doc:error name="&ERROR_PRINTS_NOT_DELETED;">if the fingerprint is not deleted from fprintd storage</doc:error> |
| 386 |
</doc:errors> |
| 387 |
</doc:doc> |
| 388 |
</method> |
| 389 |
|
| 390 |
<!-- ************************************************************ --> |
| 391 |
|
| 392 |
<method name="Claim"> |
| 393 |
<arg type="s" name="username" direction="in"> |
| 394 |
<doc:doc><doc:summary>The username for whom to claim the device. See <doc:ref type="description" to="usernames">Usernames</doc:ref>.</doc:summary></doc:doc> |
| 395 |
</arg> |
| 396 |
<doc:doc> |
| 397 |
<doc:description> |
| 398 |
<doc:para> |
| 399 |
Claim the device for the chosen user. |
| 400 |
</doc:para> |
| 401 |
</doc:description> |
| 402 |
|
| 403 |
<doc:errors> |
| 404 |
<doc:error name="&ERROR_PERMISSION_DENIED;">if the caller lacks the appropriate PolicyKit authorization</doc:error> |
| 405 |
<doc:error name="&ERROR_ALREADY_IN_USE;">if the device is already claimed</doc:error> |
| 406 |
<doc:error name="&ERROR_INTERNAL;">if the device couldn't be claimed</doc:error> |
| 407 |
</doc:errors> |
| 408 |
</doc:doc> |
| 409 |
</method> |
| 410 |
|
| 411 |
<!-- ************************************************************ --> |
| 412 |
|
| 413 |
<method name="Release"> |
| 414 |
<doc:doc> |
| 415 |
<doc:description> |
| 416 |
<doc:para> |
| 417 |
Release a device claimed with <doc:ref type="method" to="Device.Claim">Device.Claim</doc:ref>. |
| 418 |
</doc:para> |
| 419 |
</doc:description> |
| 420 |
|
| 421 |
<doc:errors> |
| 422 |
<doc:error name="&ERROR_PERMISSION_DENIED;">if the caller lacks the appropriate PolicyKit authorization</doc:error> |
| 423 |
<doc:error name="&ERROR_CLAIM_DEVICE;">if the device was not claimed</doc:error> |
| 424 |
</doc:errors> |
| 425 |
</doc:doc> |
| 426 |
</method> |
| 427 |
|
| 428 |
<!-- ************************************************************ --> |
| 429 |
|
| 430 |
<method name="VerifyStart"> |
| 431 |
<arg type="s" name="finger_name" direction="in"> |
| 432 |
<doc:doc><doc:summary>A string representing the finger to verify. See <doc:ref type="description" to="fingerprint-names">Fingerprint names</doc:ref>.</doc:summary></doc:doc> |
| 433 |
</arg> |
| 434 |
<doc:doc> |
| 435 |
<doc:description> |
| 436 |
<doc:para> |
| 437 |
Check the chosen finger against a saved fingerprint. You need to have claimed the device using |
| 438 |
<doc:ref type="method" to="Device.Claim">Device.Claim</doc:ref>. The finger selected is sent to the front-end |
| 439 |
using <doc:ref type="signal" to="Device::VerifyFingerSelected">Device::VerifyFingerSelected</doc:ref> and |
| 440 |
verification status through <doc:ref type="signal" to="Device::VerifyStatus">Device::VerifyStatus</doc:ref>. |
| 441 |
</doc:para> |
| 442 |
</doc:description> |
| 443 |
|
| 444 |
<doc:errors> |
| 445 |
<doc:error name="&ERROR_PERMISSION_DENIED;">if the caller lacks the appropriate PolicyKit authorization</doc:error> |
| 446 |
<doc:error name="&ERROR_CLAIM_DEVICE;">if the device was not claimed</doc:error> |
| 447 |
<doc:error name="&ERROR_ALREADY_IN_USE;">if the device was already being used</doc:error> |
| 448 |
<doc:error name="&ERROR_NO_ENROLLED_PRINTS;">if there are no enrolled prints for the chosen user</doc:error> |
| 449 |
<doc:error name="&ERROR_INTERNAL;">if there was an internal error</doc:error> |
| 450 |
</doc:errors> |
| 451 |
</doc:doc> |
| 452 |
</method> |
| 453 |
|
| 454 |
<!-- ************************************************************ --> |
| 455 |
|
| 456 |
<method name="VerifyStop"> |
| 457 |
<doc:doc> |
| 458 |
<doc:description> |
| 459 |
<doc:para> |
| 460 |
Stop an on-going fingerprint verification started with <doc:ref type="method" to="Device.VerifyStart">Device.VerifyStart</doc:ref>. |
| 461 |
</doc:para> |
| 462 |
</doc:description> |
| 463 |
|
| 464 |
<doc:errors> |
| 465 |
<doc:error name="&ERROR_PERMISSION_DENIED;">if the caller lacks the appropriate PolicyKit authorization</doc:error> |
| 466 |
<doc:error name="&ERROR_CLAIM_DEVICE;">if the device was not claimed</doc:error> |
| 467 |
<doc:error name="&ERROR_NO_ACTION_IN_PROGRESS;">if there was no ongoing verification</doc:error> |
| 468 |
<doc:error name="&ERROR_INTERNAL;">if there was an internal error</doc:error> |
| 469 |
</doc:errors> |
| 470 |
</doc:doc> |
| 471 |
</method> |
| 472 |
|
| 473 |
<!-- ************************************************************ --> |
| 474 |
|
| 475 |
<signal name="VerifyFingerSelected"> |
| 476 |
<arg type="s" name="finger_name"> |
| 477 |
<doc:doc> |
| 478 |
<doc:summary> |
| 479 |
<doc:para> |
| 480 |
A string representing the finger select to be verified. |
| 481 |
</doc:para> |
| 482 |
</doc:summary> |
| 483 |
</doc:doc> |
| 484 |
</arg> |
| 485 |
<doc:doc> |
| 486 |
<doc:seealso> |
| 487 |
<doc:ref type="description" to="fingerprint-names">Fingerprint names</doc:ref>. |
| 488 |
</doc:seealso> |
| 489 |
</doc:doc> |
| 490 |
</signal> |
| 491 |
|
| 492 |
<!-- ************************************************************ --> |
| 493 |
|
| 494 |
<signal name="VerifyStatus"> |
| 495 |
<arg type="s" name="result"> |
| 496 |
<doc:doc> |
| 497 |
<doc:summary> |
| 498 |
A string representing the status of the verification. |
| 499 |
</doc:summary> |
| 500 |
</doc:doc> |
| 501 |
</arg> |
| 502 |
|
| 503 |
<arg type="b" name="done"> |
| 504 |
<doc:doc> |
| 505 |
<doc:summary> |
| 506 |
Whether the verification finished and can be stopped. |
| 507 |
</doc:summary> |
| 508 |
</doc:doc> |
| 509 |
</arg> |
| 510 |
|
| 511 |
<doc:doc> |
| 512 |
<doc:seealso> |
| 513 |
<doc:ref type="description" to="verify-statuses">Verify Statuses</doc:ref> and <doc:ref type="method" to="Device.VerifyStop">Device.VerifyStop</doc:ref>. |
| 514 |
</doc:seealso> |
| 515 |
</doc:doc> |
| 516 |
</signal> |
| 517 |
|
| 518 |
<!-- ************************************************************ --> |
| 519 |
|
| 520 |
<method name="EnrollStart"> |
| 521 |
<arg type="s" name="finger_name" direction="in"> |
| 522 |
<doc:doc><doc:summary>A string representing the finger to enroll. See |
| 523 |
<doc:ref type="description" to="fingerprint-names">Fingerprint names</doc:ref>. |
| 524 |
Note that "any" is not a valid finger name for this method.</doc:summary></doc:doc> |
| 525 |
</arg> |
| 526 |
<doc:doc> |
| 527 |
<doc:description> |
| 528 |
<doc:para> |
| 529 |
Start enrollment for the selected finger. You need to have claimed the device using |
| 530 |
<doc:ref type="method" to="Device.Claim">Device.Claim</doc:ref> before calling |
| 531 |
this method. Enrollment status is sent through <doc:ref type="signal" to="Device::EnrollStatus">Device::EnrollStatus</doc:ref>. |
| 532 |
</doc:para> |
| 533 |
</doc:description> |
| 534 |
|
| 535 |
<doc:errors> |
| 536 |
<doc:error name="&ERROR_PERMISSION_DENIED;">if the caller lacks the appropriate PolicyKit authorization</doc:error> |
| 537 |
<doc:error name="&ERROR_CLAIM_DEVICE;">if the device was not claimed</doc:error> |
| 538 |
<doc:error name="&ERROR_ALREADY_IN_USE;">if the device was already being used</doc:error> |
| 539 |
<doc:error name="&ERROR_INVALID_FINGERNAME;">if the finger name passed is invalid</doc:error> |
| 540 |
<doc:error name="&FINGER_ALREADY_ENROLLED;">if the finger has been already enrolled by the user</doc:error> |
| 541 |
<doc:error name="&ERROR_INTERNAL;">if there was an internal error</doc:error> |
| 542 |
</doc:errors> |
| 543 |
|
| 544 |
</doc:doc> |
| 545 |
</method> |
| 546 |
|
| 547 |
<!-- ************************************************************ --> |
| 548 |
|
| 549 |
<method name="EnrollStop"> |
| 550 |
<doc:doc> |
| 551 |
<doc:description> |
| 552 |
<doc:para> |
| 553 |
Stop an on-going fingerprint enrollment started with <doc:ref type="method" to="Device.EnrollStart">Device.EnrollStart</doc:ref>. |
| 554 |
</doc:para> |
| 555 |
</doc:description> |
| 556 |
|
| 557 |
<doc:errors> |
| 558 |
<doc:error name="&ERROR_PERMISSION_DENIED;">if the caller lacks the appropriate PolicyKit authorization</doc:error> |
| 559 |
<doc:error name="&ERROR_CLAIM_DEVICE;">if the device was not claimed</doc:error> |
| 560 |
<doc:error name="&ERROR_NO_ACTION_IN_PROGRESS;">if there was no ongoing verification</doc:error> |
| 561 |
<doc:error name="&ERROR_INTERNAL;">if there was an internal error</doc:error> |
| 562 |
</doc:errors> |
| 563 |
</doc:doc> |
| 564 |
</method> |
| 565 |
|
| 566 |
<!-- ************************************************************ --> |
| 567 |
|
| 568 |
<signal name="EnrollStatus"> |
| 569 |
<arg type="s" name="result"> |
| 570 |
<doc:doc> |
| 571 |
<doc:summary> |
| 572 |
A string representing the status of the enrollment. |
| 573 |
</doc:summary> |
| 574 |
</doc:doc> |
| 575 |
</arg> |
| 576 |
|
| 577 |
<arg type="b" name="done"> |
| 578 |
<doc:doc> |
| 579 |
<doc:summary> |
| 580 |
Whether the enrollment finished and can be stopped. |
| 581 |
</doc:summary> |
| 582 |
</doc:doc> |
| 583 |
</arg> |
| 584 |
|
| 585 |
<doc:doc> |
| 586 |
<doc:seealso> |
| 587 |
<doc:ref type="description" to="enroll-statuses">Enrollment Statuses</doc:ref> and <doc:ref type="method" to="Device.EnrollStop">Device.EnrollStop</doc:ref>. |
| 588 |
</doc:seealso> |
| 589 |
</doc:doc> |
| 590 |
</signal> |
| 591 |
|
| 592 |
<!-- ************************************************************ --> |
| 593 |
|
| 594 |
<property name="name" type="s" access="read"> |
| 595 |
<doc:doc> |
| 596 |
<doc:description> |
| 597 |
<doc:para> |
| 598 |
The product name of the device. |
| 599 |
</doc:para> |
| 600 |
</doc:description> |
| 601 |
</doc:doc> |
| 602 |
</property> |
| 603 |
|
| 604 |
<!-- ************************************************************ --> |
| 605 |
|
| 606 |
<property name="num-enroll-stages" type="i" access="read"> |
| 607 |
<doc:doc> |
| 608 |
<doc:description> |
| 609 |
<doc:para> |
| 610 |
The number of enrollment stages for the device. This is only available when the device has been claimed, otherwise it will be undefined (-1). |
| 611 |
</doc:para> |
| 612 |
<doc:seealso> |
| 613 |
<doc:ref type="method" to="Device.Claim">Device.Claim</doc:ref> and <doc:ref type="method" to="Device.EnrollStart">Device.EnrollStart</doc:ref>. |
| 614 |
</doc:seealso> |
| 615 |
</doc:description> |
| 616 |
</doc:doc> |
| 617 |
</property> |
| 618 |
|
| 619 |
<!-- ************************************************************ --> |
| 620 |
|
| 621 |
<property name="scan-type" type="s" access="read"> |
| 622 |
<doc:doc> |
| 623 |
<doc:description> |
| 624 |
<doc:para> |
| 625 |
The scan type of the device, either "press" if you place your finger on the device, or "swipe" if you have to swipe your finger. |
| 626 |
</doc:para> |
| 627 |
</doc:description> |
| 628 |
</doc:doc> |
| 629 |
</property> |
| 630 |
|
| 631 |
<!-- ************************************************************ --> |
| 632 |
|
| 633 |
<property name="finger-present" type="b" access="read"> |
| 634 |
<doc:doc> |
| 635 |
<doc:description> |
| 636 |
<doc:para> |
| 637 |
Whether the finger is on sensor. |
| 638 |
</doc:para> |
| 639 |
</doc:description> |
| 640 |
</doc:doc> |
| 641 |
</property> |
| 642 |
|
| 643 |
<!-- ************************************************************ --> |
| 644 |
|
| 645 |
<property name="finger-needed" type="b" access="read"> |
| 646 |
<doc:doc> |
| 647 |
<doc:description> |
| 648 |
<doc:para> |
| 649 |
Whether the sensor is waiting for the finger. |
| 650 |
</doc:para> |
| 651 |
</doc:description> |
| 652 |
</doc:doc> |
| 653 |
</property> |
| 654 |
|
| 655 |
</interface> |
| 656 |
</node> |
| 657 |
|