os/ossrv/genericservices/systemagent/Inc/SaCls.h
author sl
Tue, 10 Jun 2014 14:32:02 +0200
changeset 1 260cb5ec6c19
permissions -rw-r--r--
Update contrib.
     1 // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 // All rights reserved.
     3 // This component and the accompanying materials are made available
     4 // under the terms of "Eclipse Public License v1.0"
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
     7 //
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
    10 //
    11 // Contributors:
    12 //
    13 // Description:
    14 //
    15 
    16 #ifndef __SACLS_H__
    17 #define __SACLS_H__
    18 
    19 #ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
    20 #include <saclsdefines.h>
    21 #include <saclscommon.h>
    22 #endif
    23 
    24 #include <e32std.h>
    25 
    26 /**
    27 System agent 2 - maintained entries
    28 @publishedAll
    29 @released
    30 */
    31 const TInt KUidProfileValue		=0x100052D2;
    32 const TUid KUidProfile			={KUidProfileValue};
    33 
    34 /**
    35 @capability WriteDeviceData capability is required for changing KUidPhonePwr property value.
    36 @publishedAll
    37 @released
    38 */
    39 const TInt KUidPhonePwrValue=0x100052C5;
    40 const TUid KUidPhonePwr={KUidPhonePwrValue};
    41 
    42 /**
    43 @publishedAll
    44 @released
    45 */
    46 enum TSAPhoneStatus
    47 	{
    48 	ESAPhoneOff,
    49 	ESAPhoneOn
    50 	};
    51 
    52 /**
    53 @capability WriteDeviceData capability is required for changing KUidSIMStatus property value.
    54 @publishedAll
    55 @released
    56 */
    57 const TInt KUidSIMStatusValue	=0x100052C6;
    58 const TUid KUidSIMStatus		={KUidSIMStatusValue};
    59 
    60 /**
    61 @publishedAll
    62 @released
    63 */
    64 enum TSASIMStatus
    65 	{
    66 	ESASimOk,
    67 	ESASimNotPresent,
    68 	ESASimRejected
    69 	};
    70 
    71 /**
    72 @capability WriteDeviceData capability is required for changing KUidNetworkStatus property value.
    73 @publishedAll
    74 @released
    75 */
    76 const TInt KUidNetworkStatusValue=0x100052C7;
    77 const TUid KUidNetworkStatus	={KUidNetworkStatusValue};
    78 
    79 /**
    80 @publishedAll
    81 @released
    82 */
    83 enum TSANetworkStatus
    84 	{
    85 	ESANetworkAvailable,
    86 	ESANetworkUnAvailable
    87 	};
    88 
    89 /**
    90 @capability WriteDeviceData capability is required for changing KUidNetworkStrength property value.
    91 @publishedAll
    92 @released
    93 */
    94 const TInt KUidNetworkStrengthValue  =0x100052C8;
    95 const TUid KUidNetworkStrength  ={KUidNetworkStrengthValue};
    96 
    97 /**
    98 @publishedAll
    99 @released
   100 */
   101 enum TSANetworkStrength
   102 	{
   103 	ESANetworkStrengthNone,
   104 	ESANetworkStrengthLow,
   105 	ESANetworkStrengthMedium,
   106 	ESANetworkStrengthHigh,
   107 	ESANetworkStrengthUnknown
   108 	};
   109 
   110 /**
   111 @capability WriteDeviceData capability is required for changing KUidChargerStatus property value.
   112 @publishedAll
   113 @released
   114 */
   115 const TInt KUidChargerStatusValue	=0x100052C9;
   116 const TUid KUidChargerStatus	={KUidChargerStatusValue};
   117 
   118 /**
   119 @publishedAll
   120 @released
   121 */
   122 enum TSAChargerStatus
   123 	{
   124 	ESAChargerConnected,
   125 	ESAChargerDisconnected,
   126 	ESAChargerNotCharging
   127 	};
   128 
   129 /**
   130 @capability WriteDeviceData capability is required for changing KUidBatteryStrength property value.
   131 @publishedAll
   132 @released
   133 */
   134 const TInt KUidBatteryStrengthValue  =0x100052CA;
   135 const TUid KUidBatteryStrength  ={KUidBatteryStrengthValue};
   136 
   137 /**
   138 @publishedAll
   139 @released
   140 */
   141 enum TSABatteryStrength
   142 	{
   143 	ESABatteryAlmostEmpty,
   144 	ESABatteryLow,
   145 	ESABatteryFull
   146 	};
   147 
   148 /**
   149 @capability WriteDeviceData capability is required for changing KUidCurrentCall property value.
   150 @publishedAll
   151 @released
   152 */
   153 const TInt KUidCurrentCallValue	=0x100052CB;
   154 const TUid KUidCurrentCall		={KUidCurrentCallValue};
   155 
   156 /**
   157 @publishedAll
   158 @released
   159 */
   160 enum TSACurrentCall
   161 	{
   162 	ESACallNone,
   163 	ESACallVoice,
   164 	ESACallFax,
   165 	ESACallData,
   166 	ESACallAlerting,
   167 	ESACallRinging,
   168 	ESACallAlternating,
   169 	ESACallDialling,
   170 	ESACallAnswering,
   171 	ESACallDisconnecting
   172 	};
   173 
   174 /**
   175 @publishedAll
   176 @released
   177 */
   178 const TInt KUidDataPortValue	=0x100052CC;
   179 const TUid KUidDataPort			={KUidDataPortValue};
   180 
   181 /**
   182 @publishedAll
   183 @released
   184 */
   185 enum TSAPort
   186 	{
   187 	ESADataPortIdle,
   188 	ESADataPortBusy	
   189 	};
   190 
   191 /**
   192 @publishedAll
   193 @released
   194 */
   195 const TInt KUidInboxStatusValue	=0x100052CD;
   196 const TUid KUidInboxStatus		={KUidInboxStatusValue};
   197 
   198 /**
   199 @publishedAll
   200 @released
   201 */
   202 enum TSAInboxStatus
   203 	{
   204 	ESAInboxEmpty,
   205 	ESADocumentsInInbox
   206 	};
   207 
   208 /**
   209 @publishedAll
   210 @released
   211 */
   212 const TInt KUidOutboxStatusValue=0x100052CE;
   213 const TUid KUidOutboxStatus		={KUidOutboxStatusValue};
   214 
   215 /**
   216 @publishedAll
   217 @released
   218 */
   219 enum TSAOutboxStatus
   220 	{
   221 	ESAOutboxEmpty,
   222 	ESADocumentsInOutbox
   223 	};
   224 
   225 /**
   226 @publishedAll
   227 @released
   228 */
   229 const TInt KUidClockValue		=0x100052CF;
   230 const TUid KUidClock			={KUidClockValue};
   231 
   232 /**
   233 @publishedAll
   234 @released
   235 */
   236 enum TSAClock
   237 	{
   238 	ESAAm,
   239 	ESAPm
   240 	};
   241 
   242 /**
   243 No longer used
   244 @publishedAll
   245 @released
   246 */
   247 const TInt KUidAlarmValue		=0x100052D0;
   248 const TUid KUidAlarm			={KUidAlarmValue};
   249 
   250 /**
   251 @publishedAll
   252 @released
   253 */
   254 enum TSAAlarm
   255 	{
   256 	ESAAlarmOff,
   257 	ESAAlarmOn,
   258 	};
   259 
   260 /**
   261 @publishedAll
   262 @released
   263 */
   264 const TInt KUidIrdaStatusValue	=0x100052D1;
   265 const TUid KUidIrdaStatus		={KUidIrdaStatusValue};
   266 
   267 /**
   268 @publishedAll
   269 @released
   270 */
   271 enum TSAIrdaStatus
   272 	{
   273 	ESAIrLoaded,		//IRDA Irlap layer loaded
   274 	ESAIrDiscoveredPeer,//Discovery begin
   275 	ESAIrLostPeer,		//Discovery end
   276 	ESAIrConnected,		//IRDA Irlap layer connected
   277 	ESAIrBlocked,		//IRDA Irlap layer blocked
   278 	ESAIrDisConnected,	//IRDA Irlap layer disconnected
   279 	ESAIrUnloaded		//IRDA Irlap layer unloaded
   280 	};
   281 	
   282 //-----------------------------------------------------------------------------
   283 	
   284 /**
   285 This is a duplicate of Swi::KUidSoftwareInstallKey from swi/swispubsubdefs.h
   286 This is the publish and subscribe property used by Secure Software Install to 
   287 publish its current state. The publish and subscribe key is defined by 
   288 SysAgent2 server, but we do not want to have a dependency to the security 
   289 subsystem, so we redefine a constant with the same key value here so it may be used
   290 by this and other Core OS layer components. We also define the property's
   291 values in sacls.h too, see TSASwisOperation & TSASwisOperationStatus.
   292 
   293 @publishedAll
   294 @released
   295 */
   296 const TInt KSAUidSoftwareInstallKeyValue = 0x102047B7;
   297 
   298 /**
   299 This is a duplicate of Swi::TSwisOperation from swi/swispubsubdefs.h
   300 @see KSAUidSoftwareInstallKeyValue
   301 @publishedAll
   302 @released
   303 */
   304 enum TSASwisOperation
   305 	{	
   306 	ESASwisNone			= 0x00, //< No operation
   307 	ESASwisInstall		= 0x01, //< Swis install operation is in progress
   308 	ESASwisUninstall	= 0x02, //< Swis uninstall operation is in progress
   309 	ESASwisRestore		= 0x04  //< Swis restore operation is in progress
   310 	};
   311 
   312 
   313 /**
   314 This is a duplicate of Swi::KSwisOperationStatusMask from swi/swispubsubdefs.h
   315 @see KSAUidSoftwareInstallKeyValue
   316 @publishedAll
   317 @released
   318 */
   319 const TUint KSASwisOperationStatusMask = 0xFF00;  
   320 	
   321 /**
   322 This is a duplicate of Swi::TSwisOperationStatus from swi/swispubsubdefs.h
   323 @see KSAUidSoftwareInstallKeyValue
   324 @publishedAll
   325 @released
   326 */
   327 enum TSASwisOperationStatus
   328 	{
   329 	ESASwisStatusNone		= 0x0000, //< The current operation is in progress
   330 	ESASwisStatusSuccess	= 0x0100, //< The current/last operation succeeded
   331 	ESASwisStatusAborted	= 0x0200  //< The current/last operation failed		
   332 	};	
   333 
   334 
   335 //-----------------------------------------------------------------------------
   336 		
   337 
   338 /** This is the global definition used by Software Install server (SWIS)
   339 This is the publish and subscribe property used by SWI to publish the most
   340 recently installed or updated application. If the application has 
   341 subsequently been uninstalled the value may refer to an application
   342 that no longer exists. Has value KUidNull if no applications have been 
   343 installed
   344  
   345 @publishedAll
   346 @released
   347 @capability ECapabilityTrustedUI capability is required to modify the value of this property
   348 */
   349 const TUint KUidSwiLatestInstallation = 0x10272C8E;
   350 
   351 /** This is the global definition of KUidUnifiedCertstoreFlag. This publish
   352 and subscribe property is used to notify users of changes in the unified certstore
   353 
   354 @publishedAll
   355 @released
   356 */
   357 const TUint KUidUnifiedCertstoreFlag = 0x10272C83;
   358 
   359 /**
   360 This is a duplicate of KUidBackupRestoreKey from the secure backup engine's sbdefs.h
   361 This is the Publish and Subscribe property used by Secure Backup Engine to publish its current 
   362 state. The publish and subscribe key is defined by SysAgent2 server.
   363 @publishedAll
   364 @released
   365 */
   366 const TUint KUidBackupRestoreKey = 0x10202792;
   367 
   368 /**
   369 This is the publish and subscribe property used by Secure Software Install to 
   370 Publish package UIDs which are currently being processed. The publish and subscribe key is defined by 
   371 SysAgent2 server, but we do not want to have a dependency to the security subsystem, so we define a 
   372 constant in sacls.h , By doing this it will be available for Core OS layer components. 
   373 
   374 @publishedAll
   375 @released
   376 */
   377 const TUint KSWIUidsCurrentlyBeingProcessed= 0x2002D4F4;
   378 
   379 // Deprecated - redundant method no longer used by system software
   380 IMPORT_C TInt StartSysAgt2();
   381 
   382 #endif //__SACLS_H__