MozMobileConnection.getCardLock()

This API is available on Firefox OS for internal applications only.

Summary

The getCardLock method is used to find out about the status of an integrated circuit card (ICC) lock (such as requiring a personal identification number (PIN)).

Syntax

JavaScript
var request = navigator.mozMobileConnection.getCardLock(lockType);

Parameters

lockType
This parameter is a string that identifies the lock type, for example, "pin" for the PIN lock.

Return

A DOMRequest object to handle the success or failure of the method call.

The request's result is an object containing information about the specified lock's status, for example: {lockType: "pin", enabled: true}

Example

JavaScript
var request = navigator.mozMobileConnection.getCardLock("pin");

request.onsuccess = function () {
  console.log('The card lock for "' + this.result.lockType + '" is: ' + this.result.enabled);
}

request.onerror = function () {
  console.log('operation failed: ' + this.error.name);
}

Specification

Not part of any specification.

See also

License

© 2016 Mozilla Contributors
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-us/docs/web/api/mozmobileconnection/getcardlock

API B2G Firefox OS Method Mobile Reference Référence