epoc32/include/sacls.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@2
     4
// 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
williamr@2
     5
// which accompanies this distribution, and is available
williamr@2
     6
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
//
williamr@2
    15
williamr@2
    16
#ifndef __SACLS_H__
williamr@2
    17
#define __SACLS_H__
williamr@2
    18
williamr@2
    19
#include <e32std.h>
williamr@2
    20
williamr@2
    21
/**
williamr@2
    22
System agent 2 - maintained entries
williamr@2
    23
@publishedAll
williamr@2
    24
@released
williamr@2
    25
*/
williamr@2
    26
const TInt KUidProfileValue		=0x100052D2;
williamr@2
    27
const TUid KUidProfile			={KUidProfileValue};
williamr@2
    28
williamr@2
    29
/**
williamr@2
    30
@capability WriteDeviceData capability is required for changing KUidPhonePwr property value.
williamr@2
    31
@publishedAll
williamr@2
    32
@released
williamr@2
    33
*/
williamr@2
    34
const TInt KUidPhonePwrValue=0x100052C5;
williamr@2
    35
const TUid KUidPhonePwr={KUidPhonePwrValue};
williamr@2
    36
williamr@2
    37
/**
williamr@2
    38
@publishedAll
williamr@2
    39
@released
williamr@2
    40
*/
williamr@2
    41
enum TSAPhoneStatus
williamr@2
    42
	{
williamr@2
    43
	ESAPhoneOff,
williamr@2
    44
	ESAPhoneOn
williamr@2
    45
	};
williamr@2
    46
williamr@2
    47
/**
williamr@2
    48
@capability WriteDeviceData capability is required for changing KUidSIMStatus property value.
williamr@2
    49
@publishedAll
williamr@2
    50
@released
williamr@2
    51
*/
williamr@2
    52
const TInt KUidSIMStatusValue	=0x100052C6;
williamr@2
    53
const TUid KUidSIMStatus		={KUidSIMStatusValue};
williamr@2
    54
williamr@2
    55
/**
williamr@2
    56
@publishedAll
williamr@2
    57
@released
williamr@2
    58
*/
williamr@2
    59
enum TSASIMStatus
williamr@2
    60
	{
williamr@2
    61
	ESASimOk,
williamr@2
    62
	ESASimNotPresent,
williamr@2
    63
	ESASimRejected
williamr@2
    64
	};
williamr@2
    65
williamr@2
    66
/**
williamr@2
    67
@capability WriteDeviceData capability is required for changing KUidNetworkStatus property value.
williamr@2
    68
@publishedAll
williamr@2
    69
@released
williamr@2
    70
*/
williamr@2
    71
const TInt KUidNetworkStatusValue=0x100052C7;
williamr@2
    72
const TUid KUidNetworkStatus	={KUidNetworkStatusValue};
williamr@2
    73
williamr@2
    74
/**
williamr@2
    75
@publishedAll
williamr@2
    76
@released
williamr@2
    77
*/
williamr@2
    78
enum TSANetworkStatus
williamr@2
    79
	{
williamr@2
    80
	ESANetworkAvailable,
williamr@2
    81
	ESANetworkUnAvailable
williamr@2
    82
	};
williamr@2
    83
williamr@2
    84
/**
williamr@2
    85
@capability WriteDeviceData capability is required for changing KUidNetworkStrength property value.
williamr@2
    86
@publishedAll
williamr@2
    87
@released
williamr@2
    88
*/
williamr@2
    89
const TInt KUidNetworkStrengthValue  =0x100052C8;
williamr@2
    90
const TUid KUidNetworkStrength  ={KUidNetworkStrengthValue};
williamr@2
    91
williamr@2
    92
/**
williamr@2
    93
@publishedAll
williamr@2
    94
@released
williamr@2
    95
*/
williamr@2
    96
enum TSANetworkStrength
williamr@2
    97
	{
williamr@2
    98
	ESANetworkStrengthNone,
williamr@2
    99
	ESANetworkStrengthLow,
williamr@2
   100
	ESANetworkStrengthMedium,
williamr@2
   101
	ESANetworkStrengthHigh,
williamr@2
   102
	ESANetworkStrengthUnknown
williamr@2
   103
	};
williamr@2
   104
williamr@2
   105
