include/alp/contacts_dml.h File Reference

Detailed Description

Public header for the Contacts Data Model.

#include <stdint.h>
#include <stdbool.h>
#include <string.h>
#include <alp/catmgr_dml.h>
#include <alp/hs_change_mgr.h>
#include <alp/sysclass.h>
#include <alp/types.h>
#include <glib.h>

Go to the source code of this file.

Defines

#define alp_contacts_dml_distribution_memberships_add   alp_contacts_dml_distribution_add_memberships

#define alp_contacts_dml_distribution_memberships_remove   alp_contacts_dml_distribution_remove_memberships

#define ALP_CONTACTS_DML_GET_DAY(x)   ( x & 0x1F )

#define ALP_CONTACTS_DML_GET_MONTH(x)   (((((uint32_t) x) >> 5 ) & 0xF) - 1)

#define ALP_CONTACTS_DML_GET_YEAR(x)   ((((uint32_t) x) >> 9 ) & 0x007FFFFF)

#define ALP_CONTACTS_DML_SET_DAY(x, day)   (x = ((((uint32_t) x) & 0xFFFFFFE0) | ( day & 0x1F )))

#define ALP_CONTACTS_DML_SET_MONTH(x, month)   (x = ((((uint32_t) x) & 0xFFFFFE1F) | (( (month+1) & 0xF ) << 5 )))

#define ALP_CONTACTS_DML_SET_YEAR(x, year)   (x = ((((uint32_t) x) & 0x000001FF) | (( year & 0x7FFFFF) << 9 )))

#define ALP_DATAMODEL_NOTIFICATION_TYPE_CONTACTS   "alp/datamodel/contacts"

#define ALP_STATUS_CONTACT_DML_CHANGEMGR_CONFLICT   (ALP_CLASS_CONTACTS_DML | 0x00200000)

#define ALP_STATUS_CONTACT_DML_CHANGEMGR_ERROR   (ALP_CLASS_CONTACTS_DML | 0x000A0000)

#define ALP_STATUS_CONTACT_DML_DATABASE_BUSY   (ALP_CLASS_CONTACTS_DML | 0x00300000)

#define ALP_STATUS_CONTACT_DML_NO_CHANGE_TRACKING_ERROR   (ALP_CLASS_CONTACTS_DML | 0x000B0000)

#define ALP_STATUS_CONTACTS_DML_BAD_PARAM   (ALP_CLASS_CONTACTS_DML | 0x00030000)

#define ALP_STATUS_CONTACTS_DML_CONTACTS_FULL   (ALP_CLASS_CONTACTS_DML | 0x00600000)

#define ALP_STATUS_CONTACTS_DML_DATABASE_ERR   (ALP_CLASS_CONTACTS_DML | 0x00040000)

#define ALP_STATUS_CONTACTS_DML_DRM_FILE   (ALP_CLASS_CONTACTS_DML | 0x00500000)

#define ALP_STATUS_CONTACTS_DML_DUPLICATE_ITEM   (ALP_CLASS_CONTACTS_DML | 0x00080000)

#define ALP_STATUS_CONTACTS_DML_INTERNAL_ERR   (ALP_CLASS_CONTACTS_DML | 0x00060000)

#define ALP_STATUS_CONTACTS_DML_INVALID_CUSTOM_COLUMN   (ALP_CLASS_CONTACTS_DML | 0x000D0000)

#define ALP_STATUS_CONTACTS_DML_INVALID_CUSTOM_SPECIFICATION   (ALP_CLASS_CONTACTS_DML | 0x000E0000)

#define ALP_STATUS_CONTACTS_DML_INVALID_LUID   (ALP_CLASS_CONTACTS_DML | 0x00050000)

#define ALP_STATUS_CONTACTS_DML_INVALID_TYPE   (ALP_CLASS_CONTACTS_DML | 0x00400000)

#define ALP_STATUS_CONTACTS_DML_MISSING_PROPERTY   (ALP_CLASS_CONTACTS_DML | 0x00090000)

