include/alp/postal_sms_exchange.h File Reference

Detailed Description

Postal SMS exchange APIs.

#include <alp/postal_types.h>
#include <alp/postal_property.h>
#include <alp/postal_search.h>
#include <alp/postal_sms_notify_mgr.h>
#include <alp/telephony_types.h>
#include <hiker/exgmgr_verbs.h>

Go to the source code of this file.

SMS EXCHANGE MIME TYPES

Defines the SMS exchange mime types.

#define ALP_POSTAL_SMS_EXCHANGE_MIME_TYPE_CELLBROADCAST   "sms/cbs"

CellBroadcast SMS message mime type.

#define ALP_POSTAL_SMS_EXCHANGE_MIME_TYPE_CLASS0   "sms/c0s"

Class 0 SMS message mime type.

#define ALP_POSTAL_SMS_EXCHANGE_MIME_TYPE_CLASS2   "sms/c2s"

Class 2 SMS message mime type.

#define ALP_POSTAL_SMS_EXCHANGE_MIME_TYPE_EMI   "sms/emi"

Email waiting indication SMS message mime type.

#define ALP_POSTAL_SMS_EXCHANGE_MIME_TYPE_EMS   "sms/ems"

Reassembled EMS message mime type.

#define ALP_POSTAL_SMS_EXCHANGE_MIME_TYPE_FXI   "sms/fxi"

Fax waiting indication SMS message mime type.

#define ALP_POSTAL_SMS_EXCHANGE_MIME_TYPE_OTI   "sms/oti"

Other waiting indication SMS message mime type.

#define ALP_POSTAL_SMS_EXCHANGE_MIME_TYPE_REASSEMBLED   "sms/sms"

Reassembled SMS message mime type.

#define ALP_POSTAL_SMS_EXCHANGE_MIME_TYPE_REPORT   "sms/rps"

Delivery report SMS message mime type.

#define ALP_POSTAL_SMS_EXCHANGE_MIME_TYPE_SEGMENTED   "sms/psms"

Segmented part SMS mime type.

#define ALP_POSTAL_SMS_EXCHANGE_MIME_TYPE_VCAL   "text/x-vcalendar"

VCal over SMS.

#define ALP_POSTAL_SMS_EXCHANGE_MIME_TYPE_VCARD   "text/x-vcard"

VCard over SMS.

#define ALP_POSTAL_SMS_EXCHANGE_MIME_TYPE_VMI   "sms/vmi"

Voicemail waiting indication SMS message mime type.

#define ALP_POSTAL_SMS_EXCHANGE_MIME_TYPE_WAP_PUSH   "application/x-wap-push"

Wap push SMS message mime type.

#define ALP_POSTAL_SMS_EXCHANGE_MIME_TYPE_WAP_PUSH_HTTP   "application/x-wap-push-http"

Wap push OTA HTTP SMS message mime type.

#define ALP_POSTAL_SMS_EXCHANGE_MIME_TYPE_WAP_PUSH_HTTPS   "application/x-wap-push-https"

Wap push OTA HTTP secure SMS message mime type.

#define ALP_POSTAL_SMS_EXCHANGE_MIME_TYPE_WAP_PUSH_SEC   "application/x-wap-push-sec"

Wap push secure SMS message mime type.

SMS EXCHANGE PROPERTIES

Defines the SMS exchange properties.

#define ALP_POSTAL_SMS_PROPERTY_EXCHANGE_FORCE_DELETE   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_SMS, ALP_POSTAL_SMS_SERVICE_CLASS_ID_EXCHANGE, ALP_POSTAL_PROPERTY_TYPE_BOOLEAN, 3)

Force delete a boolean that deletes the dispatched message if no consumer can be found.

#define ALP_POSTAL_SMS_PROPERTY_EXCHANGE_MIME_TYPE   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_SMS, ALP_POSTAL_SMS_SERVICE_CLASS_ID_EXCHANGE, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 2)

Mime type a string that represents the associated exchange mime type of an exchange entry.

#define ALP_POSTAL_SMS_PROPERTY_EXCHANGE_PORT   ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_SMS, ALP_POSTAL_SMS_SERVICE_CLASS_ID_EXCHANGE, ALP_POSTAL_PROPERTY_TYPE_INT, 1)

