epoc32/include/mw/sipprofilealrobserver.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:27:01 +0100
branchSymbian2
changeset 3 e1b950c65cb4
parent 2 epoc32/include/sipprofilealrobserver.h@2fe1408b6811
child 4 837f303aceeb
permissions -rw-r--r--
Attempt to represent the S^2->S^3 header reorganisation as a series of "hg rename" operations
     1 /*
     2 * Copyright (c) 2007-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 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:
    15 * Name          : sipprofilealrobserver.h
    16 * Part of       : SIP / SIP Profile Agent
    17 * Version       : SIP/6.0 
    18 *
    19 */
    20 
    21 
    22 
    23 #ifndef MSIPPROFILEALROBSERVER_H
    24 #define MSIPPROFILEALROBSERVER_H
    25 
    26 // INCLUDES
    27 #include <e32std.h>
    28 
    29 // CLASS DECLARATION
    30 /**
    31 * @publishedAll
    32 * @released
    33 *
    34 * Callback to receive notifications about ALR (Application Level Roaming) 
    35 * related events and errors.
    36 */
    37 class MSipProfileAlrObserver
    38     {
    39     public:
    40     
    41         /** SIP Profile ALR events */
    42         enum TEvent
    43             {
    44              /** 
    45             * A new IAP became available.
    46             * When receiving this event the client must call 
    47             * CSipProfileAlrController::AllowMigrationL or DisallowMigrationL.
    48             */           
    49             EIapAvailable = 0,
    50             /** 
    51             * All the clients have allowed the migration to the new IAP and
    52             * the migration to the new IAP for the SIP profile has started. 
    53             */
    54             EMigrationStarted,
    55             /** 
    56             * Migration to a new IAP for a SIP profile has been completed and
    57             * the related SIP profile has been registered via the new IAP.
    58             */
    59             EMigrationCompleted
    60             };
    61                                    
    62         /**
    63         * ALR related event occurred.
    64         * @param aEvent the event that occurred
    65         * @param aProfileId identifies the SIP profile related to the event
    66         * @param aSnapId the SNAP related to the event
    67         * @param aIapId the IAP related to the event
    68         */
    69         virtual void AlrEvent( TEvent aEvent,
    70                                TUint32 aProfileId,
    71                                TUint32 aSnapId,
    72                                TUint32 aIapId ) = 0;
    73                                
    74         /**
    75         * ALR related error occurred.
    76         * @param aError the error that occurred
    77         * @param aProfileId identifies the SIP profile related to the error
    78         * @param aSnapId the SNAP related to the error
    79         * @param aIapId the IAP related to the error
    80         */
    81         virtual void AlrError( TInt aError,
    82                                TUint32 aProfileId,
    83                                TUint32 aSnapId,
    84                                TUint32 aIapId ) = 0;                                                                  
    85     };
    86 
    87 #endif // MSIPPROFILEALROBSERVER_H