javaextensions/pim/common/inc.s60/pimcontact.h
changeset 21 2a9601315dfc
equal deleted inserted replaced
18:e8e63152f320 21:2a9601315dfc
       
     1 /*
       
     2 * Copyright (c) 2008 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:  Contact types and constants
       
    15  *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef PIMCONTACT_H
       
    20 #define PIMCONTACT_H
       
    21 
       
    22 /** @file
       
    23  * This file contains the PIM API constants and definitions for Contacts.
       
    24  */
       
    25 
       
    26 /**
       
    27  * Expresses that no preferred index has been set for a particular
       
    28  * Contact field.
       
    29  */
       
    30 #define KPIMNoPreferredIndex -1
       
    31 
       
    32 /**
       
    33  * Contact field constants.
       
    34  * [From javax.microedition.pim.Contact]
       
    35  */
       
    36 enum TPIMContactField
       
    37 {
       
    38     EPIMContactInvalidField = 0,
       
    39     /** Invalid contact field */
       
    40     EPIMContactAddr = 100,
       
    41     /**< \e String \e array, elements: \ref TPIMContactAddrElement. */
       
    42     EPIMContactBirthday = 101,
       
    43     /**< \e Date. */
       
    44     EPIMContactClass = 102,
       
    45     /**< \e Integer, values from \ref TPIMContactClassValue. */
       
    46     EPIMContactEmail = 103,
       
    47     /**< \e String. */
       
    48     EPIMContactFormattedAddr = 104,
       
    49     /**< \e String, may be compiled from \ref EPIMContactAddr field. */
       
    50     EPIMContactFormattedName = 105,
       
    51     /**< \e String, may be compiled from \ref EPIMContactName field. */
       
    52     EPIMContactName = 106,
       
    53     /**< \e String \e array, elements: \ref TPIMContactNameElement. */
       
    54     EPIMContactNickname = 107,
       
    55     /**< \e String. */
       
    56     EPIMContactNote = 108,
       
    57     /**< \e String. */
       
    58     EPIMContactOrg = 109,
       
    59     /**< \e String. */
       
    60     EPIMContactPhoto = 110,
       
    61     /**< \e Byte \e array, bundled with \ref EPIMContactPhotoUrl (see
       
    62      PIM API javadoc). */
       
    63     EPIMContactPhotoUrl = 111,
       
    64     /**< \e String, bundled with \ref EPIMContactPhoto (see PIM API
       
    65      javadoc). */
       
    66     EPIMContactPublicKey = 112,
       
    67     /**< \e Byte \e array, bundled with \ref
       
    68      EPIMContactPublicKeyString (see PIM API javadoc). */
       
    69     EPIMContactPublicKeyString = 113,
       
    70     /**< \e String, bundled with \ref EPIMContactPublicKey (see PIM
       
    71      API javadoc). */
       
    72     EPIMContactRevision = 114,
       
    73     /**< \e Date, read-only when persisted (the time of last modification). */
       
    74     EPIMContactTel = 115,
       
    75     /**< \e String. */
       
    76     EPIMContactTitle = 116,
       
    77     /**< \e String. */
       
    78     EPIMContactUid = 117,
       
    79     /**< \e String, read-only when persisted (converted from the Item ID). */
       
    80     EPIMContactUrl = 118,
       
    81     /**< \e String. */
       
    82     EPIMContactExtWvUserId = 0x1005001,
       
    83     /**< String. */
       
    84     EPIMContactExtSip = 0x1005002,
       
    85     /**< String. */
       
    86     EPIMContactExtDtmf = 0x1005003,
       
    87     /**< String. */
       
    88     EPIMContactExtDepartment = 0x1005004,
       
    89     /**< String */
       
    90     EPIMContactExtAssistantName = 0x1005005,
       
    91     /**< String */
       
    92     EPIMContactExtChildren = 0x1005006,
       
    93     /**< String */
       
    94     EPIMContactExtSpouse = 0x1005007,
       
    95     /**< String */
       
    96     EPIMContactExtAnniversary = 0x1005008,
       
    97     /**< Date */
       
    98     EPIMContactExtVoip = 0x1005009,
       
    99     /**< String */
       
   100     EPIMContactExtPTT = 0x100500A,
       
   101     /**< String */
       
   102     EPIMContactExtSWIS = 0x100500B
       
   103     /**< String */
       
   104 };
       
   105 
       
   106 /**
       
   107  * Contact field generic attributes and extended attributes.
       
   108  * [From javax.microedition.pim.Contact]
       
   109  */
       
   110 enum TPIMContactFieldAttribute
       
   111 {
       
   112     EPIMContactAttrAsst = 1,
       
   113     EPIMContactAttrAuto = 2,
       
   114     EPIMContactAttrFax = 4,
       
   115     EPIMContactAttrHome = 8,
       
   116     EPIMContactAttrMobile = 16,
       
   117     EPIMContactAttrOther = 32,
       
   118     EPIMContactAttrPager = 64,
       
   119     EPIMContactAttrPreferred = 128,
       
   120     EPIMContactAttrSms = 256,
       
   121     EPIMContactAttrWork = 512,
       
   122     EPIMContactAttrExtVideoCall = 16777216
       
   123 };
       
   124 
       
   125 /**
       
   126  * Contact \ref EPIMContactAddr field (string array) elements.
       
   127  * \ref EPIMContactFormattedAddr field is compiled from the elements.
       
   128  * [From javax.microedition.pim.Contact]
       
   129  */
       
   130 enum TPIMContactAddrElement
       
   131 {
       
   132     EPIMContactAddrPoBox = 0,
       
   133     EPIMContactAddrExtra = 1,
       
   134     EPIMContactAddrStreet = 2,
       
   135     EPIMContactAddrLocality = 3,
       
   136     EPIMContactAddrRegion = 4,
       
   137     EPIMContactAddrPostalCode = 5,
       
   138     EPIMContactAddrCountry = 6,
       
   139     EPIMContactAddrNumElements = 7
       
   140     /**< Index of last element + 1. */
       
   141 };
       
   142 
       
   143 /**
       
   144  * Contact \ref EPIMContactClass field values.
       
   145  * [From javax.microedition.pim.Contact]
       
   146  */
       
   147 enum TPIMContactClassValue
       
   148 {
       
   149     EPIMContactClassConfidential = 200,
       
   150     EPIMContactClassPrivate = 201,
       
   151     EPIMContactClassPublic = 202
       
   152 };
       
   153 
       
   154 /**
       
   155  * Contact \ref EPIMContactName field (string array) elements.
       
   156  * \ref EPIMContactFormattedName field is compiled from the elements.
       
   157  * [From javax.microedition.pim.Contact]
       
   158  */
       
   159 
       
   160 enum TPIMContactNameElement
       
   161 {
       
   162     EPIMContactNameFamily = 0,
       
   163     EPIMContactNameGiven = 1,
       
   164     EPIMContactNameOther = 2,
       
   165     EPIMContactNamePrefix = 3,
       
   166     EPIMContactNameSuffix = 4,
       
   167     EPIMContactExtFamilyNameReading = 5,
       
   168     EPIMContactExtGivenNameReading = 6,
       
   169     EPIMContactNameNumElements = 7
       
   170     /**< Index of last element + 1. */
       
   171 };
       
   172 
       
   173 #endif // PIMCONTACT_H
       
   174 // End of file