From 8763576a3488a91e09bb47fe89789ee858b09345 Mon Sep 17 00:00:00 2001 From: Aleksander Morgado Date: Mon, 21 Nov 2011 14:27:35 +0100 Subject: [PATCH] api,dbus: rewrite Methods, Properties and Signals for gdbus-codegen --- new/org.freedesktop.ModemManager1.Bearer.xml | 300 ++++++--- ...edesktop.ModemManager1.Modem.3gpp.Ussd.xml | 132 ++-- ...g.freedesktop.ModemManager1.Modem.3gpp.xml | 205 +++--- ...g.freedesktop.ModemManager1.Modem.Cdma.xml | 178 ++--- ...eedesktop.ModemManager1.Modem.Contacts.xml | 262 ++++---- ...eedesktop.ModemManager1.Modem.Firmware.xml | 149 ++--- ...eedesktop.ModemManager1.Modem.Location.xml | 330 +++++++--- ...edesktop.ModemManager1.Modem.Messaging.xml | 200 +++--- ...freedesktop.ModemManager1.Modem.Simple.xml | 271 +++++--- new/org.freedesktop.ModemManager1.Modem.xml | 611 ++++++++++-------- new/org.freedesktop.ModemManager1.Sim.xml | 163 +++-- new/org.freedesktop.ModemManager1.Sms.xml | 135 ++-- new/org.freedesktop.ModemManager1.xml | 46 +- 13 files changed, 1750 insertions(+), 1232 deletions(-) diff --git a/new/org.freedesktop.ModemManager1.Bearer.xml b/new/org.freedesktop.ModemManager1.Bearer.xml index 408ffe9c..11c16852 100644 --- a/new/org.freedesktop.ModemManager1.Bearer.xml +++ b/new/org.freedesktop.ModemManager1.Bearer.xml @@ -1,120 +1,232 @@ - + + + + + - + - - Requests activation of a packet data connection with the network using - this bearer's properties. Upon successful activation, the modem can - send and receive packet data and, depending on the addressing - capability of the modem, a connection manager may need to start PPP, - perform DHCP, or assign the IP address returned by the modem to the - data interface. Upon successful return, the Ip4Config and/or Ip6Config - properties become valid and may contain IP configuration information for - the data interface associated with this bearer. - - - - - - The number to use for dialing (optional). Usually not required, in - which case it should be an empty (zero-length) string. Only required - for POTS connections or in certain special circumstances. If a number - is given for 3GPP (GSM/UMTS/LTE) based devices, it is always ignored, - as the number is generated internally if one is required at all. - - + - - - Disconnect and deactivate this packet data connection. Any ongoing data - session will be terminated and IP addresses become invalid when this - method is called. - - - - + + Disconnect and deactivate this packet data connection. - + Any ongoing data session will be terminated and IP addresses become + invalid when this method is called. + --> + + + + + + + + + + + + + + + + + + diff --git a/new/org.freedesktop.ModemManager1.Modem.3gpp.Ussd.xml b/new/org.freedesktop.ModemManager1.Modem.3gpp.Ussd.xml index 96d322d1..76d5b44e 100644 --- a/new/org.freedesktop.ModemManager1.Modem.3gpp.Ussd.xml +++ b/new/org.freedesktop.ModemManager1.Modem.3gpp.Ussd.xml @@ -1,84 +1,94 @@ - + + + + + - - + + + + + - - + + + + - - + + - - - Indicates the state of any ongoing USSD session. Values may be one of - the following: "idle" (no active session), "active" (a session is active - and the mobile is waiting for a response), "user-response" (the network - is waiting for the client's response, which must be sent using Respond()). - - + + + + + + + + diff --git a/new/org.freedesktop.ModemManager1.Modem.3gpp.xml b/new/org.freedesktop.ModemManager1.Modem.3gpp.xml index 4e271e5f..5b1368ff 100644 --- a/new/org.freedesktop.ModemManager1.Modem.3gpp.xml +++ b/new/org.freedesktop.ModemManager1.Modem.3gpp.xml @@ -1,101 +1,142 @@ - + + + + + - + - - Request registration with a given mobile network. - - - - - - The network ID (ie, MCC-MNC, like "310260") to register. An empty - string can be used to register to the home network. - - + - - - Scan for available networks. - - - - - -

