Address
[Protocol Common Services]

Detailed Description

Common Address APIs.


POSTAL ADDRESS CLASS VALUES

Defines address class values.

#define ALP_POSTAL_ADDRESS_ALL_MASK
 All mask.
#define ALP_POSTAL_ADDRESS_CLASS_FROM   ((alp_postal_address_class_t)1<<3)
 From.
#define ALP_POSTAL_ADDRESS_CLASS_RECIPIENT_BCC   ((alp_postal_address_class_t)1<<2)
 Blind Copy recipient.
#define ALP_POSTAL_ADDRESS_CLASS_RECIPIENT_CC   ((alp_postal_address_class_t)1<<1)
 Copy recipient.
#define ALP_POSTAL_ADDRESS_CLASS_RECIPIENT_TO   ((alp_postal_address_class_t)1<<0)
 Main recipient.
#define ALP_POSTAL_ADDRESS_CLASS_REPLY_TO   ((alp_postal_address_class_t)1<<4)
 Reply to.
#define ALP_POSTAL_ADDRESS_NONE_MASK   ((alp_postal_address_class_t)0)
 None mask.
#define ALP_POSTAL_ADDRESS_RECIPIENT_ALL_MASK
 Recipients mask.

POSTAL ADDRESS DELIVERY REPORT STATUS VALUES

Defines address delivery report status values.

#define ALP_POSTAL_ADDRESS_DELIVERY_REPORT_STATUS_DELIVERED   ((alp_postal_address_delivery_report_status_t)1)
 Delivered.
#define ALP_POSTAL_ADDRESS_DELIVERY_REPORT_STATUS_NOT_DELIVERED   ((alp_postal_address_delivery_report_status_t)3)
 Permanent not delivered.
#define ALP_POSTAL_ADDRESS_DELIVERY_REPORT_STATUS_TEMP_NOT_DELIVERED   ((alp_postal_address_delivery_report_status_t)2)
 Temporary not delivered.

POSTAL ADDRESS READ REPORT STATUS VALUES

Defines address read report status values.

#define ALP_POSTAL_ADDRESS_READ_REPORT_STATUS_NOT_READ   ((alp_postal_address_read_report_status_t)2)
 Not Read.
#define ALP_POSTAL_ADDRESS_READ_REPORT_STATUS_READ   ((alp_postal_address_read_report_status_t)1)
 Read.

POSTAL ADDRESS SCHEMES

Defines the postal address scheme.

#define ALP_POSTAL_ADDRESS_SCHEME_MAIL   "mailto:"
 Electronic mail address.
#define ALP_POSTAL_ADDRESS_SCHEME_TEL   "tel:"
 Telephone address.
#define ALP_POSTAL_ADDRESS_SCHEME_WV   "wv:"
 Wireless Village address.

POSTAL ADDRESS PROPERTIES

Defines address properties.

#define ALP_POSTAL_PROPERTY_ADDRESS_APP_CONTACT_ID   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ADDRESS, ALP_POSTAL_PROPERTY_TYPE_INT, 12)
 Platform Contact id. (for storage purpose only).
#define ALP_POSTAL_PROPERTY_ADDRESS_CLASS   ALP_POSTAL_PROPERTY_READ_ONLY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ADDRESS, ALP_POSTAL_PROPERTY_TYPE_INT, 5)
 Class.
#define ALP_POSTAL_PROPERTY_ADDRESS_DELIVERY_REPORT_DATE   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ADDRESS, ALP_POSTAL_PROPERTY_TYPE_DATE, 10)
 Delivery report date.
#define ALP_POSTAL_PROPERTY_ADDRESS_DELIVERY_REPORT_DATE_TZ   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ADDRESS, ALP_POSTAL_PROPERTY_TYPE_INT, 11)
 Delivery report timezone.
#define ALP_POSTAL_PROPERTY_ADDRESS_DELIVERY_REPORT_STATUS   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ADDRESS, ALP_POSTAL_PROPERTY_TYPE_INT, 9)
 Delivery report status.
#define ALP_POSTAL_PROPERTY_ADDRESS_MESSAGE_ID   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ADDRESS, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 13)
 Protocol Message id.
#define ALP_POSTAL_PROPERTY_ADDRESS_NAME   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ADDRESS, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 1)
 Address display Name.
#define ALP_POSTAL_PROPERTY_ADDRESS_NAME_NATIVE_CHARSET   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ADDRESS, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 2)
 Address display native charset encoding.
#define ALP_POSTAL_PROPERTY_ADDRESS_READ_REPORT_DATE   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ADDRESS, ALP_POSTAL_PROPERTY_TYPE_DATE, 7)
 Read report date.
#define ALP_POSTAL_PROPERTY_ADDRESS_READ_REPORT_DATE_TZ   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ADDRESS, ALP_POSTAL_PROPERTY_TYPE_INT, 8)
 Read report timezone.
#define ALP_POSTAL_PROPERTY_ADDRESS_READ_REPORT_STATUS   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ADDRESS, ALP_POSTAL_PROPERTY_TYPE_INT, 6)
 Read report status.