Port number an integer that represents the port number of an exchange entry (can be NULL).

Defines

#define POSTAL_SMS_EXGMGR_DISPATCH_SMS_ACCESS_METHOD   "ACCESS"

Postal SMS Exchange "ACCESS" proprietary dispatching Method.

#define POSTAL_SMS_EXGMGR_DISPATCH_SMS_ACTION_CLASS   "DISPSMS"

Postal SMS Exchange "Dispatch SMS" Action Class.

#define POSTAL_SMS_EXGMGR_DISPATCH_SMS_FD_DATA_NAME   "SMS Data"

Postal SMS Exchange "Dispatch" parameter name to be used to retrieve data file decriptor.

#define POSTAL_SMS_EXGMGR_DISPATCH_SMS_FD_DATA_OBJECT_TYPE   "ReassembledSmsPdu"

Postal SMS Exchange data file decriptor parameter object type.

#define POSTAL_SMS_EXGMGR_DISPATCH_SMS_ORIGINATING_ADDRESS_NAME   "Originating Address"

Postal SMS Exchange "Dispatch" parameter name to be used to retrieve the originating address.

#define POSTAL_SMS_EXGMGR_DISPATCH_SMS_STRUCT_URL_NAME   "Struct URL"

Postal SMS Exchange "Dispatch" parameter name to be used to retrieve the URL related to a new SMS. This URL can be used with the alp_postal_sms_exchange_get_sms_parameters_from_url(...) helper API to retrieve the SMS data into a formatted structure.

#define POSTAL_SMS_EXGMGR_DISPATCH_SMS_VERB   POSTAL_SMS_EXGMGR_DISPATCH_SMS_ACTION_CLASS"/"POSTAL_SMS_EXGMGR_DISPATCH_SMS_ACCESS_METHOD

Postal SMS Exchange Dispatching SMS Verb.

#define POSTAL_SMS_EXGMGR_STORE_PARAM_URL_MAX_LENGTH   ALP_POSTAL_BODYPART_URI_PROPERTY_MAX_LENGTH

Postal SMS Exchange file descriptor path max length.

#define POSTAL_SMS_EXGMGR_STORE_SMS_VOBJECT_FD_DATA_NAME   "VObject Data"

Postal SMS Exchange "Store" parameter name to be used to retrieve "VObject" data file decriptor.

#define POSTAL_STATUS_SMS_EXGMGR_HANDLER_DID_NOT_CONSUME   ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_SMS_EXCHANGE, 0x01)

handler did not consume the request (used by handlers that accept multiple registrants)

Typedefs

typedef alp_postal_object_id_t alp_postal_sms_exchange_entry_id_t

Postal SMS exchange entry identifier type.

typedef _AlpPostalPropertyList AlpPostalSmsExchangeEntry

Postal SMS exchange entry.

Functions

alp_status_t alp_postal_sms_exchange_free_sms_parameters (AlpTelSmsMessage *iSmsParametersP, char *iDeleteUrlP)

Free the SMS parameters previously get from an url and delete the url if needed.

alp_status_t alp_postal_sms_exchange_get_sms_parameters_from_url (char *iUrlP, AlpTelSmsMessage **oSmsParametersPP)

Get the SMS parameters of a dispatched message from an url.

alp_status_t alp_postal_sms_exchange_table_entry_add_new (AlpPostalSmsExchangeEntry *iExchangeEntryP)

Add an exchange table entry to the exchange table list stored.

alp_status_t alp_postal_sms_exchange_table_entry_delete (alp_postal_sms_exchange_entry_id_t iExchangeEntryId)

Delete a stored exchange table entry.

alp_status_t alp_postal_sms_exchange_table_entry_enumerator_release (AlpPostalEnumerator *iEnumeratorP)

Release an sms exchange entry enumerator.

alp_status_t alp_postal_sms_exchange_table_entry_free (AlpPostalSmsExchangeEntry *iExchangeEntryP)

Free the given exchange table entry.

