ReadMe.txt
author cgandhi
Tue, 12 Oct 2010 15:23:52 +0530
changeset 27 b3e1347ac96a
parent 26 83d6a149c755
permissions -rw-r--r--
Updating the information for test applications and results.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
14
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
     1
Content:
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
     2
==============================================================================
27
b3e1347ac96a Updating the information for test applications and results.
cgandhi
parents: 26
diff changeset
     3
This is beta version of Social Mobile Framework code. 
b3e1347ac96a Updating the information for test applications and results.
cgandhi
parents: 26
diff changeset
     4
b3e1347ac96a Updating the information for test applications and results.
cgandhi
parents: 26
diff changeset
     5
Folder organization is as follows - 
14
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
     6
                Doxyfile - Doxygen configuration file 
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
     7
25
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
     8
                \doc - contains smfhelp.chm file, refer this for interface information
14
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
     9
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    10
                \example - contains sample plugins, auth application and client test application
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    11
                                    \example\AuthApp
20
f59934f5c7ac pushing the changes for demoGui
cgandhi
parents: 19
diff changeset
    12
                                    \example\DemoGUI
19
c412f0526c34 pushing readme changes
cgandhi
parents: 14
diff changeset
    13
                                    \example\fbactivityfetcherplugin
14
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    14
                                    \example\fbcontactfetcherplugin
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    15
                                    \example\fbpostproviderplugin
19
c412f0526c34 pushing readme changes
cgandhi
parents: 14
diff changeset
    16
                                    \example\FlickrAuthApp
14
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    17
                                    \example\flickrcontactfetcherplugin
19
c412f0526c34 pushing readme changes
cgandhi
parents: 14
diff changeset
    18
                                    \example\flickrgalleryplugin
14
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    19
                                    \example\smfclientapp
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    20
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    21
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    22
                \smf - Contains smf source code
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    23
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    24
                \smf\smfcredentialmgr - this is credential manager source code 
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    25
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    26
                \smf\smfservermodule - this is SMF server 
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    27
                                \smf\smfservermodule\smfclient
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    28
                                \smf\smfservermodule\smfserver
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    29
                                \smf\smfservermodule\smfserver\datastoremgr
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    30
                                \smf\smfservermodule\smfserver\pluginmgr
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    31
                                \smf\smfservermodule\smfserver\server
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    32
                                \smf\smfservermodule\smfserver\smfplugins
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    33
                                \smf\smfservermodule\smfserver\transportmgr
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    34
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    35
                \smf\smfservermodule\util - this contains utility classes for plugins e.g. JSON
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    36
                                \smf\smfservermodule\util\qjson
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    37
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    38
                \smf\smfsettingsui - this contains SMF settins UI [incomplete]
26
83d6a149c755 Submitting following changes -
cgandhi
parents: 25
diff changeset
    39
                
27
b3e1347ac96a Updating the information for test applications and results.
cgandhi
parents: 26
diff changeset
    40
                \Tests - contains test cases and test code for testing at smfclient level
b3e1347ac96a Updating the information for test applications and results.
cgandhi
parents: 26
diff changeset
    41
					\Smf_functional_test_cases_v0.2.xls
14
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    42
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    43
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    44
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    45
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    46
Dependencies:
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    47
==============================================================================
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    48
SMF is built on Nokia_Symbian3_SDK_v0.8 and Qt 4.6.3. 
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    49
You would need to install qt-mobility-symbian-opensource-1.0.0. 
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    50
To enable building of SMF in public SDK, the unified key store (RSA Signing) related code is 
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    51
blocked with compiler switch. Use Symbian^3 PDK if you want to enable this feature.
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    52
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    53
Main Interfaces that can be tested end-to-end using this set-up are ContactsFetcher and 
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    54
SmfPost. Though framework code is available, plugins are yet to be available for other service 
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    55
interfaces for end-to-end testing.
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    56
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    57
Limitations:
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    58
==============================================================================
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    59
1. Support for Non-Symbian (Desktop) version of Qt is not supported at this moment.
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    60
2. Integration of Authentication Application with Credential Manager is not complete at the moment. 
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    61
    So sample plugins require some hacks to access application information for Facebook and Flickr. 
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    62
    Please see pre-build step 2 on how to achieve this.
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    63
3. SMFSettingsUI is not complete at this moment. This impacts network proxy settings. See pre-build
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    64
    step 1 on how to overcome this.
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    65
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    66
Pre-build steps:
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    67
==============================================================================
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    68
1. SMF uses QNetwork classes to setup proxy-settings. For testing on emulator (WINSCW), find the 
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    69
    hardcoded value under compiler switch "EMULATORTESTING" in file smftransportmanagerutil.cpp. 
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    70
    If your proxy requires authentication, provide "<username> space <password>" in plaintext in a file 
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    71
    "DoNotShare.txt" and place this file in "C:/Data/" - which is at "\epoc32\winscw\c\data" under your 
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    72
    SDK installation folder. You are good to go now.
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    73
25
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
    74
