docs: Add Cbm And CellBroadcast

4 files changed, 232 insertions, 0 deletions

diff --git a/docs/man/mmcli.1 b/docs/man/mmcli.1
index 1d4df0f7..adb0f1b5 100644
--- a/docs/man/mmcli.1
+++ b/docs/man/mmcli.1
@@ -59,6 +59,10 @@ Show location or positioning specific options.
 Show messaging specific options. See also \fB\-\-help\-sms\fR which
 is related.
 .TP
+.B \-\-help\-cell-broadcast
+Show cell broadcast specific options.
+is related.
+.TP
 .B \-\-help\-time
 Show time specific options.
 .TP
diff --git a/docs/reference/api/ModemManager-dbus-reference.xml b/docs/reference/api/ModemManager-dbus-reference.xml
index 6d9ef43f..d6237242 100644
--- a/docs/reference/api/ModemManager-dbus-reference.xml
+++ b/docs/reference/api/ModemManager-dbus-reference.xml
@@ -31,6 +31,7 @@
         All objects (<link linkend="ref-dbus-object-manager">Manager</link>,
         <link linkend="ref-dbus-object-modem">Modems</link>,
         <link linkend="ref-dbus-object-bearer">Bearers</link>,
+        <link linkend="ref-dbus-object-cbm">CBMs</link>,
         <link linkend="ref-dbus-object-sim">SIMs</link>,
         <link linkend="ref-dbus-object-sms">SMSs</link>) exported at the
         <link linkend="ref-dbus-bus-name"><literal>org.freedesktop.ModemManager1</literal></link>
@@ -48,6 +49,7 @@
         All objects (<link linkend="ref-dbus-object-manager">Manager</link>,
         <link linkend="ref-dbus-object-modem">Modems</link>,
         <link linkend="ref-dbus-object-bearer">Bearers</link>,
+        <link linkend="ref-dbus-object-cbm">CBMs</link>,
         <link linkend="ref-dbus-object-sim">SIMs</link>,
         <link linkend="ref-dbus-object-sms">SMSs</link>) exported at the
         <link linkend="ref-dbus-bus-name"><literal>org.freedesktop.ModemManager1</literal></link>
@@ -137,6 +139,7 @@
     <xi:include href="../../../../libmm-glib/generated/mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.Location.xml"/>
     <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.Voice.xml"/>
+    <xi:include href="../../../../libmm-glib/generated/mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.CellBroadcast.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.Sar.xml"/>
     <xi:include href="../../../../libmm-glib/generated/mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.Signal.xml"/>
@@ -186,4 +189,14 @@
     <xi:include href="../../../../libmm-glib/generated/mm-gdbus-doc-org.freedesktop.ModemManager1.Call.xml"/>
   </chapter>
 
+  <chapter id="ref-dbus-object-call">
+    <title>The <literal>/org/freedesktop/ModemManager/CBM</literal> objects</title>
+    <para>
+      Modems implementing the
+      <link linkend="gdbus-org.freedesktop.ModemManager1.Modem.CellBroadcast">Cell Broadcast interface</link>
+      will export one CBM object for each Cell Broadcast message received by the device.
+    </para>
+    <xi:include href="../../../../libmm-glib/generated/mm-gdbus-doc-org.freedesktop.ModemManager1.Call.xml"/>
+  </chapter>
+
 </part>
diff --git a/docs/reference/libmm-glib/libmm-glib-docs.xml b/docs/reference/libmm-glib/libmm-glib-docs.xml
index 03ad162c..36f6727d 100644
--- a/docs/reference/libmm-glib/libmm-glib-docs.xml
+++ b/docs/reference/libmm-glib/libmm-glib-docs.xml
@@ -161,6 +161,10 @@
         <title>SAR support</title>
         <xi:include href="xml/mm-modem-sar.xml"/>
       </section>
+      <section>
+        <title>Cell Broadcast support</title>
+        <xi:include href="xml/mm-modem-cell-broadcast.xml"/>
+      </section>
     </chapter>
 
     <chapter>
@@ -190,6 +194,11 @@
       <xi:include href="xml/mm-call-audio-format.xml"/>
     </chapter>
 
+    <chapter>
+      <title>The CBM object</title>
+      <xi:include href="xml/mm-cbm.xml"/>
+    </chapter>
+
   </part>
 
   <part>
@@ -223,6 +232,10 @@
     <xi:include href="xml/MmGdbusModemCdmaProxy.xml"/>
     <xi:include href="xml/MmGdbusModemCdmaSkeleton.xml"/>
 