#define ALP_STATUS_CONTACTS_DML_NO_CAT_RINGTONE   (ALP_CLASS_CONTACTS_DML | 0x00100000)

#define ALP_STATUS_CONTACTS_DML_NO_MATCH   (ALP_CLASS_CONTACTS_DML | 0x00070000)

#define ALP_STATUS_CONTACTS_DML_NO_MEM   (ALP_CLASS_CONTACTS_DML | 0x00010000)

#define ALP_STATUS_CONTACTS_DML_NO_RECORDS   (ALP_CLASS_CONTACTS_DML | 0x00020000)

#define ALP_STATUS_CONTACTS_DML_SIM_BUSY   (ALP_CLASS_CONTACTS_DML | 0x000F0000)

#define ALP_STATUS_CONTACTS_DML_UNFETCHED_COLUMN   (ALP_CLASS_CONTACTS_DML | 0x000C0000)

#define ALP_STATUS_CONTACTS_DML_UNSUPPORTED_PROPERTY   (ALP_CLASS_CONTACTS_DML | 0x00700000)

#define kAddressLabelTypeHome   "LabelHome"

#define kAddressLabelTypeOther   "LabelOther"

#define kAddressLabelTypeWork   "LabelWork"

#define kAddressTypeHome   "Home"

#define kAddressTypeOther   "Other"

#define kAddressTypeWork   "Work"

#define kContactCategoryLocalURI   "./alp/PIM/Contacts/Category"

#define kContactCategoryTargetURI   "./alp/PIM/Contacts/Category"

#define kContactCatMembershipLocalURI   "./alp/PIM/Contacts/Membership"

#define kContactCatMembershipTargetURI   "./alp/PIM/Contacts/Membership"

#define kContactCustomLabelsLocalURI   "./alp/PIM/Contacts/CustomLabels"

#define kContactCustomLabelsTargetURI   "./alp/PIM/Contacts/CustomLabels"

#define kContactIdentifier1   "Contact1"

#define kContactIdentifier2   "Contact2"

#define kContactIdentifier3   "Contact3"

#define kContactIdentifier4   "Contact4"

#define kContactIdentifier5   "Contact5"

#define kContactIdentifier6   "Contact6"

#define kContactIdentifierIM1   kContactIMIdentifierPrefix "1"

#define kContactIdentifierIM2   kContactIMIdentifierPrefix "2"

#define kContactIdentifierPrefix   "Contact"

#define kContactIdentifierURL   "ContactURL"

#define kContactIMIdentifierPrefix   "ContactIM"

#define kContactLocalURI   "./alp/PIM/Contacts/Content"

#define kContactTargetURI   "./alp/PIM/Contacts/Content"

#define kContactTypeAIM   "AIM"

#define kContactTypeEmail   "Email"

#define kContactTypeFAX   "FAX"

#define kContactTypeHome   "Home"

#define kContactTypeICQ   "ICQ"

#define kContactTypeJabberIM   "JabberIM"

#define kContactTypeMobile   "Mobile"

#define kContactTypeMSNIM   "MSNIM"

#define kContactTypeOther   "Other"

#define kContactTypeURL   "URL"

#define kContactTypeVideo   "Video"

#define kContactTypeWork   "Work"

#define kContactTypeYahooIM   "YahooIM"

#define kCustomLabelIdentifier1   kCustomLabelIdentifierPrefix "1"

#define kCustomLabelIdentifier2   kCustomLabelIdentifierPrefix "2"

#define kCustomLabelIdentifier3   kCustomLabelIdentifierPrefix "3"

#define kCustomLabelIdentifier4   kCustomLabelIdentifierPrefix "4"

#define kCustomLabelIdentifier5   kCustomLabelIdentifierPrefix "5"

#define kCustomLabelIdentifier6   kCustomLabelIdentifierPrefix "6"

#define kCustomLabelIdentifier7   kCustomLabelIdentifierPrefix "7"

#define kCustomLabelIdentifier8   kCustomLabelIdentifierPrefix "8"

