1 Content: |
1 Content: |
2 ============================================================================== |
2 ============================================================================== |
3 This is pre-beta version of Social Mobile Framework code. Folder organization is as follows - |
3 This is pre-beta version of Social Mobile Framework code. Folder organization is as follows - |
4 Doxyfile - Doxygen configuration file |
4 Doxyfile - Doxygen configuration file |
5 |
5 |
6 \doc - contains zipped doxygen genrated documentation |
6 \doc - contains smfhelp.chm file, refer this for interface information |
7 |
7 |
8 \example - contains sample plugins, auth application and client test application |
8 \example - contains sample plugins, auth application and client test application |
9 \example\AuthApp |
9 \example\AuthApp |
10 \example\DemoGUI |
10 \example\DemoGUI |
11 \example\fbactivityfetcherplugin |
11 \example\fbactivityfetcherplugin |
67 SDK installation folder. You are good to go now. |
67 SDK installation folder. You are good to go now. |
68 2. Since sample plugins are not integrated with Auth App and Credential Mgr yet, currently it expects |
68 2. Since sample plugins are not integrated with Auth App and Credential Mgr yet, currently it expects |
69 the necessary credentials in plain text. Sample smfclientapp uses facebook plugins, place a file |
69 the necessary credentials in plain text. Sample smfclientapp uses facebook plugins, place a file |
70 named "FaceBookKeys.txt" under "C:/Data/" - which is at "\epoc32\winscw\c\data". This file should |
70 named "FaceBookKeys.txt" under "C:/Data/" - which is at "\epoc32\winscw\c\data". This file should |
71 contain keys in the following order: API key, API secret, session key, session secret.. all separated by \n |
71 contain keys in the following order: API key, API secret, session key, session secret.. all separated by \n |
72 If you want to know how to generate these, please see http://wiki.developers.facebook.com/index.php/Authorization_and_Authentication_for_Desktop_Applications |
72 If you want to know how to generate these, please see |
|
73 http://wiki.developers.facebook.com/index.php/Authorization_and_Authentication_for_Desktop_Applications |
73 We are integrating plugins with CredentialMgr, so these painful steps won't be required once it is up. |
74 We are integrating plugins with CredentialMgr, so these painful steps won't be required once it is up. |
|
75 |
74 |
76 |
75 |
77 |
76 Building Steps : - |
78 Building Steps : - |
77 ============================================================================== |
79 ============================================================================== |
78 1. Use smfrepo.pro present in top level to build. This single pro file builds SmfServer, SmfCredMgr, SmfClient, |
80 1. Use smfrepo.pro present in top level to build. This single pro file builds SmfServer, SmfCredMgr, SmfClient, |
87 2. Run Flickr Auth App - this would authenticate to Flickr. |
89 2. Run Flickr Auth App - this would authenticate to Flickr. |
88 3.Run project from \example\DemoGui. This should fetch names of the friends from facebook [for the user who |
90 3.Run project from \example\DemoGui. This should fetch names of the friends from facebook [for the user who |
89 provided the keys in step 2 in pre-build steps] and pictures from Flickr |
91 provided the keys in step 2 in pre-build steps] and pictures from Flickr |
90 4. The results might not show properly on UI due to problems in S^3 SDK for Webkit. However textual result can be viewed |
92 4. The results might not show properly on UI due to problems in S^3 SDK for Webkit. However textual result can be viewed |
91 at the generated log file - \epoc32\winscw\c\data\SmfLogs.txt |
93 at the generated log file - \epoc32\winscw\c\data\SmfLogs.txt |
|
94 |
|
95 |
|
96 |
|
97 Public Header files |
|
98 ============================================================================== |
|
99 Following section lists the public header files for application developers and plugin developers. Please |
|
100 refer to section "SMF Interfaces and Usage" in smfhelp.chm kept in doc folder for details of the classes. |
|
101 |
|
102 |
|
103 SmfClient Header Files |
|
104 ============================================================================== |
|
105 These are exported to \epoc32\include from \smf\smfservermodule\smfclient |
|
106 smfclient.h |
|
107 smfcontactfetcher.h |
|
108 smfpostprovider.h |
|
109 smfgallery.h |
|
110 smfrelationmgr.h |
|
111 smfmusic.h |
|
112 smfactivityfetcher.h |
|
113 smfeventsfetcher.h |
|
114 |
|
115 |
|
116 |
|
117 SmfPlugin Header Files |
|
118 ============================================================================== |
|
119 These are exported to \epoc32\include from \smf\smfservermodule\smfserver\smfplugins |
|
120 smfpluginbase.h |
|
121 smfproviderbase.h |
|
122 smfactivityfetcherplugin.h |
|
123 smfcontactfetcherplugin.h |
|
124 smfeventsfetcherplugin.h |
|
125 smfpostproviderplugin.h |
|
126 smflyricsserviceplugin.h |
|
127 smfmusicsearchplugin.h |
|
128 smfmusicserviceplugin.h |
|
129 smfplaylistserviceplugin.h |
|
130 smfgalleryplugin.h |
|
131 |
|
132 |
|
133 |
|
134 SmfCommon Header Files |
|
135 ============================================================================== |
|
136 These are exported to \epoc32\include from \smf\smfservermodule\smfcommon |
|
137 smfactions.h |
|
138 smfalbum.h |
|
139 smfartists.h |
|
140 smfcomment.h |
|
141 smfcontact.h |
|
142 smfevent.h |
|
143 smfgroup.h |
|
144 smflocation.h |
|
145 smflyrics.h |
|
146 smfmusicfingerprint.h |
|
147 smfmusicprofile.h |
|
148 smfmusicrating.h |
|
149 smfpicture.h |
|
150 smfpicturealbum.h |
|
151 smfplaylist.h |
|
152 smfpluginutil.h |
|
153 smfpost.h |
|
154 smfprovider.h |
|
155 smfsubtitle.h |
|
156 smftrackinfo.h |
|
157 smfurl.h |
|
158 smfclientglobal.h |
|
159 smfglobal.h |
|
160 smfobserver.h |
|
161 |
|
162 |
|
163 |
|
164 SmfCredentialManager Header Files |
|
165 ============================================================================== |
|
166 These are exported to \epoc32\include from \smf\smfcredentialmgr\smfcredmgrclient |
|
167 smfcredmgrclient.h |
|
168 smfcredmgrclientdatastruct.h |
|
169 smfcredmgrclientglobal.h |
|
170 smfutils.h |
|
171 smfcredmgrcommon.h |