#define ALP_POSTAL_PROPERTY_ADDRESS_SCHEME   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ADDRESS, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 4)
 Scheme.
#define ALP_POSTAL_PROPERTY_ADDRESS_STRING   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ADDRESS, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 3)
 Address.

Defines

#define ALP_POSTAL_ADDRESS_INVALID_ID   ((alp_postal_address_id_t)ALP_POSTAL_INVALID_OBJECT_ID)
 Invalid Address ID definition.

Typedefs

typedef uint8_t alp_postal_address_class_t
 Address class type.
typedef uint8_t alp_postal_address_delivery_report_status_t
 Address delivery report status type.
typedef alp_postal_object_id_t alp_postal_address_id_t
 Address identifier type.
typedef uint8_t alp_postal_address_read_report_status_t
 Address read report status type.

Functions

alp_status_t alp_postal_address_free (AlpPostalAddress *iAddressP)
 Free the given Postal Address.
alp_status_t alp_postal_address_get_property (AlpPostalAddress *iAddressP, alp_postal_property_id_t iPropertyId, AlpPostalProperty **oAddressPropertyP)
 Retrieve a property from a Postal Address.
alp_status_t alp_postal_address_init (AlpPostalAddress *iAddressP)
 Initialize an address. MUST be called before use.
alp_status_t alp_postal_address_set_property (AlpPostalAddress *ioAddressP, alp_postal_property_id_t iAddressPropertyId, alp_postal_property_const_value_t iAddressPropertyDataP, uint16_t iAddressPropertyDataSize)
 Set a property to a Postal Address.
alp_status_t alp_postal_address_update_all (AlpPostalAddress *iAddressTemplateP, AlpPostalAddress *iUpdatedAddressP)
 Update all the addresses matching the template address criterias.

Define Documentation

#define ALP_POSTAL_ADDRESS_ALL_MASK
 

Value:

(ALP_POSTAL_ADDRESS_CLASS_RECIPIENT_TO | \
                                                                        ALP_POSTAL_ADDRESS_CLASS_RECIPIENT_CC | \
                                                                        ALP_POSTAL_ADDRESS_CLASS_RECIPIENT_BCC | \
                                                                        ALP_POSTAL_ADDRESS_CLASS_FROM | \
                                                                        ALP_POSTAL_ADDRESS_CLASS_REPLY_TO)
All mask.

#define ALP_POSTAL_ADDRESS_CLASS_FROM   ((alp_postal_address_class_t)1<<3)
 

From.

#define ALP_POSTAL_ADDRESS_CLASS_RECIPIENT_BCC   ((alp_postal_address_class_t)1<<2)
 

Blind Copy recipient.

#define ALP_POSTAL_ADDRESS_CLASS_RECIPIENT_CC   ((alp_postal_address_class_t)1<<1)
 

Copy recipient.

#define ALP_POSTAL_ADDRESS_CLASS_RECIPIENT_TO   ((alp_postal_address_class_t)1<<0)
 

Main recipient.

#define ALP_POSTAL_ADDRESS_CLASS_REPLY_TO   ((alp_postal_address_class_t)1<<4)
 

Reply to.

#define ALP_POSTAL_ADDRESS_DELIVERY_REPORT_STATUS_DELIVERED   ((alp_postal_address_delivery_report_status_t)1)
 

Delivered.

#define ALP_POSTAL_ADDRESS_DELIVERY_REPORT_STATUS_NOT_DELIVERED   ((alp_postal_address_delivery_report_status_t)3)
 

Permanent not delivered.

#define ALP_POSTAL_ADDRESS_DELIVERY_REPORT_STATUS_TEMP_NOT_DELIVERED   ((alp_postal_address_delivery_report_status_t)2)
 

Temporary not delivered.

#define ALP_POSTAL_ADDRESS_INVALID_ID   ((alp_postal_address_id_t)ALP_POSTAL_INVALID_OBJECT_ID)
 

Invalid Address ID definition.

#define ALP_POSTAL_ADDRESS_NONE_MASK   ((alp_postal_address_class_t)0)
 

None mask.

#define ALP_POSTAL_ADDRESS_READ_REPORT_STATUS_NOT_READ   ((alp_postal_address_read_report_status_t)2)
 

Not Read.

#define ALP_POSTAL_ADDRESS_READ_REPORT_STATUS_READ   ((alp_postal_address_read_report_status_t)1)
 

Read.

#define ALP_POSTAL_ADDRESS_RECIPIENT_ALL_MASK
 

Value:

(ALP_POSTAL_ADDRESS_CLASS_RECIPIENT_TO | \
                                                                        ALP_POSTAL_ADDRESS_CLASS_RECIPIENT_CC | \
                                                                        ALP_POSTAL_ADDRESS_CLASS_RECIPIENT_BCC)
Recipients mask.

#define ALP_POSTAL_ADDRESS_SCHEME_MAIL   "mailto:"
 

Electronic mail address.

#define ALP_POSTAL_ADDRESS_SCHEME_TEL   "tel:"
 

