epoc32/include/sipconcreteprofileobserver.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
permissions -rw-r--r--
Final list of Symbian^2 public API header files

/*
* Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).
* All rights reserved.
* This component and the accompanying materials are made available
* 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
* which accompanies this distribution, and is available
* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
*
* Initial Contributors:
* Nokia Corporation - initial contribution.
*
* Contributors:
*
* Description:
* Name        : sipconcreteprofileobserver.h
* Part of     : SIP Profile Client
* Interface   : private
* The observer class that must be implemented by users of 
* CSIPConcreteProfile
* Version     : 1.0
*
*/



#ifndef MSIPCONCRETEPROFILEOBSERVER_H
#define MSIPCONCRETEPROFILEOBSERVER_H

//  INCLUDES

#include <e32base.h>

// FORWARD DECLARATIONS


// CLASS DECLARATION
/**
* @publishedAll
* @released
*
* Observer class to be implemented by users of CSIPConcreteProfile
* It provides event notifications related to profiles.
*/
class MSIPConcreteProfileObserver
    {
    public:

        /**
        * SIP profile registration status changed event
        * Event is send to those observers, who have the
        * corresponding profile instantiated.
        * @param aProfileId id of profile which registration 
        *        status has been changed.
        * @param aStatus new status of the profile
        * @param aStatusId id related to registration
        */
        virtual void RegistrationStatusChangedL(
            TUint32 aProfileId, 
            TInt aStatus,
            TUint32 aStatusId) = 0;

        /** 
        * SIP profile creation event.
        * Event is send to all observers.
        * @param aProfileId id of new SIP Profile
        */
        virtual void AddedL(TUint32 aProfileId) = 0;

        /**
        * SIP profile destruction event.
        * Event is send to those observers, who have the
        * corresponding profile instantiated.
        * @param aProfileId id of profile which was destroyed
        */        
        virtual void RemovedL(TUint32 aProfileId) = 0;

        /** 
        * SIP profile information update event
        * Event is send to those observers, who have the
        * corresponding profile instantiated.
        * @param aProfileId id of updated SIP Profile
        * @param aSize size of updated SIP Profile
        */
        virtual void UpdatedL(TUint32 aProfileId, TUint aSize) = 0;

        /**
        * An asynchronous error has occurred related to SIP profile
        * Event is send to those observers, who have the
        * corresponding profile instantiated.
        * @param aProfileId the id of failed profile 
        * @param aStatus status indicating if error occurred
        *          during registering (ERegistrationInProgress)
        *          or deregistering (EUnregistrationInProgress)
        * @param aError a error code
        */
        virtual void ErrorOccurredL(
            TUint32 aProfileId,
            TInt aStatus,
            TInt aError) = 0;
    };

#endif // MSIPCONCRETEPROFILEOBSERVER_H