QPinManager Class Reference
[QtTelephonyModule]

Detailed Description

The QPinManager class provides a method for the system to query the user interface for pin values.

The following pin types are available:

See also QCommInterface.

Member Type Documentation

enum QPinManager::Status

This enum defines whether a pin is required, valid, or locked.

Member Function Documentation

QPinManager::QPinManager ( const QString & service = QString(), QObject * parent = 0, QCommInterface::Mode mode = Client )

Construct a new pin manager object for service and attach it to parent. The object will be created in client mode if mode is Client, or server mode otherwise.

QPinManager::~QPinManager ()

Destroy this pin manager object.

void QPinManager::cancelPin ( const QString & type )   [virtual slot]

Indicate that the user has canceled entry of the pin of a specified type. The operation that was waiting on the pin will be aborted with an error.

See also enterPin().

void QPinManager::changePin ( const QString & type, const QString & oldPin, const QString & newPin )   [virtual slot]

Change a pin of a specific type from oldPin to newPin. The manager will respond by emitting the changePinResult() signal.

See also changePinResult().

void QPinManager::changePinResult ( const QString & type, bool valid )   [signal]

Signal that is emitted in response to a changePin() request for type. The valid flag indicates whether the request succeeded or failed.

See also changePin().

void QPinManager::enterPin ( const QString & type, const QString & pin )   [virtual slot]

Enter a pin of a specific type. This is typically sent in response to a pinStatus() signal that indicates NeedPin.

If the pin is valid, then the manager will respond with a pinStatus() signal indicating a status of Valid. If the pin is invalid, then the manager will response with a pinStatus() signal indicating a status of NeedPin or NeedPuk.

See also pinStatus() and cancelPin().

void QPinManager::enterPuk ( const QString & type, const QString & puk, const QString & newPin )   [virtual slot]

Enter a puk of a specific type, and change the associated pin to newPin. This is typically sent in response to a pinStatus() signal that indicates NeedPuk.

If the puk is valid, then the manager will respond with a pinStatus() signal indicating a status of Valid. If the puk is invalid, then the manager will response with a pinStatus() signal indicating a status of NeedPuk or Locked.

See also pinStatus().

void QPinManager::lockStatus ( const QString & type, bool enabled )   [signal]

Signal that is emitted in response to requestLockStatus() for type. If enabled is true, then the feature will be locked and a pin is required whenever the feature is used. If enabled is false, then the feature will be available at any time without a pin.

See also setLockStatus() and requestLockStatus().

void QPinManager::pinStatus ( const QString & type, QPinManager::Status status, const QPinOptions & options )   [signal]

Signal that is emitted to indicate the status of a pin with the specified type. If the status is NeedPin, then the user interface should ask for the pin and return it via enterPin(). If the status is NeedPuk, then the user interface should ask for a puk and a new pin, and return them via enterPuk(). For both NeedPin and NeedPuk, the function cancelPin() can be called to cancel the pin entry.

If the status is NeedPin or NeedPuk, then options provides additional information that may affect the type of user interface to use when asking the user for the pin or puk.

The type will be READY and status will be Valid when the SIM has been given sufficient pin's and puk's to return it to a ready state.

See also querySimPinStatus(), enterPin(), enterPuk(), and cancelPin().

void QPinManager::querySimPinStatus ()   [virtual slot]

Query the status of the main SIM PIN. The service will respond with a pinStatus() signal indicating the current status. This method is typically used during system start up.

See also pinStatus().

void QPinManager::requestLockStatus ( const QString & type )   [virtual slot]

Request the lock status of a pin with a specific type. The manager will respond by emitting the lockStatus() signal.

See also lockStatus() and setLockStatus().

void QPinManager::setLockStatus ( const QString & type, const QString & password, bool enabled )   [virtual slot]

Sets the lock status of a pin with a specific type to enabled. If enabled is true, then the feature will be locked and a pin is required whenever the feature is used. If enabled is false, then the feature will be available at any time without a pin.

The password parameter is the password corresponding to the lock, to turn it on or off.

The manager will respond by emitting the setLockStatusResult() signal.

See also lockStatus(), setLockStatusResult(), and requestLockStatus().

void QPinManager::setLockStatusResult ( const QString & type, bool valid )   [signal]

Signal that is emitted in response to setLockStatus() for type. The valid flag indicates whether the request succeeded or failed.

See also setLockStatus().