#define kCustomLabelIdentifier9   kCustomLabelIdentifierPrefix "9"

#define kCustomLabelIdentifierPrefix   "Custom"

#define kDistributionContactTypeEmail   "Email"

#define kDistributionContactTypeMessaging   "Messaging"

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 }

Functions

alp_status_t alp_contacts_dml_add_memberships (AlpDmlH dmlH, AlpLuid personLuid, const AlpLuid *categoryLuids, AlpLuid membershipLuid, int32_t numCategoryLuids)

Adds the given personLuid to the given categories.

alp_status_t alp_contacts_dml_address_statement_begin (AlpDmlH dmlH, AlpLuid personLuid, AlpLuid addressLuid, AlpDmlStatementH *addressStmtH, int32_t *numResults)

Creates and initializes a new AlpDmlStatementH that can be used to iterate over a set of AddressItem's in the Contacts data model.

alp_status_t alp_contacts_dml_address_statement_begin_with_columns (AlpDmlH dmlH, AlpLuid personLuid, AlpLuid addressLuid, const AlpContactsDmlColumnType *columnTypes, int16_t numColumnTypes, AlpDmlStatementH *addressStmtH, int32_t *numResults)

Creates and initializes a new AlpDmlStatementH that can be used to iterate over a set of AddressItem's in the Contacts data model fetching only data in the list of column types.

alp_status_t alp_contacts_dml_begin_modify_batch (AlpDmlH dmlH)

Wrapper for alp_hscm_begin_modify_batch.

alp_status_t alp_contacts_dml_cid_lookup (AlpDmlH dmlH, const char *lookupString, AlpLuid *personLuid, AlpLuid *contactLuid)

Given a lookup string as input, this routine searches all contact records in the data model for a matching Value field.

alp_status_t alp_contacts_dml_close (AlpDmlH dmlH)

Close a handle to the Contacts Data Model.

alp_status_t alp_contacts_dml_contact_statement_begin (AlpDmlH dmlH, AlpLuid personLuid, AlpLuid contactLuid, const char *const *contactTypes, uint16_t numContactTypes, AlpDmlStatementH *contactsStmtH, int32_t *numResults)

Creates and initializes a new AlpDmlStatementH that can be used to iterate over a set of ContactItem's in the Contacts data model.

alp_status_t alp_contacts_dml_contact_statement_begin_with_columns (AlpDmlH dmlH, AlpLuid personLuid, AlpLuid contactLuid, const char *const *contactTypes, uint16_t numContactTypes, const AlpContactsDmlColumnType *columnTypes, int16_t numColumnTypes, AlpDmlStatementH *contactsStmtH, int32_t *numResults)

Creates and initializes a new AlpDmlStatementH that can be used to iterate over a set of ContactItem's in the Contacts data model fetching only data in the list of column types.

alp_status_t alp_contacts_dml_custom_label_statement_begin (AlpDmlH dmlH, AlpDmlStatementH *customLabelStmtH, int32_t *numResults)

alp_status_t alp_contacts_dml_custom_label_statement_begin_with_columns (AlpDmlH dmlH, const AlpContactsDmlColumnType *columnTypes, int16_t numColumnTypes, AlpDmlStatementH *customLabelStmtH, int32_t *numResults)

alp_status_t alp_contacts_dml_delete (AlpDmlH dmlH, AlpContactsDmlItemType itemType, AlpLuid itemLuid)

Deletes an item from the datamodel indicated by personLuid that was created with alp_contacts_dml_item_create.

alp_status_t alp_contacts_dml_distribution_add_memberships (AlpDmlH dmlH, AlpLuid contactID, const AlpLuid *distributionLuids, int32_t numDistributionLuids)

Adds the given contact ID to the given distribution lists.

alp_status_t alp_contacts_dml_distribution_membership_statement_begin (AlpDmlH dmlH, AlpLuid contactID, AlpLuid distributionLuid, AlpContactsDmlDistributionMembershipOrderByType orderBy, AlpDmlStatementH *distMembershipStmtH, int32_t *numResults)

