colin/ModemManager
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

introspection,api: new 'Oma' interface

Browse Source
This commit is contained in:
Aleksander Morgado
2013-08-13 11:20:03 +02:00
parent b8e8c2a56d
commit 32de7d6fef
9 changed files with 315 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/reference/api/Makefile.am
View File

@@ -73,6 +73,7 @@ expand_content_files = \
$(top_builddir)/libmm-glib/generated/mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.Location.xml \
$(top_builddir)/libmm-glib/generated/mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.Time.xml \
$(top_builddir)/libmm-glib/generated/mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.Firmware.xml \
$(top_builddir)/libmm-glib/generated/mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.Oma.xml \
$(top_builddir)/libmm-glib/generated/mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.ModemCdma.xml \
$(top_builddir)/libmm-glib/generated/mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.Modem3gpp.xml \
$(top_builddir)/libmm-glib/generated/mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.Modem3gpp.Ussd.xml \

1
docs/reference/api/ModemManager-dbus-reference.xml
View File

@@ -137,6 +137,7 @@
<xi:include href="../../../../libmm-glib/generated/mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.Time.xml"/>
<xi:include href="../../../../libmm-glib/generated/mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.Firmware.xml"/>
<xi:include href="../../../../libmm-glib/generated/mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.Signal.xml"/>
<xi:include href="../../../../libmm-glib/generated/mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.Oma.xml"/>
<!--xi:include href="../../../../libmm-glib/generated/mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.Contacts.xml"/-->
</chapter>

4
docs/reference/api/ModemManager-sections.txt
View File

@@ -33,6 +33,10 @@ MMModemStateFailedReason
MMModemStateChangeReason
MMModemPowerState
MMModemPortType
MMOmaFeature
MMOmaSessionState
MMOmaSessionStateFailedReason
MMOmaSessionType
MMSmsPduType
MMSmsState
MMSmsDeliveryState

4
docs/reference/libmm-glib/libmm-glib-docs.xml
View File

@@ -184,6 +184,10 @@
<xi:include href="xml/MmGdbusModemSignalProxy.xml"/>
<xi:include href="xml/MmGdbusModemSignalSkeleton.xml"/>
<xi:include href="xml/MmGdbusModemOma.xml"/>
<xi:include href="xml/MmGdbusModemOmaProxy.xml"/>
<xi:include href="xml/MmGdbusModemOmaSkeleton.xml"/>
<!--xi:include href="xml/MmGdbusModemContacts.xml"/>
<xi:include href="xml/MmGdbusModemContactsProxy.xml"/>
<xi:include href="xml/MmGdbusModemContactsSkeleton.xml"/-->

86
docs/reference/libmm-glib/libmm-glib-sections.txt
View File