+    <xi:include href="xml/MmGdbusModemCellBroadcast.xml"/>
+    <xi:include href="xml/MmGdbusModemCellBroadcastProxy.xml"/>
+    <xi:include href="xml/MmGdbusModemCellBroadcastSkeleton.xml"/>
+
     <xi:include href="xml/MmGdbusModemLocation.xml"/>
     <xi:include href="xml/MmGdbusModemLocationProxy.xml"/>
     <xi:include href="xml/MmGdbusModemLocationSkeleton.xml"/>
@@ -278,6 +291,10 @@
     <xi:include href="xml/MmGdbusCall.xml"/>
     <xi:include href="xml/MmGdbusCallProxy.xml"/>
     <xi:include href="xml/MmGdbusCallSkeleton.xml"/>
+
+    <xi:include href="xml/MmGdbusCbm.xml"/>
+    <xi:include href="xml/MmGdbusCbmProxy.xml"/>
+    <xi:include href="xml/MmGdbusCbmSkeleton.xml"/>
   </part>
 
   <chapter>
diff --git a/docs/reference/libmm-glib/libmm-glib-sections.txt b/docs/reference/libmm-glib/libmm-glib-sections.txt
index 6378645a..877b3ef6 100644
--- a/docs/reference/libmm-glib/libmm-glib-sections.txt
+++ b/docs/reference/libmm-glib/libmm-glib-sections.txt
@@ -91,6 +91,8 @@ mm_object_peek_modem_3gpp_ussd
 mm_object_get_modem_3gpp_ussd
 mm_object_peek_modem_cdma
 mm_object_get_modem_cdma
+mm_object_peek_modem_cell_broadcast
+mm_object_get_modem_cell_broadcast
 mm_object_peek_modem_location
 mm_object_get_modem_location
 mm_object_peek_modem_messaging
@@ -923,6 +925,32 @@ mm_modem_messaging_get_type
 </SECTION>
 
 <SECTION>
+<FILE>mm-modem-cell-broadcast</FILE>
+<TITLE>MMModemCellBroadcast</TITLE>
+MMModemCellBroadcast
+<SUBSECTION Getters>
+mm_modem_cell_broadcast_get_path
+mm_modem_cell_broadcast_dup_path
+<SUBSECTION Methods>
+mm_modem_cell_broadcast_delete
+mm_modem_cell_broadcast_delete_finish
+mm_modem_cell_broadcast_delete_sync
+mm_modem_cell_broadcast_list
+mm_modem_cell_broadcast_list_finish
+mm_modem_cell_broadcast_list_sync
+<SUBSECTION Standard>
+MMModemCellBroadcastClass
+MMModemCellBroadcastPrivate
+MM_GDBUS_IS_MODEM_CELL_BROADCAST
+MM_IS_MODEM_CELL_BROADCAST_CLASS
+MM_MODEM_CELL_BROADCAST
+MM_MODEM_CELL_BROADCAST_CLASS
+MM_MODEM_CELL_BROADCAST_GET_CLASS
+MM_TYPE_MODEM_CELL_BROADCAST
+mm_modem_cell_broadcast_get_type
+</SECTION>
+
+<SECTION>
 <FILE>mm-modem-time</FILE>
 <TITLE>MMModemTime</TITLE>
 MMModemTime
@@ -1843,6 +1871,30 @@ mm_call_properties_get_type
 </SECTION>
 
 <SECTION>
+<FILE>mm-cbm</FILE>
+<TITLE>MMCbm</TITLE>
+MMCbm
+<SUBSECTION Getters>
+mm_cbm_get_channel
+mm_cbm_get_path
+mm_cbm_dup_path
+mm_cbm_get_state
+mm_cbm_get_text
+mm_cbm_dup_text
+mm_cbm_get_message_code
+mm_cbm_get_update
+<SUBSECTION Standard>
+MMCbmClass
+MM_IS_CBM
+MM_IS_CBM_CLASS
+MM_CBM
+MM_CBM_CLASS
+MM_CBM_GET_CLASS
+MM_TYPE_CBM
+mm_cbm_get_type
+</SECTION>
+
+<SECTION>
 <FILE>mm-pco</FILE>
 <TITLE>MMPco</TITLE>
 MMPco
@@ -2094,6 +2146,7 @@ mm_call_state_reason_get_string
 mm_cell_type_get_string
 mm_serving_cell_type_get_string
 mm_network_error_get_string
+mm_cbm_state_get_string
 <SUBSECTION Standard>
 MM_TYPE_BEARER_TYPE
 MM_TYPE_BEARER_IP_FAMILY
@@ -2147,6 +2200,7 @@ MM_TYPE_OMA_SESSION_TYPE
 MM_TYPE_CALL_DIRECTION
 MM_TYPE_CALL_STATE
 MM_TYPE_CALL_STATE_REASON
+MM_TYPE_CBM_STATE
 MM_TYPE_MODEM_FIRMWARE_UPDATE_METHOD
 MM_TYPE_CELL_TYPE
 MM_TYPE_SERVING_CELL_TYPE