/**
williamr@2
   106
@capability WriteDeviceData capability is required for changing KUidChargerStatus property value.
williamr@2
   107
@publishedAll
williamr@2
   108
@released
williamr@2
   109
*/
williamr@2
   110
const TInt KUidChargerStatusValue	=0x100052C9;
williamr@2
   111
const TUid KUidChargerStatus	={KUidChargerStatusValue};
williamr@2
   112
williamr@2
   113
/**
williamr@2
   114
@publishedAll
williamr@2
   115
@released
williamr@2
   116
*/
williamr@2
   117
enum TSAChargerStatus
williamr@2
   118
	{
williamr@2
   119
	ESAChargerConnected,
williamr@2
   120
	ESAChargerDisconnected,
williamr@2
   121
	ESAChargerNotCharging
williamr@2
   122
	};
williamr@2
   123
williamr@2
   124
/**
williamr@2
   125
@capability WriteDeviceData capability is required for changing KUidBatteryStrength property value.
williamr@2
   126
@publishedAll
williamr@2
   127
@released
williamr@2
   128
*/
williamr@2
   129
const TInt KUidBatteryStrengthValue  =0x100052CA;
williamr@2
   130
const TUid KUidBatteryStrength  ={KUidBatteryStrengthValue};
williamr@2
   131
williamr@2
   132
/**
williamr@2
   133
@publishedAll
williamr@2
   134
@released
williamr@2
   135
*/
williamr@2
   136
enum TSABatteryStrength
williamr@2
   137
	{
williamr@2
   138
	ESABatteryAlmostEmpty,
williamr@2
   139
	ESABatteryLow,
williamr@2
   140
	ESABatteryFull
williamr@2
   141
	};
williamr@2
   142
williamr@2
   143
/**
williamr@2
   144
@capability WriteDeviceData capability is required for changing KUidCurrentCall property value.
williamr@2
   145
@publishedAll
williamr@2
   146
@released
williamr@2
   147
*/
williamr@2
   148
const TInt KUidCurrentCallValue	=0x100052CB;
williamr@2
   149
const TUid KUidCurrentCall		={KUidCurrentCallValue};
williamr@2
   150
williamr@2
   151
/**
williamr@2
   152
@publishedAll
williamr@2
   153
@released
williamr@2
   154
*/
williamr@2
   155
enum TSACurrentCall
williamr@2
   156
	{
williamr@2
   157
	ESACallNone,
williamr@2
   158
	ESACallVoice,
williamr@2
   159
	ESACallFax,
williamr@2
   160
	ESACallData,
williamr@2
   161
	ESACallAlerting,
williamr@2
   162
	ESACallRinging,
williamr@2
   163
	ESACallAlternating,
williamr@2
   164
	ESACallDialling,
williamr@2
   165
	ESACallAnswering,
williamr@2
   166
	ESACallDisconnecting
williamr@2
   167
	};
williamr@2
   168
williamr@2
   169
/**
williamr@2
   170
@publishedAll
williamr@2
   171
@released
williamr@2
   172
*/
williamr@2
   173
const TInt KUidDataPortValue	=0x100052CC;
williamr@2
   174
const TUid KUidDataPort			={KUidDataPortValue};
williamr@2
   175
williamr@2
   176
/**
williamr@2
   177
@publishedAll
williamr@2
   178
@released
williamr@2
   179
*/
williamr@2
   180
enum TSAPort
williamr@2
   181
	{
williamr@2
   182
	ESADataPortIdle,
williamr@2
   183
	ESADataPortBusy	
williamr@2
   184
	};
williamr@2
   185
williamr@2
   186
/**
williamr@2
   187
@publishedAll
williamr@2
   188
@released
williamr@2
   189
*/
williamr@2
   190
const TInt KUidInboxStatusValue	=0x100052CD;
williamr@2
   191
const TUid KUidInboxStatus		={KUidInboxStatusValue};
williamr@2
   192
williamr@2
   193
/**
williamr@2
   194
@publishedAll
williamr@2
   195
@released
williamr@2
   196
*/
williamr@2
   197
enum TSAInboxStatus
williamr@2
   198
	{
williamr@2
   199
	ESAInboxEmpty,
williamr@2
   200
	ESADocumentsInInbox
williamr@2
   201
	};
williamr@2
   202
williamr@2
   203
/**
williamr@2
   204
@publishedAll
williamr@2
   205
@released
williamr@2
   206
*/
williamr@2
   207
