epoc32/include/app/VPbkContactStoreUris.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     1 /*
     2 * Copyright (c) 2004-2007 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:  Default store URIs offered by the Virtual Phonebook
    15 *
    16 */
    17 
    18 
    19 
    20 #ifndef VPBKCONTACTSTOREURIS_H
    21 #define VPBKCONTACTSTOREURIS_H
    22 
    23 //  INCLUDES
    24 #include <e32std.h>
    25 
    26 /**
    27  * Default store URIs offered by the Virtual Phonebook.
    28  *
    29  * The Virtual Phonebook doesn't offer dynamic URI configuration repository.
    30  * The repository of URIs is left to responsibility of a higher level component.
    31  * 
    32  * @lib VPbkEng.lib
    33  */
    34 namespace VPbkContactStoreUris
    35     {
    36     /**
    37      * Returns the default Contacts Model database store URI.
    38      *
    39      * @return The default Contacts Model database store URI.
    40      */
    41     IMPORT_C const TDesC& DefaultCntDbUri();
    42 
    43     /**
    44      * Returns the global ADN SIM store URI.
    45      * 
    46      * Global means the ADN store that can be accessed by both GSM and 3G phone.
    47      * 
    48      * @return The global ADN SIM store URI
    49      */
    50     IMPORT_C const TDesC& SimGlobalAdnUri();
    51 
    52     /**
    53      * Returns the global FDN SIM store URI.
    54      *
    55      * Global means the FDN store that can be accessed by both GSM and 3G phone.
    56      *
    57      * @return The global FDN SIM store URI
    58      */
    59     IMPORT_C const TDesC& SimGlobalFdnUri();
    60 
    61     /**
    62      * Returns the global SDN SIM store URI. 
    63      *
    64      * Global means the SDN store that can be accessed by both GSM and 3G phone.
    65      * 
    66      * @return The global SDN SIM store URI
    67      */
    68     IMPORT_C const TDesC& SimGlobalSdnUri();
    69 
    70     /**
    71      * Returns the MSISDN SIM store URI.
    72      *
    73      * Global means the MSISDN store that can be accessed by both GSM and
    74      * 3G phone.
    75      *
    76      * NOTE: Though the name of the store suggests that the store will contain
    77      *       the caller's own phone number it's not exactly the case. It can
    78      *       contain the number but only if it has been set.
    79      *
    80      * @return The MSISDN SIM store URI.
    81      */
    82     IMPORT_C const TDesC& SimGlobalOwnNumberUri();
    83     }
    84 
    85 #endif      // VPBKCONTACTSTOREURIS_H
    86             
    87 // End of File