@@ -2207,6 +2261,7 @@ mm_modem_firmware_update_method_get_type
 mm_cell_type_get_type
 mm_serving_cell_type_get_type
 mm_network_error_get_type
+mm_cbm_state_get_type
 </SECTION>
 
 <SECTION>
@@ -3205,6 +3260,77 @@ MmGdbusModemMessagingSkeletonPrivate
 mm_gdbus_modem_messaging_skeleton_get_type
 </SECTION>
 
+<SECTION>
+<FILE>MmGdbusModemCellBroadcast</FILE>
+<TITLE>MmGdbusModemCellBroadcast</TITLE>
+MmGdbusModemCellBroadcast
+MmGdbusModemCellBroadcastIface
+<SUBSECTION Getters>
+mm_gdbus_modem_cell_broadcast_get_cell_broadcasts
+mm_gdbus_modem_cell_broadcast_dup_cell_broadcasts
+<SUBSECTION Methods>
+mm_gdbus_modem_cell_broadcast_call_delete
+mm_gdbus_modem_cell_broadcast_call_delete_finish
+mm_gdbus_modem_cell_broadcast_call_delete_sync
+mm_gdbus_modem_cell_broadcast_call_list
+mm_gdbus_modem_cell_broadcast_call_list_finish
+mm_gdbus_modem_cell_broadcast_call_list_sync
+<SUBSECTION Private>
+mm_gdbus_modem_cell_broadcast_set_cell_broadcasts
+mm_gdbus_modem_cell_broadcast_complete_delete
+mm_gdbus_modem_cell_broadcast_complete_list
+mm_gdbus_modem_cell_broadcast_override_properties
+mm_gdbus_modem_cell_broadcast_interface_info
+mm_gdbus_modem_cell_broadcast_emit_added
+mm_gdbus_modem_cell_broadcast_emit_deleted
+<SUBSECTION Standard>
+MM_IS_MODEM_CELL_BROADCAST
+MM_GDBUS_MODEM_CELL_BROADCAST
+MM_GDBUS_MODEM_CELL_BROADCAST_GET_IFACE
+MM_GDBUS_TYPE_MODEM_CELL_BROADCAST
+mm_gdbus_modem_cell_broadcast_get_type
+</SECTION>
+
+<SECTION>
+<FILE>MmGdbusModemCellBroadcastProxy</FILE>
+<TITLE>MmGdbusModemCellBroadcastProxy</TITLE>
+MmGdbusModemCellBroadcastProxy
+<SUBSECTION New>
+mm_gdbus_modem_cell_broadcast_proxy_new
+mm_gdbus_modem_cell_broadcast_proxy_new_finish
+mm_gdbus_modem_cell_broadcast_proxy_new_for_bus
+mm_gdbus_modem_cell_broadcast_proxy_new_for_bus_finish
+mm_gdbus_modem_cell_broadcast_proxy_new_for_bus_sync
+mm_gdbus_modem_cell_broadcast_proxy_new_sync
+<SUBSECTION Standard>
+MmGdbusModemCellBroadcastProxyClass
+MM_GDBUS_IS_MODEM_CELL_BROADCAST_PROXY
+MM_GDBUS_IS_MODEM_CELL_BROADCAST_PROXY_CLASS
+MM_GDBUS_MODEM_CELL_BROADCAST_PROXY
+MM_GDBUS_MODEM_CELL_BROADCAST_PROXY_CLASS
+MM_GDBUS_MODEM_CELL_BROADCAST_PROXY_GET_CLASS
+MM_GDBUS_TYPE_MODEM_CELL_BROADCAST_PROXY
+MmGdbusModemCellBroadcastProxyPrivate
+mm_gdbus_modem_cell_broadcast_proxy_get_type
+</SECTION>
+
+<SECTION>
+<FILE>MmGdbusModemCellBroadcastSkeleton</FILE>
+<TITLE>MmGdbusModemCellBroadcastSkeleton</TITLE>
+MmGdbusModemCellBroadcastSkeleton
+<SUBSECTION New>
+mm_gdbus_modem_cell_broadcast_skeleton_new
+<SUBSECTION Standard>
+MmGdbusModemCellBroadcastSkeletonClass
+MM_GDBUS_IS_MODEM_CELL_BROADCAST_SKELETON
+MM_GDBUS_IS_MODEM_CELL_BROADCAST_SKELETON_CLASS
+MM_GDBUS_MODEM_CELL_BROADCAST_SKELETON
+MM_GDBUS_MODEM_CELL_BROADCAST_SKELETON_CLASS
+MM_GDBUS_MODEM_CELL_BROADCAST_SKELETON_GET_CLASS
+MM_GDBUS_TYPE_MODEM_CELL_BROADCAST_SKELETON
+MmGdbusModemCellBroadcastSkeletonPrivate
+mm_gdbus_modem_cell_broadcast_skeleton_get_type
+</SECTION>
 
 <SECTION>
 <FILE>MmGdbusModemTime</FILE>