const TInt KUidOutboxStatusValue=0x100052CE;
williamr@2
   208
const TUid KUidOutboxStatus		={KUidOutboxStatusValue};
williamr@2
   209
williamr@2
   210
/**
williamr@2
   211
@publishedAll
williamr@2
   212
@released
williamr@2
   213
*/
williamr@2
   214
enum TSAOutboxStatus
williamr@2
   215
	{
williamr@2
   216
	ESAOutboxEmpty,
williamr@2
   217
	ESADocumentsInOutbox
williamr@2
   218
	};
williamr@2
   219
williamr@2
   220
/**
williamr@2
   221
@publishedAll
williamr@2
   222
@released
williamr@2
   223
*/
williamr@2
   224
const TInt KUidClockValue		=0x100052CF;
williamr@2
   225
const TUid KUidClock			={KUidClockValue};
williamr@2
   226
williamr@2
   227
/**
williamr@2
   228
@publishedAll
williamr@2
   229
@released
williamr@2
   230
*/
williamr@2
   231
enum TSAClock
williamr@2
   232
	{
williamr@2
   233
	ESAAm,
williamr@2
   234
	ESAPm
williamr@2
   235
	};
williamr@2
   236
williamr@2
   237
/**
williamr@2
   238
No longer used
williamr@2
   239
@publishedAll
williamr@2
   240
@released
williamr@2
   241
*/
williamr@2
   242
const TInt KUidAlarmValue		=0x100052D0;
williamr@2
   243
const TUid KUidAlarm			={KUidAlarmValue};
williamr@2
   244
williamr@2
   245
/**
williamr@2
   246
@publishedAll
williamr@2
   247
@released
williamr@2
   248
*/
williamr@2
   249
enum TSAAlarm
williamr@2
   250
	{
williamr@2
   251
	ESAAlarmOff,
williamr@2
   252
	ESAAlarmOn,
williamr@2
   253
	};
williamr@2
   254
williamr@2
   255
/**
williamr@2
   256
@publishedAll
williamr@2
   257
@released
williamr@2
   258
*/
williamr@2
   259
const TInt KUidIrdaStatusValue	=0x100052D1;
williamr@2
   260
const TUid KUidIrdaStatus		={KUidIrdaStatusValue};
williamr@2
   261
williamr@2
   262
/**
williamr@2
   263
@publishedAll
williamr@2
   264
@released
williamr@2
   265
*/
williamr@2
   266
enum TSAIrdaStatus
williamr@2
   267
	{
williamr@2
   268
	ESAIrLoaded,		//IRDA Irlap layer loaded
williamr@2
   269
	ESAIrDiscoveredPeer,//Discovery begin
williamr@2
   270
	ESAIrLostPeer,		//Discovery end
williamr@2
   271
	ESAIrConnected,		//IRDA Irlap layer connected
williamr@2
   272
	ESAIrBlocked,		//IRDA Irlap layer blocked
williamr@2
   273
	ESAIrDisConnected,	//IRDA Irlap layer disconnected
williamr@2
   274
	ESAIrUnloaded		//IRDA Irlap layer unloaded
williamr@2
   275
	};
williamr@2
   276
	
williamr@2
   277
//-----------------------------------------------------------------------------
williamr@2
   278
	
williamr@2
   279
/**
williamr@2
   280
This is a duplicate of Swi::KUidSoftwareInstallKey from swi/swispubsubdefs.h
williamr@2
   281
This is the publish and subscribe property used by Secure Software Install to 
williamr@2
   282
publish its current state. The publish and subscribe key is defined by 
williamr@2
   283
SysAgent2 server, but we do not want to have a dependency to the security 
williamr@2
   284
subsystem, so we redefine a constant with the same key value here so it may be used
williamr@2
   285
by this and other Core OS layer components. We also define the property's
williamr@2
   286
values in sacls.h too, see TSASwisOperation & TSASwisOperationStatus.
williamr@2
   287
williamr@2
   288
@internalTechnology
williamr@2
   289
*/
williamr@2
   290
const TInt KSAUidSoftwareInstallKeyValue = 0x102047B7;
williamr@2
   291
williamr@2
   292
/**
williamr@2
   293
This is a duplicate of Swi::KSwisOperationMask from swi/swispubsubdefs.h
williamr@2
   294
@see KSAUidSoftwareInstallKeyValue
williamr@2
   295
@internalTechnology
williamr@2
   296
*/
williamr@2
   297
