1 /*

     2 * Copyright (c) 2003 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:  IMPS Connection UI public constants.

    15 *

    16 */

    17 

    18 #ifndef __IMPSPRESENCECONNECTIONUICONSTSNG_H

    19 #define __IMPSPRESENCECONNECTIONUICONSTSNG_H

    20 

    21 // INCLUDES

    22 #include <E32Std.h>

    23 #include "ChatNGCommonUIDs.h"

    24 

    25 /**

    26  * Client application enumeration.

    27  */

    28 enum TIMPSConnectionClient

    29     {

    30     EIMPSConnClientPEC = 0x1,   ///<Client belongs to PEC application group.

    31     EIMPSConnClientIM  = 0x2    ///<Client is IM application.

    32     };

    33 

    34 

    35 /**

    36  * Login type enumeration.

    37  *

    38  * Defines behaviour wanted from

    39  * Connection UI.

    40  */

    41 enum TIMPSLoginType

    42     {

    43     EIMPSManualLogin = 0x1,        ///<"Manual" login with server list query.

    44     EIMPSApplicationLaunch = 0x2,  ///< Application start time login. Direct login to SAPSettingsStore default server.

    45     EIMPSAAConnectionStart = 0x3   ///< AA Connection start. Starts AA connection for selected client to SAPSettingsStore default server.

    46     };

    47 

    48 

    49 /**

    50  * Application level presence events.

    51  *

    52  * Application level presence events.

    53  * These events map 1 to 1 to the

    54  * PEC engine events.

    55  *

    56  * NOTE!! Further events may be added here later.

    57  */

    58 enum TIMPSPresenceServiceEvent

    59     {

    60     EIMPSPresenceServiceUnknownEvent = -1,  ///<For not matched PEC engine events

    61     EIMPSPresenceServiceOffline = 0,        ///<Presence service not available

    62     EIMPSPresenceServiceOnline,             ///<Presence service available (logged in or network connection came back)

    63     EIMPSPresenceServiceSlotChanged,        ///<PEC engine network session slot has been changed

    64     EIMPSPresenceServiceSlotRemoved,        ///<PEC engine network session slot has been removed

    65     EIMPSPresenceServiceForceLogOut,        ///<Force log out from the IMPS network server

    66     EIMPSPresenceServiceTransport           ///<A transport specific event

    67     };

    68 

    69 

    70 /**

    71  * Application exit type enumeration.

    72  *

    73  * Defines behaviour wanted from

    74  * Connection UI.

    75  */

    76 enum TIMPSExitType

    77     {

    78     EIMPSNormalExit             = 0x1,  ///<Application close related queries are shown

    79     EIMPSForceExit              = 0x2,  ///<Application exit is handled silently without user interaction

    80     EIMPSLeaveSessionOpenExit   = 0x3,  ///<Application exit, network session is left open

    81     };

    82 

    83 

    84 /**

    85  * Connection mode event enumerations.

    86  * NOTE!! Further events may be added here later.

    87  */

    88 enum TIMPSConnectionModeEvent

    89     {

    90     EIMPSCMEUnknown         = -1,           ///<Connection UI hasn't recognized any particular connection mode change.

    91 

    92     ///<Login/logout events

    93     EIMPSCMEUserLevelSelectionEventGroup = 1,

    94     EIMPSCMEUserLevelLogout = 2,            ///<User has performed a logout trough the ConnectionUI's UI. (manual login)

    95     EIMPSCMEUserLevelLogin  = 3,            ///<User has performed a login trough the ConnectionUI's UI. (manual logout)

    96     EIMPSCMEUserLevelAAConnectionStart = 4, ///<User has started AA connection in UI level

    97 

    98     ///<Significant scheduling client start/stop events

    99     EIMPSCMESSClientEventGroup = 101,

   100     EIMPSCMEFirstSSClientStart = 102,       ///<First significant scheduling client started

   101     EIMPSCMELastSSClientStop   = 103        ///<Last significant scheduling client stopped

   102     };

   103 

   104 

   105 

   106 

   107 /**

   108  * Connection settings event enumerations.

   109  * NOTE!! Further events may be added here later.

   110  */

   111 enum TIMPSConnectionSettingsEvent

   112     {

   113     EIMPSCSEUnknown         = -1,   ///<Connection UI hasn't recognized any particular connection setting change.

   114 

   115     ///<Always Automatic (a.k.a Always Online) settings events

   116     EIMPSCSEAASettingsEventGroup = 1,

   117     EIMPSCSEAlwaysAutomaticOn    = 2,        ///<Always online has been enabled from IMPS connection settings

   118     EIMPSCSEAlwaysAutomaticOnInHNW = 3,      ///<Always online has been enabled from IMPS connection settings

   119     EIMPSCSEAlwaysAutomaticOff   = 4,        ///<Always online has been disabled from IMPS connection settings

   120 

   121     ///<Always Automatic scheduling events

   122     EIMPSCSEAASchedulingTimeEventGroup      = 101,

   123     EIMPSCSEAAScheduledConnectionStartTime  = 102,  ///<Scheduled AA connection start time passed

   124     EIMPSCSEAAScheduledConnectionEndTime    = 103,  ///<Scheduled AA connection end time passed

   125     };

   126 

   127 

   128 

   129 /**

   130  * Connection operation enumerations.

   131  * NOTE!! Further events may be added here later.

   132  */

   133 enum TIMPSConnectionOperation

   134     {

   135     EIMPSConnOppUnknown = -1,       ///<No particular operation ongoing

   136     EIMPSConnOppClientLogin = 2     ///<Client login ongoing

   137     };

   138 

   139 

   140 

   141 

   142 /**

   143  * UI notification services available to clients.

   144  *

   145  * Available services (identified by their enum values)

   146  *

   147  * 1.When this service is started, allows UI notifications

   148  *   from active connection termination and suspends

   149  *   to be shown in host application context.

   150  *   Currently shows notifications only from force logout

   151  *   events. Notifications are shown only when the host

   152  *   application connection has been active and it is ended

   153  *   or suspended by some external reason.

   154  *   (For IM & PEC.)

   155  *

   156  * 2.When this service is started, allows queries about

   157  *   currently active network connection scheduled close

   158  *   to be shown in host application context when needed.

   159  *   Connection Agent will asks from user should this

   160  *   application group currently active network connection

   161  *   be closed right now as scheduled. User has 30 seconds timeout to

   162  *   react to query. If user selects "yes" or doesn't react to query,

   163  *   or the service isn't used by any client group application,

   164  *   network connection is closed as scheduled.

   165  *   (For IM when AA scheduling is supported.)

   166  *

   167  * 3.When this service is started, allows queries about

   168  *   currently active network connection termination for

   169  *   another scheduled connection to be shown in host

   170  *   application context when needed.

   171  *   Connection Agent will ask from user should the currently

   172  *   active network connection to be closed because a

   173  *   connection to another IMPS service is scheduled. If user selects

   174  *   "yes" or doesn't react to query, or the service isn't used by any

   175  *   client group applications, current network connection is closed

   176  *   and a connection to different IMPS service is opened as scheduled.

   177  *   (For IM & PEC when AA scheduling is supported.)

   178  *

   179  * 4.When this service is started, the connection client is

   180  *   registered and counted as "significant" connection client

   181  *   in scheduling.

   182  *   (For IM & PEC when AA scheduling is supported.)

   183  *

   184  * @since 2.1

   185  */

   186 enum TIMPSConnectionUiAgentService

   187     {

   188     EIMPSNotifyActiveConnectionLostReasons = 1,

   189     EIMPSQueryActiveConnectionScheduledClose = 2,

   190     EIMPSQueryActiveConnectionSuppressForScheduledConnection = 3,

   191     EIMPSReqisterAsSignificantConnectionClientInScheduling = 4

   192     };

   193 

   194 

   195 

   196 /**

   197  * Connection UI panic panic reasons and category

   198  * Not for use. Only for debug purposes.

   199  */

   200 enum TIMPSConnectionUiPanicReason

   201     {

   202     EIMPSConnUi_NoCoeEnv = 0,

   203     EIMPSConnUi_UnknownNoteID = 1,

   204     EIMPSConn_NULLPtr = 2,

   205     EIMPSConnUi_UnknownClientType = 3,

   206     EIMPSConnOpContextUninitialized = 4,

   207     EIMPSConnStepDriverUninitialized = 5,

   208     EIMPSConnOpenerUnknownState = 6,

   209     EIMPSConnCloserUnknownState = 7

   210     };

   211 _LIT( KIMPSConnUi_PanicCat, "PresConnUi" );

   212 

   213 _LIT( KIMPSPECContactListIdentifier,  "~PEP1." );

   214 

   215 _LIT( KIMPSSubscriptionList, "/~PEP1.0_subscriptions" );

   216 _LIT( KIMPSPrivateList, "/~PEP1.0_privatelist" );

   217 _LIT( KIMPSBlockList, "/~PEP1.0_blocklist" );

   218 _LIT( KIMPSWatcherList, "watcherlist" );

   219 

   220 // constant for AA client packing key

   221 _LIT( KIMPSPackAAClientsKey, "IMPSAAClients" );

   222 

   223 // constants for storing branding resource information

   224 const TUid KBrandingUid = { KWVUIAVEEXEUIDS2 };

   225 const TInt KBrandingResourceKey = 666;

   226 const TInt KForcedLoginKey = 667;

   227 const TInt KBrandingConnUIResourceKey = 668;

   228 _LIT( KConnUiVariationResourceName, "IMConnectionUIVariationNG.rsc" );

   229 _LIT( KConnUiResourceName, "IMPSConnectionUiNG.rsc" );

   230 _LIT_SECURITY_POLICY_PASS( KIMPSPubSubReadPolicy );

   231 _LIT_SECURITY_POLICY_PASS( KIMPSPubSubWritePolicy );

   232 

   233 #endif      //__IMPSPRESENCECONNECTIONUICONSTSNG_H

   234 

   235 //  End of File

   236