SMS


Functions

SWI_API SWI_RCODE SwiGetSMSMessageStatus (SWI_STRUCT_GSM_SMS_Status *pSMS_Status, U32 timeout)
SWI_API SWI_RCODE SwiRetrieveSMSMessage (SWI_STRUCT_GSM_SMS_RetrieveSms *pSMS, U32 timeout)
SWI_API SWI_RCODE SwiDeleteSMS (const U16 msgID, U32 timeout)
SWI_API SWI_RCODE SwiGetSmsParam (SWI_STRUCT_SMS_Param *pSmsParam, U32 timeout)
SWI_API SWI_RCODE SwiSetSmsParam (const SWI_STRUCT_SMS_Param *pSmsParam, U32 timeout)
SWI_API SWI_RCODE SwiStoreSMSMessage (SWI_STRUCT_GSM_SMS_StoreSms *pStoreSMS, U32 timeout)
SWI_API SWI_RCODE SwiSendSMS (U32 timeout)
SWI_API SWI_RCODE SwiStoreSMSMessageExp (SWI_STRUCT_GSM_SMS_StoreSms *psStoreSMS, int *pcntSegments, int *piSequence, U32 timeout)
SWI_API SWI_RCODE SwiSendSMSExp (U32 timeout)
SWI_API SWI_RCODE SwiGetSmsStatusReportCfg (SWI_STRUCT_SmsStatusReportCfg *pSmsStsRptCfg, U32 timeout)
SWI_API SWI_RCODE SwiSetSmsStatusReportCfg (SWI_STRUCT_SmsStatusReportCfg *pSmsStsRptCfg, U32 timeout)

Function Documentation

SWI_API SWI_RCODE SwiDeleteSMS ( const U16  msgID,
U32  timeout 
)

This function is used to delete a mobile-terminated SMS message from the SIM.

Mobile-terminated SMS messages are NEVER automatically deleted from the SIM. It is the responsibility of the host software to explicitly remove individual messages.

There is not interface for removing stored mobile-originated SMS messages.

This function is applies to all devices.

Parameters:
[OUT] msgID: message identifier of the SMS message to delete
[IN] timeout: Response timeout value in milliseconds
Returns:
SWI_RCODE_OK: The request has been received by the device

SWI_RCODE_REQUEST_TIMEOUT: The request has timed out

See SWI_RCODE for other error return codes

See also:
See sample code, Gsm_SMSInbox

SWI_API SWI_RCODE SwiGetSMSMessageStatus ( SWI_STRUCT_GSM_SMS_Status pSMS_Status,
U32  timeout 
)

This function is used to determine the number of UNREAD and previously READ mobile-terminated SMS messages currently stored on the SIM.

This function applies to all devices.

Parameters:
[OUT] pSMS_Status: Received SMS messages status
[IN] timeout: Response timeout value in milliseconds
Returns:
SWI_RCODE_OK: The request has been received by the device

SWI_RCODE_REQUEST_TIMEOUT: The request has timed out

See SWI_RCODE for other error return codes

See also:
SWI_STRUCT_GSM_SMS_Status

See notification, SWI_NOTIFY_SmsStatus

See notification, SWI_NOTIFY_SmsSimFull

See sample code, Gsm_SMSInbox

SWI_API SWI_RCODE SwiGetSmsParam ( SWI_STRUCT_SMS_Param pSmsParam,
U32  timeout 
)

This function will fetch the SMS related parameters off the SIM.

This function applies to all devices.

Parameters:
[OUT] pSmsParam: SMS parameters
[IN] timeout: Response timeout value in milliseconds
Returns:
SWI_RCODE_OK: The request has been received by the device

SWI_RCODE_REQUEST_TIMEOUT: The request has timed out

See SWI_RCODE for other error return codes

See also:
SWI_STRUCT_SMS_Param

See sample code, Gsm_SMSOutbox

SWI_API SWI_RCODE SwiGetSmsStatusReportCfg ( SWI_STRUCT_SmsStatusReportCfg pSmsStsRptCfg,
U32  timeout 
)

This function is used to determine whether SMS status reports are currently enabled or disabled on the device.

Parameters:
[OUT] pSmsStsRptCfg: SMS status report configuration
[IN] timeout: Response timeout value in milliseconds
Returns:
SWI_RCODE_OK: The request has been received by the device

SWI_RCODE_REQUEST_TIMEOUT: The request has timed out

See SWI_RCODE for other error return codes

See also:
SWI_STRUCT_SmsStatusReportCfg

SWI_API SWI_RCODE SwiRetrieveSMSMessage ( SWI_STRUCT_GSM_SMS_RetrieveSms pSMS,
U32  timeout 
)

This function is used to read a single mobile-terminated SMS message off the SIM.

Callers of this function must specify what kind of message will be returned: UNREAD or previously READ. The act of fetching an UNREAD message from the SIM will convert its status to READ.

SMS messages are stored in a circular fashion on the SIM. To read all previously READ messages from the SIM, this function should be called repeatedly until a duplicate SMS messages id is returned. For UNREAD messages, this function should be called until it fails.

This function applies to all devices.

Parameters:
[IN/OUT] pSMS: SMS message
[IN] timeout: Response timeout value in milliseconds
Returns:
SWI_RCODE_OK: The request has been received by the device

SWI_RCODE_FAILED: In the case when attempting to fetch an UNREAD message, this this error indicates that currently there are no UNREAD messages.

SWI_RCODE_REQUEST_TIMEOUT: The request has timed out

See SWI_RCODE for other error return codes

See also:
SWI_STRUCT_GSM_SMS_RetrieveSms

See sample code, Gsm_SMSInbox

SWI_API SWI_RCODE SwiSendSMS ( U32  timeout  ) 

