Symbian^3 Application Developer Library >

RFolderItem Class Reference

class RFolderItem : public RSubSessionBase

The client side interface to a server resident FolderItem.

Library: FeedsEngine.lib

Since
3.1

Inherits from

Public Member Functions
RFolderItem ( MFolderItemObserver &, TInt , TBool )
IMPORT_C void AddFolderItemL (const TDesC &, const TDesC &, TBool , const CFolderItem &)
void CancelAllCommandsL ()
IMPORT_C void ChangeFolderItemL (const CFolderItem &, const TDesC &, const TDesC &)
IMPORT_C void Close ()
IMPORT_C void DeleteFolderItemsL ( RPointerArray < const CFolderItem > &)
IMPORT_C void ExportFolderItemsL ( RPointerArray < const CFolderItem > &, const TDesC &)
IMPORT_C void FetchRootFolderItemL ()
IMPORT_C TBool HasRootFolderItem ()
IMPORT_C void ImportOPMLL (const TDesC &, TBool )
IMPORT_C void MoveFolderItemsL ( RPointerArray < const CFolderItem > &, TInt )
IMPORT_C void MoveFolderItemsToL ( RPointerArray < const CFolderItem > &, const CFolderItem &)
void NetworkConnectionNeededL ( TInt *, TInt &, TBool &, TApBearerType &)
IMPORT_C TInt Open (RFeedsServer &)
void RequestHandlerCompleted (CRequestHandler &, TInt )
void RequestHandlerCompletedL (CTransaction &, TInt )
IMPORT_C const CFolderItem & RootFolderItem ()
void SendAsyncCommand ( TInt , const TIpcArgs &, TRequestStatus &)
IMPORT_C void UpdateAllL ()
IMPORT_C void UpdateFolderItemsL (const RPointerArray < const CFolderItem > &)
IMPORT_C void WatchFolderListL ()
Inherited Functions
RSubSessionBase::CloseSubSession(TInt)
RSubSessionBase::CreateAutoCloseSubSession(RSessionBase &,TInt,const TIpcArgs &)
RSubSessionBase::CreateSubSession(const RSessionBase &,TInt)
RSubSessionBase::CreateSubSession(const RSessionBase &,TInt,const TIpcArgs &)
RSubSessionBase::RSubSessionBase()
RSubSessionBase::Send(TInt)const
RSubSessionBase::Send(TInt,const TIpcArgs &)const
RSubSessionBase::SendReceive(TInt)const
RSubSessionBase::SendReceive(TInt,TRequestStatus &)const
RSubSessionBase::SendReceive(TInt,const TIpcArgs &)const
RSubSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
RSubSessionBase::Session()const
RSubSessionBase::SubSessionHandle()const
Private Attributes
RPointerArray < CFolderItemRequestHandler > iActiveRequests
RFeedsServer * iFeedsServer
CFolderItem * iFolderItem
TInt iFolderListId
TBool iItemTitleNeed
MFolderItemObserver & iObserver

Constructor & Destructor Documentation

RFolderItem(MFolderItemObserver &, TInt, TBool)

IMPORT_C RFolderItem ( MFolderItemObserver & aObserver,
TInt aFolderListId = 0,
TBool aItemTitleNeed = EFalse
)

C++ default constructor.

Parameters

MFolderItemObserver & aObserver
TInt aFolderListId = 0
TBool aItemTitleNeed = EFalse

Member Functions Documentation

AddFolderItemL(const TDesC &, const TDesC &, TBool, const CFolderItem &)

IMPORT_C void AddFolderItemL ( const TDesC & aName,
const TDesC & aUrl,
TBool aIsFolder,
const CFolderItem & aParent
)

Request the feeds server to add a new folder item.

Since
3.1

Parameters

const TDesC & aName The name of the item.
const TDesC & aUrl The url of the item.
TBool aIsFolder True if this is a folder.
const CFolderItem & aParent The parent folder.

CancelAllCommandsL()

void CancelAllCommandsL ( ) [inline, virtual]

ChangeFolderItemL(const CFolderItem &, const TDesC &, const TDesC &)

IMPORT_C void ChangeFolderItemL ( const CFolderItem & aFolderItem,
const TDesC & aTitle,
const TDesC & aUrl
)

Request the feeds server to change the folder item. If this is a folder then KNullDesC should be passed to the aUrl argument.

Since
3.1

Parameters

const CFolderItem & aFolderItem The item to update.
const TDesC & aTitle The item's title..
const TDesC & aUrl The item's url or KNullDesC.

Close()

IMPORT_C void Close ( )

Closes the session.

Since
3.1

DeleteFolderItemsL(RPointerArray< const CFolderItem > &)

IMPORT_C void DeleteFolderItemsL ( RPointerArray < const CFolderItem > & aFolderItems )

Request the feeds server to delete the folder items

Since
3.1

Parameters

RPointerArray < const CFolderItem > & aFolderItems

ExportFolderItemsL(RPointerArray< const CFolderItem > &, const TDesC &)

