epoc32/include/mw/sipconcreteprofileobserver.h
branchSymbian2
changeset 3 e1b950c65cb4
parent 2 2fe1408b6811
child 4 837f303aceeb
equal deleted inserted replaced
2:2fe1408b6811 3:e1b950c65cb4
       
     1 /*
       
     2 * Copyright (c) 2003-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        : sipconcreteprofileobserver.h
       
    16 * Part of     : SIP Profile Client
       
    17 * Interface   : private
       
    18 * The observer class that must be implemented by users of 
       
    19 * CSIPConcreteProfile
       
    20 * Version     : 1.0
       
    21 *
       
    22 */
       
    23 
       
    24 
       
    25 
       
    26 #ifndef MSIPCONCRETEPROFILEOBSERVER_H
       
    27 #define MSIPCONCRETEPROFILEOBSERVER_H
       
    28 
       
    29 //  INCLUDES
       
    30 
       
    31 #include <e32base.h>
       
    32 
       
    33 // FORWARD DECLARATIONS
       
    34 
       
    35 
       
    36 // CLASS DECLARATION
       
    37 /**
       
    38 * @publishedAll
       
    39 * @released
       
    40 *
       
    41 * Observer class to be implemented by users of CSIPConcreteProfile
       
    42 * It provides event notifications related to profiles.
       
    43 */
       
    44 class MSIPConcreteProfileObserver
       
    45     {
       
    46     public:
       
    47 
       
    48         /**
       
    49         * SIP profile registration status changed event
       
    50         * Event is send to those observers, who have the
       
    51         * corresponding profile instantiated.
       
    52         * @param aProfileId id of profile which registration 
       
    53         *        status has been changed.
       
    54         * @param aStatus new status of the profile
       
    55         * @param aStatusId id related to registration
       
    56         */
       
    57         virtual void RegistrationStatusChangedL(
       
    58             TUint32 aProfileId, 
       
    59             TInt aStatus,
       
    60             TUint32 aStatusId) = 0;
       
    61 
       
    62         /** 
       
    63         * SIP profile creation event.
       
    64         * Event is send to all observers.
       
    65         * @param aProfileId id of new SIP Profile
       
    66         */
       
    67         virtual void AddedL(TUint32 aProfileId) = 0;
       
    68 
       
    69         /**
       
    70         * SIP profile destruction event.
       
    71         * Event is send to those observers, who have the
       
    72         * corresponding profile instantiated.
       
    73         * @param aProfileId id of profile which was destroyed
       
    74         */        
       
    75         virtual void RemovedL(TUint32 aProfileId) = 0;
       
    76 
       
    77         /** 
       
    78         * SIP profile information update event
       
    79         * Event is send to those observers, who have the
       
    80         * corresponding profile instantiated.
       
    81         * @param aProfileId id of updated SIP Profile
       
    82         * @param aSize size of updated SIP Profile
       
    83         */
       
    84         virtual void UpdatedL(TUint32 aProfileId, TUint aSize) = 0;
       
    85 
       
    86         /**
       
    87         * An asynchronous error has occurred related to SIP profile
       
    88         * Event is send to those observers, who have the
       
    89         * corresponding profile instantiated.
       
    90         * @param aProfileId the id of failed profile 
       
    91         * @param aStatus status indicating if error occurred
       
    92         *          during registering (ERegistrationInProgress)
       
    93         *          or deregistering (EUnregistrationInProgress)
       
    94         * @param aError a error code
       
    95         */
       
    96         virtual void ErrorOccurredL(
       
    97             TUint32 aProfileId,
       
    98             TInt aStatus,
       
    99             TInt aError) = 0;
       
   100     };
       
   101 
       
   102 #endif // MSIPCONCRETEPROFILEOBSERVER_H