const TUint KSASwisOperationMask = 0xFF;
williamr@2
   298
williamr@2
   299
/**
williamr@2
   300
This is a duplicate of Swi::TSwisOperation from swi/swispubsubdefs.h
williamr@2
   301
@see KSAUidSoftwareInstallKeyValue
williamr@2
   302
@internalTechnology
williamr@2
   303
*/
williamr@2
   304
enum TSASwisOperation
williamr@2
   305
	{	
williamr@2
   306
	ESASwisNone			= 0x00, ///< No operation
williamr@2
   307
	ESASwisInstall		= 0x01, ///< Swis install operation is in progress
williamr@2
   308
	ESASwisUninstall	= 0x02, ///< Swis uninstall operation is in progress
williamr@2
   309
	ESASwisRestore		= 0x04  ///< Swis restore operation is in progress
williamr@2
   310
	};
williamr@2
   311
williamr@2
   312
williamr@2
   313
/**
williamr@2
   314
This is a duplicate of Swi::KSwisOperationStatusMask from swi/swispubsubdefs.h
williamr@2
   315
@see KSAUidSoftwareInstallKeyValue
williamr@2
   316
@internalTechnology
williamr@2
   317
*/
williamr@2
   318
const TUint KSASwisOperationStatusMask = 0xFF00;  
williamr@2
   319
	
williamr@2
   320
/**
williamr@2
   321
This is a duplicate of Swi::TSwisOperationStatus from swi/swispubsubdefs.h
williamr@2
   322
@see KSAUidSoftwareInstallKeyValue
williamr@2
   323
@internalTechnology
williamr@2
   324
*/
williamr@2
   325
enum TSASwisOperationStatus
williamr@2
   326
	{
williamr@2
   327
	ESASwisStatusNone		= 0x0000, ///< The current operation is in progress
williamr@2
   328
	ESASwisStatusSuccess	= 0x0100, ///< The current/last operation succeeded
williamr@2
   329
	ESASwisStatusAborted	= 0x0200  ///< The current/last operation failed		
williamr@2
   330
	};	
williamr@2
   331
williamr@2
   332
williamr@2
   333
//-----------------------------------------------------------------------------
williamr@2
   334
		
williamr@2
   335
/**
williamr@2
   336
This is a duplicate of KUidJavaInstallKey from swi/swispubsubdefs.h
williamr@2
   337
This is the Publish and Subscribe property used by Java install to publish its current 
williamr@2
   338
state. The publish and subscribe key is defined by SysAgent2 server, but we
williamr@2
   339
do not want to have a dependency to the security subsystem, so we redefine a constant 
williamr@2
   340
with the same value here.
williamr@2
   341
@internalTechnology
williamr@2
   342
*/
williamr@2
   343
const TInt KSAUidJavaInstallKeyValue = 0x1020806E;
williamr@2
   344
williamr@2
   345
williamr@2
   346
/** This is the global definition used by Software Install server (SWIS)
williamr@2
   347
This is the publish and subscribe property used by SWI to publish the most
williamr@2
   348
recently installed or updated application. If the application has 
williamr@2
   349
subsequently been uninstalled the value may refer to an application
williamr@2
   350
that no longer exists. Has value KUidNull if no applications have been 
williamr@2
   351
installed
williamr@2
   352
 
williamr@2
   353
@publishedPartner
williamr@2
   354
@released
williamr@2
   355
@capability ECapabilityTrustedUI capability is required to modify the value of this property
williamr@2
   356
*/
williamr@2
   357
const TUint KUidSwiLatestInstallation = 0x10272C8E;
williamr@2
   358
williamr@2
   359
/** This is the global definition of KUidJmiLatestInstallation used
williamr@2
   360
by Java Midlet Installer
williamr@2
   361
This is the publish and subscribe property used by JMI to publish the most
williamr@2
   362
recently installed application. If the application has 
williamr@2
   363
subsequently been uninstalled the value may refer to an application
williamr@2
   364
that no longer exists. Has value KUidNull if no applications have been 
williamr@2
   365
installed 
williamr@2
   366
williamr@2
   367
@publishedPartner
williamr@2
   368
@released
williamr@2
   369
@capability ECapabilityTrustedUI capability is required to modify the value of this property
williamr@2
   370
*/
williamr@2
   371
