ReadMe.txt
changeset 26 83d6a149c755
parent 25 a180113055cb
child 27 b3e1347ac96a
equal deleted inserted replaced
25:a180113055cb 26:83d6a149c755
    32 
    32 
    33                 \smf\smfservermodule\util - this contains utility classes for plugins e.g. JSON
    33                 \smf\smfservermodule\util - this contains utility classes for plugins e.g. JSON
    34                                 \smf\smfservermodule\util\qjson
    34                                 \smf\smfservermodule\util\qjson
    35 
    35 
    36                 \smf\smfsettingsui - this contains SMF settins UI [incomplete]
    36                 \smf\smfsettingsui - this contains SMF settins UI [incomplete]
       
    37                 
       
    38                 \Tests - contains test code for testing at smfclient level
    37 
    39 
    38 
    40 
    39 
    41 
    40 
    42 
    41 Dependencies:
    43 Dependencies:
    63 1. SMF uses QNetwork classes to setup proxy-settings. For testing on emulator (WINSCW), find the 
    65 1. SMF uses QNetwork classes to setup proxy-settings. For testing on emulator (WINSCW), find the 
    64     hardcoded value under compiler switch "EMULATORTESTING" in file smftransportmanagerutil.cpp. 
    66     hardcoded value under compiler switch "EMULATORTESTING" in file smftransportmanagerutil.cpp. 
    65     If your proxy requires authentication, provide "<username> space <password>" in plaintext in a file 
    67     If your proxy requires authentication, provide "<username> space <password>" in plaintext in a file 
    66     "DoNotShare.txt" and place this file in "C:/Data/" - which is at "\epoc32\winscw\c\data" under your 
    68     "DoNotShare.txt" and place this file in "C:/Data/" - which is at "\epoc32\winscw\c\data" under your 
    67     SDK installation folder. You are good to go now.
    69     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
       
    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
       
    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 
       
    73 http://wiki.developers.facebook.com/index.php/Authorization_and_Authentication_for_Desktop_Applications
       
    74 We are integrating plugins with CredentialMgr, so these painful steps won't be required once it is up.
       
    75 
       
    76 
    70 
    77 
    71 
    78 Building Steps :  - 
    72 Building Steps :  - 
    79 ==============================================================================
    73 ==============================================================================
    80 1. Use smfrepo.pro present in top level to build. This single pro file builds SmfServer, SmfCredMgr, SmfClient,
    74 1. Use smfrepo.pro present in top level to build. This single pro file builds SmfServer, SmfCredMgr, SmfClient,
   167 	smfcredmgrclient.h
   161 	smfcredmgrclient.h
   168 	smfcredmgrclientdatastruct.h
   162 	smfcredmgrclientdatastruct.h
   169 	smfcredmgrclientglobal.h
   163 	smfcredmgrclientglobal.h
   170 	smfutils.h
   164 	smfutils.h
   171 	smfcredmgrcommon.h
   165 	smfcredmgrcommon.h
       
   166 	
       
   167 	
       
   168 Observed Dependencies
       
   169 ==============================================================================
       
   170 The authentication applications are loading web pages through Qt Webkit and hence its performance depends 
       
   171 on your network speed and response from the service provider. So if the page taken time to load please be 
       
   172 patient enough till loading is completed.
       
   173 
       
   174 
       
   175 
       
   176 Using Test Applications
       
   177 ==============================================================================
       
   178 1) For testing individual interfaces, build the test applications provided (they are console bases applications). 
       
   179 Start the eshell and start individual application from eshell.
       
   180 
       
   181 2) For using test applications used to test SMF from Multiple client application, use the CrossTest1 and CrossTest2 
       
   182 applications. Build both and from the emulator start CrossTest1.exe (which in turn will send the request and 
       
   183 starts CrossTest2 immediately after sending the request to SMF.