epoc32/include/sipconcreteprofileobserver.h
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
     1.1 --- a/epoc32/include/sipconcreteprofileobserver.h	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/sipconcreteprofileobserver.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,102 @@
     1.4 -sipconcreteprofileobserver.h
     1.5 +/*
     1.6 +* Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.7 +* All rights reserved.
     1.8 +* This component and the accompanying materials are made available
     1.9 +* 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.10 +* which accompanies this distribution, and is available
    1.11 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.12 +*
    1.13 +* Initial Contributors:
    1.14 +* Nokia Corporation - initial contribution.
    1.15 +*
    1.16 +* Contributors:
    1.17 +*
    1.18 +* Description:
    1.19 +* Name        : sipconcreteprofileobserver.h
    1.20 +* Part of     : SIP Profile Client
    1.21 +* Interface   : private
    1.22 +* The observer class that must be implemented by users of 
    1.23 +* CSIPConcreteProfile
    1.24 +* Version     : 1.0
    1.25 +*
    1.26 +*/
    1.27 +
    1.28 +
    1.29 +
    1.30 +#ifndef MSIPCONCRETEPROFILEOBSERVER_H
    1.31 +#define MSIPCONCRETEPROFILEOBSERVER_H
    1.32 +
    1.33 +//  INCLUDES
    1.34 +
    1.35 +#include <e32base.h>
    1.36 +
    1.37 +// FORWARD DECLARATIONS
    1.38 +
    1.39 +
    1.40 +// CLASS DECLARATION
    1.41 +/**
    1.42 +* @publishedAll
    1.43 +* @released
    1.44 +*
    1.45 +* Observer class to be implemented by users of CSIPConcreteProfile
    1.46 +* It provides event notifications related to profiles.
    1.47 +*/
    1.48 +class MSIPConcreteProfileObserver
    1.49 +    {
    1.50 +    public:
    1.51 +
    1.52 +        /**
    1.53 +        * SIP profile registration status changed event
    1.54 +        * Event is send to those observers, who have the
    1.55 +        * corresponding profile instantiated.
    1.56 +        * @param aProfileId id of profile which registration 
    1.57 +        *        status has been changed.
    1.58 +        * @param aStatus new status of the profile
    1.59 +        * @param aStatusId id related to registration
    1.60 +        */
    1.61 +        virtual void RegistrationStatusChangedL(
    1.62 +            TUint32 aProfileId, 
    1.63 +            TInt aStatus,
    1.64 +            TUint32 aStatusId) = 0;
    1.65 +
    1.66 +        /** 
    1.67 +        * SIP profile creation event.
    1.68 +        * Event is send to all observers.
    1.69 +        * @param aProfileId id of new SIP Profile
    1.70 +        */
    1.71 +        virtual void AddedL(TUint32 aProfileId) = 0;
    1.72 +
    1.73 +        /**
    1.74 +        * SIP profile destruction event.
    1.75 +        * Event is send to those observers, who have the
    1.76 +        * corresponding profile instantiated.
    1.77 +        * @param aProfileId id of profile which was destroyed
    1.78 +        */        
    1.79 +        virtual void RemovedL(TUint32 aProfileId) = 0;
    1.80 +
    1.81 +        /** 
    1.82 +        * SIP profile information update event
    1.83 +        * Event is send to those observers, who have the
    1.84 +        * corresponding profile instantiated.
    1.85 +        * @param aProfileId id of updated SIP Profile
    1.86 +        * @param aSize size of updated SIP Profile
    1.87 +        */
    1.88 +        virtual void UpdatedL(TUint32 aProfileId, TUint aSize) = 0;
    1.89 +
    1.90 +        /**
    1.91 +        * An asynchronous error has occurred related to SIP profile
    1.92 +        * Event is send to those observers, who have the
    1.93 +        * corresponding profile instantiated.
    1.94 +        * @param aProfileId the id of failed profile 
    1.95 +        * @param aStatus status indicating if error occurred
    1.96 +        *          during registering (ERegistrationInProgress)
    1.97 +        *          or deregistering (EUnregistrationInProgress)
    1.98 +        * @param aError a error code
    1.99 +        */
   1.100 +        virtual void ErrorOccurredL(
   1.101 +            TUint32 aProfileId,
   1.102 +            TInt aStatus,
   1.103 +            TInt aError) = 0;
   1.104 +    };
   1.105 +
   1.106 +#endif // MSIPCONCRETEPROFILEOBSERVER_H