docs,libmm-glib: add missing voice/call documentation

2015-08-02 11:28:39 +02:00
parent d0b0c3c3e5
commit 6fbed014db
2 changed files with 294 additions and 0 deletions
--- a/docs/reference/libmm-glib/libmm-glib-docs.xml
+++ b/docs/reference/libmm-glib/libmm-glib-docs.xml
@@ -119,6 +119,10 @@
        <title>OMA support</title>
        <xi:include href="xml/mm-modem-oma.xml"/>
      </section>
+      <section>
+        <title>Voice support</title>
+        <xi:include href="xml/mm-modem-voice.xml"/>
+      </section>
    </chapter>

    <chapter>
@@ -139,6 +143,12 @@
      <xi:include href="xml/mm-sms-properties.xml"/>
    </chapter>

+    <chapter>
+      <title>The Call object</title>
+      <xi:include href="xml/mm-call.xml"/>
+      <xi:include href="xml/mm-call-properties.xml"/>
+    </chapter>
+
  </part>

  <part>
@@ -192,6 +202,10 @@
    <xi:include href="xml/MmGdbusModemOmaProxy.xml"/>
    <xi:include href="xml/MmGdbusModemOmaSkeleton.xml"/>

+    <xi:include href="xml/MmGdbusModemVoice.xml"/>
+    <xi:include href="xml/MmGdbusModemVoiceProxy.xml"/>
+    <xi:include href="xml/MmGdbusModemVoiceSkeleton.xml"/>
+
    <!--xi:include href="xml/MmGdbusModemContacts.xml"/>
    <xi:include href="xml/MmGdbusModemContactsProxy.xml"/>
    <xi:include href="xml/MmGdbusModemContactsSkeleton.xml"/-->
@@ -212,6 +226,9 @@
    <xi:include href="xml/MmGdbusSmsProxy.xml"/>
    <xi:include href="xml/MmGdbusSmsSkeleton.xml"/>

+    <xi:include href="xml/MmGdbusCall.xml"/>
+    <xi:include href="xml/MmGdbusCallProxy.xml"/>
+    <xi:include href="xml/MmGdbusCallSkeleton.xml"/>
  </part>

  <chapter id="object-tree">
--- a/docs/reference/libmm-glib/libmm-glib-sections.txt
+++ b/docs/reference/libmm-glib/libmm-glib-sections.txt
@@ -62,6 +62,8 @@ mm_object_peek_modem_simple
 mm_object_get_modem_simple
 mm_object_peek_modem_signal
 mm_object_get_modem_signal
+mm_object_peek_modem_voice
+mm_object_get_modem_voice
 <SUBSECTION Standard>
 MMObjectClass
 MM_IS_OBJECT
@@ -883,6 +885,36 @@ MM_TYPE_SIGNAL
 mm_signal_get_type
 </SECTION>

+<SECTION>
+<FILE>mm-modem-voice</FILE>
+<TITLE>MMModemVoice</TITLE>
+MMModemVoice
+<SUBSECTION Getters>
+mm_modem_voice_get_path
+mm_modem_voice_dup_path
+
+<SUBSECTION Methods>
+mm_modem_voice_create_call
+mm_modem_voice_create_call_finish
+mm_modem_voice_create_call_sync
+mm_modem_voice_delete_call
+mm_modem_voice_delete_call_finish
+mm_modem_voice_delete_call_sync
+mm_modem_voice_list_calls
+mm_modem_voice_list_calls_finish
+mm_modem_voice_list_calls_sync
+<SUBSECTION Standard>
+MMModemVoiceClass
+MMModemVoicePrivate
+MM_IS_MODEM_VOICE
+MM_IS_MODEM_VOICE_CLASS
+MM_MODEM_VOICE
+MM_MODEM_VOICE_CLASS
+MM_MODEM_VOICE_GET_CLASS
+MM_TYPE_MODEM_VOICE
+mm_modem_voice_get_type
+</SECTION>
+
 <SECTION>
 <FILE>mm-bearer</FILE>
 <TITLE>MMBearer</TITLE>
@@ -1133,6 +1165,74 @@ MM_TYPE_SMS_PROPERTIES
 mm_sms_properties_get_type
 </SECTION>

