• Skip to main content
  • Select language
  • Skip to search
MDN Web Docs
  • Technologies
    • HTML
    • CSS
    • JavaScript
    • Graphics
    • HTTP
    • APIs / DOM
    • WebExtensions
    • MathML
  • References & Guides
    • Learn web development
    • Tutorials
    • References
    • Developer Guides
    • Accessibility
    • Game development
    • ...more docs
B2G OS
  1. MDN
  2. Archive of obsolete content
  3. B2G OS
  4. B2G OS APIs
  5. MozMobileConnection
  6. MozMobileConnection.getCardLock()

MozMobileConnection.getCardLock()

In This Article
  1. Summary
  2. Syntax
    1. Parameters
    2. Return
  3. Example
  4. Specification
  5. See also

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

  • MozMobileConnection
  • DOMRequest

Document Tags and Contributors

Tags: 
  • API
  • B2G
  • Firefox OS
  • Method
  • Mobile
  • Non Standard
  • Reference
  • Référence
 Contributors to this page: chrisdavidmills, fscholz, kscarfone, Sheppy, jswisher, Jeremie
 Last updated by: chrisdavidmills, Feb 27, 2017, 2:07:52 AM
See also
  1. Mobile Connection API
  2. Archive
  3. Events
    1. icccardlockerror
    2. cardstatechange
  4. Related pages for Mobile Connection API
    1. CFStateChangeEvent
    2. DataErrorEvent
    3. IccCardLockError
    4. IccCardLockErrorEvent
    5. MozCellBroadcastEvent
    6. MozEmergencyCbModeEvent
    7. MozIccManager
    8. MozMobileCFInfo
    9. MozMobileCellInfo
    10. MozMobileConnection
    11. MozMobileConnectionInfo
    12. MozMobileICCInfo
    13. MozMobileNetworkInfo
    14. MozOtaStatusEvent
    15. MozStkCommandEvent
    16. USSDReceivedEvent