FCL/sf/mw/socialmobilefw: smf/smfdes.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:
25 a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 7 diff changeset	13	* Nalina Hariharan,Satish Kanteti, Rajat Roy
7 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	* Intro Page
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	* @ref smf_high_level_design
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
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	21	/**
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	22	* @mainpage SMF (Social Mobile Framework Interfaces)
25 a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 7 diff changeset	23	* @defgroup smf_high_level_design SMF Interfaces and Usage
7 be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	24	*
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	25	* Social Mobile Framework is a application level framework which allows Qt Applications
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	26	* use the common web APIs to perform social web activities.
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	* Product name is "SMF"
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	29	*
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	30	* For details please refer to http://developer.symbian.org/wiki/index.php/Social_Mobile_Framework
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	* @section smf_interfaces SMF Interfaces
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	33	*
25 a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 7 diff changeset	34	* Native applications can use SMF, via Client APIs.
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 7 diff changeset	35	* Service Providers can provide smf plugins, via Plugin APIs.
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 7 diff changeset	36	* Both would use Common APIs for common data classes
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 7 diff changeset	37	* Service Providers can optionaliy use Credential Manager APIs
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 7 diff changeset	38	*
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 7 diff changeset	39	* Here is the list of public interfaces ( exported to /epoc32/include ) -
7 be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	40	* @subsection smf_client_interfaces Client Interfaces
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	41	* - Client Applications (e.g. Media Player, Contacts, Game) uses these APIs to access SMF. see @ref smf_client_group
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	42	*
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	43	* @subsection smf_plugin_interfaces Plugin Interfaces
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	44	* - Service Providers (e.g. Facebook, Flickr, last.fm) implements these APIs to provide service to SMF - see @ref 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	45	*
25 a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 7 diff changeset	46	* @subsection smf_common_interfaces Common Interfaces
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 7 diff changeset	47	* - Both plugins and smfclient uses these for representing data - see @ref smf_common_group
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 7 diff changeset	48	*
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 7 diff changeset	49	* @subsection smf_credmgr_interfaces CredMgr Interfaces
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 7 diff changeset	50	* - Credential Manager provides APIs for digital signing, storing and retrieving keys, etc - see @ref smf_credmgr_group
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 7 diff changeset	51	* \ep
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 7 diff changeset	52	*
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 7 diff changeset	53	*
7 be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	54	*
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	55	*
25 a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 7 diff changeset	56	* @section smf_client_usage Client Usage Example
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 7 diff changeset	57	* - / example / DemoGUI / HomeView.cpp shows how to use the SMF client APIs in applications, e.g. Client can define suitable Models using lists returned by these APIs.
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 7 diff changeset	58	* - how to fetch a list of contacts from a remote server e.g. Facebook, see @ref HomeView::getFriends()
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 7 diff changeset	59	* - how to get a list of posts from a remote server e.g. Facebook, see @ref HomeView::getPosts()
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 7 diff changeset	60	* - how to get a list of images from a remote gallery e.g. Flickr.com, see @ref HomeView::getAlbums()
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 7 diff changeset	61	* - how to list all the activities that has happened recently, see @ref HomeView::getActivities()
7 be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	62	*
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	63	* @section smf_sample_plugin Sample Plugin From Service provider
25 a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 7 diff changeset	64	* - This shows how to write a plugin for extending SMF service.
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 7 diff changeset	65	* - how to create request to be sent to a remote server for fetching contacts e.g.Facebook.com, see @ref FBContactFetcherPlugin::friends
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 7 diff changeset	66	* - how to implement the fetching of posts or comment, @ref FBPostProviderPlugin::getPosts()
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 7 diff changeset	67	* - how to parse the response that arrived from Facebook.com for fetching activities, see @ref FBActivityFetcherPlugin::responseAvailable()
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 7 diff changeset	68	* - how to use JSON parsing from SmfPluginUtil, see @ref FBPostProviderPlugin::responseAvailable()
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 7 diff changeset	69	* - Authentication Application also needs to be provided for these plugins.
7 be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	70	*
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	71	* @section smf_custom_api Custom API in SMF
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	72	* - SMF strives to provide service API for generic "common" social operations. However this doesn't mean that developers have to
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	73	* use other propriatery APIs to access service specific "differentiating" features. Service Providers can provide plugins which support
25 a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 7 diff changeset	74	* APIs like @ref SmfGalleryPlugin::customRequest(). A separate library would also be provided by service providers to help SMF clients
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 7 diff changeset	75	* use this custom API
7 be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	76	*
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	77	*
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	78	*
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	79	* @section smf_dependency Dependency
25 a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 7 diff changeset	80	* - SMF uses Qt 4.6.2 on Symbian^3 ( Nokia_Symbian3_SDK_v0.8 to be specific )
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 7 diff changeset	81	* - SMF uses QtMobility 1.0 for mainly contacts information, see QtMobility project.
7 be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	82	* - SMF uses QJson as utility library, courtesy Flavio Castelli , see http://gitorious.org/qjson/qjson
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	83	*
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	84	* @section smf_notes Notes:
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	85	* - SMF defines the social activities with inspiration from http://activitystrea.ms/
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	86	* - Other such open standards would soon find their usage in SMF, one such candidate is http://xspf.org/
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	87	*
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	88	*/
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	89	/**
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	90	* @defgroup smf_common_group Common Data Classes
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	91	*/
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	92	/**
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	93	* @defgroup smf_client_group Client Classes
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	94	*/
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	95	/**
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	96	* @defgroup smf_plugin_group Plugin Classes
be09cf1f39dd Updating the source code for plugin manager, transport manager, smfserver and smf client. cgandhi <chandradeep.gandhi@sasken.com> parents: diff changeset	97	*/
25 a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 7 diff changeset	98	/**
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 7 diff changeset	99	* @defgroup smf_credmgr_group CredMgr Classes
a180113055cb Music Events are now normal Fetcher APIs added cgandhi parents: 7 diff changeset	100	*/

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