+<SECTION>
+<FILE>mm-call</FILE>
+<TITLE>MMCall</TITLE>
+MMCall
+<SUBSECTION Getters>
+mm_call_get_path
+mm_call_dup_path
+mm_call_get_number
+mm_call_dup_number
+mm_call_get_direction
+mm_call_get_state
+mm_call_get_state_reason
+<SUBSECTION Methods>
+mm_call_start
+mm_call_start_finish
+mm_call_start_sync
+mm_call_accept
+mm_call_accept_finish
+mm_call_accept_sync
+mm_call_hangup
+mm_call_hangup_finish
+mm_call_hangup_sync
+mm_call_send_dtmf
+mm_call_send_dtmf_finish
+mm_call_send_dtmf_sync
+<SUBSECTION Standard>
+MMCallClass
+MM_IS_CALL
+MM_IS_CALL_CLASS
+MM_CALL
+MM_CALL_CLASS
+MM_CALL_GET_CLASS
+MM_TYPE_CALL
+mm_call_get_type
+</SECTION>
+
+<SECTION>
+<FILE>mm-call-properties</FILE>
+<TITLE>MMCallProperties</TITLE>
+MMCallProperties
+<SUBSECTION New>
+mm_call_properties_new
+<SUBSECTION GettersSetters>
+mm_call_properties_get_number
+mm_call_properties_set_number
+mm_call_properties_get_direction
+mm_call_properties_set_direction
+mm_call_properties_get_state
+mm_call_properties_set_state
+mm_call_properties_get_state_reason
+mm_call_properties_set_state_reason
+<SUBSECTION Private>
+mm_call_properties_get_dictionary
+mm_call_properties_dup
+mm_call_properties_new_from_dictionary
+mm_call_properties_new_from_string
+<SUBSECTION Standard>
+MMCallPropertiesClass
+MMCallPropertiesPrivate
+MM_IS_CALL_PROPERTIES
+MM_IS_CALL_PROPERTIES_CLASS
+MM_CALL_PROPERTIES
+MM_CALL_PROPERTIES_CLASS
+MM_CALL_PROPERTIES_GET_CLASS
+MM_TYPE_CALL_PROPERTIES
+mm_call_properties_get_type
+</SECTION>
+
 <SECTION>
 <FILE>mm-enums-types</FILE>
 <TITLE>Flags and Enumerations</TITLE>
@@ -1171,6 +1271,9 @@ mm_oma_feature_build_string_from_mask
 mm_oma_session_type_get_string
 mm_oma_session_state_get_string
 mm_oma_session_state_failed_reason_get_string
+mm_call_direction_get_string
+mm_call_state_get_string
+mm_call_state_reason_get_string
 <SUBSECTION Private>
 mm_modem_capability_get_string
 mm_modem_lock_build_string_from_mask
@@ -1207,6 +1310,9 @@ mm_oma_feature_get_string
 mm_oma_session_type_build_string_from_mask
 mm_oma_session_state_build_string_from_mask
 mm_oma_session_state_failed_reason_build_string_from_mask
+mm_call_direction_build_string_from_mask
+mm_call_state_build_string_from_mask
+mm_call_state_reason_build_string_from_mask
 <SUBSECTION Standard>
 MM_TYPE_BEARER_IP_FAMILY
 MM_TYPE_BEARER_IP_METHOD
@@ -1243,6 +1349,9 @@ MM_TYPE_OMA_FEATURE
 MM_TYPE_OMA_SESSION_STATE
 MM_TYPE_OMA_SESSION_STATE_FAILED_REASON
 MM_TYPE_OMA_SESSION_TYPE
+MM_TYPE_CALL_DIRECTION
+MM_TYPE_CALL_STATE
+MM_TYPE_CALL_STATE_REASON
 mm_bearer_ip_family_get_type
 mm_bearer_ip_method_get_type
 mm_bearer_allowed_auth_get_type
@@ -1278,6 +1387,9 @@ mm_oma_feature_get_type
 mm_oma_session_state_failed_reason_get_type
 mm_oma_session_state_get_type
 mm_oma_session_type_get_type
+mm_call_direction_get_type
+mm_call_state_get_type
+mm_call_state_reason_get_type
 </SECTION>

 <SECTION>
@@ -2425,6 +2537,82 @@ MmGdbusModemSignalSkeletonPrivate
 mm_gdbus_modem_signal_skeleton_get_type
 </SECTION>

