Join MDN and developers like you at Mozilla's View Source conference, 12-14 September in Berlin, Germany. Learn more at https://viewsourceconf.org

MozMobileConnection.unlockCardLock()

This article needs a technical review. How you can help.

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

Document Tags and Contributors

 Contributors to this page: chrisdavidmills, fscholz, kscarfone, Sheppy, Jeremie
 Last updated by: chrisdavidmills,