YSms (Yoctopuce Java API 2.1.15129-SNAPSHOT API)

java.lang.Object
- com.yoctopuce.YoctoAPI.YSms

```
public class YSms
extends Object
```
YSms Class: SMS message sent or received, returned by messageBox.get_messages or messageBox.newMessage YSms objects are used to describe an SMS message, received or to be sent. These objects are used in particular in conjunction with the YMessageBox class.

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`_aggCnt`
`protected int`	`_aggIdx`
`protected String`	`_aggSig`
`protected int`	`_alphab`
`protected boolean`	`_deliv`
`protected String`	`_dest`
`protected boolean`	`_isnew`
`protected YMessageBox`	`_mbox`
`protected int`	`_mclass`
`protected int`	`_mref`
`protected int`	`_npdu`
`protected String`	`_orig`
`protected ArrayList<YSms>`	`_parts`
`protected byte[]`	`_pdu`
`protected int`	`_pid`
`protected int`	`_slot`
`protected String`	`_smsc`
`protected String`	`_stamp`
`protected byte[]`	`_udata`
`protected byte[]`	`_udh`

Constructor Summary

Constructors
Modifier Constructor and Description

protected YSms(YMessageBox mbox)

Constructors
Modifier	Constructor and Description
`protected`	`YSms(YMessageBox mbox)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`addText(String val)` Adds regular text to the SMS.
`int`	`addUnicodeData(ArrayList<Integer> val)` Adds unicode characters to the SMS.
`int`	`convertToUnicode()`
`String`	`decodeAddress(byte[] addr, int ofs, int siz)`
`String`	`decodeTimeStamp(byte[] exp, int ofs, int siz)`
`int`	`deleteFromSIM()` Delete the SMS from the SIM card.
`byte[]`	`encodeAddress(String addr)`
`byte[]`	`encodeTimeStamp(String exp)`
`byte[]`	`encodeUserData()`
`int`	`generateParts()`
`int`	`generatePdu()`
`int`	`get_alphabet()`
`int`	`get_concatCount()`
`int`	`get_concatIndex()`
`String`	`get_concatSignature()`
`int`	`get_dcs()`
`int`	`get_msgClass()`
`int`	`get_msgRef()`
`int`	`get_partCount()`
`ArrayList<YSms>`	`get_parts()`
`byte[]`	`get_pdu()`
`int`	`get_protocolId()`
`String`	`get_recipient()`
`String`	`get_sender()` Returns the reported message sender.
`int`	`get_slot()`
`String`	`get_smsc()`
`String`	`get_textData()` Returns the content of the message as a text string.
`String`	`get_timestamp()` Returns the reported message timestamp.
`ArrayList<Integer>`	`get_unicodeData()` Returns the content of the message, as a list of integer unicode values.
`byte[]`	`get_userData()`
`byte[]`	`get_userDataHeader()`
`boolean`	`isFlashMessage()` Returns true iff the message is a "Flash" SMS (class 0 message).
`boolean`	`isNew()`
`boolean`	`isReceived()`
`int`	`parsePdu(byte[] pdu)`
`int`	`parseUserDataHeader()`
`int`	`send()` Sends the SMS to the recipient.
`int`	`set_alphabet(int val)`
`int`	`set_dcs(int val)`
`int`	`set_msgClass(int val)`
`int`	`set_msgRef(int val)`
`int`	`set_new(boolean val)`
`int`	`set_parts(ArrayList<YSms> parts)`
`int`	`set_pdu(byte[] pdu)`
`int`	`set_protocolId(int val)`
`int`	`set_received(boolean val)`
`int`	`set_recipient(String val)`
`int`	`set_sender(String val)`
`int`	`set_slot(int val)`
`int`	`set_smsc(String val)`
`int`	`set_timestamp(String val)`
`int`	`set_userData(byte[] val)`
`int`	`set_userDataHeader(byte[] val)`
`int`	`udataSize()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_mbox
```
protected YMessageBox _mbox
```

_slot
```
protected int _slot
```

_deliv
```
protected boolean _deliv
```

_isnew
```
protected boolean _isnew
```

_smsc
```
protected String _smsc
```

_mref
```
protected int _mref
```

_orig
```
protected String _orig
```

_dest
```
protected String _dest
```

_pid
```
protected int _pid
```

_alphab
```
protected int _alphab
```

_mclass
```
protected int _mclass
```

_stamp
```
protected String _stamp
```

_udh
```
protected byte[] _udh
```

_udata
```
protected byte[] _udata
```

_npdu
```
protected int _npdu
```

_pdu
```
protected byte[] _pdu
```

_parts
```
protected ArrayList<YSms> _parts
```

_aggSig
```
protected String _aggSig
```

_aggIdx
```
protected int _aggIdx
```

_aggCnt
```
protected int _aggCnt
```

Constructor Detail
- YSms
```
protected YSms(YMessageBox mbox)
```
  Parameters:
  
  mbox - : message box

Method Detail

get_slot
```
public int get_slot()
```

get_smsc
```
public String get_smsc()
```

get_msgRef
```
public int get_msgRef()
```

get_protocolId
```
public int get_protocolId()
```

get_recipient
```
public String get_recipient()
```

isNew
```
public boolean isNew()
```

isReceived
```
public boolean isReceived()
```

