• 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.unlockCardLock()

MozMobileConnection.unlockCardLock()

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

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

Summary

The unlockCardLock method is used to unlock a card lock.

Note: If the unlockCardLock call fails the icccardlockerror event is fired.

Syntax

var request = navigator.mozMobileConnection.unlockCardLock(info);

Parameters

info

An object containing information to unlock the given lock. At a minimum, this object must have a lockType property which specifies the type of lock, e.g., "pin" for the PIN lock. Other properties are dependent on the lock type:

Object for unlocking the PIN:

{
  lockType: "pin",
  pin     : "..." // The current pin number
}

Object for unlocking the network control key (NCK) :

{
  lockType: "nck",
  pin     : "..." // The current pin number
}

Object for unlocking the PUK and supplying a new PIN:

{
  lockType: "puk",
  puk     : "...",
  newPin  : "..."
}

Return

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

The request's result will be an object containing information about the operation:

The resulting object if the unlock failed:

{
  lockType  : "pin", // Can be "pin", "nck" or "puk"
  success   : false,
  retryCount: 2
}

The resulting object if unlock succeeded:

{
  lockType: "pin", // Can be "pin", "nck" or "puk"
  success : true
}

Specification

Not part of any specification.

See also

  • MozMobileConnection
  • DOMRequest

Document Tags and Contributors

Tags: 
  • API
  • B2G
  • Firefox OS
  • Method
  • Non Standard
  • Reference
  • Référence
 Contributors to this page: chrisdavidmills, fscholz, kscarfone, Sheppy, Jeremie
 Last updated by: chrisdavidmills, Feb 27, 2017, 2:07:54 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