14
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    75
Building Steps :  - 
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    76
==============================================================================
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    77
1. Use smfrepo.pro present in top level to build. This single pro file builds SmfServer, SmfCredMgr, SmfClient,
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    78
Sample Plugins and Sample TestApp
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    79
2. To test on emulator (WINSCW) you can run smfclientapp.exe.
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    80
3. QJson requires high capability, so testing on device would require appropriate cerificatres for signing. 
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    81
see https://www.symbiansigned.com/app/page
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    82
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    83
Running Sample Application
a469c0e6e7fb changes for SmfPost, SmfCredentialMgr, PLuginManager, SmfServer. Adding Sample Plugins and Sample Client Applications.
cgandhi <chandradeep.gandhi@sasken.com>
parents:
diff changeset
    84
==============================================================================
20
f59934f5c7ac pushing the changes for demoGui
cgandhi
parents: 19
diff changeset
    85
1. Run AuthApp - this would authenticate to Facebook.
f59934f5c7ac pushing the changes for demoGui
cgandhi
parents: 19
diff changeset
    86
2. Run Flickr Auth App - this would authenticate to Flickr.
f59934f5c7ac pushing the changes for demoGui
cgandhi
parents: 19
diff changeset
    87
3.Run project from \example\DemoGui. This should fetch names of the friends from facebook [for the user who
f59934f5c7ac pushing the changes for demoGui
cgandhi
parents: 19
diff changeset
    88
provided the keys in step 2 in pre-build steps] and pictures from Flickr
f59934f5c7ac pushing the changes for demoGui
cgandhi
parents: 19
diff changeset
    89
4. The results might not show properly on UI due to problems in S^3 SDK for Webkit. However textual result can be viewed
f59934f5c7ac pushing the changes for demoGui
cgandhi
parents: 19
diff changeset
    90
at the generated log file - \epoc32\winscw\c\data\SmfLogs.txt
25
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
    91
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
    92
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
    93
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
    94
Public Header files
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
    95
==============================================================================
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
    96
Following section lists the public header files for application developers and plugin developers. Please
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
    97
refer to section "SMF Interfaces and Usage" in smfhelp.chm kept in doc folder for details of the classes. 
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
    98
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
    99
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   100
SmfClient Header Files
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   101
==============================================================================
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   102
These are exported to \epoc32\include from \smf\smfservermodule\smfclient
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   103
	smfclient.h
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   104
	smfcontactfetcher.h
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   105
	smfpostprovider.h
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   106
	smfgallery.h
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   107
	smfrelationmgr.h
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   108
	smfmusic.h
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   109
	smfactivityfetcher.h
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   110
	smfeventsfetcher.h
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   111
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   112
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   113
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   114
SmfPlugin Header Files
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   115
==============================================================================
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   116
These are exported to \epoc32\include from \smf\smfservermodule\smfserver\smfplugins
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   117
	smfpluginbase.h
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   118
	smfproviderbase.h
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   119
	smfactivityfetcherplugin.h
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   120
	smfcontactfetcherplugin.h
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   121
	smfeventsfetcherplugin.h
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   122
	smfpostproviderplugin.h
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   123
	smflyricsserviceplugin.h
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   124
	smfmusicsearchplugin.h
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   125
	smfmusicserviceplugin.h
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   126
	smfplaylistserviceplugin.h
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   127
	smfgalleryplugin.h
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   128
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   129
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   130
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   131
SmfCommon Header Files
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   132
==============================================================================
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   133
These are exported to \epoc32\include from \smf\smfservermodule\smfcommon
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   134
	smfactions.h
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   135
	smfalbum.h
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   136
	smfartists.h
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   137
	smfcomment.h
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   138
	smfcontact.h
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   139
	smfevent.h
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   140
	smfgroup.h
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   141
	smflocation.h
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   142
	smflyrics.h
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   143
	smfmusicfingerprint.h
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   144
	smfmusicprofile.h
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   145
	smfmusicrating.h
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   146
	smfpicture.h
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   147
	smfpicturealbum.h
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   148
	smfplaylist.h
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   149
	smfpluginutil.h
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   150
	smfpost.h
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   151
	smfprovider.h
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   152
	smfsubtitle.h
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   153
	smftrackinfo.h
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   154
	smfurl.h
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   155
	smfclientglobal.h
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   156
	smfglobal.h
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   157
	smfobserver.h
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   158
	
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   159
	
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   160
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   161
SmfCredentialManager Header Files
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   162
==============================================================================
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   163
These are exported to \epoc32\include from \smf\smfcredentialmgr\smfcredmgrclient	
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   164
	smfcredmgrclient.h
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   165
	smfcredmgrclientdatastruct.h
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   166
	smfcredmgrclientglobal.h
a180113055cb Music Events are now normal Fetcher APIs added
cgandhi
parents: 20
diff changeset
   167
	smfutils.h
26
83d6a149c755 Submitting following changes -
cgandhi
parents: 25
diff changeset
   168
	smfcredmgrcommon.h
