1 /*

     2 * Copyright (c) 2006 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 *

    16 */

    17 

    18 

    19 #ifndef NCD_CONFIGURATION_KEYS_H

    20 #define NCD_CONFIGURATION_KEYS_H

    21 

    22 /**

    23  * Configurations supported by the provider

    24  *

    25  * Clients can set values for these with

    26  * MNcdProvider::AddConfigurationL()

    27  *

    28  * Keys mentioned here are mostly used for filling specific

    29  * elements/attributes in configuration requests.

    30  *

    31  * Keys that are not listed here, are always added 

    32  * to software details in configuration requests.

    33  */

    34 namespace NcdConfigurationKeys

    35     {

    36     /**

    37      * List at least all of the keys that are used for

    38      * filling specific attributes/elements in configuration 

    39      * requests. Preferably list all so that clients don't have to know

    40      * the exact configuration attribute/element names.

    41      */

    42     

    43     /** 

    44      * The following keys MUST be set by the client before

    45      * any requests are sent

    46      */

    47      

    48      /**

    49       * Maximum disk space that the node cache is allowed to use

    50       *

    51       * @note This is not sent in any requests

    52       */

    53     _LIT( KMaxStorageSize, "max-storage-size" );

    54     

    55     /**

    56      * Client's version number

    57      */

    58     _LIT( KSoftwareVersion, "version" );

    59     

    60     /**

    61      * Type of the client software.

    62      * 

    63      * This can used to denote a client variant or the general type of the client

    64      */

    65     _LIT( KSoftwareType, "type" );

    66 

    67 

    68     /**

    69      * Master server URI, also known as CDB URI

    70      */

    71     _LIT( KMasterServer, "master-server" );

    72 

    73 

    74 

    75 

    76     /**

    77      * These keys SHOULD always be set

    78      */

    79      

    80      

    81     /**

    82      * Client provisioning

    83      *

    84      * @note Sent as a software detail in the client's client-element

    85      */

    86     _LIT( KProvisioning, "provisioning" );

    87     

    88     /**

    89      * Client language

    90      */

    91     _LIT( KSoftwareLanguage, "language" );

    92 

    93 

    94     /**

    95      * Key for setting display properties

    96      *

    97      * Format for the value: 

    98      * "'display number' 'width' 'height' 'number of colors'"

    99      *

   100      * eg. value="1 240 320 256"

   101      *

   102      * @note Display number is for future use. It should be 1 for now.

   103      */

   104     _LIT( KDisplay, "display" );

   105     

   106     

   107     /**

   108      * These keys MAY BE set

   109      */

   110     

   111      /**

   112       * Client-specific ID of the client skin.

   113       */

   114     _LIT( KSkinId, "skinId" );  

   115     

   116     /**

   117      * Drive letter where the client is installed on, eg. C:

   118      */  

   119     _LIT( KInstallDrive, "installDrive" );        

   120     

   121    /**

   122     * If this application-specific Online Info url is not set, the corresponding 

   123     * menu option is not visible

   124     */

   125     _LIT( KOnlineInfoUrl, "online-info-url");

   126     

   127     /**

   128      * Capability key can be added multiple times with different values

   129      * @see NcdCapabilities     

   130      */

   131     _LIT( KCapability, "capability" );

   132 

   133 

   134     /**

   135      * These keys MAY BE set for hardware information

   136      */

   137 

   138     /**

   139      * Device product code can be set for the hardware information.

   140      * This information is sent in requests to the server.

   141      */

   142     _LIT( KDeviceProductCode, "productCode" );

   143 

   144     }

   145     

   146 #endif // NCD_CONFIGURATION_KEYS_H