@@ -3779,6 +3905,8 @@ mm_gdbus_object_peek_modem3gpp_profile_manager
 mm_gdbus_object_get_modem3gpp_profile_manager
 mm_gdbus_object_peek_modem_cdma
 mm_gdbus_object_get_modem_cdma
+mm_gdbus_object_get_modem_cell_broadcast
+mm_gdbus_object_peek_modem_cell_broadcast
 mm_gdbus_object_peek_modem_location
 mm_gdbus_object_get_modem_location
 mm_gdbus_object_peek_modem_messaging
@@ -3837,6 +3965,7 @@ mm_gdbus_object_skeleton_set_modem3gpp
 mm_gdbus_object_skeleton_set_modem3gpp_ussd
 mm_gdbus_object_skeleton_set_modem3gpp_profile_manager
 mm_gdbus_object_skeleton_set_modem_cdma
+mm_gdbus_object_skeleton_set_modem_cell_broadcast
 mm_gdbus_object_skeleton_set_modem_firmware
 mm_gdbus_object_skeleton_set_modem_oma
 mm_gdbus_object_skeleton_set_modem_location
@@ -4208,3 +4337,72 @@ MM_GDBUS_TYPE_CALL_SKELETON
 MmGdbusCallSkeletonPrivate
 mm_gdbus_call_skeleton_get_type
 </SECTION>
+
+<SECTION>
+<FILE>MmGdbusCbm</FILE>
+<TITLE>MmGdbusCbm</TITLE>
+MmGdbusCbm
+MmGdbusCbmIface
+<SUBSECTION Getters>
+mm_gdbus_cbm_dup_text
+mm_gdbus_cbm_get_channel
+mm_gdbus_cbm_get_message_code
+mm_gdbus_cbm_get_state
+mm_gdbus_cbm_get_text
+mm_gdbus_cbm_get_update
+<SUBSECTION Private>
+mm_gdbus_cbm_set_channel
+mm_gdbus_cbm_set_message_code
+mm_gdbus_cbm_set_state
+mm_gdbus_cbm_set_text
+mm_gdbus_cbm_set_update
+mm_gdbus_cbm_interface_info
+mm_gdbus_cbm_override_properties
+p<SUBSECTION Standard>
+MM_GDBUS_IS_CBM
+MM_GDBUS_CBM
+MM_GDBUS_CBM_GET_IFACE
+MM_GDBUS_TYPE_CBM
+mm_gdbus_cbm_get_type
+</SECTION>
+
+<SECTION>
+<FILE>MmGdbusCbmProxy</FILE>
+<TITLE>MmGdbusCbmProxy</TITLE>
+MmGdbusCallProxy
+<SUBSECTION New>
+mm_gdbus_cbm_proxy_new
+mm_gdbus_cbm_proxy_new_finish
+mm_gdbus_cbm_proxy_new_for_bus
+mm_gdbus_cbm_proxy_new_for_bus_finish
+mm_gdbus_cbm_proxy_new_for_bus_sync
+mm_gdbus_cbm_proxy_new_sync
+<SUBSECTION Standard>
+MmGdbusCbmProxyClass
+MM_GDBUS_IS_CBM_PROXY
+MM_GDBUS_IS_CBM_PROXY_CLASS
+MM_GDBUS_CBM_PROXY
+MM_GDBUS_CBM_PROXY_CLASS
+MM_GDBUS_CBM_PROXY_GET_CLASS
+MM_GDBUS_TYPE_CBM_PROXY
+MmGdbusCbmProxyPrivate
+mm_gdbus_cbm_proxy_get_type
+</SECTION>
+
+<SECTION>
+<FILE>MmGdbusCbmSkeleton</FILE>
+<TITLE>MmGdbusCbmSkeleton</TITLE>
+MmGdbusCallSkeleton
+<SUBSECTION New>
+mm_gdbus_cbm_skeleton_new
+<SUBSECTION Standard>
+MmGdbusCbmSkeletonClass
+MM_GDBUS_IS_CBM_SKELETON
+MM_GDBUS_IS_CBM_SKELETON_CLASS
+MM_GDBUS_CBM_SKELETON
+MM_GDBUS_CBM_SKELETON_CLASS
+MM_GDBUS_CBM_SKELETON_GET_CLASS
+MM_GDBUS_TYPE_CBM_SKELETON
+MmGdbusCbmSkeletonPrivate
+mm_gdbus_cbm_skeleton_get_type
+</SECTION>