+<SECTION>
+<FILE>MmGdbusModemVoice</FILE>
+<TITLE>MmGdbusModemVoice</TITLE>
+MmGdbusModemVoice
+MmGdbusModemVoiceIface
+<SUBSECTION Getters>
+mm_gdbus_modem_voice_get_calls
+mm_gdbus_modem_voice_dup_calls
+<SUBSECTION Methods>
+mm_gdbus_modem_voice_call_create_call
+mm_gdbus_modem_voice_call_create_call_finish
+mm_gdbus_modem_voice_call_create_call_sync
+mm_gdbus_modem_voice_call_delete_call
+mm_gdbus_modem_voice_call_delete_call_finish
+mm_gdbus_modem_voice_call_delete_call_sync
+mm_gdbus_modem_voice_call_list_calls
+mm_gdbus_modem_voice_call_list_calls_finish
+mm_gdbus_modem_voice_call_list_calls_sync
+<SUBSECTION Private>
+mm_gdbus_modem_voice_set_calls
+mm_gdbus_modem_voice_emit_call_added
+mm_gdbus_modem_voice_emit_call_deleted
+mm_gdbus_modem_voice_complete_create_call
+mm_gdbus_modem_voice_complete_delete_call
+mm_gdbus_modem_voice_complete_list_calls
+mm_gdbus_modem_voice_interface_info
+mm_gdbus_modem_voice_override_properties
+<SUBSECTION Standard>
+MM_GDBUS_IS_MODEM_VOICE
+MM_GDBUS_MODEM_VOICE
+MM_GDBUS_MODEM_VOICE_GET_IFACE
+MM_GDBUS_TYPE_MODEM_VOICE
+mm_gdbus_modem_voice_get_type
+</SECTION>
+
+<SECTION>
+<FILE>MmGdbusModemVoiceProxy</FILE>
+<TITLE>MmGdbusModemVoiceProxy</TITLE>
+MmGdbusModemVoiceProxy
+<SUBSECTION New>
+mm_gdbus_modem_voice_proxy_new
+mm_gdbus_modem_voice_proxy_new_finish
+mm_gdbus_modem_voice_proxy_new_for_bus
+mm_gdbus_modem_voice_proxy_new_for_bus_finish
+mm_gdbus_modem_voice_proxy_new_for_bus_sync
+mm_gdbus_modem_voice_proxy_new_sync
+<SUBSECTION Standard>
+MmGdbusModemVoiceProxyClass
+MM_GDBUS_IS_MODEM_VOICE_PROXY
+MM_GDBUS_IS_MODEM_VOICE_PROXY_CLASS
+MM_GDBUS_MODEM_VOICE_PROXY
+MM_GDBUS_MODEM_VOICE_PROXY_CLASS
+MM_GDBUS_MODEM_VOICE_PROXY_GET_CLASS
+MM_GDBUS_TYPE_MODEM_VOICE_PROXY
+MmGdbusModemVoiceProxyPrivate
+mm_gdbus_modem_voice_proxy_get_type
+</SECTION>
+
+<SECTION>
+<FILE>MmGdbusModemVoiceSkeleton</FILE>
+<TITLE>MmGdbusModemVoiceSkeleton</TITLE>
+MmGdbusModemVoiceSkeleton
+<SUBSECTION New>
+mm_gdbus_modem_voice_skeleton_new
+<SUBSECTION Standard>
+MmGdbusModemVoiceSkeletonClass
+MM_GDBUS_IS_MODEM_VOICE_SKELETON
+MM_GDBUS_IS_MODEM_VOICE_SKELETON_CLASS
+MM_GDBUS_MODEM_VOICE_SKELETON
+MM_GDBUS_MODEM_VOICE_SKELETON_CLASS
+MM_GDBUS_MODEM_VOICE_SKELETON_GET_CLASS
+MM_GDBUS_TYPE_MODEM_VOICE_SKELETON
+MmGdbusModemVoiceSkeletonPrivate
+mm_gdbus_modem_voice_skeleton_get_type
+</SECTION>
+
 <SECTION>
 <FILE>MmGdbusObject</FILE>
 <TITLE>MmGdbusObject</TITLE>
@@ -2453,6 +2641,8 @@ mm_gdbus_object_peek_modem_simple
 mm_gdbus_object_get_modem_simple
 mm_gdbus_object_peek_modem_signal
 mm_gdbus_object_get_modem_signal
+mm_gdbus_object_peek_modem_voice
+mm_gdbus_object_get_modem_voice
 <SUBSECTION Methods>
 <SUBSECTION Private>
 <SUBSECTION Standard>
