messagingappbase/mce/inc/mceiaupdateutils.h
author hgs
Thu, 04 Nov 2010 02:02:03 +0530
changeset 81 2043ea884c04
parent 79 2981cb3aa489
permissions -rw-r--r--
201044_03
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
79
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:  
hgs
parents:
diff changeset
    15
*     Application class for Mce.
hgs
parents:
diff changeset
    16
*
hgs
parents:
diff changeset
    17
*/
hgs
parents:
diff changeset
    18
hgs
parents:
diff changeset
    19
#ifndef C_CMCEIAUPDATEUTILS_H
hgs
parents:
diff changeset
    20
#define C_CMCEIAUPDATEUTILS_H
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
// system include files go here:
hgs
parents:
diff changeset
    23
#include <e32base.h>
hgs
parents:
diff changeset
    24
#include <iaupdateobserver.h>
hgs
parents:
diff changeset
    25
hgs
parents:
diff changeset
    26
// forward declarations go here:
hgs
parents:
diff changeset
    27
class CMceUi;
hgs
parents:
diff changeset
    28
class CIAUpdate;
hgs
parents:
diff changeset
    29
class CIAUpdateParameters;
hgs
parents:
diff changeset
    30
hgs
parents:
diff changeset
    31
/**
hgs
parents:
diff changeset
    32
 *  Has utilities to help IAD aware applications to
hgs
parents:
diff changeset
    33
 *  update themselves (discover, download and install updates).
hgs
parents:
diff changeset
    34
 *
hgs
parents:
diff changeset
    35
 *  @code
hgs
parents:
diff changeset
    36
 *   const TUid KYourAppUid ={0x10005ABC};
hgs
parents:
diff changeset
    37
 *   CMceIAUpdateUtils *MsgIadUpdate = CMceIAUpdateUtils::NewL();
hgs
parents:
diff changeset
    38
 *   iMsgIadUpdate->StartL(KYourAppUid);
hgs
parents:
diff changeset
    39
 *  @endcode
hgs
parents:
diff changeset
    40
 *
hgs
parents:
diff changeset
    41
 */
hgs
parents:
diff changeset
    42
class CMceIAUpdateUtils : public CActive,
hgs
parents:
diff changeset
    43