Creates and initializes a new AlpDmlStatementH that can be used to iterate over the distribution list memberships.

alp_status_t alp_contacts_dml_distribution_remove_memberships (AlpDmlH dmlH, AlpLuid contactID, const AlpLuid *distributionLuids, int32_t numDistributionLuids)

Removes a given contact ID from a set of distribution lists.

alp_status_t alp_contacts_dml_distribution_statement_begin (AlpDmlH dmlH, AlpLuid distributionLuid, const char *const *distributionTypes, uint16_t numDistributionTypes, AlpContactsDmlDistributionOrderByType orderBy, int32_t limit, int32_t offset, AlpDmlStatementH *distributionStmtH, int32_t *numResults)

Creates and initializes a new AlpDmlStatementH that can be used to iterate over a set of DistributionItem's in the Contacts data model fetching only data in the list of column types.

alp_status_t alp_contacts_dml_duplicate (AlpDmlH dmlH, AlpLuid srcContact, AlpLuid *dupedContact)

Duplicates the given contact returning, if successful, the new contact LUID.

alp_status_t alp_contacts_dml_end_modify_batch (AlpDmlH dmlH, bool batchSucceeded)

Wrapper for alp_hscm_begin_modify_batch.

alp_status_t alp_contacts_dml_event_statement_begin (AlpDmlH dmlH, uint32_t startDay, uint32_t startMonth, uint32_t endDay, uint32_t endMonth, uint32_t year, AlpDmlStatementH *personStmtH, int32_t *numResults)

alp_status_t alp_contacts_dml_event_statement_begin_with_columns (AlpDmlH dmlH, uint32_t startDay, uint32_t startMonth, uint32_t endDay, uint32_t endMonth, uint32_t year, const AlpContactsDmlColumnType *columnTypes, int16_t numColumnTypes, AlpDmlStatementH *personStmtH, int32_t *numResults)

alp_status_t alp_contacts_dml_extrafields_statement_begin (AlpDmlH dmlH, AlpLuid personLuid, AlpDmlStatementH *extraFieldsStmtH, int32_t *numResults)

Creates and initializes a new AlpDmlStatementH that can be used to iterate over a set of ExtraFieldItem's in the Contacts data model.

alp_status_t alp_contacts_dml_extrafields_statement_begin_with_columns (AlpDmlH dmlH, AlpLuid personLuid, const AlpContactsDmlColumnType *columnTypes, int16_t numColumnTypes, AlpDmlStatementH *extraFieldsStmtH, int32_t *numResults)

Creates and initializes a new AlpDmlStatementH that can be used to iterate over a set of ExtraFieldItem's in the Contacts data model fetching only data in the list of column types.

alp_status_t alp_contacts_dml_get_category_ringtone (AlpDmlH dmlH, AlpLuid categoryLuid, AlpContactsDmlRingtoneType ringtoneType, char **ringtoneMFURL)

Retrieves any ringtone associated with the given category.

AlpDmlH alp_contacts_dml_get_catmgr_handle (AlpDmlH dmlH)

Returns an AlpDmlH that can be passed to Category Manager functions.

alp_status_t alp_contacts_dml_get_person_ringtone (AlpDmlH dmlH, AlpLuid personLuid, AlpContactsDmlRingtoneType ringtoneType, char **ringtoneFilePath)

Retrieves any ringtone associated with the given person. It will automatically search the person, its category, and finally default preferences for the appropriate ringtone.

alp_status_t alp_contacts_dml_get_thumbnail_sizes (uint32_t *largeWidth, uint32_t *largeHeight, uint32_t *smallWidth, uint32_t *smallHeight)

Returns the sizes used for thumbnail data.

alp_status_t alp_contacts_dml_get_version (AlpDmlH dmlH, int32_t *version)

alp_status_t alp_contacts_dml_insert (AlpDmlH dmlH, AlpDmlItemH itemH, AlpLuid *itemLuid)