@@ -2089,6 +2089,89 @@ MmGdbusModemFirmwareSkeletonPrivate
mm_gdbus_modem_firmware_skeleton_get_type
</SECTION>
<SECTION>
<FILE>MmGdbusModemOma</FILE>
<TITLE>MmGdbusModemOma</TITLE>
MmGdbusModemOma
MmGdbusModemOmaIface
<SUBSECTION Getters>
<SUBSECTION Methods>
mm_gdbus_modem_oma_call_accept_network_initiated_session
mm_gdbus_modem_oma_call_accept_network_initiated_session_finish
mm_gdbus_modem_oma_call_accept_network_initiated_session_sync
mm_gdbus_modem_oma_call_cancel_session
mm_gdbus_modem_oma_call_cancel_session_finish
mm_gdbus_modem_oma_call_cancel_session_sync
mm_gdbus_modem_oma_call_setup
mm_gdbus_modem_oma_call_setup_finish
mm_gdbus_modem_oma_call_setup_sync
mm_gdbus_modem_oma_call_start_client_initiated_session
mm_gdbus_modem_oma_call_start_client_initiated_session_finish
mm_gdbus_modem_oma_call_start_client_initiated_session_sync
mm_gdbus_modem_oma_get_session_state
mm_gdbus_modem_oma_get_session_type
mm_gdbus_modem_oma_get_pending_network_initiated_sessions
mm_gdbus_modem_oma_dup_pending_network_initiated_sessions
<SUBSECTION Private>
mm_gdbus_modem_oma_set_pending_network_initiated_sessions
mm_gdbus_modem_oma_set_session_state
mm_gdbus_modem_oma_set_session_type
mm_gdbus_modem_oma_emit_session_state_changed
mm_gdbus_modem_oma_complete_accept_network_initiated_session
mm_gdbus_modem_oma_complete_cancel_session
mm_gdbus_modem_oma_complete_setup
mm_gdbus_modem_oma_complete_start_client_initiated_session
mm_gdbus_modem_oma_interface_info
mm_gdbus_modem_oma_override_properties
<SUBSECTION Standard>
MM_GDBUS_IS_MODEM_OMA
MM_GDBUS_MODEM_OMA
MM_GDBUS_MODEM_OMA_GET_IFACE
MM_GDBUS_TYPE_MODEM_OMA
mm_gdbus_modem_oma_get_type
</SECTION>
<SECTION>
<FILE>MmGdbusModemOmaProxy</FILE>
<TITLE>MmGdbusModemOmaProxy</TITLE>
MmGdbusModemOmaProxy
<SUBSECTION New>
mm_gdbus_modem_oma_proxy_new
mm_gdbus_modem_oma_proxy_new_finish
mm_gdbus_modem_oma_proxy_new_for_bus
mm_gdbus_modem_oma_proxy_new_for_bus_finish
mm_gdbus_modem_oma_proxy_new_for_bus_sync
mm_gdbus_modem_oma_proxy_new_sync
<SUBSECTION Standard>
MmGdbusModemOmaProxyClass
MM_GDBUS_IS_MODEM_OMA_PROXY
MM_GDBUS_IS_MODEM_OMA_PROXY_CLASS
MM_GDBUS_MODEM_OMA_PROXY
MM_GDBUS_MODEM_OMA_PROXY_CLASS
MM_GDBUS_MODEM_OMA_PROXY_GET_CLASS
MM_GDBUS_TYPE_MODEM_OMA_PROXY
MmGdbusModemOmaProxyPrivate
mm_gdbus_modem_oma_proxy_get_type
</SECTION>
<SECTION>
<FILE>MmGdbusModemOmaSkeleton</FILE>
<TITLE>MmGdbusModemOmaSkeleton</TITLE>
MmGdbusModemOmaSkeleton
<SUBSECTION New>
mm_gdbus_modem_oma_skeleton_new
<SUBSECTION Standard>
MmGdbusModemOmaSkeletonClass
MM_GDBUS_IS_MODEM_OMA_SKELETON
MM_GDBUS_IS_MODEM_OMA_SKELETON_CLASS
MM_GDBUS_MODEM_OMA_SKELETON
MM_GDBUS_MODEM_OMA_SKELETON_CLASS
MM_GDBUS_MODEM_OMA_SKELETON_GET_CLASS
MM_GDBUS_TYPE_MODEM_OMA_SKELETON
MmGdbusModemOmaSkeletonPrivate
mm_gdbus_modem_oma_skeleton_get_type
</SECTION>
<SECTION>
<FILE>MmGdbusModemSimple</FILE>
<TITLE>MmGdbusModemSimple</TITLE>
@@ -2261,6 +2344,8 @@ mm_gdbus_object_peek_modem_time
mm_gdbus_object_get_modem_time
mm_gdbus_object_peek_modem_firmware
mm_gdbus_object_get_modem_firmware
mm_gdbus_object_peek_modem_oma
mm_gdbus_object_get_modem_oma
mm_gdbus_object_peek_modem_simple
mm_gdbus_object_get_modem_simple
mm_gdbus_object_peek_modem_signal
@@ -2305,6 +2390,7 @@ mm_gdbus_object_skeleton_set_modem3gpp
mm_gdbus_object_skeleton_set_modem3gpp_ussd
mm_gdbus_object_skeleton_set_modem_cdma
mm_gdbus_object_skeleton_set_modem_firmware
mm_gdbus_object_skeleton_set_modem_oma
mm_gdbus_object_skeleton_set_modem_location
mm_gdbus_object_skeleton_set_modem_messaging
mm_gdbus_object_skeleton_set_modem_simple

92
include/ModemManager-enums.h
View File

