File: mm-gdbus-doc-org.freedesktop.ModemManager1.Modem.Time.xml

package info (click to toggle)
modemmanager 1.6.4-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 18,892 kB
  • ctags: 21,240
  • sloc: ansic: 145,068; xml: 5,204; sh: 4,833; makefile: 1,894; python: 90
file content (107 lines) | stat: -rw-r--r-- 5,679 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
]>
<refentry id="gdbus-org.freedesktop.ModemManager1.Modem.Time">
  <refmeta>    <refentrytitle role="top_of_page" id="gdbus-interface-org-freedesktop-ModemManager1-Modem-Time.top_of_page">org.freedesktop.ModemManager1.Modem.Time</refentrytitle>
  <indexterm zone="gdbus-interface-org-freedesktop-ModemManager1-Modem-Time.top_of_page"><primary sortas="Modem.Time">org.freedesktop.ModemManager1.Modem.Time</primary></indexterm>
  </refmeta>  <refnamediv>    <refname>org.freedesktop.ModemManager1.Modem.Time</refname>    <refpurpose>The ModemManager Time interface.</refpurpose>  </refnamediv>  <refsynopsisdiv role="synopsis">
    <title role="synopsis.title">Methods</title>
    <synopsis>
<link linkend="gdbus-method-org-freedesktop-ModemManager1-Modem-Time.GetNetworkTime">GetNetworkTime</link> (OUT s time);
</synopsis>
  </refsynopsisdiv>
  <refsect1 role="signal_proto">
    <title role="signal_proto.title">Signals</title>
    <synopsis>
<link linkend="gdbus-signal-org-freedesktop-ModemManager1-Modem-Time.NetworkTimeChanged">NetworkTimeChanged</link> (s time);
</synopsis>
  </refsect1>
  <refsect1 role="properties">
    <title role="properties.title">Properties</title>
    <synopsis>
<link linkend="gdbus-property-org-freedesktop-ModemManager1-Modem-Time.NetworkTimezone">NetworkTimezone</link>  readable   a{sv}
</synopsis>
  </refsect1>
<refsect1 role="desc" id="gdbus-interface-org-freedesktop-ModemManager1-Modem-Time">
  <title role="desc.title">Description</title>
  <para>      This interface allows clients to receive network time and timezone
      updates broadcast by mobile networks.
</para>
</refsect1>
<refsect1 role="details" id="gdbus-methods-org.freedesktop.ModemManager1.Modem.Time">
  <title role="details.title">Method Details</title>
<refsect2 role="method" id="gdbus-method-org-freedesktop-ModemManager1-Modem-Time.GetNetworkTime">
  <title>The GetNetworkTime() method</title>
  <indexterm zone="gdbus-method-org-freedesktop-ModemManager1-Modem-Time.GetNetworkTime"><primary sortas="Modem.Time.GetNetworkTime">org.freedesktop.ModemManager1.Modem.Time.GetNetworkTime()</primary></indexterm>
<programlisting>
GetNetworkTime (OUT s time);
</programlisting>
<para>        time, and (if available) UTC offset in ISO 8601 format. If the network
        time is unknown, the empty string.
</para><para>        Gets the current network time in local time.
</para><para>        This method will only work if the modem tracks, or can request, the
        current network time; it will not attempt to use previously-received
        network time updates on the host to guess the current network time.
</para>
<variablelist role="params">
<varlistentry>
  <term><literal>OUT s <parameter>time</parameter></literal>:</term>
  <listitem><para>If the network time is known, a string containing local date,</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<refsect1 role="details" id="gdbus-signals-org.freedesktop.ModemManager1.Modem.Time">
  <title role="details.title">Signal Details</title>
<refsect2 role="signal" id="gdbus-signal-org-freedesktop-ModemManager1-Modem-Time.NetworkTimeChanged">
  <title>The "NetworkTimeChanged" signal</title>
  <indexterm zone="gdbus-signal-org-freedesktop-ModemManager1-Modem-Time.NetworkTimeChanged"><primary sortas="Modem.Time::NetworkTimeChanged">org.freedesktop.ModemManager1.Modem.Time::NetworkTimeChanged</primary></indexterm>
<programlisting>
NetworkTimeChanged (s time);
</programlisting>
<para>        Sent when the network time is updated.
</para>
<variablelist role="params">
<varlistentry>
  <term><literal>s <parameter>time</parameter></literal>:</term>
  <listitem><para>A string containing date and time in ISO 8601 format.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<refsect1 role="details" id="gdbus-properties-org.freedesktop.ModemManager1.Modem.Time">
  <title role="details.title">Property Details</title>
<refsect2 role="property" id="gdbus-property-org-freedesktop-ModemManager1-Modem-Time.NetworkTimezone">
  <title>The "NetworkTimezone" property</title>
  <indexterm zone="gdbus-property-org-freedesktop-ModemManager1-Modem-Time.NetworkTimezone"><primary sortas="Modem.Time:NetworkTimezone">org.freedesktop.ModemManager1.Modem.Time:NetworkTimezone</primary></indexterm>
<programlisting>
NetworkTimezone  readable   a{sv}
</programlisting>
<para>        The timezone data provided by the network. It may include one or more
        of the following fields:
</para><para>        <variablelist>
          <varlistentry><term><literal>"offset"</literal></term>
            <listitem>
              Offset of the timezone from UTC, in minutes (including DST, if applicable),
              given as a signed integer value (signature <literal>"i"</literal>).
            </listitem>
          </varlistentry>
          <varlistentry><term><literal>"dst-offset"</literal></term>
            <listitem>
              Amount of offset that is due to DST (daylight saving time),
              given as a signed integer value (signature <literal>"i"</literal>).
            </listitem>
          </varlistentry>
          <varlistentry><term><literal>"leap-seconds"</literal></term>
            <listitem>
              Number of leap seconds included in the network time,
              given as a signed integer value (signature <literal>"i"</literal>).
            </listitem>
          </varlistentry>
        </variablelist>
</para>
</refsect2>
</refsect1>
</refentry>