mmsharing/inc/musavaobserver.h
changeset 0 f0cf47e981f9
child 31 33a5d2bbf6fc
equal deleted inserted replaced
-1:000000000000 0:f0cf47e981f9
       
     1 /*
       
     2 * Copyright (c) 2005-2007 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 "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:  This observer is used by
       
    15 *                ECOM clients to get function call from the availability Plug-in
       
    16 *
       
    17 */
       
    18 
       
    19 
       
    20 
       
    21 #ifndef MMUSAVAOBSERVER
       
    22 #define MMUSAVAOBSERVER
       
    23 
       
    24 #include <e32def.h>
       
    25 
       
    26 
       
    27 /**
       
    28  *  MusAvailability Observer base class
       
    29  *
       
    30  *  Observer interface for ECOM clients.
       
    31  *
       
    32  *  @lib musavailabilityplugin.lib
       
    33  *  @since S60 v3.2
       
    34  */
       
    35 
       
    36 class MMusAvaObserver
       
    37     {
       
    38 
       
    39 public:
       
    40 
       
    41     /**  Status definition */
       
    42     enum TAvailabilityStatus
       
    43         {
       
    44 
       
    45         /** Availability Error States */
       
    46         
       
    47         /** Manual Activation*/
       
    48 		EMusAvaManualActivation	        = -13, 
       
    49         /** Unsuccessfull response with response code 403 */
       
    50         EMusAvaFailureCode              = -12,
       
    51 
       
    52         /** SIP options query not available. */
       
    53         EMusAvaOptionNotAvailable       = -11,
       
    54 
       
    55         /** No SIP profile. */
       
    56         EMusAvaStatusNoSipProfile       = -10,
       
    57 
       
    58         /** Not Registered / Registering failed. */
       
    59         EMusAvaStatusNotRegistered      = -9,
       
    60 
       
    61         /** No Call. */
       
    62         EMusAvaStatusNoCall             = -8,
       
    63 
       
    64         /** Call on hold. */
       
    65         EMusAvaStatusCallOnHold         = -7,
       
    66 
       
    67         /** Call on hold. */
       
    68         EMusAvaStatusConferenceCall     = -6,
       
    69 
       
    70         /** Connection error. */
       
    71         EMusAvaConnectionErr            = -5,
       
    72 
       
    73         /** User not allow roaming. */
       
    74         EMusAvaRoamingError             = -4,
       
    75 
       
    76         /** User not allow to start application. */
       
    77         EMusActivationError             = -3,
       
    78 
       
    79         /** SIP Options returned a negative/erroneous result */
       
    80         EMusAvaNegativeSipOptions       = -2,
       
    81 
       
    82         /** Network bearer type is insuitable. */
       
    83         EMusAvaNetworkType              = -1,
       
    84 
       
    85         /** Availability States */
       
    86 
       
    87         /** No availability query is made. */
       
    88         EMusAvaStatusNotExecuted       =  0,
       
    89         EMusAvaStatusInProgress        =  1,
       
    90         EMusAvaStatusAvailable         =  2,
       
    91         /** options query pending */
       
    92 		EMusAvaStatusOptionsSent	   =  3,
       
    93 		/** options query is not sent */
       
    94 		EMusAvaStatusOptionsNotSent	   =  4,
       
    95         /** Edge/DTM is configured but unsupported */
       
    96 		EMusAvaEdgeDtmStatusUnknown       = 5, 
       
    97 		
       
    98         };
       
    99 
       
   100      /**  Status definition */
       
   101     enum TAvailabilityName
       
   102         {
       
   103         /** No defined.*/
       
   104         EMusAvaNameNotDefined,
       
   105 
       
   106         // Always on class availabilities ->
       
   107 
       
   108         /** Invite handler.*/
       
   109         EMusAvaInviteHandler,
       
   110 
       
   111         // Minimum class availabilities ->
       
   112 
       
   113         /** Default Option handler.*/
       
   114         EMusAvaDefaultOptionHandler,
       
   115 
       
   116         /** Settings Availability */
       
   117         EMusAvaNameSetting,
       
   118         
       
   119         /** Sipprofile must exist */
       
   120         EMusAvaNameSipprofileExist,
       
   121 
       
   122         /** NetworkStatus.*/
       
   123         EMusAvaNameNetworkStatus,
       
   124 
       
   125         /** ContactStatus.*/
       
   126         EMusAvaNameContactStatus,
       
   127 
       
   128         /** Bearer Status.*/
       
   129         EMusAvaBearerStatus,
       
   130 
       
   131         // Mandatory class availabilities ->
       
   132 
       
   133         /** Registration.*/
       
   134         EMusAvaNameRegistration,
       
   135 
       
   136         // Extension class availabilities ->
       
   137 
       
   138         /** Option handler.*/
       
   139         EMusAvaOptionHandler,
       
   140 
       
   141         // Full availability ->
       
   142 
       
   143         /** Full availability, all availabilities go */
       
   144         EMusAvaFullAvailability
       
   145         };
       
   146 
       
   147 public:
       
   148 
       
   149     /**
       
   150      * Availability report
       
   151      *
       
   152      * @since  S60 v3.2
       
   153      * @param aStatus New status for availability.
       
   154      */
       
   155     virtual void AvailabilityChanged(
       
   156         TAvailabilityName aName,
       
   157         TAvailabilityStatus aStatus ) = 0;
       
   158 
       
   159     virtual void AvailabilityError(
       
   160         TAvailabilityName aName,
       
   161         TAvailabilityStatus aStatus ) = 0;
       
   162         
       
   163     };
       
   164 
       
   165 
       
   166 #endif //MMUSAVAOBSERVER