freesmartphone.org Framework DBus Interface Specification

org.freesmartphone.GSM.SMS

Description

The SMS interface is used to send and signal incoming short messages (SMS) directly, i.e. as opposed to using the SIM interface which always buffers short messages on the SIM after receiving and before sending.

Namespace

org.freesmartphone.GSM.SMS

Methods

Signals

Errors

None

Methods

GetSizeForTextMessage ( s ) → u

Description: Calculates the number of GSM Short Messages necessary to deliver a given text.

Parameters

s: contents

The contents of the message.

Returns

u: messages

The number of SMS to be sent, if this message were to be delivered.

SendTextMessage ( ssb ) → is

Description: Sends a text message via the GSM Short Message Service (SMS)

Text messages can be of unlimited length. They might get fragmented by the underlying transport layers though.

Parameters

s: recipient_number

The number of the recipient.

s: contents

The contents of the message.

b: want_report

If true, status reports (message receipts) will be sent by the SMSC, delivered via the IncomingMessageReceipt signal.

Returns

i: transaction_index

The given transaction index for this message. This is the message-reference number of this message.

s: timestamp

The timestamp this message was received by the SMSC.

SendMessage ( ssa{sv} ) → is

Description: Sends a message via the GSM Short Message Service (SMS)

This maps to the GSM 07.05 command +CMGS=..., see 3GPP TS 07.05 Chapter 3.5.1 (text mode) and 4.3 (pdu mode).

Parameters

s: recipient_number

The number of the recipient.

s: contents

The contents of the message.

a{sv}: properties

Additional properties of the message. Valid properties are:

  • (int:message-indication-type) = Type of messages that are waiting,
  • (int:message-indication-count) = Number of messages that are waiting.
  • Returns

    i: transaction_index

    The given transaction index for this message. This is the message-reference number of this message.

    s: timestamp

    The timestamp this message was received by the SMSC.

    AckMessage ( sa{sv} )

    Description: Acknowledges the receipt of a message via the GSM Short Message Service (SMS). Every message that has been delivered with the IncomingMessage signal needs to be either acked or nacked.

    This maps to the GSM 07.05 command +CNMA=..., see 3GPP TS 07.05 Chapter 3.4.4 (text mode) and 4.6 (pdu mode).

    Parameters

    s: contents

    Optional text to send along with the acknowledgement. Will usually be empty.

    a{sv}: properties

    Additional properties of the message. Valid properties are:

    NackMessage ( sa{sv} )

    Description: Reports that an error has occured during the receipt of a message via the GSM Short Message Service (SMS). Every message that has been delivered with the IncomingMessage signal needs to be either acked or nacked.

    This maps to the GSM 07.05 command +CNMA=..., see 3GPP TS 07.05 Chapter 3.4.4 (text mode) and 4.6 (pdu mode).

    Parameters

    s: contents

    Optional text to send along with the negative acknowledgement. Will usually be empty.

    a{sv}: properties

    Additional properties of the message. Valid properties are:

    Signals

    IncomingMessage ( ssa{sv} )

    Description: Sent, when a message has been received. The receipt of a message needs to be either acked or nacked with the AckMessage or NackMessage methods.

    Parameters

    s: sender_number

    The number of the sender.

    s: contents

    The contents of the message.

    a{sv}: properties

    Additional properties of the message. Valid properties are:

    IncomingMessageReceipt ( ssa{sv} )

    Description: Sent when a status report for a message has been received. Status reports for messages can be requested by setting the property "status-report-request" to True when sending messages through SendMessage

    Parameters

    s: sender_number

    The number of the sender.

    s: contents

    Optional contents of the receipt. Will usually be empty.

    a{sv}: properties

    Additional properties of the message. Valid properties are:


    | Specified 2008-2009 by the Freesmartphone.org team. | Join us and discuss further drafts smartphones-standards (at) linuxtogo (dot) org