doc/technology-api.txt

   1 Technology hierarchy
   2 ====================
   3
   4 Service         net.connman
   5 Interface       net.connman.Technology
   6 Object path     [variable prefix]/{technology0,technology1,...}
   7
   8 Methods         dict GetProperties()  [deprecated]
   9
  10                         Returns properties for the technology object. See
  11                         the properties section for available properties.
  12
  13                         Usage of this method is highly discouraged. Use
  14                         the Manager.GetTechnologies() method instead.
  15
  16                         Possible Errors: [service].Error.InvalidArguments
  17
  18                 void SetProperty(string name, variant value)
  19
  20                         Changes the value of the specified property. Only
  21                         properties that are listed as read-write are
  22                         changeable. On success a PropertyChanged signal
  23                         will be emitted.
  24
  25                         Possible Errors: [service].Error.InvalidArguments
  26                                          [service].Error.InvalidProperty
  27
  28                 void Scan()
  29
  30                         Trigger a scan for this specific technology. The
  31                         method call will return when a scan has been
  32                         finished and results are available. So setting
  33                         a longer D-Bus timeout might be a really good
  34                         idea.
  35
  36                         Results will be signaled via the ServicesChanged
  37                         signal from the manager interface.
  38
  39                         In case of P2P technology, results will be signaled
  40                         via the PeersChanged signal from the manager
  41                         interface.
  42
  43 Signals         PropertyChanged(string name, variant value)
  44
  45                         This signal indicates a changed value of the given
  46                         property.
  47
  48                 DhcpConnected(string aptype, string ipaddr,
  49                                         string macaddr, string hostname)
  50
  51                         This signal indicates a station information that
  52                         has connected to the AP(Access Point).
  53
  54                 DhcpLeaseDeleted(string aptype, string ipaddr,
  55                                         string macaddr, string hostname)
  56
  57                         This signal indicates a station information that
  58                         has disconnected to the AP(Access Point).
  59
  60 Properties      boolean Powered [readwrite]
  61
  62                         Boolean representing the power state of the
  63                         technology. False means that the technology is
  64                         off (and is available RF-Killed) while True means
  65                         that the technology is enabled.
  66
  67                 boolean Connected [readonly]
  68
  69                         Boolean representing if a technology is connected.
  70
  71                         This is just a convience property for allowing the
  72                         UI to easily show if this technology has an active
  73                         connection or not.
  74
  75                         If this property is True it means that at least one
  76                         service of this technology is in ready state.
  77
  78                 string Name [readonly]
  79
  80                         Name of this technology.
  81
  82                 string Type [readonly]
  83
  84                         The technology type (for example "ethernet" etc.)
  85
  86                         This information should only be used to determine
  87                         advanced properties or showing the correct icon
  88                         to the user.
  89
  90                 boolean Tethering [readwrite]
  91
  92                         This option allows to enable or disable the support
  93                         for tethering. When tethering is enabled then the
  94                         default service is bridged to all clients connected
  95                         through the technology.
  96
  97                 string TetheringIdentifier [readwrite]
  98
  99                         The tethering broadcasted identifier.
 100
 101                         This property is only valid for the WiFi technology,
 102                         and is then mapped to the WiFi AP SSID clients will
 103                         have to join in order to gain internet connectivity.
 104
 105                 string TetheringPassphrase [readwrite]
 106
 107                         The tethering connection passphrase.
 108
 109                         This property is only valid for the WiFi technology,
 110                         and is then mapped to the WPA pre-shared key clients
 111                         will have to use in order to establish a connection.
 112
 113                 boolean Hidden [readwrite]
 114
 115                         This option allows to enable or disable the support
 116                         for the hidden Wi-Fi tethering.