alp_status_t alp_postal_sms_exchange_table_entry_get_enumerator (AlpPostalEnumerator *oEnumeratorP)

Get an enumerator of the stored exchange table entries.

alp_status_t alp_postal_sms_exchange_table_entry_get_id (AlpPostalSmsExchangeEntry *iExchangeEntryP, alp_postal_sms_exchange_entry_id_t *oExchangeEntryP)

Get the id of an exchange table entry structure provided by the server, otherwise id won't exist.

alp_status_t alp_postal_sms_exchange_table_entry_get_next (AlpPostalEnumerator *iEnumeratorP, AlpPostalSmsExchangeEntry *ioExchangeEntryP)

Return the exchange table entry for the current position and increment the enumerator.

alp_status_t alp_postal_sms_exchange_table_entry_get_property (AlpPostalSmsExchangeEntry *iExchangeEntryP, alp_postal_property_id_t iSmsExchangeEntryPropertyId, AlpPostalProperty **ioExchangeEntryPropertyPP)

Retrieve a property from an exchange table entry.

alp_status_t alp_postal_sms_exchange_table_entry_init (AlpPostalSmsExchangeEntry *iExgEntryP)

Initialize an sms exchange entry.

alp_status_t alp_postal_sms_exchange_table_entry_init_enumerator (AlpPostalEnumerator *iEnumeratorP)

Initialize an sms exchange entry enumerator. MUST be called before alp_postal_sms_exchange_table_entry_get_enumerator API.

alp_status_t alp_postal_sms_exchange_table_entry_set_property (AlpPostalSmsExchangeEntry *ioSmsExchangeEntryP, alp_postal_property_id_t iSmsExchangeEntryPropertyId, alp_postal_property_const_value_t iSmsExchangeEntryPropertyDataP, uint16_t iSmsExchangeEntryPropertyDataSize)

Set a property to a Postal SmsExchangeEntry.

alp_status_t alp_postal_sms_exchange_table_entry_update (alp_postal_sms_exchange_entry_id_t iExchangeEntryId, AlpPostalSmsExchangeEntry *iExchangeEntryP)

Update a stored exchange table entry.

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


SMS EXCHANGE MIME TYPES
Defines the SMS exchange mime types.
#define	ALP_POSTAL_SMS_EXCHANGE_MIME_TYPE_CELLBROADCAST "sms/cbs"
	CellBroadcast SMS message mime type.
#define	ALP_POSTAL_SMS_EXCHANGE_MIME_TYPE_CLASS0 "sms/c0s"
	Class 0 SMS message mime type.
#define	ALP_POSTAL_SMS_EXCHANGE_MIME_TYPE_CLASS2 "sms/c2s"
	Class 2 SMS message mime type.
#define	ALP_POSTAL_SMS_EXCHANGE_MIME_TYPE_EMI "sms/emi"
	Email waiting indication SMS message mime type.
#define	ALP_POSTAL_SMS_EXCHANGE_MIME_TYPE_EMS "sms/ems"
	Reassembled EMS message mime type.
#define	ALP_POSTAL_SMS_EXCHANGE_MIME_TYPE_FXI "sms/fxi"
	Fax waiting indication SMS message mime type.
#define	ALP_POSTAL_SMS_EXCHANGE_MIME_TYPE_OTI "sms/oti"
	Other waiting indication SMS message mime type.
#define	ALP_POSTAL_SMS_EXCHANGE_MIME_TYPE_REASSEMBLED "sms/sms"
	Reassembled SMS message mime type.
#define	ALP_POSTAL_SMS_EXCHANGE_MIME_TYPE_REPORT "sms/rps"
	Delivery report SMS message mime type.
#define	ALP_POSTAL_SMS_EXCHANGE_MIME_TYPE_SEGMENTED "sms/psms"
	Segmented part SMS mime type.
#define	ALP_POSTAL_SMS_EXCHANGE_MIME_TYPE_VCAL "text/x-vcalendar"
	VCal over SMS.
#define	ALP_POSTAL_SMS_EXCHANGE_MIME_TYPE_VCARD "text/x-vcard"
	VCard over SMS.
