Symbian^3 Application Developer Library >

CRetrieveMobilePhoneAuthenticationIds Class Reference

class CRetrieveMobilePhoneAuthenticationIds : public CAsyncRetrievePhoneList

Reads stored fixed length Authentication GBA and MBMS list (EF_GBANL and EF_MSK) from the phone.

Instead of reading each list individually, a client may be able to retrieve multiple lists currently stored in one go. This functionality will be available if the TSY supports reading both Authentication GBA and MBMS list. When all authentication list entries are read in one go, a list ( CMobilePhoneGbaNafIdList or CMobilePhoneMbmsMskIdList ) object will be returned to the client.This object will contain the authentication entries and the client is able to use the function members of the list class to enumerate and read the message entries.

Due to the probable time taken to retrieve a list, clients must use an asynchronous approach based around the use of this object.

Inherits from

Nested Classes and Structures

Public Member Functions
~CRetrieveMobilePhoneAuthenticationIds ()
IMPORT_C CRetrieveMobilePhoneAuthenticationIds * NewL ( RMobilePhone &)
IMPORT_C CMobilePhoneGbaNafIdList * RetrieveGbaListL ()
IMPORT_C CMobilePhoneMbmsMskIdList * RetrieveMbmsListL ()
IMPORT_C void Start ( TRequestStatus &, const TDesC8 &)
Protected Member Functions
CRetrieveMobilePhoneAuthenticationIds ( RMobilePhone &)
void ConstructL ()
void RestoreListL ()
Inherited Functions
CActive::CActive(TInt)
CActive::Cancel()
CActive::Deque()
CActive::Extension_(TUint,TAny *&,TAny *)
CActive::IsActive()const
CActive::IsAdded()const
CActive::Priority()const
CActive::RunError(TInt)
CActive::SetActive()
CActive::SetPriority(TInt)
CActive::~CActive()
CAsyncRetrievePhoneList::CAsyncRetrievePhoneList(RMobilePhone &)
CAsyncRetrievePhoneList::CancelReq(TInt,TInt)
CAsyncRetrievePhoneList::Get(TInt,TRequestStatus &,TDes8 &,TDes8 &)
CAsyncRetrievePhoneList::~CAsyncRetrievePhoneList()
CAsyncRetrieveVariableLengthBufferV2::CAsyncRetrieveVariableLengthBufferV2()
CAsyncRetrieveVariableLengthBufferV2::CompleteIfInUse(TRequestStatus &)
CAsyncRetrieveVariableLengthBufferV2::FreeBuffer()
CAsyncRetrieveVariableLengthBufferV2::Start(TRequestStatus &,TDes8 *,TDes8 *)
CAsyncRetrieveVariableLengthBufferV2::~CAsyncRetrieveVariableLengthBufferV2()
CAsyncRetrieveWithClientIds::CAsyncRetrieveWithClientIds(TInt,TInt)
CBase::CBase()
CBase::Delete(CBase *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
Inherited Enumerations
CActive:TPriority
CAsyncRetrieveVariableLengthBufferV2:@151
Private Attributes
TPckgBuf < TAuthRequestData > iAuthRequestData
CMobilePhoneGbaNafIdList * iGbaNafIdResults
RMobilePhone::TAuthData iListType
CMobilePhoneMbmsMskIdList * iMbmsMskIdResults
Inherited Attributes
CActive::iStatus
CAsyncRetrievePhoneList::iPhone
CAsyncRetrieveVariableLengthBufferV2::iIpcCancel
CAsyncRetrieveVariableLengthBufferV2::iIpcPhase1
CAsyncRetrieveVariableLengthBufferV2::iIpcPhase2
CAsyncRetrieveVariableLengthBufferV2::iResultsBuf
CAsyncRetrieveVariableLengthBufferV2::iResultsPtr
CAsyncRetrieveVariableLengthBufferV2::iState
CAsyncRetrieveWithClientIds::iId

Constructor & Destructor Documentation

CRetrieveMobilePhoneAuthenticationIds(RMobilePhone &)

CRetrieveMobilePhoneAuthenticationIds ( RMobilePhone & aPhone ) [protected]

Parameters

RMobilePhone & aPhone

~CRetrieveMobilePhoneAuthenticationIds()

IMPORT_C ~CRetrieveMobilePhoneAuthenticationIds ( )

The destructor frees all resources owned by the object, prior to its destruction.

Member Functions Documentation

ConstructL()

void ConstructL ( ) [protected]

NewL(RMobilePhone &)

IMPORT_C CRetrieveMobilePhoneAuthenticationIds * NewL ( RMobilePhone & aPhone ) [static]

This function member creates an instance of the CActive derived CRetrieveMobilePhoneAuthenticationIds class.

capability
None

Parameters

RMobilePhone & aPhone An instance of RMobilePhone as this store that the list retrieval class will operate on.

RestoreListL()

void RestoreListL ( ) [protected, virtual]

This method restores a list from a buffer that contains the streamed version of the list

RetrieveGbaListL()

IMPORT_C CMobilePhoneGbaNafIdList * RetrieveGbaListL ( )

These function members will provide the client with a handle to the appropriate GbaNaf list class retrieved from the Authentication.

The client will call this function member once Start() has completed.

When the client calls this function member the ownership of the list object will transfer to the client, so the client is then responsible for eventual deletion of this object.

leave
KErrNotFound If there is no valid list object to return to the client.
capability
ReadDeviceData

RetrieveMbmsListL()

IMPORT_C CMobilePhoneMbmsMskIdList * RetrieveMbmsListL ( )

These function members will provide the client with a handle to the appropriate MBMS MSK ID list class retrieved from the Authentication.

The client will call this function member once Start() has completed.

When the client calls this function member the ownership of the list object will transfer to the client, so the client is then responsible for eventual deletion of this object.

leave
KErrNotFound If there is no valid list object to return to the client.
capability
ReadDeviceData

Start(TRequestStatus &, const TDesC8 &)

IMPORT_C void Start ( TRequestStatus & aReqStatus,
const TDesC8 & aData
)

This function member starts the two-phase list retrieval of all entries within the store.

capability
ReadDeviceData

Parameters

TRequestStatus & aReqStatus On completion, the status of the request; KErrNone if successful, KErrNotSupported if the phone does not support access to an Gba/Mbms list and KErrNotFound if the list does not exist. If the list is empty then KErrNone is returned.
const TDesC8 & aData

Member Data Documentation

TPckgBuf< TAuthRequestData > iAuthRequestData

TPckgBuf < TAuthRequestData > iAuthRequestData [private]

CMobilePhoneGbaNafIdList * iGbaNafIdResults

CMobilePhoneGbaNafIdList * iGbaNafIdResults [private]

RMobilePhone::TAuthData iListType

RMobilePhone::TAuthData iListType [private]

CMobilePhoneMbmsMskIdList * iMbmsMskIdResults

CMobilePhoneMbmsMskIdList * iMbmsMskIdResults [private]

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.