Data Types
[Contacts Data Model]

Enumerations
enum	AlpContactsDmlColumnType {   Prefix = 1, Suffix = 2, FirstName = 3, LastName = 4,   MiddleName = 5, Title = 6, SmallThumbnail = 7, Company = 8,   NickName = 9, ThumbnailFileName = 10, YomiFirstName = 11, YomiLastName = 12,   YomiCompany = 13, Ringtone = 14, Note = 15, Birthday = 16,   BirthdayAlarm = 17, Anniversary = 18, AnniversaryAlarm = 19, EnglishName = 20,   UseCount = 21, DontBeamNote = 22, IsBusinessCard = 23, Identifier = 24,   Address = 25, City = 26, State = 27, PostalCode = 28,   Country = 29, VCardSrc = 30, LargeThumbnail = 31, Value = 32,   ContactType = 34, SpeedDial = 35, DefaultContact = 36, ThumbnailData = 37,   Label = 38, SIMPhoneBook = 39, SIMEntryID = 40, ContactID = 41,   VideoRingtone = 42, kContactsDMLLastPublicColumn = VideoRingtone, kContactsDMLReservedColumn = -1 }
enum	AlpContactsDmlDistributionMembershipOrderByType { OrderDistributionMembershipByNone, OrderDistributionMembershipByDistributionID, NumDistributionMembershipOrderByTypes }
enum	AlpContactsDmlDistributionOrderByType { OrderDistributionByID, OrderDistributionByValue, OrderDistributionByType, NumDistributionOrderByTypes }
enum	AlpContactsDmlFormatNameType { FriendlyName, ListViewSortLastName, ListViewSortCompany, ListViewSortFirstName }
enum	AlpContactsDmlItemType {   PersonItem = 1, ContactItem = 2, AddressItem = 3, ExtraFieldItem = 4,   ThumbnailItem = 5, CustomLabelItem = 6, DistributionItem = 7, ListViewItem = 8,   DistributionMembershipItem = 9 }
enum	AlpContactsDmlOrderByType {   OrderByNone, OrderByLastFirstCompany, OrderByLastCompanyFirst, OrderByFirstLastCompany,   OrderByFirstCompanyLast, OrderByCompanyFirstLast, OrderByCompanyLastFirst, NumOrderByTypes }
enum	AlpContactsDmlRingtoneType { VoiceRingtoneType, VideoRingtoneType }

---

Enumeration Type Documentation

enum AlpContactsDmlColumnType

