1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/epoc32/include/sipprofilealrobserver.h Tue Mar 16 16:12:26 2010 +0000
1.3 @@ -0,0 +1,87 @@
1.4 +/*
1.5 +* Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).
1.6 +* All rights reserved.
1.7 +* This component and the accompanying materials are made available
1.8 +* 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
1.9 +* which accompanies this distribution, and is available
1.10 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.11 +*
1.12 +* Initial Contributors:
1.13 +* Nokia Corporation - initial contribution.
1.14 +*
1.15 +* Contributors:
1.16 +*
1.17 +* Description:
1.18 +* Name : sipprofilealrobserver.h
1.19 +* Part of : SIP / SIP Profile Agent
1.20 +* Version : SIP/6.0
1.21 +*
1.22 +*/
1.23 +
1.24 +
1.25 +
1.26 +#ifndef MSIPPROFILEALROBSERVER_H
1.27 +#define MSIPPROFILEALROBSERVER_H
1.28 +
1.29 +// INCLUDES
1.30 +#include <e32std.h>
1.31 +
1.32 +// CLASS DECLARATION
1.33 +/**
1.34 +* @publishedAll
1.35 +* @released
1.36 +*
1.37 +* Callback to receive notifications about ALR (Application Level Roaming)
1.38 +* related events and errors.
1.39 +*/
1.40 +class MSipProfileAlrObserver
1.41 + {
1.42 + public:
1.43 +
1.44 + /** SIP Profile ALR events */
1.45 + enum TEvent
1.46 + {
1.47 + /**
1.48 + * A new IAP became available.
1.49 + * When receiving this event the client must call
1.50 + * CSipProfileAlrController::AllowMigrationL or DisallowMigrationL.
1.51 + */
1.52 + EIapAvailable = 0,
1.53 + /**
1.54 + * All the clients have allowed the migration to the new IAP and
1.55 + * the migration to the new IAP for the SIP profile has started.
1.56 + */
1.57 + EMigrationStarted,
1.58 + /**
1.59 + * Migration to a new IAP for a SIP profile has been completed and
1.60 + * the related SIP profile has been registered via the new IAP.
1.61 + */
1.62 + EMigrationCompleted
1.63 + };
1.64 +
1.65 + /**
1.66 + * ALR related event occurred.
1.67 + * @param aEvent the event that occurred
1.68 + * @param aProfileId identifies the SIP profile related to the event
1.69 + * @param aSnapId the SNAP related to the event
1.70 + * @param aIapId the IAP related to the event
1.71 + */
1.72 + virtual void AlrEvent( TEvent aEvent,
1.73 + TUint32 aProfileId,
1.74 + TUint32 aSnapId,
1.75 + TUint32 aIapId ) = 0;
1.76 +
1.77 + /**
1.78 + * ALR related error occurred.
1.79 + * @param aError the error that occurred
1.80 + * @param aProfileId identifies the SIP profile related to the error
1.81 + * @param aSnapId the SNAP related to the error
1.82 + * @param aIapId the IAP related to the error
1.83 + */
1.84 + virtual void AlrError( TInt aError,
1.85 + TUint32 aProfileId,
1.86 + TUint32 aSnapId,
1.87 + TUint32 aIapId ) = 0;
1.88 + };
1.89 +
1.90 +#endif // MSIPPROFILEALROBSERVER_H