FCL/sf/app/commonemail: emailservices/nmclientapi/inc/nmapiengine.h@2dc6caa42ec3 (annotated)

18 578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	1	/*
578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	2	* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	3	* All rights reserved.
578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	4	* This component and the accompanying materials are made available
578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	5	* under the terms of "Eclipse Public License v1.0"
578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	6	* which accompanies this distribution, and is available
578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	7	* at the URL "http://www.eclipse.org/legal/epl-v10.html".
578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	8	*
578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	9	* Initial Contributors:
578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	10	* Nokia Corporation - initial contribution.
578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	11	*
578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	12	* Contributors:
578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	13	*
578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	14	* Description:
578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	15	*
578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	16	*/
578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	17
578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	18	#ifndef NMAPIENGINE_H
578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	19	#define NMAPIENGINE_H
578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	20
578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	21	#include "nmcommon.h"
23 2dc6caa42ec3 Revision: 201017 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 18 diff changeset	22	#include "nmapiprivateclasses.h"
2dc6caa42ec3 Revision: 201017 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 18 diff changeset	23
2dc6caa42ec3 Revision: 201017 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 18 diff changeset	24	class NmApiDataPluginFactory;
18 578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	25
23 2dc6caa42ec3 Revision: 201017 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 18 diff changeset	26	namespace EmailClientApi
2dc6caa42ec3 Revision: 201017 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 18 diff changeset	27	{
2dc6caa42ec3 Revision: 201017 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 18 diff changeset	28	class NmApiMailbox;
2dc6caa42ec3 Revision: 201017 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 18 diff changeset	29	class NmApiFolder;
2dc6caa42ec3 Revision: 201017 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 18 diff changeset	30	class NmApiMessageEnvelope;
2dc6caa42ec3 Revision: 201017 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 18 diff changeset	31	}
18 578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	32
23 2dc6caa42ec3 Revision: 201017 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 18 diff changeset	33	class NmApiEngine : public QObject
18 578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	34	{
578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	35	Q_OBJECT
578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	36	public:
23 2dc6caa42ec3 Revision: 201017 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 18 diff changeset	37	static NmApiEngine* instance();
2dc6caa42ec3 Revision: 201017 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 18 diff changeset	38	static void releaseInstance(NmApiEngine *&engine);
18 578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	39
23 2dc6caa42ec3 Revision: 201017 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 18 diff changeset	40	void listMailboxes(QList<EmailClientApi::NmApiMailbox> &mailboxList);
18 578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	41
23 2dc6caa42ec3 Revision: 201017 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 18 diff changeset	42	void listFolders(const quint64 mailboxId, QList<EmailClientApi::NmApiFolder> &folderList);
2dc6caa42ec3 Revision: 201017 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 18 diff changeset	43	void listEnvelopes(const quint64 mailboxId, const quint64 folderId,
2dc6caa42ec3 Revision: 201017 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 18 diff changeset	44	QList<EmailClientApi::NmApiMessageEnvelope> &messageEnvelopeList);
18 578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	45
23 2dc6caa42ec3 Revision: 201017 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 18 diff changeset	46	bool getEnvelopeById(
18 578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	47	const quint64 mailboxId,
578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	48	const quint64 folderId,
578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	49	const quint64 envelopeId,
23 2dc6caa42ec3 Revision: 201017 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 18 diff changeset	50	EmailClientApi::NmApiMessageEnvelope &envelope);
2dc6caa42ec3 Revision: 201017 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 18 diff changeset	51
2dc6caa42ec3 Revision: 201017 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 18 diff changeset	52	bool getMailboxById(const quint64 mailboxId, EmailClientApi::NmApiMailbox &mailbox);
18 578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	53
578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	54	void startCollectingEvents();
23 2dc6caa42ec3 Revision: 201017 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 18 diff changeset	55
18 578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	56	signals:
578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	57	/*!
23 2dc6caa42ec3 Revision: 201017 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 18 diff changeset	58	It contains info about event in emailstore.
2dc6caa42ec3 Revision: 201017 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 18 diff changeset	59
2dc6caa42ec3 Revision: 201017 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 18 diff changeset	60	\arg Contains info about event and related object (message or mailbox list)
18 578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	61	*/
578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	62	void emailStoreEvent(NmApiMessage message);
578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	63
23 2dc6caa42ec3 Revision: 201017 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 18 diff changeset	64	private slots:
18 578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	65	void mailboxChangedArrived(NmMailboxEvent, const QList<NmId> &mailboxIds);
578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	66	void messageChangedArrived(
578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	67	NmMessageEvent messageEvent,
578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	68	const NmId &folderId,
578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	69	const QList<NmId> &messageIds,
578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	70	const NmId &mailboxId);
578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	71
578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	72	private:
23 2dc6caa42ec3 Revision: 201017 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 18 diff changeset	73	NmApiEngine();
2dc6caa42ec3 Revision: 201017 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 18 diff changeset	74	virtual ~NmApiEngine();
18 578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	75
578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	76	private:
23 2dc6caa42ec3 Revision: 201017 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 18 diff changeset	77	static NmApiEngine *mInstance;//!<Static instance of NmApiEngine. There can be only one instance of engine
18 578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	78	static quint32 mReferenceCount;//!<Count of refences to engine instance
578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	79
23 2dc6caa42ec3 Revision: 201017 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 18 diff changeset	80	NmApiDataPluginFactory *mFactory;//!<Plugin factory. Is needed to get plugins for emails
18 578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	81	};
578830873419 Revision: 201011 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: diff changeset	82
23 2dc6caa42ec3 Revision: 201017 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 18 diff changeset	83	#endif /* NMAPIENGINE_H */

author	Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
	Fri, 14 May 2010 15:41:10 +0300
changeset 23	2dc6caa42ec3
parent 18	578830873419
child 68	83cc6bae1de8
permissions	-rw-r--r--