Collapse all Symbian^3 Product Developer Library

MCTAuthenticationObject Class Reference

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.

Inherits from

MCTAuthenticationObject
- MCTTokenObject

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 &)

Inherited Functions
	MCTTokenObject::AddTokenRef()
	MCTTokenObject::DoRelease()
	MCTTokenObject::Handle()const
	MCTTokenObject::Label()const
	MCTTokenObject::MCTTokenObject(MCTToken &)
	MCTTokenObject::Release()
	MCTTokenObject::Token()const
	MCTTokenObject::Type()const
	MCTTokenObject::~MCTTokenObject()

Constructor & Destructor Documentation

MCTAuthenticationObject(MCTToken &)

MCTAuthenticationObject

(

MCTToken &

aToken

)

[inline]

Constructor

Parameters

MCTToken & aToken

Member Functions Documentation

CancelChangeReferenceData()

void

CancelChangeReferenceData

(

)

[pure virtual]

Cancels an asynchronous ChangeReferenceData() operation.

CancelClose()

void

CancelClose

(

)

[inline, virtual]

Cancels an asynchronous Close() operation.

CancelDisable()

void

CancelDisable

(

)

[pure virtual]

Cancels an asynchronous Disable() operation.

CancelEnable()

void

CancelEnable

(

)

[pure virtual]

Cancels an asynchronous Enable() operation.

CancelListProtectedObjects()

void

CancelListProtectedObjects

(

)

[pure virtual]

Cancels an asynchronous ListProtectedObjects() operation.

CancelOpen()

void

CancelOpen

(

)

[inline, virtual]

Cancels an asynchronous Open() operation.

CancelSetTimeout()

void

CancelSetTimeout

(

)

[inline, virtual]

Cancels an asynchronous SetTimeout() operation.

CancelTimeRemaining()

void

CancelTimeRemaining

(

)

[inline, virtual]

Cancels an asynchronous TimeRemaining() operation.

CancelTimeout()

void

CancelTimeout

(

)

[inline, virtual]

Cancels an asynchronous Timeout() operation.

CancelUnblock()

void

CancelUnblock

(

)

[pure virtual]

Cancels an asynchronous Unblock() operation.

ChangeReferenceData(TRequestStatus &)

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.

leave: KErrNotFound If no reference data was originally set.

Parameters

TRequestStatus & aStatus

Completed with the return code when the operation completes.

Close(TRequestStatus &)

void

(

TRequestStatus &

aStatus

)

[pure virtual]

Closes an authentication object.

Parameters

TRequestStatus & aStatus

Completed with the return code when the operation completes.

Disable(TRequestStatus &)

void

Disable

(

TRequestStatus &

aStatus

)

[pure virtual]

Disables the authentication object.

It is only valid to call this method if the object is enabled, indicated by the EEnabled bit of Status() being set.

Also, the authentication object may not support being enabled/disabled - the EDisableAllowed bit of Status() must be set for this to work.

Parameters

TRequestStatus & aStatus

Completed with the return code when the operation completes.

Enable(TRequestStatus &)

void

Enable

(

TRequestStatus &

aStatus

)

[pure virtual]

Enables the authentication object.

It is only valid to call this method if the object is disabled, indicated by the EEnabled bit of Status() being clear.

Also, the authentication object may not support being enabled/disabled - the EDisableAllowed bit of Status() must be set for this to work.

Parameters

TRequestStatus & aStatus

Completed with the return code when the operation completes.

ListProtectedObjects(RMPointerArray< MCTTokenObject > &, TRequestStatus &)

void	ListProtectedObjects	(	RMPointerArray< MCTTokenObject > &	aObjects,
			TRequestStatus &	aStatus
		)	[pure virtual]

Gets a list of all the objects that this authentication object protects.

Parameters

RMPointerArray< MCTTokenObject > & aObjects	The returned objects will be appended to this array.
TRequestStatus & aStatus	Completed with the return code when the operation completes.

Open(TRequestStatus &)

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.

Parameters

TRequestStatus & aStatus

Completed with the return code when the operation completes.

SetTimeout(TInt, TRequestStatus &)

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.

leave: KErrArgument If the timeout specified is invalid.

Parameters

TInt aTime	Time in seconds
TRequestStatus & aStatus	Completed with the return code when the operation completes

Status()

TUint32

Status

(

)

const [pure virtual]

Gets the status of the authentication object.

TimeRemaining(TInt &, TRequestStatus &)

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.

Parameters

TInt & aStime	Time in seconds when the operation completes.
TRequestStatus & aStatus	Completed with the return code when the operation completes.

Timeout(TInt &, TRequestStatus &)

void	Timeout	(	TInt &	aTime,
			TRequestStatus &	aStatus
		)	[pure virtual]

Gets the current timeout value, in seconds.

For an explanation of the values, see SetTimeout().

Parameters

TInt & aTime	Time in seconds.
TRequestStatus & aStatus	Completed with the return code when the operation completes.

Unblock(TRequestStatus &)

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.

Parameters

TRequestStatus & aStatus

Completed with the return code when the operation completes.