epoc32/include/SyncMLContactSuiteProgressClient.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
     1 /*
     2 * Copyright (c) 2002-2004 Nokia Corporation and/or its subsidiary(-ies). 
     3 * All rights reserved.
     4 * This component and the accompanying materials are made available
     5 * under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     6 * which accompanies this distribution, and is available
     7 * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     8 *
     9 * Initial Contributors:
    10 * Nokia Corporation - initial contribution.
    11 *
    12 * Contributors:
    13 *
    14 * Description: Sync session progress notification.
    15 *
    16 */
    17 
    18 #ifndef __SYNCMLCONTACTSUITEPROGRESSCLIENT_H__
    19 #define __SYNCMLCONTACTSUITEPROGRESSCLIENT_H__
    20 //
    21 #include <e32std.h>
    22 #include <badesca.h>
    23 #include <SyncMLDef.h>
    24 #include <SyncMLHistory.h>
    25 #include <SyncMLClient.h>
    26 //
    27 class MSyncMLProgressObserver;
    28 class CSmlContactSuiteActiveCallback;
    29 //
    30 
    31 ///////////////////////////////////////////////////////////////////////////////
    32 // RContactSuiteSyncMLSession
    33 ///////////////////////////////////////////////////////////////////////////////
    34 /**
    35 	A client handle to a SyncML Sync Agent session and to listen the sync 
    36 	progress notifications.
    37 
    38 	An instance of this class must be created in order to instantiate any of 
    39 	the other client-side classes.
    40 
    41 	Accessor methods are provided to enable clients to retrieve identifiers 
    42 	of current and queued jobs, and of available profiles, transports, and 
    43 	data providers. These IDs can be used to open handles on these objects 
    44 	in order to manipulate them.
    45 
    46 	Clients can request notifications of events related to jobs, profiles, transports,
    47 	and the SyncML Agent, and can request progress for the currently running job.
    48 	@publishedAll
    49 	@released
    50 */
    51 class RContactSuiteSyncMLSession:public RSyncMLSession
    52     {    
    53 public:    
    54     IMPORT_C void CloseContactSuiteSession();
    55     IMPORT_C void RequestContactSuiteProgressL(  TInt aProfileId, MSyncMLProgressObserver& aProgressObserver );    
    56 
    57 private:
    58     CSmlContactSuiteActiveCallback *iContactSuiteCallBack;    
    59     };
    60 
    61 ///////////////////////////////////////////////////////////////////////////////
    62 ///////////////////////////////////////////////////////////////////////////////
    63 ///////////////////////////////////////////////////////////////////////////////
    64 #endif