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