@@ -801,4 +801,96 @@ typedef enum { /*< underscore_name=mm_firmware_image_type >*/
MM_FIRMWARE_IMAGE_TYPE_GOBI = 2,
} MMFirmwareImageType;
/**
* MMOmaFeature:
* @MM_OMA_FEATURE_NONE: None.
* @MM_OMA_FEATURE_DEVICE_PROVISIONING: Device provisioning service.
* @MM_OMA_FEATURE_PRL_UPDATE: PRL update service.
* @MM_OMA_FEATURE_HANDS_FREE_ACTIVATION: Hands free activation service.
*
* Features that can be enabled or disabled in the OMA device management support.
*/
typedef enum { /*< underscore_name=mm_oma_feature >*/
MM_OMA_FEATURE_NONE = 0,
MM_OMA_FEATURE_DEVICE_PROVISIONING = 1 << 0,
MM_OMA_FEATURE_PRL_UPDATE = 1 << 1,
MM_OMA_FEATURE_HANDS_FREE_ACTIVATION = 1 << 2,
} MMOmaFeature;
/**
* MMOmaSessionType:
* @MM_OMA_SESSION_TYPE_UNKNOWN: Unknown session type.
* @MM_OMA_SESSION_TYPE_CLIENT_INITIATED_DEVICE_CONFIGURE: Client-initiated device configure.
* @MM_OMA_SESSION_TYPE_CLIENT_INITIATED_PRL_UPDATE: Client-initiated PRL update.
* @MM_OMA_SESSION_TYPE_CLIENT_INITIATED_HANDS_FREE_ACTIVATION: Client-initiated hands free activation.
* @MM_OMA_SESSION_TYPE_NETWORK_INITIATED_DEVICE_CONFIGURE: Network-initiated device configure.
* @MM_OMA_SESSION_TYPE_NETWORK_INITIATED_PRL_UPDATE: Network-initiated PRL update.
* @MM_OMA_SESSION_TYPE_DEVICE_INITIATED_PRL_UPDATE: Device-initiated PRL update.
* @MM_OMA_SESSION_TYPE_DEVICE_INITIATED_HANDS_FREE_ACTIVATION: Device-initiated hands free activation.
*
* Type of OMA device management session.
*/
typedef enum { /*< underscore_name=mm_oma_session_type >*/
MM_OMA_SESSION_TYPE_UNKNOWN = 0,
MM_OMA_SESSION_TYPE_CLIENT_INITIATED_DEVICE_CONFIGURE = 10,
MM_OMA_SESSION_TYPE_CLIENT_INITIATED_PRL_UPDATE = 11,
MM_OMA_SESSION_TYPE_CLIENT_INITIATED_HANDS_FREE_ACTIVATION = 12,
MM_OMA_SESSION_TYPE_NETWORK_INITIATED_DEVICE_CONFIGURE = 20,
MM_OMA_SESSION_TYPE_NETWORK_INITIATED_PRL_UPDATE = 21,
MM_OMA_SESSION_TYPE_DEVICE_INITIATED_PRL_UPDATE = 30,
MM_OMA_SESSION_TYPE_DEVICE_INITIATED_HANDS_FREE_ACTIVATION = 31,
} MMOmaSessionType;
/**
* MMOmaSessionState:
* @MM_OMA_SESSION_STATE_FAILED: Failed.
* @MM_OMA_SESSION_STATE_UNKNOWN: Unknown.
* @MM_OMA_SESSION_STATE_STARTED: Started.
* @MM_OMA_SESSION_STATE_RETRYING: Retrying.
* @MM_OMA_SESSION_STATE_CONNECTING: Connecting.
* @MM_OMA_SESSION_STATE_CONNECTED: Connected.
* @MM_OMA_SESSION_STATE_AUTHENTICATED: Authenticated.
* @MM_OMA_SESSION_STATE_MDN_DOWNLOADED: MDN downloaded.
* @MM_OMA_SESSION_STATE_MSID_DOWNLOADED: MSID downloaded.
* @MM_OMA_SESSION_STATE_PRL_DOWNLOADED: PRL downloaded.
* @MM_OMA_SESSION_STATE_MIP_PROFILE_DOWNLOADED: MIP profile downloaded.
* @MM_OMA_SESSION_STATE_COMPLETED: Session completed.
*
* State of the OMA device management session.
*/
typedef enum { /*< underscore_name=mm_oma_session_state >*/
MM_OMA_SESSION_STATE_FAILED = -1,
MM_OMA_SESSION_STATE_UNKNOWN = 0,
MM_OMA_SESSION_STATE_STARTED = 1,
MM_OMA_SESSION_STATE_RETRYING = 2,
MM_OMA_SESSION_STATE_CONNECTING = 3,
MM_OMA_SESSION_STATE_CONNECTED = 4,
MM_OMA_SESSION_STATE_AUTHENTICATED = 5,
MM_OMA_SESSION_STATE_MDN_DOWNLOADED = 10,
MM_OMA_SESSION_STATE_MSID_DOWNLOADED = 11,
MM_OMA_SESSION_STATE_PRL_DOWNLOADED = 12,
MM_OMA_SESSION_STATE_MIP_PROFILE_DOWNLOADED = 13,
MM_OMA_SESSION_STATE_COMPLETED = 20,
} MMOmaSessionState;
/**
* MMOmaSessionStateFailedReason:
* @MM_OMA_SESSION_STATE_FAILED_REASON_UNKNOWN: No reason or unknown.
* @MM_OMA_SESSION_STATE_FAILED_REASON_NETWORK_UNAVAILABLE: Network unavailable.
* @MM_OMA_SESSION_STATE_FAILED_REASON_SERVER_UNAVAILABLE: Server unavailable.
* @MM_OMA_SESSION_STATE_FAILED_REASON_AUTHENTICATION_FAILED: Authentication failed.
* @MM_OMA_SESSION_STATE_FAILED_REASON_MAX_RETRY_EXCEEDED: Maximum retries exceeded.
* @MM_OMA_SESSION_STATE_FAILED_REASON_SESSION_CANCELLED: Session cancelled.
*
* Reason of failure in the OMA device management session.
*/
typedef enum { /*< underscore_name=mm_oma_session_state_failed_reason >*/
MM_OMA_SESSION_STATE_FAILED_REASON_UNKNOWN = 0,
MM_OMA_SESSION_STATE_FAILED_REASON_NETWORK_UNAVAILABLE = 1,
MM_OMA_SESSION_STATE_FAILED_REASON_SERVER_UNAVAILABLE = 2,
MM_OMA_SESSION_STATE_FAILED_REASON_AUTHENTICATION_FAILED = 3,
MM_OMA_SESSION_STATE_FAILED_REASON_MAX_RETRY_EXCEEDED = 4,
MM_OMA_SESSION_STATE_FAILED_REASON_SESSION_CANCELLED = 5
} MMOmaSessionStateFailedReason;
#endif /* _MODEMMANAGER_ENUMS_H_ */

