realtimenetprots/sipfw/ProfileAgent/Server/Src/sipalrmigrationobserver.h
changeset 0 307788aac0a8
equal deleted inserted replaced
-1:000000000000 0:307788aac0a8
       
     1 /*
       
     2 * Copyright (c) 2008-2009 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 "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:
       
    15 * Name          : sipalrmigrationobserver.h
       
    16 * Part of       : SIP / SIP Profile Server
       
    17 * Version       : SIP/6.0 
       
    18 *
       
    19 */
       
    20 
       
    21 
       
    22 
       
    23 
       
    24 /**
       
    25  @internalComponent
       
    26 */
       
    27 
       
    28 #ifndef MSIPALRMIGRATIONOBSERVER_H
       
    29 #define MSIPALRMIGRATIONOBSERVER_H
       
    30 
       
    31 // INCLUDES
       
    32 #include <e32base.h>
       
    33 
       
    34 // FORWARD DECLARATIONS
       
    35 
       
    36 // CLASS DECLARATION
       
    37 /**
       
    38 * Callback implemented by the users of CSipAlrMigrationController
       
    39 *
       
    40 * @lib sipsrofilesrv.exe
       
    41 */
       
    42 class MSipAlrMigrationObserver
       
    43 	{
       
    44 	public:
       
    45 		/**
       
    46 		* A new IAP has became available.
       
    47 		* A class implementing MSipAlrMigrationObserver must not ignore this
       
    48 		* callback. It must either use
       
    49 		* CSipAlrMigrationController::SetMigrationPermission, or forward the
       
    50 		* IapAvailable event to client.
       
    51 		* @param aSnapId a SNAP id.
       
    52 		* @param aNewIapId an IAP id. 
       
    53 		*/
       
    54 		virtual void IapAvailable(TUint32 aSnapId, TUint32 aNewIapId) = 0;
       
    55 
       
    56 		/**
       
    57         * The overall result to migrating to aIapId is allowed.
       
    58         * @param aIapId IAP id
       
    59         */
       
    60         virtual void MigrationIsAllowedL(TUint32 aIapId) = 0;
       
    61 
       
    62 		/**
       
    63         * The overall result to migrating to aIapId is disallowed.
       
    64         * @param aIapId IAP id
       
    65         */
       
    66         virtual void MigrationIsDisallowedL(TUint32 aIapId) = 0;
       
    67 
       
    68 		/**
       
    69         * Leave occurred from one of the callbacks of MSipAlrMigrationObserver.       
       
    70         * @param aError Leave code
       
    71         */
       
    72         virtual void ErrorOccurred(TInt aError) = 0;
       
    73 
       
    74         /**
       
    75         * No new IAP available in the SNAP
       
    76         */
       
    77         virtual void NoNewIapAvailable() = 0;
       
    78 
       
    79 		/**
       
    80         * Refreshing IAPs of the SNAP failed.
       
    81         */
       
    82         virtual void RefreshIAPsFailed() = 0;
       
    83 
       
    84 		/**
       
    85         * The user has rejected the offered IAP
       
    86         */
       
    87         virtual void OfferedIapRejected() = 0;
       
    88     };
       
    89 
       
    90 #endif // MSIPALRMIGRATIONOBSERVER_H