@@ -2499,6 +2689,7 @@ mm_gdbus_object_skeleton_set_modem_messaging
 mm_gdbus_object_skeleton_set_modem_simple
 mm_gdbus_object_skeleton_set_modem_time
 mm_gdbus_object_skeleton_set_modem_signal
+mm_gdbus_object_skeleton_set_modem_voice
 <SUBSECTION Standard>
 MmGdbusObjectSkeletonClass
 MM_GDBUS_IS_OBJECT_SKELETON
@@ -2728,3 +2919,89 @@ MM_GDBUS_TYPE_SMS_SKELETON
 MmGdbusSmsSkeletonPrivate
 mm_gdbus_sms_skeleton_get_type
 </SECTION>
+
+<SECTION>
+<FILE>MmGdbusCall</FILE>
+<TITLE>MmGdbusCall</TITLE>
+MmGdbusCall
+MmGdbusCallIface
+<SUBSECTION Getters>
+mm_gdbus_call_get_direction
+mm_gdbus_call_get_number
+mm_gdbus_call_dup_number
+mm_gdbus_call_get_state
+mm_gdbus_call_get_state_reason
+mm_gdbus_call_emit_dtmf_received
+mm_gdbus_call_emit_state_changed
+<SUBSECTION Methods>
+mm_gdbus_call_call_accept
+mm_gdbus_call_call_accept_finish
+mm_gdbus_call_call_accept_sync
+mm_gdbus_call_call_start
+mm_gdbus_call_call_start_finish
+mm_gdbus_call_call_start_sync
+mm_gdbus_call_call_hangup
+mm_gdbus_call_call_hangup_finish
+mm_gdbus_call_call_hangup_sync
+mm_gdbus_call_call_send_dtmf
+mm_gdbus_call_call_send_dtmf_finish
+mm_gdbus_call_call_send_dtmf_sync
+<SUBSECTION Private>
+mm_gdbus_call_set_direction
+mm_gdbus_call_set_number
+mm_gdbus_call_set_state
+mm_gdbus_call_set_state_reason
+mm_gdbus_call_complete_accept
+mm_gdbus_call_complete_hangup
+mm_gdbus_call_complete_send_dtmf
+mm_gdbus_call_complete_start
+mm_gdbus_call_interface_info
+mm_gdbus_call_override_properties
+<SUBSECTION Standard>
+MM_GDBUS_IS_CALL
+MM_GDBUS_CALL
+MM_GDBUS_CALL_GET_IFACE
+MM_GDBUS_TYPE_CALL
+mm_gdbus_call_get_type
+</SECTION>
+
+<SECTION>
+<FILE>MmGdbusCallProxy</FILE>
+<TITLE>MmGdbusCallProxy</TITLE>
+MmGdbusCallProxy
+<SUBSECTION New>
+mm_gdbus_call_proxy_new
+mm_gdbus_call_proxy_new_finish
+mm_gdbus_call_proxy_new_for_bus
+mm_gdbus_call_proxy_new_for_bus_finish
+mm_gdbus_call_proxy_new_for_bus_sync
+mm_gdbus_call_proxy_new_sync
+<SUBSECTION Standard>
+MmGdbusCallProxyClass
+MM_GDBUS_IS_CALL_PROXY
+MM_GDBUS_IS_CALL_PROXY_CLASS
+MM_GDBUS_CALL_PROXY
+MM_GDBUS_CALL_PROXY_CLASS
+MM_GDBUS_CALL_PROXY_GET_CLASS
+MM_GDBUS_TYPE_CALL_PROXY
+MmGdbusCallProxyPrivate
+mm_gdbus_call_proxy_get_type
+</SECTION>
+
+<SECTION>
+<FILE>MmGdbusCallSkeleton</FILE>
+<TITLE>MmGdbusCallSkeleton</TITLE>
+MmGdbusCallSkeleton
+<SUBSECTION New>
+mm_gdbus_call_skeleton_new
+<SUBSECTION Standard>
+MmGdbusCallSkeletonClass
+MM_GDBUS_IS_CALL_SKELETON
+MM_GDBUS_IS_CALL_SKELETON_CLASS
+MM_GDBUS_CALL_SKELETON
+MM_GDBUS_CALL_SKELETON_CLASS
+MM_GDBUS_CALL_SKELETON_GET_CLASS
+MM_GDBUS_TYPE_CALL_SKELETON
+MmGdbusCallSkeletonPrivate
+mm_gdbus_call_skeleton_get_type
+</SECTION>