1
introspection/all.xml
View File

@@ -15,6 +15,7 @@
<xi:include href="org.freedesktop.ModemManager1.Modem.Time.xml"/>
<xi:include href="org.freedesktop.ModemManager1.Modem.Firmware.xml"/>
<xi:include href="org.freedesktop.ModemManager1.Modem.Signal.xml"/>
<xi:include href="org.freedesktop.ModemManager1.Modem.Oma.xml"/>
<!--xi:include href="wip-org.freedesktop.ModemManager1.Modem.Contacts.xml"/-->

123
introspection/org.freedesktop.ModemManager1.Modem.Oma.xml Normal file
View File

@@ -0,0 +1,123 @@
<?xml version="1.0" encoding="UTF-8" ?>
<!--
ModemManager 1.0 Interface Specification
Copyright (C) 2013 Google, Inc.
-->
<node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
<!--
org.freedesktop.ModemManager1.Modem.Oma:
@short_description: The ModemManager Open Mobile Alliance interface.
This interface allows clients to handle device management operations as
specified by the Open Mobile Alliance (OMA).
Device management sessions are either on-demand (client-initiated), or
automatically initiated by either the device itself or the network.
-->
<interface name="org.freedesktop.ModemManager1.Modem.Oma">
<!--
Setup:
@features: Bitmask of <link linkend="MMModemOmaFeature">MMModemOmaFeature</link> flags, specifying which device management features should get enabled or disabled. <link linkend="MM-OMA-FEATURE-NONE:CAPS">MM_OMA_FEATURE_NONE</link> will disable all features.
Configures which OMA device management features should be enabled.
-->
<method name="Setup">
<arg name="features" type="u" direction="in" />
</method>
<!--
StartClientInitiatedSession:
@session_type: Type of client-initiated device management session,given as a <link linkend="MMModemOmaSessionType">MMModemOmaSessionType</link>
Starts a client-initiated device management session.
-->
<method name="StartClientInitiatedSession">
<arg name="session_type" type="u" direction="in" />
</method>
<!--
AcceptNetworkInitiatedSession:
@session_id: Unique ID of the network-initiated device management session.
@accept: Boolean specifying whether the session is accepted or rejected.
Accepts or rejects a network-initiated device management session.
-->
<method name="AcceptNetworkInitiatedSession">
<arg name="session_id" type="u" direction="in" />
<arg name="accept" type="b" direction="in" />
</method>
<!--
CancelSession:
Cancels the current on-going device management session.
-->
<method name="CancelSession" />
<!--
Features:
Bitmask of <link linkend="MMModemOmaFeature">MMModemOmaFeature</link>
flags, specifying which device management features are enabled or
disabled.
-->
<property name="Features" type="u" access="read" />
<!--
PendingNetworkInitiatedSessions:
List of network-initiated sessions which are waiting to be accepted or
rejected, given as an array of unsigned integer pairs, where:
<variablelist>
<varlistentry>
<listitem>
The first integer is a <link linkend="MMOmaSessionType">MMOmaSessionType</link>.
</listitem>
</varlistentry>
<varlistentry>
<listitem>
The second integer is the unique session ID.
</listitem>
</varlistentry>
</variablelist>
-->
<property name="PendingNetworkInitiatedSessions" type="a(uu)" access="read" />
<!--
SessionType:
Type of the current on-going device management session, given as a
<link linkend="MMOmaSessionType">MMOmaSessionType</link>.
-->
<property name="SessionType" type="u" access="read" />
<!--
SessionState:
State of the current on-going device management session, given as a
<link linkend="MMOmaSessionState">MMOmaSessionState</link>.
-->
<property name="SessionState" type="i" access="read" />
<!--
SessionStateChanged:
@old_session_state: Previous session state, given as a <link linkend="MMOmaSessionState">MMOmaSessionState</link>.
@new_session_state: Current session state, given as a <link linkend="MMOmaSessionState">MMOmaSessionState</link>.
@session_state_failed_reason: Reason of failure, given as a <link linkend="MMOmaSessionStateFailedReason">MMOmaSessionStateFailedReason</link>, if @session_state is <link linkend="MM-OMA-SESSION-STATE-FAILED:CAPS">MM_OMA_SESSION_STATE_FAILED</link>.
The session state changed.
-->
<signal name="SessionStateChanged">
<arg name="old_session_state" type="i" />
<arg name="new_session_state" type="i" />
<arg name="session_state_failed_reason" type="u" />
</signal>
</interface>
</node>

