_AlpTelSmsMessage Struct Reference
[SMS Service]

#include <telephony_types.h>


Data Fields

AlpTelNumber address1
 AlpTelNumber structure that holds the destination address for a submitted message; originating address for delivered and report messages.
AlpTelNumber address2
 AlpTelNumber structure that holds the service center for submitted and delivered GSM messages; callback number for submitted and delivered CDMA and TDMA messages.*/.
uint16_t apiVersion
 Version of the SMS API associated with this message. Set to ALP_TEL_SMS_API_VERSION.
uint8_t dataCodingScheme
 One of the constants beginning with ALP_TEL_SMS_ENCODING prefix.
uint8_t * dataP
 Buffer containing the message data.
size_t dataSize
 Size of the buffer dataP.
size_t extensionCount
 On input, this is the number of extension structures allocated for this message. Upon return, this is the number of extensions in the SMS header. If the SMS header contains more extensions than you have allocated, the available extension structures are filled, and this function generates a ALP_STATUS_TEL_BUFFER_SIZE error.
AlpTelSmsExtensionextensionP
 A pointer to an array of AlpTelSmsExtension structures that you have allocated for this message.
union {
   AlpTelSmsCellBroadcastMessage   cellbroadcast
 Depending of messageType, the message holds information about a AlpTelSmsCellBroadcastMessage structure.
   AlpTelSmsDeliverMessage   deliver
 Depending of messageType, the message holds information about a AlpTelSmsDeliverMessage structure.
   AlpTelSmsReportMessage   report
 Depending of messageType, the message holds information about a AlpTelSmsReportMessage structure.
   AlpTelSmsSubmitMessage   submit
 Depending of messageType, the message holds information about a AlpTelSmsSubmitMessage structure.
message
uint32_t messageId
 Message identifier.
uint8_t messageType
 One of the constants beginning with ALP_TEL_SMS_MESSAGE_TYPE prefix.
AlpTelSmsMultiPartInfo multiPartInfo
 AlpTelSmsMultiPartInfo structure that holds information about a multipart message.
uint16_t phoneIndex
 Upon return, the SMS index (0-based) of the message on the phone. This value is used for input only when calling the alp_tel_sms_read_message() function to read one message at a time, or when calling the alp_tel_sms_delete_message() function to delete a message.
uint8_t status
 One of the constants beginning with ALP_TEL_SMS_STATUS prefix.


Field Documentation

AlpTelNumber address1
 

AlpTelNumber structure that holds the destination address for a submitted message; originating address for delivered and report messages.

AlpTelNumber address2
 

AlpTelNumber structure that holds the service center for submitted and delivered GSM messages; callback number for submitted and delivered CDMA and TDMA messages.*/.

uint16_t apiVersion
 

Version of the SMS API associated with this message. Set to ALP_TEL_SMS_API_VERSION.

AlpTelSmsCellBroadcastMessage cellbroadcast
 

Depending of messageType, the message holds information about a AlpTelSmsCellBroadcastMessage structure.

uint8_t dataCodingScheme
 

One of the constants beginning with ALP_TEL_SMS_ENCODING prefix.

uint8_t* dataP
 

Buffer containing the message data.

size_t dataSize
 

Size of the buffer dataP.

AlpTelSmsDeliverMessage deliver
 

Depending of messageType, the message holds information about a AlpTelSmsDeliverMessage structure.

size_t extensionCount
 

On input, this is the number of extension structures allocated for this message. Upon return, this is the number of extensions in the SMS header. If the SMS header contains more extensions than you have allocated, the available extension structures are filled, and this function generates a ALP_STATUS_TEL_BUFFER_SIZE error.

AlpTelSmsExtension* extensionP
 

A pointer to an array of AlpTelSmsExtension structures that you have allocated for this message.

union { ... } message
 

uint32_t messageId
 

Message identifier.

uint8_t messageType
 

One of the constants beginning with ALP_TEL_SMS_MESSAGE_TYPE prefix.

AlpTelSmsMultiPartInfo multiPartInfo
 

AlpTelSmsMultiPartInfo structure that holds information about a multipart message.

uint16_t phoneIndex
 

Upon return, the SMS index (0-based) of the message on the phone. This value is used for input only when calling the alp_tel_sms_read_message() function to read one message at a time, or when calling the alp_tel_sms_delete_message() function to delete a message.

AlpTelSmsReportMessage report
 

Depending of messageType, the message holds information about a AlpTelSmsReportMessage structure.

uint8_t status
 

One of the constants beginning with ALP_TEL_SMS_STATUS prefix.

AlpTelSmsSubmitMessage submit
 

Depending of messageType, the message holds information about a AlpTelSmsSubmitMessage structure.


The documentation for this struct was generated from the following file:
Generated on Wed Jul 30 07:06:41 2008 by Doxygen 1.4.6 for ALP SDK + Hiker Documentation

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