1 Content:

     2 ==============================================================================

     3 This is pre-beta version of Social Mobile Framework code. Folder organization is as follows - 

     4                 Doxyfile - Doxygen configuration file 

     5 

     6                 \doc - contains zipped doxygen genrated documentation

     7 

     8                 \example - contains sample plugins, auth application and client test application

     9                                     \example\AuthApp

    10                                     \example\fbcontactfetcherplugin

    11                                     \example\fbpostproviderplugin

    12                                     \example\flickrcontactfetcherplugin

    13                                     \example\smfclientapp

    14 

    15 

    16                 \smf - Contains smf source code

    17 

    18                 \smf\smfcredentialmgr - this is credential manager source code 

    19 

    20                 \smf\smfservermodule - this is SMF server 

    21                                 \smf\smfservermodule\smfclient

    22                                 \smf\smfservermodule\smfserver

    23                                 \smf\smfservermodule\smfserver\datastoremgr

    24                                 \smf\smfservermodule\smfserver\pluginmgr

    25                                 \smf\smfservermodule\smfserver\server

    26                                 \smf\smfservermodule\smfserver\smfplugins

    27                                 \smf\smfservermodule\smfserver\transportmgr

    28 

    29                 \smf\smfservermodule\util - this contains utility classes for plugins e.g. JSON

    30                                 \smf\smfservermodule\util\qjson

    31 

    32                 \smf\smfsettingsui - this contains SMF settins UI [incomplete]

    33 

    34 

    35 

    36 

    37 Dependencies:

    38 ==============================================================================

    39 SMF is built on Nokia_Symbian3_SDK_v0.8 and Qt 4.6.3. 

    40 You would need to install qt-mobility-symbian-opensource-1.0.0. 

    41 To enable building of SMF in public SDK, the unified key store (RSA Signing) related code is 

    42 blocked with compiler switch. Use Symbian^3 PDK if you want to enable this feature.

    43 

    44 Main Interfaces that can be tested end-to-end using this set-up are ContactsFetcher and 

    45 SmfPost. Though framework code is available, plugins are yet to be available for other service 

    46 interfaces for end-to-end testing.

    47 

    48 Limitations:

    49 ==============================================================================

    50 1. Support for Non-Symbian (Desktop) version of Qt is not supported at this moment.

    51 2. Integration of Authentication Application with Credential Manager is not complete at the moment. 

    52     So sample plugins require some hacks to access application information for Facebook and Flickr. 

    53     Please see pre-build step 2 on how to achieve this.

    54 3. SMFSettingsUI is not complete at this moment. This impacts network proxy settings. See pre-build

    55     step 1 on how to overcome this.

    56 

    57 Pre-build steps:

    58 ==============================================================================

    59 1. SMF uses QNetwork classes to setup proxy-settings. For testing on emulator (WINSCW), find the 

    60     hardcoded value under compiler switch "EMULATORTESTING" in file smftransportmanagerutil.cpp. 

    61     If your proxy requires authentication, provide "<username> space <password>" in plaintext in a file 

    62     "DoNotShare.txt" and place this file in "C:/Data/" - which is at "\epoc32\winscw\c\data" under your 

    63     SDK installation folder. You are good to go now.

    64 2. Since sample plugins are not integrated with Auth App and Credential Mgr yet, currently it expects

    65 the necessary credentials in plain text. Sample smfclientapp uses facebook plugins, place a file 

    66 named "FaceBookKeys.txt" under "C:/Data/" - which is at "\epoc32\winscw\c\data". This file should

    67 contain keys in the following order:  API key, API secret, session key, session secret.. all separated by \n

    68 If you want to know how to generate these, please see http://wiki.developers.facebook.com/index.php/Authorization_and_Authentication_for_Desktop_Applications

    69 We are integrating plugins with CredentialMgr, so these painful steps won't be required once it is up.

    70 

    71 

    72 Building Steps :  - 

    73 ==============================================================================

    74 1. Use smfrepo.pro present in top level to build. This single pro file builds SmfServer, SmfCredMgr, SmfClient,

    75 Sample Plugins and Sample TestApp

    76 2. To test on emulator (WINSCW) you can run smfclientapp.exe.

    77 3. QJson requires high capability, so testing on device would require appropriate cerificatres for signing. 

    78 see https://www.symbiansigned.com/app/page

    79 

    80 Running Sample Application

    81 ==============================================================================

    82 1. Run project from \example\smfclientapp. This should fetch names of the friends from facebook [for the user who

    83 provided the keys in step 2 in pre-build steps]

    84 2. The results might not show properly on UI due to problems in S^3 SDK. However textual result can be viewed

    85 at the generated log file - \epoc32\winscw\c\data\SmfClientLogs.txt

    86 3. The Smf Server generates a separate log file under same directiry - \epoc32\winscw\c\data\SmfLog.txt

    87 If the