Collapse all Symbian^3 Application Developer Library

RFeed Class Reference

class RFeed : public RSubSessionBase

The client side interface to a server resident Feed.

Library: FeedsEngine.lib

Since: 3.1

Inherits from

RFeed
- RSubSessionBase

Public Member Functions
	RFeed ( MFeedObserver &)
void	CancelAllCommandsL ()
IMPORT_C void	Close ()
IMPORT_C const CFeed &	Feed ()
IMPORT_C void	FetchFeedL (const TDesC &, TInt , TBool , TBool )
IMPORT_C void	FetchFeedL ( TInt , TBool , TBool )
IMPORT_C TBool	HasCurrentFeed ()
void	NetworkConnectionNeededL ( TInt *, TInt &, TBool &, TApBearerType &)
IMPORT_C TInt	Open (RFeedsServer &)
void	RequestHandlerCompleted (CRequestHandler &, TInt )
void	RequestHandlerCompletedL (CTransaction &, TInt )
void	SendAsyncCommand ( TInt , const TIpcArgs &, TRequestStatus &)
IMPORT_C void	UpdateFeedItemStatusL (const RArray < TInt > &, const RArray < TItemStatus > &, TInt )

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 < CFeedRequestHandler >	iActiveRequests
CFeed *	iFeed
RFeedsServer *	iFeedsServer
MFeedObserver &	iObserver
TBool	iPendingFetchFeed

Constructor & Destructor Documentation

RFeed(MFeedObserver &)

IMPORT_C

RFeed

(

MFeedObserver &

aObserver

)

C++ default constructor.

Parameters

MFeedObserver & aObserver

Member Functions Documentation

CancelAllCommandsL()

void

CancelAllCommandsL

(

)

[inline, virtual]

Preserving Binary Compatibility.

Since: 7.1 Empty function does nothing.

Close()

IMPORT_C void

(

)

Closes the session.

Since: 3.1

Feed()

IMPORT_C const CFeed &

Feed

(

)

const

Once fetched, it returns the CFeed . This method panics the client if it is called before the feed item is available.

Since: 3.1

FetchFeedL(const TDesC &, TInt, TBool, TBool)

IMPORT_C void	FetchFeedL	(	const TDesC &	aUrl,
			TInt	aFolderListId = 0,
			TBool	aForceUpdate = EFalse,
			TBool	aNoCache = EFalse
		)

Fetches the given feed. FetchFeedCompleted is called upon completion. The same url could appear multiple times in the feeds DB if each has different folder list ID.

Since: 3.1

Parameters

const TDesC & aUrl	The url of the feed.
TInt aFolderListId = 0	The folder list ID associate with the feed.
TBool aForceUpdate = EFalse	When true the server will ignore the cache.
TBool aNoCache = EFalse	When true the server will not cache the feed.

FetchFeedL(TInt, TBool, TBool)

IMPORT_C void	FetchFeedL	(	TInt	aFeedId,
			TBool	aForceUpdate = EFalse,
			TBool	aNoCache = EFalse
		)

Fetches the given feed -- using the feed's id. FetchFeedCompleted is called upon completion.

Since: 3.1

Parameters

TInt aFeedId	The id of the feed (from the associated CFolderItem).
TBool aForceUpdate = EFalse	When true the server will ignore the cache.
TBool aNoCache = EFalse	When true the server will not cache the feed.

HasCurrentFeed()

IMPORT_C TBool

HasCurrentFeed

(

)

const

Returns ETrue if it has an available current feed.

Since: 3.1

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 given feed 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]

Preserving Binary Compatibility.

Since: 7.1 Empty function does nothing.

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.

SendAsyncCommand(TInt, const TIpcArgs &, TRequestStatus &)

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

Requests the observer to send a command to the server.

Since: 7.1

Parameters

TInt
const TIpcArgs &
TRequestStatus &

UpdateFeedItemStatusL(const RArray< TInt > &, const RArray< TItemStatus > &, TInt)

IMPORT_C void	UpdateFeedItemStatusL	(	const RArray < TInt > &	aItemIds,
			const RArray < TItemStatus > &	aItemStatus,
			TInt	aUnreadCount
		)

Request the feeds server to update the feed's item status.

Since: 3.1

Parameters

const RArray < TInt > & aItemIds	The id's of the items to update.
const RArray < TItemStatus > & aItemStatus	The new item status.
TInt aUnreadCount

Member Data Documentation

RPointerArray< CFeedRequestHandler > iActiveRequests

RPointerArray < CFeedRequestHandler >

iActiveRequests

[private]

CFeed * iFeed

CFeed *

iFeed

[private]

RFeedsServer * iFeedsServer

RFeedsServer *

iFeedsServer

[private]

MFeedObserver & iObserver

MFeedObserver &

iObserver

[private]

TBool iPendingFetchFeed

TBool

iPendingFetchFeed

[private]