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.
williamr@4
     1
/*
williamr@4
     2
* Copyright (c) 2004-2007 Nokia Corporation and/or its subsidiary(-ies).
williamr@4
     3
* All rights reserved.
williamr@4
     4
* This component and the accompanying materials are made available
williamr@4
     5
* under the terms of "Eclipse Public License v1.0"
williamr@4
     6
* which accompanies this distribution, and is available
williamr@4
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@4
     8
*
williamr@4
     9
* Initial Contributors:
williamr@4
    10
* Nokia Corporation - initial contribution.
williamr@4
    11
*
williamr@4
    12
* Contributors:
williamr@4
    13
*
williamr@4
    14
* Description:  Default store URIs offered by the Virtual Phonebook
williamr@4
    15
*
williamr@4
    16
*/
williamr@4
    17
williamr@4
    18
williamr@4
    19
williamr@4
    20
#ifndef VPBKCONTACTSTOREURIS_H
williamr@4
    21
#define VPBKCONTACTSTOREURIS_H
williamr@4
    22
williamr@4
    23
//  INCLUDES
williamr@4
    24
#include <e32std.h>
williamr@4
    25
williamr@4
    26
/**
williamr@4
    27
 * Default store URIs offered by the Virtual Phonebook.
williamr@4
    28
 *
williamr@4
    29
 * The Virtual Phonebook doesn't offer dynamic URI configuration repository.
williamr@4
    30
 * The repository of URIs is left to responsibility of a higher level component.
williamr@4
    31
 * 
williamr@4
    32
 * @lib VPbkEng.lib
williamr@4
    33
 */
williamr@4
    34
namespace VPbkContactStoreUris
williamr@4
    35
    {
williamr@4
    36
    /**
williamr@4
    37
     * Returns the default Contacts Model database store URI.
williamr@4
    38
     *
williamr@4
    39
     * @return The default Contacts Model database store URI.
williamr@4
    40
     */
williamr@4
    41
    IMPORT_C const TDesC& DefaultCntDbUri();
williamr@4
    42
williamr@4
    43
    /**
williamr@4
    44
     * Returns the global ADN SIM store URI.
williamr@4
    45
     * 
williamr@4
    46
     * Global means the ADN store that can be accessed by both GSM and 3G phone.
williamr@4
    47
     * 
williamr@4
    48
     * @return The global ADN SIM store URI
williamr@4
    49
     */
williamr@4
    50
    IMPORT_C const TDesC& SimGlobalAdnUri();
williamr@4
    51
williamr@4
    52
    /**
williamr@4
    53
     * Returns the global FDN SIM store URI.
williamr@4
    54
     *
williamr@4
    55
     * Global means the FDN store that can be accessed by both GSM and 3G phone.
williamr@4
    56
     *
williamr@4
    57
     * @return The global FDN SIM store URI
williamr@4
    58
     */
williamr@4
    59
    IMPORT_C const TDesC& SimGlobalFdnUri();
williamr@4
    60
williamr@4
    61
    /**
williamr@4
    62
     * Returns the global SDN SIM store URI. 
williamr@4
    63
     *
williamr@4
    64
     * Global means the SDN store that can be accessed by both GSM and 3G phone.
williamr@4
    65
     * 
williamr@4
    66
     * @return The global SDN SIM store URI
williamr@4
    67
     */
williamr@4
    68
    IMPORT_C const TDesC& SimGlobalSdnUri();
williamr@4
    69
williamr@4
    70
    /**
williamr@4
    71
     * Returns the MSISDN SIM store URI.
williamr@4
    72
     *
williamr@4
    73
     * Global means the MSISDN store that can be accessed by both GSM and
williamr@4
    74
     * 3G phone.
williamr@4
    75
     *
williamr@4
    76
     * NOTE: Though the name of the store suggests that the store will contain
williamr@4
    77
     *       the caller's own phone number it's not exactly the case. It can
williamr@4
    78
     *       contain the number but only if it has been set.
williamr@4
    79
     *
williamr@4
    80
     * @return The MSISDN SIM store URI.
williamr@4
    81
     */
williamr@4
    82
    IMPORT_C const TDesC& SimGlobalOwnNumberUri();
williamr@4
    83
    }
williamr@4
    84
williamr@4
    85
#endif      // VPBKCONTACTSTOREURIS_H
williamr@4
    86
            
williamr@4
    87
// End of File