#define	ALP_POSTAL_SMS_EXCHANGE_MIME_TYPE_VMI "sms/vmi"
	Voicemail waiting indication SMS message mime type.
#define	ALP_POSTAL_SMS_EXCHANGE_MIME_TYPE_WAP_PUSH "application/x-wap-push"
	Wap push SMS message mime type.
#define	ALP_POSTAL_SMS_EXCHANGE_MIME_TYPE_WAP_PUSH_HTTP "application/x-wap-push-http"
	Wap push OTA HTTP SMS message mime type.
#define	ALP_POSTAL_SMS_EXCHANGE_MIME_TYPE_WAP_PUSH_HTTPS "application/x-wap-push-https"
	Wap push OTA HTTP secure SMS message mime type.
#define	ALP_POSTAL_SMS_EXCHANGE_MIME_TYPE_WAP_PUSH_SEC "application/x-wap-push-sec"
	Wap push secure SMS message mime type.
SMS EXCHANGE PROPERTIES
Defines the SMS exchange properties.
#define	ALP_POSTAL_SMS_PROPERTY_EXCHANGE_FORCE_DELETE ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_SMS, ALP_POSTAL_SMS_SERVICE_CLASS_ID_EXCHANGE, ALP_POSTAL_PROPERTY_TYPE_BOOLEAN, 3)
	Force delete a boolean that deletes the dispatched message if no consumer can be found.
#define	ALP_POSTAL_SMS_PROPERTY_EXCHANGE_MIME_TYPE ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_SMS, ALP_POSTAL_SMS_SERVICE_CLASS_ID_EXCHANGE, ALP_POSTAL_PROPERTY_TYPE_C_STRING, 2)
	Mime type a string that represents the associated exchange mime type of an exchange entry.
#define	ALP_POSTAL_SMS_PROPERTY_EXCHANGE_PORT ALP_POSTAL_PROPERTY(ALP_POSTAL_SERVICE_ID_SMS, ALP_POSTAL_SMS_SERVICE_CLASS_ID_EXCHANGE, ALP_POSTAL_PROPERTY_TYPE_INT, 1)
	Port number an integer that represents the port number of an exchange entry (can be NULL).
Defines
#define	POSTAL_SMS_EXGMGR_DISPATCH_SMS_ACCESS_METHOD "ACCESS"
	Postal SMS Exchange "ACCESS" proprietary dispatching Method.
#define	POSTAL_SMS_EXGMGR_DISPATCH_SMS_ACTION_CLASS "DISPSMS"
	Postal SMS Exchange "Dispatch SMS" Action Class.
#define	POSTAL_SMS_EXGMGR_DISPATCH_SMS_FD_DATA_NAME "SMS Data"
	Postal SMS Exchange "Dispatch" parameter name to be used to retrieve data file decriptor.
#define	POSTAL_SMS_EXGMGR_DISPATCH_SMS_FD_DATA_OBJECT_TYPE "ReassembledSmsPdu"
	Postal SMS Exchange data file decriptor parameter object type.
#define	POSTAL_SMS_EXGMGR_DISPATCH_SMS_ORIGINATING_ADDRESS_NAME "Originating Address"
	Postal SMS Exchange "Dispatch" parameter name to be used to retrieve the originating address.
#define	POSTAL_SMS_EXGMGR_DISPATCH_SMS_STRUCT_URL_NAME "Struct URL"
	Postal SMS Exchange "Dispatch" parameter name to be used to retrieve the URL related to a new SMS. This URL can be used with the alp_postal_sms_exchange_get_sms_parameters_from_url(...) helper API to retrieve the SMS data into a formatted structure.
#define	POSTAL_SMS_EXGMGR_DISPATCH_SMS_VERB POSTAL_SMS_EXGMGR_DISPATCH_SMS_ACTION_CLASS"/"POSTAL_SMS_EXGMGR_DISPATCH_SMS_ACCESS_METHOD
	Postal SMS Exchange Dispatching SMS Verb.
#define	POSTAL_SMS_EXGMGR_STORE_PARAM_URL_MAX_LENGTH ALP_POSTAL_BODYPART_URI_PROPERTY_MAX_LENGTH
	Postal SMS Exchange file descriptor path max length.
