epoc32/include/mw/sipconcreteprofileobserver.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 3 e1b950c65cb4
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@4
     5
* under the terms of "Eclipse Public License v1.0"
williamr@2
     6
* which accompanies this distribution, and is available
williamr@4
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description:
williamr@2
    15
* Name        : sipconcreteprofileobserver.h
williamr@2
    16
* Part of     : SIP Profile Client
williamr@2
    17
* Interface   : private
williamr@2
    18
* The observer class that must be implemented by users of 
williamr@2
    19
* CSIPConcreteProfile
williamr@2
    20
* Version     : 1.0
williamr@2
    21
*
williamr@2
    22
*/
williamr@2
    23
williamr@2
    24
williamr@2
    25
williamr@2
    26
#ifndef MSIPCONCRETEPROFILEOBSERVER_H
williamr@2
    27
#define MSIPCONCRETEPROFILEOBSERVER_H
williamr@2
    28
williamr@2
    29
//  INCLUDES
williamr@2
    30
williamr@2
    31
#include <e32base.h>
williamr@2
    32
williamr@2
    33
// FORWARD DECLARATIONS
williamr@2
    34
williamr@2
    35
williamr@2
    36
// CLASS DECLARATION
williamr@2
    37
/**
williamr@2
    38
* @publishedAll
williamr@2
    39
* @released
williamr@2
    40
*
williamr@2
    41
* Observer class to be implemented by users of CSIPConcreteProfile
williamr@2
    42
* It provides event notifications related to profiles.
williamr@2
    43
*/
williamr@2
    44
class MSIPConcreteProfileObserver
williamr@2
    45
    {
williamr@2
    46
    public:
williamr@2
    47
williamr@2
    48
        /**
williamr@2
    49
        * SIP profile registration status changed event
williamr@2
    50
        * Event is send to those observers, who have the
williamr@2
    51
        * corresponding profile instantiated.
williamr@2
    52
        * @param aProfileId id of profile which registration 
williamr@2
    53
        *        status has been changed.
williamr@2
    54
        * @param aStatus new status of the profile
williamr@2
    55
        * @param aStatusId id related to registration
williamr@2
    56
        */
williamr@2
    57
        virtual void RegistrationStatusChangedL(
williamr@2
    58
            TUint32 aProfileId, 
williamr@2
    59
            TInt aStatus,
williamr@2
    60
            TUint32 aStatusId) = 0;
williamr@2
    61
williamr@2
    62
        /** 
williamr@2
    63
        * SIP profile creation event.
williamr@2
    64
        * Event is send to all observers.
williamr@2
    65
        * @param aProfileId id of new SIP Profile
williamr@2
    66
        */
williamr@2
    67
        virtual void AddedL(TUint32 aProfileId) = 0;
williamr@2
    68
williamr@2
    69
        /**
williamr@2
    70
        * SIP profile destruction event.
williamr@2
    71
        * Event is send to those observers, who have the
williamr@2
    72
        * corresponding profile instantiated.
williamr@2
    73
        * @param aProfileId id of profile which was destroyed
williamr@2
    74
        */        
williamr@2
    75
        virtual void RemovedL(TUint32 aProfileId) = 0;
williamr@2
    76
williamr@2
    77
        /** 
williamr@2
    78
        * SIP profile information update event
williamr@2
    79
        * Event is send to those observers, who have the
williamr@2
    80
        * corresponding profile instantiated.
williamr@2
    81
        * @param aProfileId id of updated SIP Profile
williamr@2
    82
        * @param aSize size of updated SIP Profile
williamr@2
    83
        */
williamr@2
    84
        virtual void UpdatedL(TUint32 aProfileId, TUint aSize) = 0;
williamr@2
    85
williamr@2
    86
        /**
williamr@2
    87
        * An asynchronous error has occurred related to SIP profile
williamr@2
    88
        * Event is send to those observers, who have the
williamr@2
    89
        * corresponding profile instantiated.
williamr@2
    90
        * @param aProfileId the id of failed profile 
williamr@2
    91
        * @param aStatus status indicating if error occurred
williamr@2
    92
        *          during registering (ERegistrationInProgress)
williamr@2
    93
        *          or deregistering (EUnregistrationInProgress)
williamr@2
    94
        * @param aError a error code
williamr@2
    95
        */
williamr@2
    96
        virtual void ErrorOccurredL(
williamr@2
    97
            TUint32 aProfileId,
williamr@2
    98
            TInt aStatus,
williamr@2
    99
            TInt aError) = 0;
williamr@2
   100
    };
williamr@2
   101
williamr@2
   102
#endif // MSIPCONCRETEPROFILEOBSERVER_H