FCL/sf/mw/socialmobilefw: smf/smfservermodule/smfserver/smfplugins/smfpluginbase.h@a180113055cb (annotated)

7 be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	1	/**
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	2	* Copyright (c) 2010 Sasken Communication Technologies Ltd.
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	3	* All rights reserved.
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	4	* This component and the accompanying materials are made available
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	5	* under the terms of the "Eclipse Public License v1.0"
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	6	* which accompanies this distribution, and is available
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	7	* at the URL "http://www.eclipse.org/legal/epl-v10.html"
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	8	*
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	9	* Initial Contributors:
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	10	* Chandradeep Gandhi, Sasken Communication Technologies Ltd - Initial contribution
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	11	*
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	12	* Contributors:
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	13	* Manasij Roy, Nalina Hariharan
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	14	*
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	15	* Description:
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	16	* The SmfPluginBase class is the base class for all plugins.
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	17	*
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	18	*/
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	19
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	20	#ifndef SMFPLUGINBASE_H_
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	21	#define SMFPLUGINBASE_H_
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	22
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	23	#include <smfproviderbase.h>
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	24	#include <smfglobal.h>
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	25
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	26	class SmfPluginUtil;
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	27
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	28	/**
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	29	* @ingroup smf_plugin_group
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	30	* The SmfPluginBase class is the base class for all plugins
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	31	*/
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	32	class SmfPluginBase
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	33	{
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	34	public:
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	35	/**
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	36	* Destructor
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	37	*/
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	38	virtual ~SmfPluginBase( ) {}
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	39
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	40	/**
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	41	* The first method to be called in the plugin that implements this interface.
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	42	* If this method is not called, plugin may not behave as expected.
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	43	*/
18 013a02bf2bb0 pushing changes for common libs and trace messages cgandhi parents: 14 diff changeset	44	virtual void initialize( ) = 0;
7 be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	45
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	46	/**
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	47	* Method to get the provider information
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	48	* @return Instance of SmfProviderBase
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	49	*/
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	50	virtual SmfProviderBase* getProviderInfo( ) = 0;
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	51
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	52	/**
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	53	* Method to get the result for a network request.
25 a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 18 diff changeset	54	* @param aOperation [in] The type of operation to be requested
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 18 diff changeset	55	* @param aTransportResult [in] The result of transport operation
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 18 diff changeset	56	* @param aReply [in] The QByteArray instance containing the network response.
7 be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	57	* The plugins should delete this instance once they have read the
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	58	* data from it.
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	59	* @param aResult [out] An output parameter to the plugin manager.If the
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	60	* return value is SmfSendRequestAgain, QVariant will be of type
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	61	* SmfPluginRequestData.
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	62	*
25 a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 18 diff changeset	63	* For SmfActivityFetcherPlugin: If the last operation was selfActivities(),
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 18 diff changeset	64	* friendsActivities() or filtered(), aResult will be of type QList<SmfActivityEntry>
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 18 diff changeset	65	*
7 be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	66	* For SmfContactFetcherPlugin: If last operation was friends() or followers()
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	67	* or search() or searchInGroup() or searchNear(), aResult will be of type
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	68	* QList<SmfContact>. If last operation was groups(), aResult will be of
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	69	* type QList<SmfGroup>
25 a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 18 diff changeset	70	*
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 18 diff changeset	71	* For SmfEventsFetcherPlugin: If the last operation was events(), aResult will
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 18 diff changeset	72	* be of type QList<SmfEvent>. If the last operation was venues(), aResult
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 18 diff changeset	73	* will be of type QList<SmfLocation>. If the last operation was attendees(),
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 18 diff changeset	74	* aResult will be of type QList<SmfContact>. If the last operation was
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 18 diff changeset	75	* postEvents(), aResult will be of type bool.
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 18 diff changeset	76	*
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 18 diff changeset	77	* For SmfGalleryPlugin: If last operation was albums, aResult will be of
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 18 diff changeset	78	* type QList<SmfPictureAlbum>. If the last operation was pictures(), aResult
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 18 diff changeset	79	* will be of type QList<SmfPicture>. If last operation was description(),
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 18 diff changeset	80	* aResult will be of type QString. If last operation was upload() or
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 18 diff changeset	81	* postComment(), aResult will be of type bool.
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 18 diff changeset	82	*
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 18 diff changeset	83	* For SmfLyricsServicePlugin: If last operation was lyrics(), aResult will
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 18 diff changeset	84	* be of type QList<SmfLyrics>. If last operation was subtitles(), aResult will
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 18 diff changeset	85	* be of type QList<SmfSubtitle>.
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 18 diff changeset	86	*
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 18 diff changeset	87	* For SmfMusicSearchPlugin: If last operation was recommendations() or
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 18 diff changeset	88	* tracksSimilar() or tracksOfAlbum() or tracksOfArtist() or trackInfo(),
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 18 diff changeset	89	* aResult will be of type QList<SmfTrackInfo>. If last operation was
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 18 diff changeset	90	* stores(), aResult will be of type QList<SmfProvider>.
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 18 diff changeset	91	*
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 18 diff changeset	92	* For SmfMusicServicePlugin: If last operation was userMusicInfo(), aResult
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 18 diff changeset	93	* will be of type SmfMusicProfile. If last operation was searchArtist(),
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 18 diff changeset	94	* aResult will be of type QList<SmfArtists>. If last operation was searchAlbum(),
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 18 diff changeset	95	* aResult will be of type QList<SmfAlbum>. If last operation was searchEvents(),
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 18 diff changeset	96	* aResult will be of type QList<SmfEvent>. If last operation was searchVenue(),
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 18 diff changeset	97	* aResult will be of type QList<Smfocation>. If last operation was searchUser(),
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 18 diff changeset	98	* aResult will be of type QList<SmfMusicProfile>. If last operation was
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 18 diff changeset	99	* postCurrentPlaying() or postRating() or postComments(), aResult will be of
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 18 diff changeset	100	* type bool.
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 18 diff changeset	101	*
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 18 diff changeset	102	* For SmfPlaylistServicePlugin: If last operation was playlists() or
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 18 diff changeset	103	* playlistsOf(), aResult will be of type QList<SmfPlaylist>. If last
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 18 diff changeset	104	* operation was addToPlaylist() or postCurrentPlayingPlaylist(),
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 18 diff changeset	105	* aResult will be of type bool.
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 18 diff changeset	106	*
7 be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	107	* For SmfPostProviderPlugin: If last operation was retrieve(), aResult will be
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	108	* of type QList<SmfPost>. If last operation was post() or updatePost() or
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	109	* postDirected() or commentOnAPost() or postAppearence() or sharePost(),
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	110	* aResult will be of type bool
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	111	*
25 a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 18 diff changeset	112	* @param aRetType [out] Appropriate value of the enum SmfPluginRetType
7 be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	113	* @param aPageResult [out] The SmfResultPage structure variable
25 a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 18 diff changeset	114	* @return Appropriate value of the enum SmfPluginError.
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 18 diff changeset	115	* Plugin error if any, else SmfPluginErrNone for success
7 be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	116	*/
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	117	virtual SmfPluginError responseAvailable(
14 a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications. cgandhi <chandradeep.gandhi@sasken.com> parents: 7 diff changeset	118	const SmfRequestTypeID aOperation,
7 be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	119	const SmfTransportResult &aTransportResult,
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	120	QByteArray *aReply,
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	121	QVariant* aResult,
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	122	SmfPluginRetType &aRetType,
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	123	SmfResultPage &aPageResult ) = 0;
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	124
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	125	};
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	126
14 a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications. cgandhi <chandradeep.gandhi@sasken.com> parents: 7 diff changeset	127	Q_DECLARE_INTERFACE( SmfPluginBase, "org.symbian.smf.plugin.smfpluginbase/v0.2" );
7 be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	128
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	129	#endif /* SMFPLUGINBASE_H_ */

author	cgandhi
	Thu, 23 Sep 2010 17:43:31 +0530
changeset 25	a180113055cb
parent 18	013a02bf2bb0
permissions	-rw-r--r--