Inserts a given item into the datamodel.

alp_status_t alp_contacts_dml_item_create (AlpContactsDmlItemType itemType, AlpDmlItemH *itemH)

Creates an item.

alp_status_t alp_contacts_dml_item_create_with_custom_fields (AlpDmlH dmlH, AlpContactsDmlItemType itemType, AlpDmlItemH *itemH)

Creates an item that allows any custom fields that were added to the default database to be set.

alp_status_t alp_contacts_dml_item_destroy (AlpDmlItemH itemH)

Destroys an item.

alp_status_t alp_contacts_dml_item_set_blob (AlpDmlItemH itemH, AlpContactsDmlColumnType column, const void *value, int32_t size)

Sets a blob for a given itemH.

alp_status_t alp_contacts_dml_item_set_int32 (AlpDmlItemH itemH, AlpContactsDmlColumnType column, const int32_t *value)

Sets an int32_t value in an item.

alp_status_t alp_contacts_dml_item_set_string (AlpDmlItemH itemH, AlpContactsDmlColumnType column, const char *value)

Sets a string value in an item.

alp_status_t alp_contacts_dml_listview_person_index (AlpDmlH dmlH, AlpLuid personLuid, AlpLuid categoryLuid, bool unfiled, AlpContactsDmlOrderByType orderBy, const char *filterBy, int32_t *index)

Given a set of list view creation criteria and a person luid calculate the index of the person in the list.

alp_status_t alp_contacts_dml_listview_statement_begin (AlpDmlH dmlH, AlpLuid categoryLuid, AlpLuid distributionLuid, bool unfiled, const char *const *contactTypes, int16_t numContactTypes, AlpContactsDmlOrderByType orderBy, int32_t limit, int32_t offset, const char *filterBy, bool filterDataOnly, AlpDmlStatementH *listViewStmtH, int32_t *totalPersons, int32_t *totalItems)

Creates and initializes a new AlpDmlStatementH that can be used to iterate over a set of specific PersonItem and ContactItem fields needed by the Contacts list view in the Contacts data model.

alp_status_t alp_contacts_dml_listview_statement_begin2 (AlpDmlH dmlH, AlpLuid categoryLuid, AlpLuid distributionLuid, bool unfiled, const char *const *contactTypes, int16_t numContactTypes, AlpContactsDmlOrderByType orderBy, int32_t limit, int32_t offset, const char *filterBy, AlpDmlStatementH *listViewStmtH, int32_t *totalPersons)

alp_status_t alp_contacts_dml_memberships_add (AlpDmlH dmlH, AlpLuid personLuid, const AlpLuid *categoryIDs, AlpLuid membershipLuid, int32_t numCategoryIDs) __attribute((deprecated))

Deprecated. Use alp_contacts_dml_add_memberships instead.

alp_status_t alp_contacts_dml_memberships_remove (AlpDmlH dmlH, AlpLuid personLuid, const AlpLuid *categoryIDs, AlpLuid membershipLuid, int32_t numCategoryIDs) __attribute((deprecated))

Deprecated. Use alp_contacts_dml_remove_memberships instead.

alp_status_t alp_contacts_dml_monitor_object (AlpDmlH dmlH, AlpLuid personLuid, AlpLuid *conflictLuid, AlpHsMonitorPtr *ppMonitor)

Creates an internal change manager object monitor for the given luid. The policy will be to create conflicts. If alp_contacts_dml_update returns ALP_STATUS_CONTACT_DML_CHANGEMGR_CONFLICT the conflictLuid pointer will be set.

alp_status_t alp_contacts_dml_open (AlpDmlH *dmlH, bool changeTrackingOn)

Opens and returns a handle to the Contacts Data Model.

alp_status_t alp_contacts_dml_person_get_name (AlpDmlStatementH personStmtH, AlpContactsDmlFormatNameType formatType, char **name)

Builds a Display Name.