The enum below lists all the fields that can be get and set in any of the AlpContactsDmlItemType's above. Note the enum value is used in the names of the edit dialog items (quasi data-driven programming with no meta info avail) Enumerator: Prefix  String - Used in: PersonItem. Suffix  String - Used in: PersonItem. FirstName  String - Used in: PersonItem. LastName  String - Used in: PersonItem. MiddleName  String - Used in: PersonItem. Title  String - Used in: PersonItem. SmallThumbnail  Blob - Cannot be set in ThumbnailItem but can be read from ThumbnailItem iterator. The value will be a GdkPixbuf scaled to a size defined in the global settings by a licensee. Company  String - Used in: PersonItem. NickName  String - Used in: PersonItem. ThumbnailFileName  String - Used in ThumbnailItem. This property can only be written, but not read from a ThumbnailItem. Either this field or ThumbnailData must be set in the ThumbnailItem. But if more than one property is set, or one property set more than once, the most recent setting is stored. YomiFirstName  String - Used in: PersonItem. YomiLastName  String - Used in: PersonItem. YomiCompany  String - Used in: PersonItem. Ringtone  String - Used in: PersonItem. Note  String - Used in: PersonItem. Birthday  Int32 - Used in: PersonItem. Packed int year:23 month:4 day:5. BirthdayAlarm  Int32 - Used in: PersonItem. In days (<365). -1 No alarm. Anniversary  Int32 - Used in: PersonItem. Packed int year:23 month:4 day:5. AnniversaryAlarm  Int32 - Used in: PersonItem. In days (<365). -1 No alarm. EnglishName  String - Used in: PersonItem. UseCount  Int32 - Used in: ContactItem, PersonItem - Cannot be NULL. DontBeamNote  Int32 - Used in: PersonItem - Cannot be NULL. IsBusinessCard  Int32 - Used in: PersonItem - Cannot be NULL. Identifier  String - Used in: AddressItem, ContactItem, ExtraFieldItem. For a ContactItem, the Contacts application uses AlpContactIdentifierType. Address  String - Used in: AddressItem. City  String - Used in: AddressItem. State  String - Used in: AddressItem. PostalCode  String - Used in: AddressItem. Country  String - Used in: AddressItem. VCardSrc  String - Used in: ExtraFieldItem, ContactItem, AddressItem. LargeThumbnail  Blob - Cannot be set in ThumbnailItem but can be read from ThumbnailItem iterator. The value will be a JPG image scaled to a size defined in the global settings by a licensee. Value  String - Used in: ExtraFieldItem, ContactItem, DistributionItem (name of the list). ContactType  String - Used in: ContactItem, DistributionItem. SpeedDial  Int32 - Used in: ContactItem. DefaultContact  Int32 - Used in: ContactItem - Cannot be NULL. ThumbnailData  Blob - Used in ThumbnailItem. Can only be written to but not read from a ThumbnailItem. Either this field or ThumbnailFileName must be set in the ThumbnailItem, but if this or the ThumbnailFileName property are set more than once, the most recent property setting is stored in the ThumbnailItem. Label  String - Used in CustomLabelItem. SIMPhoneBook  Int32 - Used in: PersonItem. SIMEntryID  Int32 - Used in: PersonItem. ContactID  Int32 - Used in distribution membership iteration. VideoRingtone  String - Used in: PersonItem. kContactsDMLLastPublicColumn  kContactsDMLReservedColumn

enum AlpContactsDmlDistributionMembershipOrderByType

Used by alp_contacts_dml_distribution_membership_statement_begin() Enumerator: OrderDistributionMembershipByNone  OrderDistributionMembershipByDistributionID  NumDistributionMembershipOrderByTypes

enum AlpContactsDmlDistributionOrderByType

Used by alp_contacts_dml_distribution_statement_begin Enumerator: OrderDistributionByID  OrderDistributionByValue  OrderDistributionByType  NumDistributionOrderByTypes

enum AlpContactsDmlFormatNameType

Used by alp_contacts_dml_person_get_name() Enumerator: FriendlyName  "John Q. Smith Jr." ListViewSortLastName  "Last, First, Company" ListViewSortCompany  "Company, Last, First" ListViewSortFirstName  "First, Last, Company"

enum AlpContactsDmlItemType

Used for alp_contacts_dml_item_create() Enumerator: PersonItem  ContactItem  AddressItem  ExtraFieldItem  ThumbnailItem  CustomLabelItem  DistributionItem  ListViewItem  Not creatable. DistributionMembershipItem  Not creatable.

enum AlpContactsDmlOrderByType

Used by alp_contacts_dml_person_statement_begin() Enumerator: OrderByNone  OrderByLastFirstCompany  OrderByLastCompanyFirst  OrderByFirstLastCompany  OrderByFirstCompanyLast  OrderByCompanyFirstLast  OrderByCompanyLastFirst  NumOrderByTypes

enum AlpContactsDmlRingtoneType

Used by alp_contacts_dml_get_category_ringtone(), alp_contacts_dml_set_category_ringtone() and alp_contacts_dml_get_person_ringtone Enumerator: VoiceRingtoneType  VideoRingtoneType

---

Generated on Wed Jul 30 07:06:42 2008 by Doxygen 1.4.6 for ALP SDK + Hiker Documentation

Copyright © 1999-2008 ACCESS CO., LTD. All rights reserved.