Telephone address.

#define ALP_POSTAL_ADDRESS_SCHEME_WV   "wv:"
 

Wireless Village address.

#define ALP_POSTAL_PROPERTY_ADDRESS_APP_CONTACT_ID   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ADDRESS, ALP_POSTAL_PROPERTY_TYPE_INT, 12)
 

Platform Contact id. (for storage purpose only).

#define ALP_POSTAL_PROPERTY_ADDRESS_CLASS   ALP_POSTAL_PROPERTY_READ_ONLY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ADDRESS, ALP_POSTAL_PROPERTY_TYPE_INT, 5)
 

Class.

#define ALP_POSTAL_PROPERTY_ADDRESS_DELIVERY_REPORT_DATE   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ADDRESS, ALP_POSTAL_PROPERTY_TYPE_DATE, 10)
 

Delivery report date.

#define ALP_POSTAL_PROPERTY_ADDRESS_DELIVERY_REPORT_DATE_TZ   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ADDRESS, ALP_POSTAL_PROPERTY_TYPE_INT, 11)
 

Delivery report timezone.

#define ALP_POSTAL_PROPERTY_ADDRESS_DELIVERY_REPORT_STATUS   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ADDRESS, ALP_POSTAL_PROPERTY_TYPE_INT, 9)
 

Delivery report status.

#define ALP_POSTAL_PROPERTY_ADDRESS_MESSAGE_ID   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ADDRESS, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 13)
 

Protocol Message id.

#define ALP_POSTAL_PROPERTY_ADDRESS_NAME   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ADDRESS, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 1)
 

Address display Name.

#define ALP_POSTAL_PROPERTY_ADDRESS_NAME_NATIVE_CHARSET   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ADDRESS, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 2)
 

Address display native charset encoding.

#define ALP_POSTAL_PROPERTY_ADDRESS_READ_REPORT_DATE   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ADDRESS, ALP_POSTAL_PROPERTY_TYPE_DATE, 7)
 

Read report date.

#define ALP_POSTAL_PROPERTY_ADDRESS_READ_REPORT_DATE_TZ   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ADDRESS, ALP_POSTAL_PROPERTY_TYPE_INT, 8)
 

Read report timezone.

#define ALP_POSTAL_PROPERTY_ADDRESS_READ_REPORT_STATUS   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ADDRESS, ALP_POSTAL_PROPERTY_TYPE_INT, 6)
 

Read report status.

#define ALP_POSTAL_PROPERTY_ADDRESS_SCHEME   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ADDRESS, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 4)
 

Scheme.

#define ALP_POSTAL_PROPERTY_ADDRESS_STRING   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_COMMON, ALP_POSTAL_SERVICE_CLASS_ID_ADDRESS, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 3)
 

Address.

Typedef Documentation

typedef uint8_t alp_postal_address_class_t
 

Address class type.

typedef uint8_t alp_postal_address_delivery_report_status_t
 

Address delivery report status type.

typedef alp_postal_object_id_t alp_postal_address_id_t
 

Address identifier type.

typedef uint8_t alp_postal_address_read_report_status_t
 

Address read report status type.

Function Documentation

alp_status_t alp_postal_address_free (  AlpPostalAddress *  iAddressP  ) 
 

Free the given Postal Address.

Parameters:
[in] iAddressP An address Ptr.
Returns:
Returns an error code.

alp_status_t alp_postal_address_get_property (  AlpPostalAddress *  iAddressP,
alp_postal_property_id_t  iPropertyId,
AlpPostalProperty **  oAddressPropertyP
) 
 

Retrieve a property from a Postal Address.

Parameters:
[in] iAddressP The Postal Address in which a property must be retrieved.
[in] iPropertyId an address property Id.
[out] oAddressPropertyP The Postal Address property to be retrieved.
Returns:
Returns an error code.

alp_status_t alp_postal_address_init (  AlpPostalAddress *  iAddressP  ) 
 

Initialize an address. MUST be called before use.

Parameters:
[in] iAddressP The Postal Address to be initialized.

alp_status_t alp_postal_address_set_property (  AlpPostalAddress *  ioAddressP,
alp_postal_property_id_t  iAddressPropertyId,
alp_postal_property_const_value_t  iAddressPropertyDataP,
uint16_t  iAddressPropertyDataSize
) 
 

Set a property to a Postal Address.

Parameters:
[in,out] ioAddressP The Postal Address in which a property must be set.
[in] iAddressPropertyId The Id of the property to be created.
[in] iAddressPropertyDataP The value of the property to be created.
[in] iAddressPropertyDataSize the size of the data, strlen+1 if it's a string
Returns:
Returns an error code.

alp_status_t alp_postal_address_update_all (  AlpPostalAddress *  iAddressTemplateP,
AlpPostalAddress *  iUpdatedAddressP
) 
 

Update all the addresses matching the template address criterias.

Parameters:
[in] iAddressTemplateP An address Ptr used for searching addresses to update.
[in] iUpdatedAddressP An address Ptr containing the updated properties.
Returns:
Returns an error code.

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

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