#define	POSTAL_SMS_EXGMGR_STORE_SMS_VOBJECT_FD_DATA_NAME "VObject Data"
	Postal SMS Exchange "Store" parameter name to be used to retrieve "VObject" data file decriptor.
#define	POSTAL_STATUS_SMS_EXGMGR_HANDLER_DID_NOT_CONSUME ALP_POSTAL_ERROR_DECLARE(ALP_CLASS_SMS_EXCHANGE, 0x01)
	handler did not consume the request (used by handlers that accept multiple registrants)
Typedefs
typedef alp_postal_object_id_t	alp_postal_sms_exchange_entry_id_t
	Postal SMS exchange entry identifier type.
typedef _AlpPostalPropertyList	AlpPostalSmsExchangeEntry
	Postal SMS exchange entry.
Functions
alp_status_t	alp_postal_sms_exchange_free_sms_parameters (AlpTelSmsMessage iSmsParametersP, char iDeleteUrlP)
	Free the SMS parameters previously get from an url and delete the url if needed.
alp_status_t	alp_postal_sms_exchange_get_sms_parameters_from_url (char iUrlP, AlpTelSmsMessage *oSmsParametersPP)
	Get the SMS parameters of a dispatched message from an url.
alp_status_t	alp_postal_sms_exchange_table_entry_add_new (AlpPostalSmsExchangeEntry *iExchangeEntryP)
	Add an exchange table entry to the exchange table list stored.
alp_status_t	alp_postal_sms_exchange_table_entry_delete (alp_postal_sms_exchange_entry_id_t iExchangeEntryId)
	Delete a stored exchange table entry.
alp_status_t	alp_postal_sms_exchange_table_entry_enumerator_release (AlpPostalEnumerator *iEnumeratorP)
	Release an sms exchange entry enumerator.
alp_status_t	alp_postal_sms_exchange_table_entry_free (AlpPostalSmsExchangeEntry *iExchangeEntryP)
	Free the given exchange table entry.
alp_status_t	alp_postal_sms_exchange_table_entry_get_enumerator (AlpPostalEnumerator *oEnumeratorP)
	Get an enumerator of the stored exchange table entries.
alp_status_t	alp_postal_sms_exchange_table_entry_get_id (AlpPostalSmsExchangeEntry iExchangeEntryP, alp_postal_sms_exchange_entry_id_t oExchangeEntryP)
	Get the id of an exchange table entry structure provided by the server, otherwise id won't exist.
alp_status_t	alp_postal_sms_exchange_table_entry_get_next (AlpPostalEnumerator iEnumeratorP, AlpPostalSmsExchangeEntry ioExchangeEntryP)
	Return the exchange table entry for the current position and increment the enumerator.
alp_status_t	alp_postal_sms_exchange_table_entry_get_property (AlpPostalSmsExchangeEntry iExchangeEntryP, alp_postal_property_id_t iSmsExchangeEntryPropertyId, AlpPostalProperty *ioExchangeEntryPropertyPP)
	Retrieve a property from an exchange table entry.
alp_status_t	alp_postal_sms_exchange_table_entry_init (AlpPostalSmsExchangeEntry *iExgEntryP)
	Initialize an sms exchange entry.
alp_status_t	alp_postal_sms_exchange_table_entry_init_enumerator (AlpPostalEnumerator *iEnumeratorP)
	Initialize an sms exchange entry enumerator. MUST be called before alp_postal_sms_exchange_table_entry_get_enumerator API.
alp_status_t	alp_postal_sms_exchange_table_entry_set_property (AlpPostalSmsExchangeEntry *ioSmsExchangeEntryP, alp_postal_property_id_t iSmsExchangeEntryPropertyId, alp_postal_property_const_value_t iSmsExchangeEntryPropertyDataP, uint16_t iSmsExchangeEntryPropertyDataSize)
	Set a property to a Postal SmsExchangeEntry.
alp_status_t	alp_postal_sms_exchange_table_entry_update (alp_postal_sms_exchange_entry_id_t iExchangeEntryId, AlpPostalSmsExchangeEntry *iExchangeEntryP)
	Update a stored exchange table entry.