83d6a149c755 Submitting following changes -
cgandhi
parents: 25
diff changeset
   169
	
83d6a149c755 Submitting following changes -
cgandhi
parents: 25
diff changeset
   170
	
83d6a149c755 Submitting following changes -
cgandhi
parents: 25
diff changeset
   171
Observed Dependencies
83d6a149c755 Submitting following changes -
cgandhi
parents: 25
diff changeset
   172
==============================================================================
83d6a149c755 Submitting following changes -
cgandhi
parents: 25
diff changeset
   173
The authentication applications are loading web pages through Qt Webkit and hence its performance depends 
27
b3e1347ac96a Updating the information for test applications and results.
cgandhi
parents: 26
diff changeset
   174
on your network speed and response from the service provider. In a slow connection scenario please be 
b3e1347ac96a Updating the information for test applications and results.
cgandhi
parents: 26
diff changeset
   175
patient while the page loading is completed.
26
83d6a149c755 Submitting following changes -
cgandhi
parents: 25
diff changeset
   176
83d6a149c755 Submitting following changes -
cgandhi
parents: 25
diff changeset
   177
83d6a149c755 Submitting following changes -
cgandhi
parents: 25
diff changeset
   178
83d6a149c755 Submitting following changes -
cgandhi
parents: 25
diff changeset
   179
Using Test Applications
83d6a149c755 Submitting following changes -
cgandhi
parents: 25
diff changeset
   180
==============================================================================
27
b3e1347ac96a Updating the information for test applications and results.
cgandhi
parents: 26
diff changeset
   181
For testing individual interfaces, build the test applications provided (they are console bases applications). 
26
83d6a149c755 Submitting following changes -
cgandhi
parents: 25
diff changeset
   182
Start the eshell and start individual application from eshell.
83d6a149c755 Submitting following changes -
cgandhi
parents: 25
diff changeset
   183
27
b3e1347ac96a Updating the information for test applications and results.
cgandhi
parents: 26
diff changeset
   184
b3e1347ac96a Updating the information for test applications and results.
cgandhi
parents: 26
diff changeset
   185
b3e1347ac96a Updating the information for test applications and results.
cgandhi
parents: 26
diff changeset
   186
Maturity Information
b3e1347ac96a Updating the information for test applications and results.
cgandhi
parents: 26
diff changeset
   187
==============================================================================
b3e1347ac96a Updating the information for test applications and results.
cgandhi
parents: 26
diff changeset
   188
This release has been tested with plug-ins written for Facebook, Flickr, Last.fm, Lyricsfly.com
b3e1347ac96a Updating the information for test applications and results.
cgandhi
parents: 26
diff changeset
   189
However these plugins are far from complete in terms of full funtionality support. As a result 
b3e1347ac96a Updating the information for test applications and results.
cgandhi
parents: 26
diff changeset
   190
there are quite a few cases failing as shown in the summary below - 
b3e1347ac96a Updating the information for test applications and results.
cgandhi
parents: 26
diff changeset
   191
TOTAL			171
b3e1347ac96a Updating the information for test applications and results.
cgandhi
parents: 26
diff changeset
   192
PASSED		58	   
b3e1347ac96a Updating the information for test applications and results.
cgandhi
parents: 26
diff changeset
   193
FAILED		75	   
b3e1347ac96a Updating the information for test applications and results.
cgandhi
parents: 26
diff changeset
   194
NOT TESTED		19	   
b3e1347ac96a Updating the information for test applications and results.
cgandhi
parents: 26
diff changeset
   195
NOT IMPLEMENTED	19	   
b3e1347ac96a Updating the information for test applications and results.
cgandhi
parents: 26
diff changeset
   196
Please see detials of the test cases under socialmobilefw\Tests\Smf_functional_test_cases_v0.2.xls
b3e1347ac96a Updating the information for test applications and results.
cgandhi
parents: 26
diff changeset
   197
		 
b3e1347ac96a Updating the information for test applications and results.
cgandhi
parents: 26
diff changeset
   198
The failed cases which are not contributed only towards limitations of Plugins, are raised as bugs 
b3e1347ac96a Updating the information for test applications and results.
cgandhi
parents: 26
diff changeset
   199
Bug 3810 -
b3e1347ac96a Updating the information for test applications and results.
cgandhi
parents: 26
diff changeset
   200
Bug 3811 - 
b3e1347ac96a Updating the information for test applications and results.
cgandhi
parents: 26
diff changeset
   201
Bug 3812 -
b3e1347ac96a Updating the information for test applications and results.
cgandhi
parents: 26
diff changeset
   202
Bug 3813 - 
b3e1347ac96a Updating the information for test applications and results.
cgandhi
parents: 26
diff changeset
   203
b3e1347ac96a Updating the information for test applications and results.
cgandhi
parents: 26
diff changeset
   204
b3e1347ac96a Updating the information for test applications and results.
cgandhi
parents: 26
diff changeset
   205
The work is ongoing to bridge the gaps in test-plugins for full funtional tests.