extensions/generic-types.xml

   1 <tp:generic-types
   2   xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
   3
   4   <tp:simple-type name="Unix_Timestamp" type="u">
   5     <tp:docstring>An unsigned 32-bit integer representing time as the number
   6       of seconds elapsed since the Unix epoch
   7       (1970-01-01T00:00:00Z)</tp:docstring>
   8   </tp:simple-type>
   9
  10   <tp:simple-type name="Unix_Timestamp64" type="x">
  11     <tp:docstring>An signed 64-bit integer representing time as the number
  12       of seconds elapsed since the Unix epoch
  13       (1970-01-01T00:00:00Z); negative for times before the epoch</tp:docstring>
  14
  15     <tp:rationale>The Text interface is the only user of Unix_Timestamp so
  16       far, and we'd like to be Y2038 compatible in future
  17       interfaces.</tp:rationale>
  18   </tp:simple-type>
  19
  20   <tp:simple-type name="DBus_Bus_Name" type="s">
  21     <tp:docstring>A string representing a D-Bus bus name - either a well-known
  22       name like "org.freedesktop.Telepathy.MissionControl" or a unique name
  23       like ":1.123"</tp:docstring>
  24   </tp:simple-type>
  25
  26   <tp:simple-type name="DBus_Well_Known_Name" type="s">
  27     <tp:docstring>A string representing a D-Bus well-known
  28       name like "org.freedesktop.Telepathy.MissionControl".</tp:docstring>
  29   </tp:simple-type>
  30
  31   <tp:simple-type name="DBus_Unique_Name" type="s">
  32     <tp:docstring>A string representing a D-Bus unique name, such as
  33       ":1.123"</tp:docstring>
  34   </tp:simple-type>
  35
  36   <tp:simple-type name="DBus_Interface" type="s">
  37     <tp:docstring>An ASCII string representing a D-Bus interface - two or more
  38       elements separated by dots, where each element is a non-empty
  39       string of ASCII letters, digits and underscores, not starting with
  40       a digit. The maximum total length is 255 characters. For example,
  41       "org.freedesktop.DBus.Peer".</tp:docstring>
  42   </tp:simple-type>
  43
  44   <tp:simple-type name="DBus_Error_Name" type="s">
  45     <tp:docstring>An ASCII string representing a D-Bus error. This is
  46       syntactically the same as a <tp:type>DBus_Interface</tp:type>, but the
  47       meaning is different.</tp:docstring>
  48   </tp:simple-type>
  49
  50   <tp:simple-type name="DBus_Signature" type="s">
  51     <tp:docstring>A string representing a D-Bus signature
  52       (the 'g' type isn't used because of poor interoperability, particularly
  53       with dbus-glib)</tp:docstring>
  54   </tp:simple-type>
  55
  56   <tp:struct name="DBus_Tube_Member" array-name="DBus_Tube_Member_List">
  57      <tp:docstring>A struct (handle, unique name) representing a participant
  58        in a D-Bus tube, as returned by GetDBusNames on the Tubes channel
  59        type, and as seen in the DBusNamesChanged signal.</tp:docstring>
  60      <tp:member type="u" tp:type="Contact_Handle" name="Handle"/>
  61      <tp:member type="s" tp:type="DBus_Unique_Name" name="Unique_Name"/>
  62   </tp:struct>
  63
  64   <tp:simple-type name="DBus_Member" type="s">
  65     <tp:docstring>An ASCII string representing a D-Bus method, signal
  66       or property name - a non-empty string of ASCII letters, digits and
  67       underscores, not starting with a digit, with a maximum length of 255
  68       characters. For example, "Ping".</tp:docstring>
  69   </tp:simple-type>
  70
  71   <tp:simple-type name="DBus_Qualified_Member" type="s">
  72     <tp:docstring>A string representing the full name of a D-Bus method,
  73       signal or property, consisting of a DBus_Interface, followed by
  74       a dot, followed by a DBus_Member. For example,
  75       "org.freedesktop.DBus.Peer.Ping".</tp:docstring>
  76   </tp:simple-type>
  77
  78   <tp:mapping name="Qualified_Property_Value_Map"
  79     array-name="Qualified_Property_Value_Map_List">
  80     <tp:docstring>A mapping from strings representing D-Bus
  81       properties (by their namespaced names) to their values.</tp:docstring>
  82     <tp:member type="s" name="Key" tp:type="DBus_Qualified_Member">
  83       <tp:docstring>
  84         A D-Bus interface name, followed by a dot and a D-Bus property name.
  85       </tp:docstring>
  86     </tp:member>
  87     <tp:member type="v" name="Value">
  88       <tp:docstring>
  89         The value of the property.
  90       </tp:docstring>
  91     </tp:member>
  92   </tp:mapping>
  93
  94   <tp:mapping name="String_Variant_Map" array-name="String_Variant_Map_List">
  95     <tp:docstring>A mapping from strings to variants representing extra
  96       key-value pairs.</tp:docstring>
  97     <tp:member type="s" name="Key"/>
  98     <tp:member type="v" name="Value"/>
  99   </tp:mapping>
 100
 101   <tp:mapping name="String_String_Map">
 102     <tp:docstring>A mapping from strings to strings representing extra
 103       key-value pairs.</tp:docstring>
 104     <tp:member type="s" name="Key"/>
 105     <tp:member type="s" name="Value"/>
 106   </tp:mapping>
 107
 108 </tp:generic-types>