Content:

==============================================================================

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

                Doxyfile - Doxygen configuration file 

                \doc - contains smfhelp.chm file, refer this for interface information

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

                                    \example\AuthApp

                                    \example\DemoGUI

                                    \example\fbactivityfetcherplugin

                                    \example\fbcontactfetcherplugin

                                    \example\fbpostproviderplugin

                                    \example\FlickrAuthApp

                                    \example\flickrcontactfetcherplugin

                                    \example\flickrgalleryplugin

                                    \example\smfclientapp

                \smf - Contains smf source code

                \smf\smfcredentialmgr - this is credential manager source code 

                \smf\smfservermodule - this is SMF server 

                                \smf\smfservermodule\smfclient

                                \smf\smfservermodule\smfserver

                                \smf\smfservermodule\smfserver\datastoremgr

                                \smf\smfservermodule\smfserver\pluginmgr

                                \smf\smfservermodule\smfserver\server

                                \smf\smfservermodule\smfserver\smfplugins

                                \smf\smfservermodule\smfserver\transportmgr

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

                                \smf\smfservermodule\util\qjson

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

Dependencies:

==============================================================================

SMF is built on Nokia_Symbian3_SDK_v0.8 and Qt 4.6.3. 

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

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

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

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

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

interfaces for end-to-end testing.

Limitations:

==============================================================================

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

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

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

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

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

    step 1 on how to overcome this.

Pre-build steps:

==============================================================================

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

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

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

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

    SDK installation folder. You are good to go now.

Building Steps :  - 

==============================================================================

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

Sample Plugins and Sample TestApp

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

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

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

Running Sample Application

==============================================================================

1. Run AuthApp - this would authenticate to Facebook.

2. Run Flickr Auth App - this would authenticate to Flickr.

3.Run project from \example\DemoGui. This should fetch names of the friends from facebook [for the user who

provided the keys in step 2 in pre-build steps] and pictures from Flickr

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

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

Public Header files

==============================================================================

Following section lists the public header files for application developers and plugin developers. Please

refer to section "SMF Interfaces and Usage" in smfhelp.chm kept in doc folder for details of the classes. 

SmfClient Header Files

==============================================================================

These are exported to \epoc32\include from \smf\smfservermodule\smfclient

	smfclient.h

	smfcontactfetcher.h

	smfpostprovider.h

	smfgallery.h

	smfrelationmgr.h

	smfmusic.h

	smfactivityfetcher.h

	smfeventsfetcher.h

SmfPlugin Header Files

==============================================================================

These are exported to \epoc32\include from \smf\smfservermodule\smfserver\smfplugins

	smfpluginbase.h

	smfproviderbase.h

	smfactivityfetcherplugin.h

	smfcontactfetcherplugin.h

	smfeventsfetcherplugin.h

	smfpostproviderplugin.h

	smflyricsserviceplugin.h

	smfmusicsearchplugin.h

	smfmusicserviceplugin.h

	smfplaylistserviceplugin.h

	smfgalleryplugin.h

SmfCommon Header Files

==============================================================================

These are exported to \epoc32\include from \smf\smfservermodule\smfcommon

	smfactions.h

	smfalbum.h

	smfartists.h

	smfcomment.h

	smfcontact.h

	smfevent.h

	smfgroup.h

	smflocation.h

	smflyrics.h

	smfmusicfingerprint.h

	smfmusicprofile.h

	smfmusicrating.h

	smfpicture.h

	smfpicturealbum.h

	smfplaylist.h

	smfpluginutil.h

	smfpost.h

	smfprovider.h

	smfsubtitle.h

	smftrackinfo.h

	smfurl.h

	smfclientglobal.h

	smfglobal.h

	smfobserver.h

SmfCredentialManager Header Files

==============================================================================

These are exported to \epoc32\include from \smf\smfcredentialmgr\smfcredmgrclient	

	smfcredmgrclient.h

	smfcredmgrclientdatastruct.h

	smfcredmgrclientglobal.h

	smfutils.h