alp_status_t alp_contacts_dml_person_statement_begin (AlpDmlH dmlH, AlpLuid personLuid, AlpLuid categoryLuid, bool unfiled, const char *const *contactTypes, int16_t numContactTypes, AlpContactsDmlOrderByType orderBy, AlpDmlStatementH *personStmtH, int32_t *numResults)

Creates and initializes a new AlpDmlStatementH that can be used to iterate over a set of PersonItem's in the Contacts data model.

alp_status_t alp_contacts_dml_person_statement_begin_with_columns (AlpDmlH dmlH, AlpLuid personLuid, AlpLuid categoryLuid, bool unfiled, const char *const *contactTypes, int16_t numContactTypes, AlpContactsDmlOrderByType orderBy, const AlpContactsDmlColumnType *columnTypes, int16_t numColumnTypes, AlpDmlStatementH *personStmtH, int32_t *numResults)

Creates and initializes a new AlpDmlStatementH that can be used to iterate over a set of PersonItem's in the Contacts data model fetching only data in the list of column types.

alp_status_t alp_contacts_dml_persons_from_vCard_buffer (AlpDmlH dmlH, const uint8_t *dataBuf, int32_t dataBufSize, bool fromExgMgr, bool forModify, GList **personIDs) __attribute((deprecated))

Deprecated. Use alp_contacts_dml_read_from_vCard_buffer instead.

alp_status_t alp_contacts_dml_persons_from_vCard_file (AlpDmlH dmlH, int theDataFd, bool fromExgMgr, bool forModify, GList **personIDs) __attribute((deprecated))

Deprecated. Use alp_contacts_dml_read_from_vCard_file.

alp_status_t alp_contacts_dml_persons_to_vCard_buffer (AlpDmlH dmlH, uint8_t **dataBuf, int32_t *dataBufSize, bool toExgMgr, GList *personLuids) __attribute((deprecated))

Deprecated. Use alp_contacts_dml_write_to_vCard_buffer instead.

alp_status_t alp_contacts_dml_persons_to_vCard_file (AlpDmlH dmlH, int theDataFd, bool toExgMgr, GList *personLuids) __attribute((deprecated))

Deprecated. Use alp_contacts_dml_write_to_vCard_file instead.

alp_status_t alp_contacts_dml_read_from_vCard_buffer (AlpDmlH dmlH, const uint8_t *dataBuf, int32_t dataBufSize, bool fromExgMgr, bool forModify, GList **personLuids)

Creates/Modifies one or more contacts from the contents of a buffer containing vCards.

alp_status_t alp_contacts_dml_read_from_vCard_file (AlpDmlH dmlH, int theDataFd, bool fromExgMgr, bool forModify, GList **personLuids)

Creates/Modifies one or more contacts from the contents of a file containing vCards.

alp_status_t alp_contacts_dml_register_alarm_ui_handler (AlpDmlH dmlH, char *appName)

alp_status_t alp_contacts_dml_release_monitor (AlpDmlH dmlH, AlpHsMonitorPtr pMonitor)

Releases any monitor set from alp_contacts_dml_monitor_object.

alp_status_t alp_contacts_dml_remove_memberships (AlpDmlH dmlH, AlpLuid personLuid, const AlpLuid *categoryLuids, AlpLuid membershipLuid, int32_t numCategoryLuids)

Removes a given personLuid's membership from a set of categories.

alp_status_t alp_contacts_dml_search_begin (AlpDmlH dmlH, AlpDmlStatementH *personStmtH, char *string, int32_t *numResults)

alp_status_t alp_contacts_dml_search_statement_begin (AlpDmlH dmlH, char *string, AlpDmlStatementH *personStmtH, int32_t *numResults) __attribute((deprecated))

Deprecated. Use alp_contacts_dml_search_begin instead.

alp_status_t alp_contacts_dml_set_category_ringtone (AlpDmlH dmlH, AlpLuid categoryLuid, AlpContactsDmlRingtoneType ringtoneType, const char *ringtoneFilePath)

Sets any ringtone associated with the given category.