3
libmm-glib/generated/Makefile.am
View File

@@ -30,6 +30,7 @@ GENERATED_DOC = \
mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.Location.xml \
mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.Time.xml \
mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.Firmware.xml \
mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.Oma.xml \
mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.ModemCdma.xml \
mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.Modem3gpp.xml \
mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.Modem3gpp.Ussd.xml \
@@ -95,6 +96,7 @@ mm_gdbus_modem_generated = \
mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.Location.xml \
mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.Time.xml \
mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.Firmware.xml \
mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.Oma.xml \
mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.ModemCdma.xml \
mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.Modem3gpp.xml \
mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.Modem3gpp.Ussd.xml \
@@ -106,6 +108,7 @@ mm_gdbus_modem_deps = \
$(top_srcdir)/introspection/org.freedesktop.ModemManager1.Modem.Location.xml \
$(top_srcdir)/introspection/org.freedesktop.ModemManager1.Modem.Time.xml \
$(top_srcdir)/introspection/org.freedesktop.ModemManager1.Modem.Firmware.xml \
$(top_srcdir)/introspection/org.freedesktop.ModemManager1.Modem.Oma.xml \
$(top_srcdir)/introspection/org.freedesktop.ModemManager1.Modem.ModemCdma.xml \
$(top_srcdir)/introspection/org.freedesktop.ModemManager1.Modem.Modem3gpp.xml \
$(top_srcdir)/introspection/org.freedesktop.ModemManager1.Modem.Modem3gpp.Ussd.xml \