IMPORT_C void ExportFolderItemsL ( RPointerArray < const CFolderItem > & aFolderItems,
const TDesC & aExportFileName
)

Request the feeds server to export the folder items

Since
3.2

Parameters

RPointerArray < const CFolderItem > & aFolderItems
const TDesC & aExportFileName The OPML file name.

FetchRootFolderItemL()

IMPORT_C void FetchRootFolderItemL ( )

Fetches the root FolderItem. FetchRootFolderItemCompleted is called upon completion.

Since
3.1

HasRootFolderItem()

IMPORT_C TBool HasRootFolderItem ( ) const

Returns ETrue if it has an available root folder.

Since
3.1

ImportOPMLL(const TDesC &, TBool)

IMPORT_C void ImportOPMLL ( const TDesC & aPath,
TBool aClearFolderList = EFalse
)

Import OPML file passed from the client.

Since
3.2

Parameters

const TDesC & aPath The OPML file path.
TBool aClearFolderList = EFalse Flag indicating to or not to clear entries under this Folder List before load OPML.

MoveFolderItemsL(RPointerArray< const CFolderItem > &, TInt)

IMPORT_C void MoveFolderItemsL ( RPointerArray < const CFolderItem > & aFolderItems,
TInt aIndex
)

Request the feeds server to move the folder item to a different index.

Since
3.1

Parameters

RPointerArray < const CFolderItem > & aFolderItems
TInt aIndex The new index of the folder item (within its parent).

MoveFolderItemsToL(RPointerArray< const CFolderItem > &, const CFolderItem &)

IMPORT_C void MoveFolderItemsToL ( RPointerArray < const CFolderItem > & aFolderItems,
const CFolderItem & aParent
)

Request the feeds server to move the folder item to a different parent.

Since
3.1

Parameters

RPointerArray < const CFolderItem > & aFolderItems
const CFolderItem & aParent The folder item's new parent.

NetworkConnectionNeededL(TInt *, TInt &, TBool &, TApBearerType &)

void NetworkConnectionNeededL ( TInt * aConnectionPtr,
TInt & aSockSvrHandle,
TBool & aNewConn,
TApBearerType & aBearerType
) [virtual]

Request to create a network connection.

Since
3.1

Parameters

TInt * aConnectionPtr A pointer to the new connection. If NULL, the proxy filter will automatically create a network connection.
TInt & aSockSvrHandle A handle to the socket server.
TBool & aNewConn A flag if a new connection was created. If the connection is not new, proxy filter optimization will not read the proxy again from CommsBd.
TApBearerType & aBearerType The bearer type of the new connection

Open(RFeedsServer &)

IMPORT_C TInt Open ( RFeedsServer & aFeedsServer )

Opens a session to the root FolderItem on the server.

Since
3.1

Parameters

RFeedsServer & aFeedsServer The shared connection to the feeds server.

RequestHandlerCompleted(CRequestHandler &, TInt)

void RequestHandlerCompleted ( CRequestHandler & ,
TInt
) [inline, virtual]

Notifies the observer that the request is completed.

Since
3.1

Parameters

CRequestHandler &
TInt

RequestHandlerCompletedL(CTransaction &, TInt)

void RequestHandlerCompletedL ( CTransaction & aTrans,
TInt aStatus
)

Notifies the observer that the request is completed.

Since
3.1

Parameters

CTransaction & aTrans
TInt aStatus The result code of the request.

RootFolderItem()

IMPORT_C const CFolderItem & RootFolderItem ( ) const

Once fetched, it returns the root CFolderItem . This method panics the client if it is called before the folder item is available.

Since
3.1

SendAsyncCommand(TInt, const TIpcArgs &, TRequestStatus &)

void SendAsyncCommand ( TInt ,
const TIpcArgs & ,
TRequestStatus &
) const [inline, virtual]

Parameters

TInt
const TIpcArgs &
TRequestStatus &

UpdateAllL()

IMPORT_C void UpdateAllL ( )

Request the feeds server to update all the folder items (refresh them from the web) in a current folder-list.

Since
3.1

UpdateFolderItemsL(const RPointerArray< const CFolderItem > &)

IMPORT_C void UpdateFolderItemsL ( const RPointerArray < const CFolderItem > & aFolderItems )

Request the feeds server to update the folder items (refresh them from the web).

Since
3.1

Parameters

const RPointerArray < const CFolderItem > & aFolderItems The folder items being updated, has to be feed, not folder

WatchFolderListL()

IMPORT_C void WatchFolderListL ( )

Sets up a notifier to execute when the folder list changes.

Since
3.1

Member Data Documentation

RPointerArray< CFolderItemRequestHandler > iActiveRequests

RPointerArray < CFolderItemRequestHandler > iActiveRequests [private]

RFeedsServer * iFeedsServer

RFeedsServer * iFeedsServer [private]

CFolderItem * iFolderItem

CFolderItem * iFolderItem [private]

TInt iFolderListId

TInt iFolderListId [private]

TBool iItemTitleNeed

TBool iItemTitleNeed [private]

MFolderItemObserver & iObserver

MFolderItemObserver & iObserver [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.