public MIAUpdateObserver
hgs
parents:
diff changeset
    44
    {
hgs
parents:
diff changeset
    45
public:
hgs
parents:
diff changeset
    46
hgs
parents:
diff changeset
    47
    /**
hgs
parents:
diff changeset
    48
     * Two-phased constructor.
hgs
parents:
diff changeset
    49
     * @param aAppUid Uid of the app for which update needs to be checked.
hgs
parents:
diff changeset
    50
     */
hgs
parents:
diff changeset
    51
    static CMceIAUpdateUtils* NewL(CMceUi& aMceUi);
hgs
parents:
diff changeset
    52
hgs
parents:
diff changeset
    53
hgs
parents:
diff changeset
    54
    /**
hgs
parents:
diff changeset
    55
    * Destructor.
hgs
parents:
diff changeset
    56
    */
hgs
parents:
diff changeset
    57
    virtual ~CMceIAUpdateUtils();
hgs
parents:
diff changeset
    58
hgs
parents:
diff changeset
    59
    void StartL( const TUid aAppUid );
hgs
parents:
diff changeset
    60
    
hgs
parents:
diff changeset
    61
    /**
hgs
parents:
diff changeset
    62
     * Is IAD Update requried to do now
hgs
parents:
diff changeset
    63
     * @return TBool
hgs
parents:
diff changeset
    64
     * ETrue, If the KMceIADUpdateCheckRetryInterval is over after the previous try
hgs
parents:
diff changeset
    65
     * EFalse, If the KMceIADUpdateCheckRetryInterval is not over after the previous retry 
hgs
parents:
diff changeset
    66
     */
hgs
parents:
diff changeset
    67
    TBool IsUpdateRequired();
hgs
parents:
diff changeset
    68
    
hgs
parents:
diff changeset
    69
protected: 
hgs
parents:
diff changeset
    70
hgs
parents:
diff changeset
    71
     /**
hgs
parents:
diff changeset
    72
     * From CActive
hgs
parents:
diff changeset
    73
     */
hgs
parents:
diff changeset
    74
     void RunL();
hgs
parents:
diff changeset
    75
     
hgs
parents:
diff changeset
    76
     void DoCancel();  
hgs
parents:
diff changeset
    77
hgs
parents:
diff changeset
    78
private:
hgs
parents:
diff changeset
    79
	
hgs
parents:
diff changeset
    80
    /**
hgs
parents:
diff changeset
    81
     * C++ default constructor.
hgs
parents:
diff changeset
    82
     */
hgs
parents:
diff changeset
    83
    CMceIAUpdateUtils(CMceUi& aMceUi);
hgs
parents:
diff changeset
    84
hgs
parents:
diff changeset
    85
    /**
hgs
parents:
diff changeset
    86
     * By default Symbian 2nd phase constructor is private.
hgs
parents:
diff changeset
    87
     */
hgs
parents:
diff changeset
    88
    void ConstructL();
hgs
parents:
diff changeset
    89
hgs
parents:
diff changeset
    90
    /**
hgs
parents:
diff changeset
    91
     * Cleanup function.
hgs
parents:
diff changeset
    92
     */
hgs
parents:
diff changeset
    93
    void Delete();
hgs
parents:
diff changeset
    94
	
hgs
parents:
diff changeset
    95
	/**
hgs
parents:
diff changeset
    96
     * For Setting the active object active immediately.
hgs
parents:
diff changeset
    97
     */	
hgs
parents:
diff changeset
    98
	void CompleteSelf();
hgs
parents:
diff changeset
    99
	
hgs
parents:
diff changeset
   100
	/**
hgs
parents:
diff changeset
   101
     * Start IA update process.
hgs
parents:
diff changeset
   102
     * @param aAppUid Uid of the app for which update needs to be checked.
hgs
parents:
diff changeset
   103
     */
hgs
parents:
diff changeset
   104
    void DoStartL(TUid aAppUid);
hgs
parents:
diff changeset
   105
hgs
parents:
diff changeset
   106
private: // From MIAUpdateObserver
hgs
parents:
diff changeset
   107
hgs
parents:
diff changeset
   108
    /**
hgs
parents:
diff changeset
   109
     * From MIAUpdateObserver.
hgs
parents:
diff changeset
   110
     * This callback function is called when the update checking operation has
hgs
parents:
diff changeset
   111
     * completed.
hgs
parents:
diff changeset
   112
     *
hgs
parents:
diff changeset
   113
     * @param aErrorCode The error code of the observed update operation.
hgs
parents:
diff changeset
   114
     *                   KErrNone for successful completion,
hgs
parents:
diff changeset
   115
     *                   otherwise a system wide error code.
hgs
parents:
diff changeset
   116
     * @param aAvailableUpdates Number of the updates that were found available.
hgs
parents:
diff changeset
   117
     */
hgs
parents:
diff changeset
   118
    void CheckUpdatesComplete( TInt aErrorCode, TInt aAvailableUpdates );
hgs
parents:
diff changeset
   119
hgs
parents:
diff changeset
   120
hgs
parents:
diff changeset
   121
    /**
hgs
parents:
diff changeset
   122
     * From MIAUpdateObserver.
hgs
parents:
diff changeset
   123
     * This callback function is called when an update operation has completed.
hgs
parents:
diff changeset
   124
     * Even if multiple functions are provided to start different update
hgs
parents:
diff changeset
   125
     * operations, this callback function is always called after an update
hgs
parents:
diff changeset
   126
     * operation has completed.
hgs
parents:
diff changeset
   127
     *
hgs
parents:
diff changeset
   128
     * @param aErrorCode The error code of the completed update operation.
hgs
parents:
diff changeset
   129
     *                   KErrNone for successful completion,
hgs
parents:
diff changeset
   130
     *                   otherwise a system wide error code.
hgs
parents:
diff changeset
   131
     * @param aResult Details about the completed update operation.
hgs
parents:
diff changeset
   132
     *                Ownership is transferred.
hgs
parents:
diff changeset
   133
     */
hgs
parents:
diff changeset
   134
    void UpdateComplete( TInt aErrorCode, CIAUpdateResult* aResultDetails );
hgs
parents:
diff changeset
   135
hgs
parents:
diff changeset
   136
hgs
parents:
diff changeset
   137
    /**
hgs
parents:
diff changeset
   138
     * From MIAUpdateObserver.
hgs
parents:
diff changeset
   139
     * This callback function is called when an update query operation has
hgs
parents:
diff changeset
   140
     * completed.
hgs
parents:
diff changeset
   141
     *
hgs
parents:
diff changeset
   142
     * @param aErrorCode The error code of the observed query operation.
hgs
parents:
diff changeset
   143
     *                   KErrNone for successful completion,
hgs
parents:
diff changeset
   144
     *                   otherwise a system wide error code.
hgs
parents:
diff changeset
   145
     * @param aUpdateNow ETrue informs that an update operation should be started.
hgs
parents:
diff changeset
   146
     *                   EFalse informs that there is no need to start an update
hgs
parents:
diff changeset
   147
     *                   operation.
hgs
parents:
diff changeset
   148
     */
hgs
parents:
diff changeset
   149
    void UpdateQueryComplete( TInt aErrorCode, TBool aUpdateNow );
hgs
parents:
diff changeset
   150
hgs
parents:
diff changeset
   151
private: // data
hgs
parents:
diff changeset
   152
hgs
parents:
diff changeset
   153
    /**
hgs
parents:
diff changeset
   154
     * IAD update API.
hgs
parents:
diff changeset
   155
     * Own.
hgs
parents:
diff changeset
   156
     */
hgs
parents:
diff changeset
   157
    CIAUpdate* iUpdate;
hgs
parents:
diff changeset
   158
hgs
parents:
diff changeset
   159
    /**
hgs
parents:
diff changeset
   160
     * IAD update parameters.
hgs
parents:
diff changeset
   161
     * Own.
hgs
parents:
diff changeset
   162
     */
hgs
parents:
diff changeset
   163
    CIAUpdateParameters* iParameters;
hgs
parents:
diff changeset
   164
    
hgs
parents:
diff changeset
   165
    TUid 				 iAppUid;
hgs
parents:
diff changeset
   166
    
hgs
parents:
diff changeset
   167
    CMceUi&              iMceUi;
hgs
parents:
diff changeset
   168
	
hgs
parents:
diff changeset
   169
    /**
hgs
parents:
diff changeset
   170
	 * Previous IAD update check retry time
hgs
parents:
diff changeset
   171
	 */
hgs
parents:
diff changeset
   172
    TTime                iPrevIADUpdateCheckTry;
hgs
parents:
diff changeset
   173
    };
hgs
parents:
diff changeset
   174
hgs
parents:
diff changeset
   175
#endif // C_CMCEIAUPDATEUTILS_H
hgs
parents:
diff changeset
   176
hgs
parents:
diff changeset
   177
//EOF