--- /dev/null
+CDMA Connection Manager hierarchy [experimental]
+=================================
+
+Service org.ofono
+Interface org.ofono.cdma.ConnectionManager
+Object path [variable]
+
+Methods dict GetProperties()
+
+ Returns all global system properties. See the
+ properties section for available properties.
+
+ Possible Errors: [service].Error.InvalidArguments
+
+ void SetProperty(string property, variant value)
+
+ Sets the property to a desired value
+
+ Possible Errors: [service].Error.InvalidArguments
+ [service].Error.InvalidFormat
+ [service].Error.Failed
+
+Signals PropertyChanged(string property, variant value)
+
+ This signal indicates a changed value of the given
+ property.
+
+Properties boolean Powered [readwrite]
+
+ Controls whether the CDMA data connection is
+ enabled.
+
+ boolean Dormant [readonly]
+
+ Contains whether the connection is dormant. Will
+ always be false if the connection is not powered.
+
+ dict Settings [readonly, optional]
+
+ Holds all the IP network settings
+
+ string Interface [readonly, optional]
+
+ Holds the interface of the network interface
+ used by this context (e.g. "ppp0" "usb0")
+
+ string Method [readonly, optional]
+
+ Holds the IP network config method
+ "static"- Set IP network statically
+ "dhcp" - Set IP network through DHCP
+
+ string Address [readonly, optional]
+
+ Holds the IP address for this context.
+
+ string Netmask [readonly, optional]
+
+ Holds the Netmask for this context.
+
+ array{string} DomainNameServers [readonly, optional]
+
+ Holds the list of domain name servers for this
+ context.
+
+ string Gateway [readonly, optional]
+
+ Holds the gateway IP for this connection.
--- /dev/null
+CDMA Message Manager hierarchy [experimental]
+==============================
+
+Service org.ofono
+Interface org.ofono.cdma.MessageManager
+Object path [variable prefix]/{modem0,modem1,...}
+
+Methods dict GetProperties()
+
+ Returns properties for the manager object. See
+ the properties section for available properties.
+
+ Possible Errors: [service].Error.InvalidArguments
+
+ array{object,dict} GetMessages()
+
+ Get an array of message object paths and properties
+ that represents the currently pending messages.
+
+ This method call should only be used once when an
+ application starts up. Further message additions
+ and removal shall be monitored via MessageAdded and
+ MessageRemoved signals.
+
+ void SetProperty(string name, variant value)
+
+ Changes the value of the specified property. Only
+ properties that are listed as readwrite are
+ changeable. On success a PropertyChanged signal
+ will be emitted.
+
+ Possible Errors: [service].Error.InvalidArguments
+ [service].Error.DoesNotExist
+
+ object SendMessage(dict message_info)
+
+ The dictionary can contain the following keys:
+
+ string "To" - Address of the receiver
+
+ string "Text" - The text to send
+
+ string "Priority" - The value can be one of:
+ "normal",
+ "interactive",
+ "urgent",
+ "emergency",
+
+ TODO: Figure out where this is really needed
+
+ string "Privacy" - The value can be one of:
+ "not restricted",
+ "restricted",
+ "confidential",
+ "secret"
+
+ TODO: Figure out where this is really needed
+
+ If the message could be queued successfully, this
+ method returns an object path to the created Message
+ object.
+
+Signals PropertyChanged(string name, variant value)
+
+ This signal indicates a changed value of the given
+ property.
+
+ ImmediateMessage(string message, dict info)
+
+ New immediate SMS received. Info has Sender,
+ LocalSentTime, SentTime, Priority, Privacy and
+ CallbackNumber information. Sender address is given
+ in string format. LocalSentTime and SentTime are
+ given in string form using ISO8601 format.
+
+ IncomingMessage(string message, dict info)
+
+ New incoming text SMS received. Info has Sender,
+ LocalSentTime, SentTime, Priority, Privacy, and
+ CallbackNumber.
+
+ MessageAdded(object path, dict properties)
+
+ This signal is emitted whenever a new Message object
+ has been created.
+
+ MessageRemoved(object path)
+
+ This signal is emitted whenever a Message object
+ has been removed, e.g. when it reaches a final state.
+
+Properties boolean UseDeliveryAcknowledgement
+
+ Request to be notified when the SMSC has delivered
+ the message to the receiving user. In effect this
+ is the same as the GSM Status Report.
+
+ boolean UseUserAcknowledgement
+
+ Request to be notified when the receiving user has
+ acknowledged the message.
+
+ boolean UseReadAcknowledgement
+
+ Request to be notified when the receiving User has
+ read the message.
+
+ string CallbackNumber
+
+ The call back number for the user. If the number is
+ empty, then the optional field is not included
+ in the encoded PDU.
--- /dev/null
+CDMA Network registration hierarchy [experimental]
+===================================
+
+Service org.ofono
+Interface org.ofono.cdma.NetworkRegistration
+Object path [variable prefix]/{modem0,modem1,...}
+
+Methods dict GetProperties()
+
+ Returns all network registration properties. See the
+ properties section for available properties.
+
+ Possible Errors: [service].Error.InvalidArguments
+
+ void SetProperty(string name, variant value)
+
+ Changes the value of the specified property. Only
+ properties that are listed as readwrite are
+ changeable. On success a PropertyChanged signal
+ will be emitted.
+
+ Possible Errors: [service].Error.InvalidArguments
+ [service].Error.DoesNotExist
+
+Signals PropertyChanged(string property, variant value)
+
+ This signal indicates a changed value of the given
+ property.
+
+Properties string Status [readonly]
+
+ The current registration status of a modem.
+
+ The possible values are:
+ "unregistered" Not registered
+ "registered" Registered to home network
+ "roaming" Roaming
+
+ byte Strength [readonly]
+
+ Contains the current signal strength as a percentage
+ between 0-100 percent.
+
+ byte DataStrength [readonly]
+
+ Contains the current signal strength of the High Data
+ Rate network. This is a percentage value between
+ 0-100 percent.
+
+ uint16 SystemIdentifier [readonly, optional]
+
+ Contains the system identifier of the currently
+ selected network.
+
+ uint16 NetworkIdentifier [readonly, optional]
+
+ Contains the network identifier of the currently
+ selected network.
+
+ uint16 MobileCountryCode [readonly, optional]
+
+ Contains the Mobile Country Code (MCC).
+
+ uint16 MobileNetworkCode [readonly, optional]
+
+ Contains the Mobile Network Code (MNC).
+
+ string Name [readonly, optional]
+
+ Contains the name of the current network.
--- /dev/null
+CDMA VoiceCallManager hierarchy [experimental]
+===============================
+
+Service org.ofono
+Interface org.ofono.cdma.VoiceCallManager
+Object path [variable prefix]/{modem0,modem1,...}
+
+Methods void Dial(string number)
+
+ Initiates a new outgoing call. This is usually
+ implemented using the ATD AT command.
+
+ void Hangup()
+
+ Hangup all active calls.
+
+ void Answer()
+
+ Answer the incoming call. This only affects the
+ incoming call.
+
+ void SendFlash(string flash_string)
+
+ Sends the flash string to the network.
+
+ void SendTones(string tones)
+
+ Sends the DTMF tones to the network. The tones have
+ a fixed duration. Tones can be one of: '0' - '9',
+ '*', '#', 'A', 'B', 'C', 'D'. The last four are
+ typically not used in normal circumstances.
+
+Signals PropertyChanged(string property, variant value)
+
+ Signal is emitted whenever a property has changed.
+ The new value is passed as the signal argument.
+
+Properties string State [readonly]
+
+ Contains the state of the current call. The state
+ can be one of:
+ - "active" - The call is active
+ - "dialing" - The call is being dialed
+ - "alerting" - The remote party is being alerted
+ - "incoming" - Incoming call in progress
+ - "disconnected" - No call is connected
+
+ boolean CallWaiting [readonly]
+
+ Contains whether a call is waiting.
+
+ string CallWaitingNumber [readonly, optional]
+
+ Contains the call waiting number.
+
+ DisconnectReason(string reason)
+
+ This signal is emitted when the modem manager can
+ provide extra information about why the call was
+ released. The possible reason values are:
+ "local" - The call was release due to local
+ user action
+ "remote" - Remote party released the call
+ "network" - Network released the call, most
+ likely due to low signal or
+ other network failure
+
+ Not all implementations are able to provide this
+ information, so applications should treat the emission
+ of this signal as optional. This signal will be
+ emitted before the PropertyChanged signal.
+
+ string ToneDuration [readwrite]
+
+ Contains the length of the DTMF tone duration. The
+ currently supported values are:
+ "short",
+ "long"
projects / platform / upstream / ofono.git / commitdiff