SMS messages
[Messages]
|
Detailed Description
SMS messages manipulations.Enumeration Type Documentation
| enum EncodeMultiPartSMSID |
ID during packing SMS for Smart Messaging 3.0, EMS and other
- Enumerator:
Definition at line 761 of file gammu-message.h.
00761 { 00765 SMS_Text = 1, 00769 SMS_ConcatenatedTextLong, 00773 SMS_ConcatenatedAutoTextLong, 00774 SMS_ConcatenatedTextLong16bit, 00775 SMS_ConcatenatedAutoTextLong16bit, 00779 SMS_NokiaProfileLong, 00783 SMS_NokiaPictureImageLong, 00787 SMS_NokiaScreenSaverLong, 00791 SMS_NokiaRingtone, 00795 SMS_NokiaRingtoneLong, 00799 SMS_NokiaOperatorLogo, 00803 SMS_NokiaOperatorLogoLong, 00807 SMS_NokiaCallerLogo, 00811 SMS_NokiaWAPBookmarkLong, 00815 SMS_NokiaWAPSettingsLong, 00819 SMS_NokiaMMSSettingsLong, 00823 SMS_NokiaVCARD10Long, 00827 SMS_NokiaVCARD21Long, 00831 SMS_NokiaVCALENDAR10Long, 00832 SMS_NokiaVTODOLong, 00833 SMS_VCARD10Long, 00834 SMS_VCARD21Long, 00835 SMS_DisableVoice, 00836 SMS_DisableFax, 00837 SMS_DisableEmail, 00838 SMS_EnableVoice, 00839 SMS_EnableFax, 00840 SMS_EnableEmail, 00841 SMS_VoidSMS, 00845 SMS_EMSSound10, 00849 SMS_EMSSound12, 00853 SMS_EMSSonyEricssonSound, 00857 SMS_EMSSound10Long, 00861 SMS_EMSSound12Long, 00865 SMS_EMSSonyEricssonSoundLong, 00866 SMS_EMSPredefinedSound, 00867 SMS_EMSPredefinedAnimation, 00868 SMS_EMSAnimation, 00872 SMS_EMSFixedBitmap, 00873 SMS_EMSVariableBitmap, 00874 SMS_EMSVariableBitmapLong, 00875 SMS_MMSIndicatorLong, 00876 SMS_WAPIndicatorLong, 00880 SMS_AlcatelMonoBitmapLong, 00884 SMS_AlcatelMonoAnimationLong, 00885 SMS_AlcatelSMSTemplateName, 00889 SMS_SiemensFile 00890 } EncodeMultiPartSMSID;
| enum GSM_Coding_Type |
Coding type of SMS.
- Enumerator:
-
SMS_Coding_Unicode_No_Compression Unicode SMS_Coding_Unicode_Compression SMS_Coding_Default_No_Compression Default GSM alphabet. SMS_Coding_Default_Compression SMS_Coding_8bit 8-bit.
Definition at line 267 of file gammu-message.h.
00267 { 00271 SMS_Coding_Unicode_No_Compression = 1, 00272 SMS_Coding_Unicode_Compression, 00276 SMS_Coding_Default_No_Compression, 00277 SMS_Coding_Default_Compression, 00281 SMS_Coding_8bit 00282 } GSM_Coding_Type;
| enum GSM_SMS_State |
Status of SMS message.
Definition at line 255 of file gammu-message.h.
00255 { 00256 SMS_Sent = 1, 00257 SMS_UnSent, 00258 SMS_Read, 00259 SMS_UnRead 00260 } GSM_SMS_State;
| enum GSM_SMSFormat |
Enum defines format of SMS messages. See GSM 03.40 section 9.2.3.9
Definition at line 169 of file gammu-message.h.
00169 { 00170 SMS_FORMAT_Pager = 1, 00171 SMS_FORMAT_Fax, 00172 SMS_FORMAT_Email, 00173 SMS_FORMAT_Text 00174 /* Some values not handled here */ 00175 } GSM_SMSFormat;
| enum GSM_SMSMessageType |
TP-Message-Type-Indicator. See GSM 03.40 section 9.2.3.1.
- Enumerator:
-
SMS_Deliver SMS in Inbox. SMS_Status_Report Delivery Report SMS_Submit SMS for sending or in Outbox
Definition at line 361 of file gammu-message.h.
00361 { 00365 SMS_Deliver = 1, 00369 SMS_Status_Report, 00373 SMS_Submit 00374 /* specification gives more */ 00375 } GSM_SMSMessageType;
| enum GSM_UDH |
Types of UDH (User Data Header).
- Enumerator:
Definition at line 289 of file gammu-message.h.
00289 { 00290 UDH_NoUDH = 1, 00294 UDH_ConcatenatedMessages, 00298 UDH_ConcatenatedMessages16bit, 00299 UDH_DisableVoice, 00300 UDH_DisableFax, 00301 UDH_DisableEmail, 00302 UDH_EnableVoice, 00303 UDH_EnableFax, 00304 UDH_EnableEmail, 00305 UDH_VoidSMS, 00306 UDH_NokiaRingtone, 00307 UDH_NokiaRingtoneLong, 00308 UDH_NokiaOperatorLogo, 00309 UDH_NokiaOperatorLogoLong, 00310 UDH_NokiaCallerLogo, 00311 UDH_NokiaWAP, 00312 UDH_NokiaWAPLong, 00313 UDH_NokiaCalendarLong, 00314 UDH_NokiaProfileLong, 00315 UDH_NokiaPhonebookLong, 00316 UDH_UserUDH, 00317 UDH_MMSIndicatorLong 00318 } GSM_UDH;
| enum GSM_ValidityPeriod |
Enum defines some the most often used validity lengths for SMS messages for relative validity format. See GSM 03.40 section 9.2.3.12.1 - it gives more values.
- Enumerator:
-
SMS_VALID_1_Hour SMS_VALID_6_Hours SMS_VALID_1_Day SMS_VALID_3_Days SMS_VALID_1_Week SMS_VALID_Max_Time
Definition at line 184 of file gammu-message.h.
00184 { 00185 SMS_VALID_1_Hour = 0x0b, 00186 SMS_VALID_6_Hours = 0x47, 00187 SMS_VALID_1_Day = 0xa7, 00188 SMS_VALID_3_Days = 0xa9, 00189 SMS_VALID_1_Week = 0xad, 00190 SMS_VALID_Max_Time = 0xff 00191 } GSM_ValidityPeriod;
Enum defines format of validity period for SMS messages. See GSM 03.40 section 9.2.3.12
Definition at line 199 of file gammu-message.h.
00199 { 00200 SMS_Validity_NotAvailable = 1, 00201 SMS_Validity_RelativeFormat 00202 /* Specification gives also other possibilities */ 00203 } GSM_ValidityPeriodFormat;
Function Documentation
| GSM_Error GSM_AddSMS | ( | GSM_StateMachine * | s, | |
| GSM_SMSMessage * | sms | |||
| ) |
Adds SMS to specified folder.
- Parameters:
-
s State machine pointer.
- Returns:
- Error code.
| GSM_Error GSM_AddSMSFolder | ( | GSM_StateMachine * | s, | |
| unsigned char * | name | |||
| ) |
Creates SMS folder.
- Parameters:
-
s State machine pointer.
- Returns:
- Error code.
| void GSM_ClearMultiPartSMSInfo | ( | GSM_MultiPartSMSInfo * | Info | ) |
Clears GSM_MultiPartSMSInfo to default values.
| bool GSM_DecodeMultiPartSMS | ( | GSM_Debug_Info * | di, | |
| GSM_MultiPartSMSInfo * | Info, | |||
| GSM_MultiSMSMessage * | SMS, | |||
| bool | ems | |||
| ) |
Decodes multi part SMS to "readable" format.
| bool GSM_DecodeSiemensOTASMS | ( | GSM_Debug_Info * | di, | |
| GSM_SiemensOTASMSInfo * | Info, | |||
| GSM_SMSMessage * | SMS | |||
| ) |
Decodes Siemens OTA data.
| GSM_Error GSM_DecodeSMSFrame | ( | GSM_Debug_Info * | di, | |
| GSM_SMSMessage * | SMS, | |||
| unsigned char * | buffer, | |||
| GSM_SMSMessageLayout | Layout | |||
| ) |
Decodes SMS frame.
| GSM_Error GSM_DecodeSMSFrameStatusReportData | ( | GSM_Debug_Info * | di, | |
| GSM_SMSMessage * | SMS, | |||
| unsigned char * | buffer, | |||
| GSM_SMSMessageLayout | Layout | |||
| ) |
Decodes SMS frame for status report.
| GSM_Error GSM_DecodeSMSFrameText | ( | GSM_Debug_Info * | di, | |
| GSM_SMSMessage * | SMS, | |||
| unsigned char * | buffer, | |||
| GSM_SMSMessageLayout | Layout | |||
| ) |
Decodes SMS frame in textual representation.
| void GSM_DecodeUDHHeader | ( | GSM_Debug_Info * | di, | |
| GSM_UDHHeader * | UDH | |||
| ) |
Decodes UDH header.
| GSM_Error GSM_DeleteSMS | ( | GSM_StateMachine * | s, | |
| GSM_SMSMessage * | sms | |||
| ) |
Deletes SMS.
- Parameters:
-
s State machine pointer.
- Returns:
- Error code.
| GSM_Error GSM_DeleteSMSFolder | ( | GSM_StateMachine * | s, | |
| int | ID | |||
| ) |
Deletes SMS folder.
- Parameters:
-
s State machine pointer.
- Returns:
- Error code.
| GSM_Error GSM_EncodeMultiPartSMS | ( | GSM_Debug_Info * | di, | |
| GSM_MultiPartSMSInfo * | Info, | |||
| GSM_MultiSMSMessage * | SMS | |||
| ) |
Encodes multi part SMS from "readable" format.
- Returns:
- Error code.
| GSM_Error GSM_EncodeSMSFrame | ( | GSM_Debug_Info * | di, | |
| GSM_SMSMessage * | SMS, | |||
| unsigned char * | buffer, | |||
| GSM_SMSMessageLayout | Layout, | |||
| int * | length, | |||
| bool | clear | |||
| ) |
Encodes SMS frame.
| void GSM_EncodeUDHHeader | ( | GSM_Debug_Info * | di, | |
| GSM_UDHHeader * | UDH | |||
| ) |
Encodes UDH header.
| void GSM_FreeMultiPartSMSInfo | ( | GSM_MultiPartSMSInfo * | Info | ) |
Frees any allocated structures inside GSM_MultiPartSMSInfo.
| GSM_Error GSM_GetNextSMS | ( | GSM_StateMachine * | s, | |
| GSM_MultiSMSMessage * | sms, | |||
| bool | start | |||
| ) |
Reads next (or first if start set) SMS message. This might be faster for some phones than using GSM_GetSMS for each message.
Please note that this commend does not have to mark message as read in phone. To do so, you have to call GSM_GetSMS.
- Parameters:
-
s State machine pointer.
- Returns:
- Error code.
| GSM_Error GSM_GetSMS | ( | GSM_StateMachine * | s, | |
| GSM_MultiSMSMessage * | sms | |||
| ) |
Reads SMS message.
- Parameters:
-
s State machine pointer.
- Returns:
- Error code.
| GSM_Error GSM_GetSMSC | ( | GSM_StateMachine * | s, | |
| GSM_SMSC * | smsc | |||
| ) |
Gets SMS Service Center number and SMS settings.
- Parameters:
-
s State machine pointer.
- Returns:
- Error code.
| GSM_Error GSM_GetSMSFolders | ( | GSM_StateMachine * | s, | |
| GSM_SMSFolders * | folders | |||
| ) |
Returns SMS folders information.
- Parameters:
-
s State machine pointer.
- Returns:
- Error code.
| GSM_Error GSM_GetSMSStatus | ( | GSM_StateMachine * | s, | |
| GSM_SMSMemoryStatus * | status | |||
| ) |
Gets information about SMS memory (read/unread/size of memory for both SIM and phone).
- Parameters:
-
s State machine pointer.
- Returns:
- Error code.
| GSM_Error GSM_LinkSMS | ( | GSM_Debug_Info * | di, | |
| GSM_MultiSMSMessage ** | INPUT, | |||
| GSM_MultiSMSMessage ** | OUTPUT, | |||
| bool | ems | |||
| ) |
Links SMS messages according to IDs.
- Returns:
- Error code.
| GSM_Error GSM_SendSavedSMS | ( | GSM_StateMachine * | s, | |
| int | Folder, | |||
| int | Location | |||
| ) |
Sends SMS already saved in phone.
- Parameters:
-
s State machine pointer.
- Returns:
- Error code.
| GSM_Error GSM_SendSMS | ( | GSM_StateMachine * | s, | |
| GSM_SMSMessage * | sms | |||
| ) |
Sends SMS.
- Parameters:
-
s State machine pointer.
- Returns:
- Error code.
| void GSM_SetDefaultReceivedSMSData | ( | GSM_SMSMessage * | SMS | ) |
Sets default content for SMS except for changing locations. Use this for clearing structure while keeping location of message.
- Parameters:
-
SMS Pointer to structure which should be cleaned up.
| void GSM_SetDefaultSMSData | ( | GSM_SMSMessage * | SMS | ) |
Sets default content for SMS. Use this for clearing structure.
- Parameters:
-
SMS Pointer to structure which should be cleaned up.
| GSM_Error GSM_SetFastSMSSending | ( | GSM_StateMachine * | s, | |
| bool | enable | |||
| ) |
Configures fast SMS sending.
- Parameters:
-
s State machine pointer.
- Returns:
- Error code.
| GSM_Error GSM_SetIncomingSMS | ( | GSM_StateMachine * | s, | |
| bool | enable | |||
| ) |
Enable/disable notification on incoming SMS.
- Parameters:
-
s State machine pointer.
- Returns:
- Error code.
| GSM_Error GSM_SetSMS | ( | GSM_StateMachine * | s, | |
| GSM_SMSMessage * | sms | |||
| ) |
Sets SMS.
- Parameters:
-
s State machine pointer.
- Returns:
- Error code.
| GSM_Error GSM_SetSMSC | ( | GSM_StateMachine * | s, | |
| GSM_SMSC * | smsc | |||
| ) |
Sets SMS Service Center number and SMS settings.
- Parameters:
-
s State machine pointer.
- Returns:
- Error code.
| GSM_Error PHONE_EncodeSMSFrame | ( | GSM_StateMachine * | s, | |
| GSM_SMSMessage * | SMS, | |||
| unsigned char * | buffer, | |||
| GSM_SMSMessageLayout | Layout, | |||
| int * | length, | |||
| bool | clear | |||
| ) |
Encodes SMS frame according to layout.
- Returns:
- Error code.
Variable Documentation
Layout for deliver message.
Layout for status report messa