class MCTAuthenticationObject : public MCTTokenObject |
This class allows authentication objects to be queried and manipulated.
Authentication objects are obtained from the MCTAuthenticationObjectList class, which is the class returned as the token interface.
Public Member Functions | |
---|---|
MCTAuthenticationObject ( MCTToken &) | |
void | CancelChangeReferenceData () |
void | CancelClose () |
void | CancelDisable () |
void | CancelEnable () |
void | CancelListProtectedObjects () |
void | CancelOpen () |
void | CancelSetTimeout () |
void | CancelTimeRemaining () |
void | CancelTimeout () |
void | CancelUnblock () |
void | ChangeReferenceData ( TRequestStatus &) |
void | Close ( TRequestStatus &) |
void | Disable ( TRequestStatus &) |
void | Enable ( TRequestStatus &) |
void | ListProtectedObjects ( RMPointerArray < MCTTokenObject > &, TRequestStatus &) |
void | Open ( TRequestStatus &) |
void | SetTimeout ( TInt , TRequestStatus &) |
TUint32 | Status () |
void | TimeRemaining ( TInt &, TRequestStatus &) |
void | Timeout ( TInt &, TRequestStatus &) |
void | Unblock ( TRequestStatus &) |
MCTAuthenticationObject | ( | MCTToken & | aToken | ) | [inline] |
Constructor
MCTToken & aToken |
void | CancelChangeReferenceData | ( | ) | [pure virtual] |
Cancels an asynchronous ChangeReferenceData() operation.
void | CancelListProtectedObjects | ( | ) | [pure virtual] |
Cancels an asynchronous ListProtectedObjects() operation.
void | CancelSetTimeout | ( | ) | [inline, virtual] |
Cancels an asynchronous SetTimeout() operation.
void | CancelTimeRemaining | ( | ) | [inline, virtual] |
Cancels an asynchronous TimeRemaining() operation.
void | CancelTimeout | ( | ) | [inline, virtual] |
Cancels an asynchronous Timeout() operation.
void | ChangeReferenceData | ( | TRequestStatus & | aStatus | ) | [pure virtual] |
Changes the reference data (e.g. PIN value).
The security dialog component will prompt for the old and new reference data.
The authentication object may not allow its reference data to be changed - this is indicated by the EChangeDisabled bit of Status() being set.
TRequestStatus & aStatus | Completed with the return code when the operation completes. |
void | Close | ( | TRequestStatus & | aStatus | ) | [pure virtual] |
Closes an authentication object.
TRequestStatus & aStatus | Completed with the return code when the operation completes. |
void | Disable | ( | TRequestStatus & | aStatus | ) | [pure virtual] |
TRequestStatus & aStatus | Completed with the return code when the operation completes. |
void | Enable | ( | TRequestStatus & | aStatus | ) | [pure virtual] |
TRequestStatus & aStatus | Completed with the return code when the operation completes. |
void | ListProtectedObjects | ( | RMPointerArray < MCTTokenObject > & | aObjects, |
TRequestStatus & | aStatus | |||
) | [pure virtual] |
Gets a list of all the objects that this authentication object protects.
RMPointerArray < MCTTokenObject > & aObjects | The returned objects will be appended to this array. |
TRequestStatus & aStatus | Completed with the return code when the operation completes. |
void | Open | ( | TRequestStatus & | aStatus | ) | [pure virtual] |
Opens the authentication object.
This means that the protected objects can be accessed without provoking the authentication mechanism for the duration of the timeout period.
Note that it is not strictly necessary to call this function, as the authentication object will be opened when any operation that needs it to be opened is called, but it is sometimes useful to control the timing of authentication dialogs. Note also that this function will do nothing if the authentication object is open, or if the authentication object requires the authentication data to be entered every time.
TRequestStatus & aStatus | Completed with the return code when the operation completes. |
void | SetTimeout | ( | TInt | aTime, |
TRequestStatus & | aStatus | |||
) | [pure virtual] |
Sets the time in seconds for this authentication object.
Permitted values include 0, meaning always ask, and -1, meaning until it's explicitly closed. Particular authentication objects might restrict the range of values permitted.
TInt aTime | Time in seconds |
TRequestStatus & aStatus | Completed with the return code when the operation completes |
void | TimeRemaining | ( | TInt & | aStime, |
TRequestStatus & | aStatus | |||
) | [pure virtual] |
Gets the amount of time in seconds that the authentication object will remain open for, or 0 if it is closed.
TInt & aStime | Time in seconds when the operation completes. |
TRequestStatus & aStatus | Completed with the return code when the operation completes. |
void | Timeout | ( | TInt & | aTime, |
TRequestStatus & | aStatus | |||
) | [pure virtual] |
TInt & aTime | Time in seconds. |
TRequestStatus & aStatus | Completed with the return code when the operation completes. |
void | Unblock | ( | TRequestStatus & | aStatus | ) | [pure virtual] |
Unblocks the authentication object.
The security dialog component will prompt for the unblocking authentication object.
It is only valid to call this method when the authentication object is blocked, ie when the EAuthObjectBlocked bit of Status() is set.
The object may not allow unblocking (either because of failed unblock attempts or because it doesn't support the concept) - this is indicated by the EUnblockDisabled bit of Status() being set.
TRequestStatus & aStatus | Completed with the return code when the operation completes. |
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.