get_alphabet
```
public int get_alphabet()
```

get_msgClass
```
public int get_msgClass()
```

get_dcs
```
public int get_dcs()
```

get_userDataHeader
```
public byte[] get_userDataHeader()
```

get_userData
```
public byte[] get_userData()
```

isFlashMessage
```
public boolean isFlashMessage()
```
Returns true iff the message is a "Flash" SMS (class 0 message). Flash messages are displayed on the handset immediately and usually not saved on the SIM card.

Returns:

a boolean.

get_timestamp
```
public String get_timestamp()
```
Returns the reported message timestamp.

Returns:

the timestamp as a text string.

get_sender
```
public String get_sender()
```
Returns the reported message sender.

Returns:

a text string.

get_textData
```
public String get_textData()
```
Returns the content of the message as a text string.

Returns:

a string with the content of the message.

get_unicodeData
```
public ArrayList<Integer> get_unicodeData()
```
Returns the content of the message, as a list of integer unicode values.

Returns:

a list of integers.

get_partCount
```
public int get_partCount()
```

get_pdu
```
public byte[] get_pdu()
```

get_parts
```
public ArrayList<YSms> get_parts()
```

get_concatSignature
```
public String get_concatSignature()
```

get_concatIndex
```
public int get_concatIndex()
```

get_concatCount
```
public int get_concatCount()
```

set_slot
```
public int set_slot(int val)
```

set_received
```
public int set_received(boolean val)
```

set_new
```
public int set_new(boolean val)
```

set_smsc
```
public int set_smsc(String val)
```

set_msgRef
```
public int set_msgRef(int val)
```

set_sender
```
public int set_sender(String val)
```

set_recipient
```
public int set_recipient(String val)
```

set_protocolId
```
public int set_protocolId(int val)
```

set_alphabet
```
public int set_alphabet(int val)
```

set_msgClass
```
public int set_msgClass(int val)
```

set_dcs
```
public int set_dcs(int val)
```

set_timestamp
```
public int set_timestamp(String val)
```

set_userDataHeader

public int set_userDataHeader(byte[] val)

set_userData
```
public int set_userData(byte[] val)
```

convertToUnicode
```
public int convertToUnicode()
```

addText
```
public int addText(String val)
```
Adds regular text to the SMS. This function support messages of more than 160 characters. ISO-latin accented characters are supported. For messages with special unicode characters such as asian characters and emoticons, use the addUnicodeData method.

Parameters:

val - : the text to be sent in the message

Returns:

YAPI.SUCCESS when the call succeeds.

addUnicodeData
```
public int addUnicodeData(ArrayList<Integer> val)
```
Adds unicode characters to the SMS. This function support messages of more than 160 characters, using SMS concatenation.

Parameters:

val - : a list of unicode characters provided as integers

Returns:

YAPI.SUCCESS when the call succeeds.

set_pdu
```
public int set_pdu(byte[] pdu)
```

set_parts

public int set_parts(ArrayList<YSms> parts)

encodeAddress

public byte[] encodeAddress(String addr)

decodeAddress

public String decodeAddress(byte[] addr,
                            int ofs,
                            int siz)

encodeTimeStamp

public byte[] encodeTimeStamp(String exp)

decodeTimeStamp

public String decodeTimeStamp(byte[] exp,
                              int ofs,
                              int siz)

udataSize
```
public int udataSize()
```

encodeUserData
```
public byte[] encodeUserData()
```

generateParts
```
public int generateParts()
```

generatePdu
```
public int generatePdu()
```

parseUserDataHeader
```
public int parseUserDataHeader()
```

parsePdu
```
public int parsePdu(byte[] pdu)
```

send
```
public int send()
         throws YAPI_Exception
```
Sends the SMS to the recipient. Messages of more than 160 characters are supported using SMS concatenation.

Returns:

YAPI.SUCCESS when the call succeeds.

Throws:

YAPI_Exception - on error

deleteFromSIM
```
public int deleteFromSIM()
                  throws YAPI_Exception
```
Delete the SMS from the SIM card.

Returns:

YAPI.SUCCESS when the call succeeds.

Throws:

YAPI_Exception - on error

Class YSms

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_mbox

_slot

_deliv

_isnew

_smsc

_mref

_orig

_dest

_pid

_alphab

_mclass

_stamp

_udh

_udata

_npdu

_pdu

_parts

_aggSig

_aggIdx

_aggCnt

Constructor Detail

YSms

Method Detail

get_slot

get_smsc

get_msgRef

get_protocolId

get_recipient

isNew

isReceived

get_alphabet

get_msgClass

get_dcs

get_userDataHeader

get_userData

isFlashMessage

get_timestamp

get_sender

get_textData

get_unicodeData

get_partCount

get_pdu

get_parts

get_concatSignature

get_concatIndex

get_concatCount

set_slot

set_received

set_new

set_smsc

set_msgRef

set_sender

set_recipient

set_protocolId

set_alphabet

set_msgClass

set_dcs

set_timestamp

set_userDataHeader

set_userData

convertToUnicode

addText

addUnicodeData

set_pdu

set_parts

encodeAddress

decodeAddress

encodeTimeStamp

decodeTimeStamp

udataSize

encodeUserData

generateParts

generatePdu

parseUserDataHeader