alp_status_t alp_contacts_dml_set_next_alarm (AlpDmlH dmlH, AlpLuid personLuid)

alp_status_t alp_contacts_dml_statement_end (AlpDmlStatementH stmtH)

Disposes of the statement handle.

alp_status_t alp_contacts_dml_statement_get_blob (AlpDmlStatementH stmtH, AlpContactsDmlColumnType column, bool copy, void **value, int32_t *size)

Retrieves a blob from a statement handle.

alp_status_t alp_contacts_dml_statement_get_int32 (AlpDmlStatementH stmtH, AlpContactsDmlColumnType column, int32_t *value)

Retrieves an integer from a statement handle.

alp_status_t alp_contacts_dml_statement_get_luids (AlpDmlStatementH stmtH, AlpLuid *personLuid, AlpLuid *itemLuid)

Retrieves luids from a statement handle.

alp_status_t alp_contacts_dml_statement_get_string (AlpDmlStatementH stmtH, AlpContactsDmlColumnType column, bool copy, char **value)

Retrieves a string from a statement handle.

alp_status_t alp_contacts_dml_statement_next (AlpDmlStatementH stmtH)

Given a statement handle initialized with an alp_contacts_dml_*_statement_init() API, this routine will step the statement forward to point to the next item in the sequence.

alp_status_t alp_contacts_dml_thumbnail_statement_begin (AlpDmlH dmlH, AlpLuid personLuid, AlpDmlStatementH *thumbnailStmtH, int32_t *numResults)

Creates and initializes a new AlpDmlStatementH that can be used to iterate over a set of ThumbnailItem's in the Contacts data model.

alp_status_t alp_contacts_dml_thumbnail_statement_begin_with_columns (AlpDmlH dmlH, AlpLuid personLuid, const AlpContactsDmlColumnType *columnTypes, int16_t numColumnTypes, AlpDmlStatementH *thumbnailStmtH, int32_t *numResults)

Creates and initializes a new AlpDmlStatementH that can be used to iterate over a set of ThumbnailItem's in the Contacts data model fetching only data in the list of column types.

alp_status_t alp_contacts_dml_transaction_begin (AlpDmlH dmlH, bool exclusive)

Begins a transaction.

alp_status_t alp_contacts_dml_transaction_end (AlpDmlH dmlH)

Ends a transaction.

alp_status_t alp_contacts_dml_transaction_rollback (AlpDmlH dmlH)

Rolls back a transaction.

alp_status_t alp_contacts_dml_update (AlpDmlH dmlH, AlpDmlItemH itemH, AlpLuid itemLuid)

Updates a given item in the datamodel.

alp_status_t alp_contacts_dml_write_to_vCard_buffer (AlpDmlH dmlH, uint8_t **dataBuf, int32_t *dataBufSize, bool toExgMgr, const GList *personLuids)

Writes one or more contact vCards to an allocated buffer.

alp_status_t alp_contacts_dml_write_to_vCard_file (AlpDmlH dmlH, int theDataFd, bool toExgMgr, const GList *personLuids)

Writes one or more contact vCards to the given file.

Define Documentation

#define ALP_DATAMODEL_NOTIFICATION_TYPE_CONTACTS "alp/datamodel/contacts"

Data-change notification-type for "contacts". Any data-change in content, category, membership, label of a contact will fire this notification-event.

#define kContactCategoryLocalURI "./alp/PIM/Contacts/Category"

#define kContactCategoryTargetURI "./alp/PIM/Contacts/Category"

#define kContactCatMembershipLocalURI "./alp/PIM/Contacts/Membership"

#define kContactCatMembershipTargetURI "./alp/PIM/Contacts/Membership"

#define kContactCustomLabelsLocalURI "./alp/PIM/Contacts/CustomLabels"

#define kContactCustomLabelsTargetURI "./alp/PIM/Contacts/CustomLabels"

#define kContactLocalURI "./alp/PIM/Contacts/Content"

URI's used by change manager and contacts data stores

#define kContactTargetURI "./alp/PIM/Contacts/Content"

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