Found networks. It's an array of dictionaries (strings for both - keys and values) with each array element describing a mobile network - found in the scan. Each dict may include one or more of the following - keys:

-
    -
  • - "status": a number representing network availability status as - defined in 3GPP TS 27.007 section 7.3. e.g. "0" (unknown), "1" - (available), "2" (current), or "3" (forbidden). This key will + + + - + + - - - Mobile registration status as defined in 3GPP TS 27.007 section - 10.1.19. - - + + - - - Current operator name of the operator to which the mobile is - currently registered. If the operator name is not knowon or the - mobile is not registered to a mobile network, this property will + + + + + + + + diff --git a/new/org.freedesktop.ModemManager1.Modem.Cdma.xml b/new/org.freedesktop.ModemManager1.Modem.Cdma.xml index fda3790d..ca9b5db6 100644 --- a/new/org.freedesktop.ModemManager1.Modem.Cdma.xml +++ b/new/org.freedesktop.ModemManager1.Modem.Cdma.xml @@ -1,104 +1,124 @@ - + + + + + - + + + + - - + + + - + - - The device activation state changed. - - - Current activation state - - - Carrier-specific error code - - - - Selected Modem.Simple.GetStatus keys that have changed as a result of - this activation state change. Will include 'mdn' and 'min'. - - + + + - + + - - - The modem's Electronic Serial Number (superceded by the MEID but still - used by older devices). - - - - - The System Identifier of the serving CDMA 1x network, if known, and - if the modem is registered with a CDMA 1x network. See ifast.org or - the mobile broadband provider database for mappings of SIDs to network - providers. - - + + + + + - - EVDO registration state. - + + + + + + + + diff --git a/new/org.freedesktop.ModemManager1.Modem.Contacts.xml b/new/org.freedesktop.ModemManager1.Modem.Contacts.xml index 8e3c85f0..1fb4d236 100644 --- a/new/org.freedesktop.ModemManager1.Modem.Contacts.xml +++ b/new/org.freedesktop.ModemManager1.Modem.Contacts.xml @@ -1,154 +1,176 @@ - - + + + + + + + - - Add a new contact. - - - - - - Dictionary of properties describing the contact. If any property - exceeds the modem's size limit, that property will be truncated to fit. - Known properties are: - - name : (string) Full name of the contact - number : (string) Telephone number - email : (string) Email address - group : (string) Group this contact belongs to - name2 : (string) Additional contact name - number2 : (string) Additional contact telephone number - hidden : (bool) Whether this entry is hidden or not - storage : (uint) Phonebook in which contact is stored, one of - MM_MODEM_CONTACTS_STORAGE - - - - - The index number of the new contact; this number is an internal - private number to ModemManager and does not correspond to the index - of the contact in the modem or SIM itself. - - + + + - - Delete a contact. - - - - - - The index of the contact to delete. - - + + - - Retrieve a contact. - - - - - - The index of the contact. - - - - - The properties of the contact including those properties defined by - the Add method. - - + + + - - List all contacts. - - - - - - An array of dictionaries, each dictionary representing a contact. - - + + - - Find a contact. - - - - - - The pattern to search for. - - - - - An array of dictionaries, each dictionary representing a contact which - matches the query pattern. - - + + + - - Get the number of contacts. - - - - - - The number of contacts. - - + - + + + + + - - Emitted when a contact has been deleted. - - - - Index number of the now deleted contact. - - + diff --git a/new/org.freedesktop.ModemManager1.Modem.Firmware.xml b/new/org.freedesktop.ModemManager1.Modem.Firmware.xml index a34cc0ec..7ab2ed9f 100644 --- a/new/org.freedesktop.ModemManager1.Modem.Firmware.xml +++ b/new/org.freedesktop.ModemManager1.Modem.Firmware.xml @@ -1,8 +1,20 @@ - - - + + + + + + + + + + + + - - + + + - - + + + + + diff --git a/new/org.freedesktop.ModemManager1.Modem.Location.xml b/new/org.freedesktop.ModemManager1.Modem.Location.xml index 7a5908fa..2532a46d 100644 --- a/new/org.freedesktop.ModemManager1.Modem.Location.xml +++ b/new/org.freedesktop.ModemManager1.Modem.Location.xml @@ -1,111 +1,253 @@ - - - - This interface allows devices to provide location information to client - applications. Not all devices can provide this information, or even if - they do, they may not be able to provide it while a data session is + + + + + + - - - Location capabilities of the device. - - + - - Enable or disable location information gathering. This method may - require the client to authenticate itself. This method may also cause - any necessary functionality of the mobile be be turned on, including - enabling the modem device itself. - - - - - - TRUE to enable location information gathering, FALSE to disable. - - - - - When enabling location information gathering, this argument controls - whether the device emits signals with new location information or not. - When signals are emitted, any client application (including malicious - ones!) can listen for location updates unless D-Bus permissions - restrict these signals from certain users. If further security is - desired, this argument can be set to FALSE to disable location - updates via D-Bus signals and require applications to call - authenticated APIs (like GetLocation) to get location information. - This argument is ignored when disabling location information - gathering. - - + + + - - Return current location information, if any. This method may require - the client to authenticate itself. - - - - - - Dict of available location information when location information - gathering is enabled. If the modem supports multiple location types - it may return more than one here. - - + - - - TRUE if location updates will be emitted via D-Bus signals, FALSE - if location updates will not be emitted. See the Enable method for - more information. - - + + - - - A mapping from location type to type-specific location information. - - - - Identifies the type and format of the associated location information. - Contrary to the value description, this is not a bitfield but uses the - same values as the MM_MODEM_LOCATION_CAPABILITIES bitfield. - - - - - Contains type-specific location information. See the documentation for - each type for a description of its data format. - - - + + + + + + + + + + diff --git a/new/org.freedesktop.ModemManager1.Modem.Messaging.xml b/new/org.freedesktop.ModemManager1.Modem.Messaging.xml index 165cedff..084ad5ae 100644 --- a/new/org.freedesktop.ModemManager1.Modem.Messaging.xml +++ b/new/org.freedesktop.ModemManager1.Modem.Messaging.xml @@ -1,132 +1,122 @@ - + + + + + - - This interface handles sending SMS messages and notification of new - incoming messages. - + - - - Retrieve all SMS messages. - - - - - - A dict of message object paths mapped to a dictionary containing that - message's properties as specified in the - org.freedesktop.ModemManager1.Modem.SMS D-Bus interface. This method - should only be used once and subsequent information retreived either - by listening for the Received and Completed signals, or by querying - the specific SMS object of interest. - - + + This method should only be used once and subsequent information + retreived either by listening for the + #org.freedesktop.ModemManager1.Modem.Messaging::Added and + #org.freedesktop.ModemManager1.Modem.Messaging::Completed signals, + or by querying the specific SMS object of interest. + --> + + + - - Delete an SMS message. Alternatively you may use the Delete() method - on the message object itself. - - - - - - The object path of the SMS to delete. - - + - - + + + + + - + + + + + - - - Emitted when the complete-ness status of an SMS message changes. An SMS - may not necessarily be complete when the first part is received; this - signal will be emitted when all parts have been received, even for + + + + - - + + + diff --git a/new/org.freedesktop.ModemManager1.Modem.Simple.xml b/new/org.freedesktop.ModemManager1.Modem.Simple.xml index 20af2934..0df3e709 100644 --- a/new/org.freedesktop.ModemManager1.Modem.Simple.xml +++ b/new/org.freedesktop.ModemManager1.Modem.Simple.xml @@ -1,115 +1,186 @@ - + + + + + - + - - Do everything needed to connect the modem using the given properties. - This method will attempt to find a matching packet data bearer and - activate it if necessary, returning the bearer's IP details. If no - matching bearer is found, a new bearer will be created and activated, - but this operation may fail if no resources are available to complete - this connection attempt (ie, if a conflicting bearer is already active). - - - - - - Dictionary of properties needed to get the modem connected. This - call may make a large number of changes to modem configuration based - on properties passed in. For example, given a PIN-locked, disabled - GSM/UMTS modem, this call may unlock the SIM PIN, alter the access - technology preference, wait for network registration (or force - registration to a specific provider), create a new packet data bearer - using the given 'apn', and connect that bearer. - - 'pin' : (string) SIM-PIN unlock code - 'network-id' : (string) ETSI MCC-MNC of a network to force registration with - 'band' : (uint) Bitfield of radio bands the modem may use - 'allowed-mode' : (uint) Allowed network technology preference (ie, 2G/3G, etc) - 'apn' : (string) For GSM/UMTS and LTE devices the APN to use - 'ip-type' : (string) For GSM/UMTS and LTE devices the IP addressing - type to use, one of "IPV4", "IPV4V6", or "IPV6" - 'number' : (string) For POTS devices, the number to dial - 'home_only' : (uint) 1 to allow only connections to home networks - - - - - On successful connect, returns the object path of the connected - packet data bearer used for the connection attempt. - - - - - The operating system name for the network data interface that provides - packet data using this bearer. Connection managers must configure this - interface using the given IP configuration returned by bearer activation. - - - - - If the bearer was configured for IPv4 addressing, upon successful - connect this argument contains the addressing details for assignment - to the data interface. If the bearer specifies configuration via PPP - or DHCP, only the 'method' item will be present. See the description - of the property of this name in the - org.freedesktop.ModemManager1.Modem.Bearer interface. - - - - - If the bearer was configured for IPv6 addressing, upon successful - connect this argument contains the addressing details for assignment - to the data interface. If the bearer specifies configuration via PPP - or DHCP, only the 'method' item will be present. See the description - of the property of this name in the - org.freedesktop.ModemManager1.Modem.Bearer interface. - - + + + + + + - - Disconnect an active packet data connection. - - - - - - If given this method will disconnect the referenced packet data bearer, - while if "/" (ie, no object given) this method will disconnect all - active packet data bearers. - - + - - - - Get the modem status. - - - - - - Dictionary of properties. The predefined common properties are: + + + diff --git a/new/org.freedesktop.ModemManager1.Modem.xml b/new/org.freedesktop.ModemManager1.Modem.xml index 14538968..4711b24d 100644 --- a/new/org.freedesktop.ModemManager1.Modem.xml +++ b/new/org.freedesktop.ModemManager1.Modem.xml @@ -1,334 +1,419 @@ - + + + + + - + - - Enable or disables the modem. When enabled, the modem's radio is powered - on and data sessions, voice calls, location services, and Short Message - Service may be available. When disabled, the modem enters low-power - state and no network-related operations are available. - - - - - - Pass True to enable the modem, or False to disable it. - - + + - - List configured packet data bearers (EPS Bearers, PDP Contexts, or - CDMA2000 Packet Data Sessions). - - - - - - The list of bearer object paths. - - + + - - Create a new packet data bearer using the given characteristics. This - request may fail if the modem does not support additional bearers, if - too many bearers are already defined, or if properties are invalid. - - - - - - List of properties to assign to the bearer after creating it. Some - properties are only applicable to a bearer of certain access - technologies, for example the "apn" property is not applicable to - CDMA2000 Packet Data Session bearers. Allowed properties are: - - apn : (3GPP, required) Access Point Name - ip-type : (3GPP and CMDA, optional) Addressing type, one of - "IPV4", "IPV4V6", or "IPV6" - user : (3GPP, optional) user name (if any) required by the network - password : (3GPP, optional) password (if any) required by the network - number : (POTS, required) telphone number to dial - - ** FIXME: how about QoS? - - - - - On success, the object path of the newly created bearer. - - + + + - - Delete an existing packet data bearer. - - - - - - Object path of the bearer to delete. If the bearer is currently - active and providing packet data server, it will be disconnected - and that packet data service will terminate. - - + - - + + + + + + - - + + + + - - + + + - + - - The modem's state (see the State property) changed. - - - Old state - - - New state - - - Reason for this state change - + + + - + + - - - The generic family of access technologies the modem supports. Not all - capabilities are available at the same time however; some modems require - a firmware reload or other reinitialization to switch between eg CDMA/EVDO - and GSM/UMTS. - - + + + + + + + + + + + - - - The equipment model, as reported by the modem. - - + + - - - A best-effort device identifier based on various device information like - model name, firmware revision, USB/PCI/PCMCIA IDs, and other properties. - This ID is not guaranteed to be unique and may be shared between - identical devices with the same firmware, but is intended to be - "unique enough" for use as a casual device identifier for various - user experience operations. This is not the device's IMEI or ESN since - those may not be available before unlocking the device via a PIN. - - + + - - - The Operating System device driver handling communication with the - modem hardware. - - + + + + + + + + + + + + + + - - - The identity of the device. This will be the IMEI number for - GSM devices and the hex-format ESN/MEID for CDMA devices. - - + + - - - Overall state of the modem. - - + + + + + + + + + + + + + + + + + - - - The preferred access technology (eg 2G/3G/4G), among the ones defined in - the allowed modes. Only one or none values must be given. - - + + - - - Radio frequency and technology bands supported by the device. For POTS - devices, only the "any" value will be returned. - - + + + + + + + + + + + diff --git a/new/org.freedesktop.ModemManager1.Sim.xml b/new/org.freedesktop.ModemManager1.Sim.xml index e21b5609..14f90774 100644 --- a/new/org.freedesktop.ModemManager1.Sim.xml +++ b/new/org.freedesktop.ModemManager1.Sim.xml @@ -1,104 +1,103 @@ - + + + + + - - Handles communication with SIM, USIM, and RUIM (CDMA SIM) cards. - + - - Send the PIN to unlock the SIM card. - - - - - - The PIN code. - - + + + + + + + + - - Enable or disable the PIN checking. - - - - - - The PIN code. - - - - - True to enable PIN checking. - - + + + - - Change the PIN code. - - - - - - The current PIN code. - - - - - The new PIN code. - - + + - - - An obfuscated SIM identifier based on the IMSI or the ICCID. This may - be available before the PIN has been entered depending on the device - itself. - - + + + + + + + + + + + + diff --git a/new/org.freedesktop.ModemManager1.Sms.xml b/new/org.freedesktop.ModemManager1.Sms.xml index 01622d31..64ab1750 100644 --- a/new/org.freedesktop.ModemManager1.Sms.xml +++ b/new/org.freedesktop.ModemManager1.Sms.xml @@ -1,75 +1,98 @@ - + + + + + - - Defines operations and properties of a single SMS message. - + + Delete the message. + --> + - - - Deletes the message. - - - - + + - + + - - - Indicates the number to which the message is addressed. - - + + - - - Indicates the SMS service center number. Always empty for 3GPP2/CDMA. - - + + - - - Time message was received or was sent in ISO8601 format. - - + + + + + + + + + + + diff --git a/new/org.freedesktop.ModemManager1.xml b/new/org.freedesktop.ModemManager1.xml index 17106f16..b782177f 100644 --- a/new/org.freedesktop.ModemManager1.xml +++ b/new/org.freedesktop.ModemManager1.xml @@ -1,28 +1,40 @@ - + + + + + - + + + + + +