This function is used to send all stored mobile-originated SMS message from the SIM. Once these messages are sent they will be deleted from the SIM. The mobile-originated SMS messages were stored using SwiStoreSMSMessage.

This function will block until all the stored messages have been sent. This can take up to 20 seconds. For most application that is a very long time to be blocked on an API. To address this shortcoming this function has been replaced with the non-blocking SwiSendSMSExp function.

SwiSendSMSExp should be used instead of this function

This function applies to all devices.

Parameters:
[IN] timeout: Response timeout value in milliseconds
Returns:
SWI_RCODE_OK: The request has been received by the device

SWI_RCODE_REQUEST_TIMEOUT: The request has timed out

See SWI_RCODE for other error return codes

See also:
This function is replaced by SwiSendSMSExp

SwiStoreSMSMessage

SWI_API SWI_RCODE SwiSendSMSExp ( U32  timeout  ) 

This function is used to send all stored mobile-originated SMS message from the SIM. Once these messages are sent they will be deleted from the SIM. The mobile-originated SMS messages were stored using SwiStoreSMSMessageExp.

Neither this function nor SwiStoreSMSMessageExp should not be called again until a SWI_NOTIFY_SmsSendExp notification has been received indicating that sending has been completed.

This function is used to send SMS messages already stored on the SIM. The message sent was previously stored by SwiStoreSMSMessageExp.

This function applies to all devices.

Parameters:
[IN] timeout: Response timeout value in milliseconds
Returns:
SWI_RCODE_OK: The request has been received by the device

SWI_RCODE_REQUEST_TIMEOUT: The request has timed out

See SWI_RCODE for other error return codes

See also:
SwiStoreSMSMessageExp

SWI_NOTIFY_SmsSendExp

See sample code, Gsm_SMSOutbox

SwiSendSMS was replaced by this function

SWI_API SWI_RCODE SwiSetSmsParam ( const SWI_STRUCT_SMS_Param pSmsParam,
U32  timeout 
)

This function will update the SMS related parameters on the SIM.

This function is applies to all devices.

Parameters:
[IN] pSmsParam: SMS parameters
[IN] timeout: Response timeout value in milliseconds
Returns:
SWI_RCODE_OK: The request has been received by the device

SWI_RCODE_REQUEST_TIMEOUT: The request has timed out

See SWI_RCODE for other error return codes

See also:
SWI_STRUCT_SMS_Param

SWI_API SWI_RCODE SwiSetSmsStatusReportCfg ( SWI_STRUCT_SmsStatusReportCfg pSmsStsRptCfg,
U32  timeout 
)

This function is used to configure the SMS status report settings

Parameters:
[IN] pSmsStsRptCfg: SMS status report configuration
[IN] timeout: Response timeout value in milliseconds
Returns:
SWI_RCODE_OK: The request has been received by the device

SWI_RCODE_REQUEST_TIMEOUT: The request has timed out

See SWI_RCODE for other error return codes

See also:
SWI_STRUCT_SmsStatusReportCfg

SWI_API SWI_RCODE SwiStoreSMSMessage ( SWI_STRUCT_GSM_SMS_StoreSms pStoreSMS,
U32  timeout 
)

This function is used to store a mobile-originated SMS message on the SIM. It can be called repeatedly to store longer messages or multiple messages.

Once a mobile-terminated message or messages have been copied to the SIM they can be sent by calling SwiSendSMS. Sent messages will automatically be deleted from the SIM.

This function will block until the SMS message or SMS message segment has been copied to the SIM. This can take up to 20 seconds. For most application that is a very long time to be blocked on an API. To address this shortcoming this function has been replaced with the non-blocking SwiStoreSMSMessageExp function.

SwiStoreSMSMessageExp should be used instead of this function

This function applies to all devices.

Parameters:
[IN] pStoreSMS: SMS message to store
[IN] timeout: Response timeout value in milliseconds
Returns:
SWI_RCODE_OK: The request has been received by the device

SWI_RCODE_REQUEST_TIMEOUT: The request has timed out

See SWI_RCODE for other error return codes

See also:
This function is replaced by SwiStoreSMSMessageExp

SwiSendSMS

SWI_STRUCT_GSM_SMS_StoreSms

SWI_API SWI_RCODE SwiStoreSMSMessageExp ( SWI_STRUCT_GSM_SMS_StoreSms psStoreSMS,
int *  pcntSegments,
int *  piSequence,
U32  timeout 
)

This function is used to copy a mobile-originated SMS message to the SIM. It can be called repeatedly to store longer messages or multiple messages.

Neither this function nor SwiSendSMSExp should not be called again until a SWI_NOTIFY_SmsStoreExp notification has been received indicating that the copy has been completed.

Once a mobile-terminated message or messages have been copied to the SIM they can be sent by calling SwiSendSMSExp. Sent messages will automatically be deleted from the SIM.

Parameters:
[IN] pStoreSMS: SMS message to store
[OUT] pcntSegments: Indicates the number of segments to be stored. This is -1 initially.
[OUT] piSequence: Indicates the sequence number of the segment. This is 0 initially.
[IN] timeout: Response timeout value in milliseconds
Returns:
SWI_RCODE_OK: The request has been received by the device

SWI_RCODE_REQUEST_TIMEOUT: The request has timed out

See SWI_RCODE for other error return codes

See also:
SwiSendSMSExp

SWI_NOTIFY_SmsStoreExp

SWI_STRUCT_GSM_SMS_StoreSms

See sample code, Gsm_SMSOutbox

SwiStoreSMSMessage was replaced by this function


Generated on Fri Oct 2 10:27:31 2009 for 3G SDK by  doxygen 1.5.9