author | cgandhi <chandradeep.gandhi@sasken.com> |
Thu, 15 Apr 2010 15:40:08 +0530 | |
changeset 4 | 969092730d34 |
parent 3 | 0446eb7b28aa |
child 5 | edb9dc8273d9 |
permissions | -rw-r--r-- |
3
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
1 |
/** |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
2 |
* Copyright (c) 2010 Sasken Communication Technologies Ltd. |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
3 |
* All rights reserved. |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
4 |
* This component and the accompanying materials are made available |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
5 |
* under the terms of the "Eclipse Public License v1.0" |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
6 |
* which accompanies this distribution, and is available |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
7 |
* at the URL "http://www.eclipse.org/legal/epl-v10.html" |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
8 |
* |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
9 |
* Initial Contributors: |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
10 |
* Chandradeep Gandhi, Sasken Communication Technologies Ltd - Initial contribution |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
11 |
* |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
12 |
* Contributors: |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
13 |
* Manasij Roy, Nalina Hariharan |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
14 |
* |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
15 |
* Description: |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
16 |
* Intro Page |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
17 |
* |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
18 |
* @ref smf_high_level_design |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
19 |
*/ |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
20 |
|
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
21 |
/** |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
22 |
* @mainpage SMF (Social Mobile Framework Interfaces) |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
23 |
* @defgroup smf_high_level_design SMF high level design |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
24 |
* |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
25 |
* Social Mobile Framework is a application level framework which allows Qt Applications |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
26 |
* use the common web APIs to perform social web activities. |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
27 |
* |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
28 |
* Product name is "SMF" |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
29 |
* |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
30 |
* For details please refer to http://developer.symbian.org/wiki/index.php/Social_Mobile_Framework |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
31 |
* |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
32 |
* @section smf_interfaces SMF Interfaces |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
33 |
* |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
34 |
* There are two sets of interfaces - |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
35 |
* @subsection smf_client_interfaces Client Interfaces |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
36 |
* - Client Applications (e.g. Media Player, Contacts, Game) uses these APIs to access SMF. see @ref smf_client_group |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
37 |
* |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
38 |
* @subsection smf_plugin_interfaces Plugin Interfaces |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
39 |
* - Service Providers (e.g. Facebook, Flickr, last.fm) implements these APIs to provide service to SMF - see @ref smf_plugin_group |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
40 |
* |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
41 |
* Currently, @ref smf_client_interfaces and @ref smf_plugin_interfaces are defined for remote contacts, remote |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
42 |
* image gallery and remote music services. There are common classes defined for holding data accross clients |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
43 |
* and plugins, present in inc\common, see - @ref smf_common_group |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
44 |
* |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
45 |
* |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
46 |
* @section smf_client_usage Client Usage Example |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
47 |
* - This shows how to use the SMF client APIs in applications, e.g. Client can define suitable Models using lists returned by these APIs |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
48 |
* - how to fetch a list of contacts from a remote server e.g. Facebook, see @ref MyApplication::displayFriends() |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
49 |
* - how to get a @ref QContact from a SmfContacts see @ref MyApplication::showlist() |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
50 |
* - how to get a list of images from a remote gallery e.g. Flickr.com, see @ref MyApplication::displayGallery() |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
51 |
* - how to post privately to a contact see @ref MyApplication::postUpdate() |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
52 |
* - how to tell others about the music you are currently listen to, see @ref MyApplication::updateCurrentPlaying() |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
53 |
* |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
54 |
* @section smf_sample_plugin Sample Plugin From Service provider |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
55 |
* - This shows how to write a plugin for extending SMF service. Authentication Application also needs to be provided for these plugins. |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
56 |
* - how to create request to be sent to a remote server e.g. Flickr.com, see @ref SamplePlugin::pictures() |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
57 |
* - how to implement posting of comment on a picture to Flickr.com, @ref SamplePlugin::postComment() |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
58 |
* - how to parse the response that arrived from Flickr.com, see @ref SamplePlugin::responseAvailable() |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
59 |
* - how to use JSON parsing from SmfPluginUtil, see @ref SamplePlugin::responseAvailable() |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
60 |
* |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
61 |
* @section smf_dependency Dependency |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
62 |
* SMF uses QtMobility for mainly contacts information, see QtMobility project. |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
63 |
*/ |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
64 |
/** |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
65 |
* @defgroup smf_common_group Common Data Classes |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
66 |
*/ |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
67 |
/** |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
68 |
* @defgroup smf_client_group Client Classes |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
69 |
*/ |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
70 |
/** |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
71 |
* @defgroup smf_plugin_group Plugin Classes |
0446eb7b28aa
Updating the sample plugin and other related changes for clients and plugins
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff
changeset
|
72 |
*/ |