const TUint KUidJmiLatestInstallation = 0x10272D3D;
williamr@2
   372
williamr@2
   373
williamr@2
   374
/** This is the global definitioin of KUidUnifiedCertstoreFlag. This publish
williamr@2
   375
and subscribe property is used to notify users of changes in the unified certstore
williamr@2
   376
williamr@2
   377
@publishedPartner
williamr@2
   378
@released
williamr@2
   379
*/
williamr@2
   380
const TUint KUidUnifiedCertstoreFlag = 0x10272C83;
williamr@2
   381
williamr@2
   382
/**
williamr@2
   383
This is a duplicate of KUidBackupRestoreKey from the secure backup engine's sbdefs.h
williamr@2
   384
This is the Publish and Subscribe property used by Secure Backup Engine to publish its current 
williamr@2
   385
state. The publish and subscribe key is defined by SysAgent2 server.
williamr@2
   386
@publishedAll
williamr@2
   387
@released
williamr@2
   388
*/
williamr@2
   389
const TUint KUidBackupRestoreKey = 0x10202792;
williamr@2
   390
williamr@2
   391
williamr@2
   392
/** 
williamr@2
   393
This is a duplicate of KPosLastKnownLocationCategory from lbs's epos_lastknownlocationpsykeys.h
williamr@2
   394
It should NOT be used directly.
williamr@2
   395
Defines value UID of Location P&S keys category.
williamr@2
   396
The publish and subscribe key is defined by SysAgent2 server.
williamr@2
   397
@internalTechnology
williamr@2
   398
 */
williamr@2
   399
const TInt KSAPosLastKnownLocationCategoryValue	= 0x10009BFA;
williamr@2
   400
const TUid KSAPosLastKnownLocationCategory = { KSAPosLastKnownLocationCategoryValue };
williamr@2
   401
williamr@2
   402
/**
williamr@2
   403
This is a duplicate of KPosLastKnownLocation from lbs's epos_lastknownlocationpsykeys.h
williamr@2
   404
ID of the Last Known Location key.
williamr@2
   405
It should NOT be used directly.
williamr@2
   406
Contains binary values, a buffer with packaged TPositionInfo.
williamr@2
   407
williamr@2
   408
If it contains a buffer, which length does not match TPositionInfo,
williamr@2
   409
such value shall be ignored.
williamr@2
   410
williamr@2
   411
Client must have ReadDeviceData capability in order to read this key.
williamr@2
   412
@internalTechnology
williamr@2
   413
*/
williamr@2
   414
const TInt KSAPosLastKnownLocation = 0x00000001;
williamr@2
   415
williamr@2
   416
/** 
williamr@2
   417
This is a duplicate of KPosIndicatorCategoryUid from lbs's locationfwdomainpskeys.h
williamr@2
   418
It should NOT be used directly.
williamr@2
   419
Defines UID of Positioning Indicator P&S keys category. 
williamr@2
   420
@internalTechnology
williamr@2
   421
*/
williamr@2
   422
const TInt KSAPosIndicatorCategoryValue = 0x101F7A79 ;
williamr@2
   423
const TUid KSAPosIndicatorCategory = {KSAPosIndicatorCategoryValue};
williamr@2
   424
williamr@2
   425
/**
williamr@2
   426
This is a duplicate of KPosIntGpsHwStatus from lbs's locationfwdomainpskeys.h
williamr@2
   427
ID of the Integrated GPS HW Status key.
williamr@2
   428
It should NOT be used directly.
williamr@2
   429
May contain values defined by @ref TPosIntGpsHwIndicatorState.
williamr@2
   430
williamr@2
   431
Default value (i.e. when this key is not found) is EPosIntGpsHwIndicatorOff.
williamr@2
   432
williamr@2
   433
If it contains any other value than defined in @ref TPosIntGpsHwState,
williamr@2
   434
such value shall be ignored and TPosIndicatorState::EPosIntGpsHwIndicatorOff
williamr@2
   435
shall be assumed.
williamr@2
   436
@internalTechnology
williamr@2
   437
*/
williamr@2
   438
const TInt KSAPosIntGpsHwStatus = 0x00000001;
williamr@2
   439
// Deprecated - redundant method no longer used by system software
williamr@2
   440
IMPORT_C TInt StartSysAgt2();
williamr@2
   441
williamr@2
   442
#endif //__SACLS_H__