MozMobileConnection.getCardLock()

This article is in need of a technical review.

Non-standard
This feature is not on a current W3C standards track, but it is supported on the Firefox OS platform. Although implementations may change in the future and it is not supported widely across browsers, it is suitable for use in code dedicated to Firefox OS apps.

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

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

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

Document Tags and Contributors

Contributors to this page: fscholz, kscarfone, Sheppy, jswisher, Jeremie
Last updated by: fscholz,
Hide Sidebar