mmsengine/inc/MmsEnginePrivateCRKeys.h
changeset 0 72b543305e3a
equal deleted inserted replaced
-1:000000000000 0:72b543305e3a
       
     1 /*
       
     2 * Copyright (c) 2004-2009 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:  
       
    15 *     Definitions of private keys related to MmsEngine settings in CenRep
       
    16 *
       
    17 */
       
    18 
       
    19 
       
    20 
       
    21 #ifndef MMSENGINEPRIVATECRKEYS_H
       
    22 #define MMSENGINEPRIVATECRKEYS_H
       
    23 
       
    24 #include <MmsEngineDomainCRKeys.h>
       
    25 
       
    26 const TUid KCRUidMmsEngineRegistryId = {0x101FB0D5};
       
    27 
       
    28 /**
       
    29 * KMmsServerSettingsVersion 
       
    30 * Defines the settings version.
       
    31 * Default value: 30
       
    32 */
       
    33 const TUint32 KMmsEngineSettingsVersion =               0x00000001;
       
    34 
       
    35 /**
       
    36 * KMmsEngineDefaultService 
       
    37 * Defines the entry id of the default service.
       
    38 * Default value: 0
       
    39 */
       
    40 const TUint32 KMmsEngineDefaultServiceId =              0x00000002;
       
    41 
       
    42 /**
       
    43 * KMmsEngineNotificationFolderId
       
    44 * Defines the folder entry id of the notification folder.
       
    45 * Default value: 0
       
    46 */
       
    47 const TUint32 KMmsEngineNotificationFolderId =          0x0000001B;
       
    48 
       
    49 /**
       
    50 * KMmsEngineMMBoxFolderId
       
    51 * Defines the folder entry id of the mmbox folder.
       
    52 * Default value: 0
       
    53 */
       
    54 const TUint32 KMmsEngineMMBoxFolderId =                 0x0000001C;
       
    55 
       
    56 /**
       
    57 * KMmsEngineApplicationFolderId
       
    58 * Defines the folder entry id of the application folder.
       
    59 * Default value: 0
       
    60 */
       
    61 const TUint32 KMmsEngineApplicationFolderId =           0x00000020;
       
    62 
       
    63 
       
    64 /**
       
    65 * KMmsEngineAllowPersonal
       
    66 * Defines whether fetching personal messages are allowed or not.
       
    67 * Possible values:
       
    68 * 0 ( no )
       
    69 * 1 ( yes )
       
    70 * Default value: 1
       
    71 */
       
    72 const TUint32 KMmsEngineAllowPersonal =                 0x00000003;
       
    73 
       
    74 /**
       
    75 * KMmsEngineAllowAdvertisements 
       
    76 * Defines whether fetching advertisements are allowed or not. 
       
    77 * Possible values:
       
    78 * 0 ( no )
       
    79 * 1 ( yes )
       
    80 * Default value: 1
       
    81 */
       
    82 const TUint32 KMmsEngineAllowAdvertisement =            0x00000004;
       
    83 
       
    84 /**
       
    85 * KMmsEngineAllowInfomational 
       
    86 * Defines whether fetching of informational messages are allowed or not.
       
    87 * Possible values:
       
    88 * 0 ( no )
       
    89 * 1 ( yes )
       
    90 * Default value: 1
       
    91 */
       
    92 const TUint32 KMmsEngineAllowInformational =            0x00000005;
       
    93 
       
    94 /**
       
    95 * KMmsEngineAllowAnonymous 
       
    96 * Defines whether fetching of anonymous messages are allowed or not.
       
    97 * Possible values:
       
    98 * 0 ( no )
       
    99 * 1 ( yes )
       
   100 * Default value: 1
       
   101 */
       
   102 const TUint32 KMmsEngineAllowAnonymous =                0x00000006;
       
   103 
       
   104 /**
       
   105 * KMmsEngineDeliveryReportWanted 
       
   106 * Defines whether a delivery report is requested for sent messages.
       
   107 * Possible values:
       
   108 * 128 ( yes )
       
   109 * 129 ( no )
       
   110 * Default value: 129
       
   111 */
       
   112 const TUint32 KMmsEngineDeliveryReportWanted =          0x00000007;
       
   113 
       
   114 /**
       
   115 * KMmsEngineDeliveryReportSendingAllowed 
       
   116 * Defines whether to allow network to send a delivery report to sender
       
   117 * after receiving a message.
       
   118 * Possible values:
       
   119 * 128 ( yes )
       
   120 * 129 ( no )
       
   121 * Default value: 128
       
   122 */
       
   123 const TUint32 KMmsEngineDeliveryReportSendingAllowed =  0x00000008;
       
   124 
       
   125 /**
       
   126 * KMmsEngineExpiryInterval 
       
   127 * Defines the validity period in hours that is requested from the network
       
   128 * when sending a message.
       
   129 * Hours are valid in cen rep, seconds in code.
       
   130 * Recommended values:
       
   131 * 0 ( = maximum allowed by MMSC )
       
   132 * 1 ( 1 hour )
       
   133 * 6 ( 6 hours )
       
   134 * 24 ( 24 hours )
       
   135 * 72 ( 3 days = 72 hours )
       
   136 * 168 ( 1 week = 168 hours )
       
   137 * Default value: 0
       
   138 */
       
   139 const TUint32 KMmsEngineExpiryInterval =                0x00000009;
       
   140 
       
   141 /**
       
   142 * KMmsEngineExpiryOvershoot 
       
   143 * Defines a period of time in seconds that the expiry time (reported in
       
   144 * the received notification) can be overshoot and message fetching still tried.
       
   145 * Default value: 300
       
   146 */
       
   147 const TUint32 KMmsEngineExpiryOvershoot =               0x0000000A;
       
   148 
       
   149 /**
       
   150 * KMmsEngineSenderVisibility 
       
   151 * Defines whether network sends our number to the message recipient.
       
   152 * This feature has to be supported also by the network.
       
   153 * Possible values:
       
   154 * 0   ( network desides )
       
   155 * 128 ( hide sender identity )
       
   156 * 129 ( show sender identity )
       
   157 * Default value: 0
       
   158 */
       
   159 const TUint32 KMmsEngineSenderVisibility =              0x0000000D;
       
   160 
       
   161 /**
       
   162 * KMmsEngineReadReplyReportWanted
       
   163 * Defines whether read report is requested when sending a message.
       
   164 * Possible values:
       
   165 * 128 ( yes )
       
   166 * 129 ( no )
       
   167 * Default value: 129
       
   168 */
       
   169 const TUint32 KMmsEngineReadReplyReportWanted =         0x0000000E;
       
   170 
       
   171 /**
       
   172 * KMmsEngineReadReplyReportSendingAllowed
       
   173 * Defines whether to allow sending a read report related to a received message.
       
   174 * Possible values:
       
   175 * 0 ( no )
       
   176 * 1 ( yes )
       
   177 * Default value: 1
       
   178 */
       
   179 const TUint32 KMmsEngineReadReplyReportSendingAllowed = 0x0000000F;
       
   180 
       
   181 /**
       
   182 * KMmsEngineLogEmailRecipients
       
   183 * Defines whether email recipients should get an entry into log
       
   184 * when sending a message (i.e. entry having a "Pending" status).
       
   185 * This feature depends also upon KMmsEngineDeliveryReport setting.
       
   186 * (email gateways often do not support delivery reporting)
       
   187 * Possible values:
       
   188 * 0 ( no )
       
   189 * 1 ( yes )
       
   190 * Default value: 1
       
   191 */
       
   192 const TUint32 KMmsEngineLogEmailRecipients =            0x00000012;
       
   193 
       
   194 /**
       
   195 * KMmsEngineReceivingModeForeign
       
   196 * Defines the receive mode when roaming.
       
   197 * Possible values:
       
   198 * 1 ( Automatic )
       
   199 * 2 ( Manual )
       
   200 * 3 ( Postpone )
       
   201 * 4 ( Reject )
       
   202 * Default value: 2
       
   203 */
       
   204 const TUint32 KMmsEngineReceivingModeForeign =          0x00000014;
       
   205 
       
   206 /**
       
   207 * KMmsEngineReceivingModeHome 
       
   208 * Defines the receive mode when in home network.
       
   209 * Possible values:
       
   210 * 1 ( Automatic )
       
   211 * 2 ( Manual )
       
   212 * 3 ( Postpone )
       
   213 * 4 ( Reject )
       
   214 * Default value: 1
       
   215 */
       
   216 const TUint32 KMmsEngineReceivingModeHome =             0x00000015;
       
   217 
       
   218 /**
       
   219 * KMmsEnginePseudoMMBox 
       
   220 * Defines the default value of the X-StoredInMMBox header value used
       
   221 * if the header is not present in the MM Notification.
       
   222 * (i.e. if received notification really specifies this,
       
   223 * it will override this setting)
       
   224 * Possible values:
       
   225 * 0 ( No MMBox by default)
       
   226 * 1 ( Message is in MMBox by default)
       
   227 * Default value: 0
       
   228 */
       
   229 const TUint32 KMmsEnginePseudoMMBox =                   0x00000016;
       
   230 
       
   231 /**
       
   232 * KMmsEngineShowSentTime
       
   233 * Defines whether received mms messages show time when the message was sent or
       
   234 * when the mms message was received to the device.
       
   235 * Note this affects only received mms messages.  
       
   236 * 
       
   237 * Possible values:
       
   238 * 0 ( no, received mms message shows time when the message arrives to device is shown. ) 
       
   239 * 1 ( yes, received mms message shows time when the message was sent. )
       
   240 * Default value: 0
       
   241 */
       
   242 const TUint32 KMmsEngineShowSentTime = 0x00000021;
       
   243 
       
   244 /**
       
   245 * KMmsEngineMessagePriority 
       
   246 * Defines message priority code
       
   247 * Possible values:
       
   248 * 128 ( Low )
       
   249 * 129 ( Normal )
       
   250 * 130 ( High )
       
   251 * Default value: 129
       
   252 */
       
   253 const TUint32 KMmsEngineMessagePriority =               0x00000017;
       
   254 
       
   255 /**
       
   256 * KMmsEngineMessageClass 
       
   257 * Defines message class
       
   258 * Possible values:
       
   259 * 128 ( Personal )
       
   260 * 129 ( Advertisement )
       
   261 * 130 ( Informational )
       
   262 * 131 ( Auto )
       
   263 * Default value: 128
       
   264 */
       
   265 const TUint32 KMmsEngineMessageClass =                  0x00000018;
       
   266 
       
   267 /**
       
   268 * KMmsEngineLocalMode 
       
   269 * Defines whether MMS engine should run in local or normal mode
       
   270 * Possible values:
       
   271 * 0 ( EFalse )
       
   272 * 1 ( ETrue )
       
   273 * Default value: 0
       
   274 */
       
   275 const TUint32 KMmsEngineLocalMode =                     0x0000001D;
       
   276 
       
   277 /**
       
   278 * KMmsEngineDecodeLog 
       
   279 * Defines whether MMS engine should produce extra logging when decoding messages
       
   280 * Possible values:
       
   281 * 0 ( EFalse )
       
   282 * 1 ( ETrue )
       
   283 * Default value: 0
       
   284 
       
   285 */
       
   286 const TUint32 KMmsEngineDecodeLog =                     0x0000001E;
       
   287 
       
   288 /**
       
   289 * KMmsEngineBinaryDump 
       
   290 * Defines whether MMS engine should dump the binary messages into file when decoding
       
   291 * Possible values:
       
   292 * 0 ( EFalse )
       
   293 * 1 ( ETrue )
       
   294 * Default value: 0
       
   295 */
       
   296 const TUint32 KMmsEngineBinaryDump =                    0x0000001F;
       
   297 
       
   298 /**
       
   299 * KMmsEncodingType
       
   300 * Defines target encoding type to be used to send MMS message. 
       
   301 * Currently text objects/attachments can be encoded in different encoding type specified,
       
   302 * provided corresponding conversion plugins are available  
       
   303 * Possible values:
       
   304 * 0  (Default encoding mechanism)
       
   305 * 36 (Korean specific-KSC5601 encoding)
       
   306 * Default value: 0
       
   307 */
       
   308 const TUint32 KMmsEncodingType =                        0x00000023;
       
   309 
       
   310 ///////////////////////////////////////////////////////////////////////////////
       
   311 //
       
   312 // Following constants are for schedule settings
       
   313 //
       
   314 ///////////////////////////////////////////////////////////////////////////////
       
   315 
       
   316 const TUint32 KMmsScheduleVersion =                     0x00010000;
       
   317 const TUint32 KMmsSchedulePriority =                    0x00010001;
       
   318 const TUint32 KMmsScheduleValidityPeriod =              0x00010002;
       
   319 const TUint32 KMmsScheduleIntervalType =                0x00010003;
       
   320 const TUint32 KMmsScheduleLatency =                     0x00010004;
       
   321 const TUint32 KMmsScheduleSendLongInterval =            0x00010005;     	
       
   322 const TUint32 KMmsScheduleSendShortInterval =           0x00010006;
       
   323 const TUint32 KMmsScheduleSendVariableIntervalsCount =  0x00010007;
       
   324 const TUint32 KMmsScheduleSendVariableIntervalArrayBase	= 0x00011000;
       
   325 const TUint32 KMmsScheduleRecvLongInterval =            0x00010008;     	
       
   326 const TUint32 KMmsScheduleRecvShortInterval =           0x00010009;
       
   327 const TUint32 KMmsScheduleRecvVariableIntervalsCount =  0x0001000A;
       
   328 const TUint32 KMmsScheduleRecvVariableIntervalArrayBase	= 0x00012000;
       
   329 const TUint32 KMmsSchedulePendingConditionsTimeout      = 0x0001000B;
       
   330 
       
   331 ///////////////////////////////////////////////////////////////////////////////
       
   332 //
       
   333 // Following constants are for schedule error action settings
       
   334 //
       
   335 ///////////////////////////////////////////////////////////////////////////////
       
   336 
       
   337 const TUint32 KMmsScheduleErrorActionsVersion =         0x00030000;
       
   338 const TUint32 KMmsScheduleSendErrorActionsCount	=       0x00030001;
       
   339 const TUint32 KMmsScheduleRecvErrorActionsCount	=       0x00030002;
       
   340 // Number of errors that cause an immediate failure (no retries)
       
   341 const TUint32 KMmsImmediateFailureErrorCount =          0x00030003;
       
   342 
       
   343 // Error action bases
       
   344 
       
   345 // This error action is used in sending when error code is not found
       
   346 // from the action list
       
   347 const TUint32 KMmsScheduleSendErrorDefaultAction =      0x00031000;
       
   348 
       
   349 // Start of error actions that require different handling for sending.
       
   350 // These are complete structures defining number of retries and intervals.
       
   351 // Immediate failure cases that are common for sending and receiving
       
   352 // are in a separate list
       
   353 const TUint32 KMmsScheduleSendErrorActionsBase =        0x00032000;
       
   354 
       
   355 // This error action is used in receiving when error code is not found
       
   356 // from the action list
       
   357 const TUint32 KMmsScheduleRecvErrorDefaultAction =      0x00033000;
       
   358 
       
   359 // Start of error actions that require different handling for receiving.
       
   360 // These are complete structures defining number of retries and intervals.
       
   361 // Immediate failure cases that are common for sending and receiving
       
   362 // are in a separate list.
       
   363 const TUint32 KMmsScheduleRecvErrorActionsBase =        0x00034000;
       
   364 
       
   365 // List for error codes that cause an immediate failure
       
   366 // This list is common for sending and receiving
       
   367 // This is just a list of error codes, no action information is defined for these
       
   368 // Each error only takes one line (one key), so no spacing for these needs to 
       
   369 // be defined
       
   370 const TUint32 KMmsImmediateFailureErrorBase =           0x00035000;
       
   371 
       
   372 // Elements of the error action structure
       
   373 // These are used for errors in lists starting from
       
   374 // KMmsScheduleSendErrorActionsBase and KMmsScheduleRecvErrorActionsBase
       
   375 const TUint32 KMmsErrorActionVersion =                  0x00000000; // obsolete
       
   376 const TUint32 KMmsErrorActionError =                    0x00000001;
       
   377 const TUint32 KMmsErrorActionMaxRetries	=               0x00000002;    	
       
   378 const TUint32 KMmsErrorActionRetries =                  0x00000003;
       
   379 const TUint32 KMmsErrorActionAction =                   0x00000004;
       
   380 const TUint32 KMmsErrorActionRetrySpacing =             0x00000005;
       
   381 
       
   382 
       
   383 #endif      // MMSENGINEPRIVATECRKEYS_H