MozMobileConnection.unlockCardLock Redirect 1

Non-standard
This feature is non-standard and is not on a standards track. Do not use it on production sites facing the Web: it will not work for every user. There may also be large incompatibilities between implementations and the behavior may change in the future.

This API is available on Firefox OS for certified 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

Last updated by: Sheppy,