X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=doc%2Fservice-api.txt;h=7cc6fb4e4ffb90568a98226b4f008c224e05ce58;hb=091f5fa9229897a52424cd442b325f97d361dbc3;hp=462452223c45b5452c70e33f5c97f0ddd432136c;hpb=fc6a5bcad7df1b234bd0fbd2aa5b89f7bcd443b8;p=framework%2Fconnectivity%2Fconnman.git diff --git a/doc/service-api.txt b/doc/service-api.txt index 4624522..7cc6fb4 100644 --- a/doc/service-api.txt +++ b/doc/service-api.txt @@ -1,15 +1,18 @@ Service hierarchy ================= -Service org.moblin.connman -Interface org.moblin.connman.Service +Service net.connman +Interface net.connman.Service Object path [variable prefix]/{service0,service1,...} -Methods dict GetProperties() +Methods dict GetProperties() [deprecated] Returns properties for the service object. See the properties section for available properties. + Usage of this method is highly discouraged. Use + the Manager.GetServices() method instead. + Possible Errors: [service].Error.InvalidArguments void SetProperty(string name, variant value) @@ -104,7 +107,7 @@ Methods dict GetProperties() Possible Errors: [service].Error.InvalidArguments - void ResetCounters() + void ResetCounters() [experimental] Reset the counter statistics. @@ -120,18 +123,19 @@ Properties string State [readonly] The service state information. Valid states are "idle", "failure", "association", - "configuration" and "ready". + "configuration", "ready" and "online". - Also "login" and "online" states are used. The - state "online" signals that an Internet connection - is available and has been verified. + The "ready" state signals a successfully + connected device. "online" signals that an + Internet connection is available and has been + verified. string Error [readonly] The service error status details. When error occur during connection or disconnection - the detailed information are represented in this + the detailed information is represented in this property to help the user interface to present the user with alternate options. @@ -146,10 +150,11 @@ Properties string State [readonly] The service name (for example "Wireless" etc.) This name can be used for directly displaying it in - the application. It has pure informational purpose. + the application. It has pure informational purpose + and no attempt should be made to translate it. - For Ethernet devices and hidden WiFi networks it is - not guaranteed that this property is present. + For Ethernet devices and hidden WiFi networks this + property is not present. string Type [readonly] @@ -159,60 +164,21 @@ Properties string State [readonly] advanced properties or showing the correct icon to the user. - string Mode [readonly] - - If the service type is WiFi or Cellular, then this - property is present and contains the mode of the - network. - - For WiFi services the possible values are "managed" - and "adhoc". For Cellular services it describes the - network technology. Possible values are "gprs", "edge" - and "umts". + Together with a missing Name property, this can + be used to identify hidden WiFi networks. - This property might be only present for WiFi and - Cellular services. - - string Security [readonly] + array{string} Security [readonly] If the service type is WiFi, then this property is - present and contains the security method or key - management setting. + present and contains the list of security methods + or key management settings. - Possible values are "none", "wep", "psk" and - also "ieee8021x". Alternate values for "psk" - can also be "wpa" and "rsn". + Possible values are "none", "wep", "psk", "ieee8021x" + and also "wps". This property might be only present for WiFi services. - boolean LoginRequired [readonly] - - This property indicates that an additional login - step is needed before the connection establishment - can proceed. - - string Passphrase [readwrite] - - If the service type is WiFi, then this property - can be used to store a passphrase. - - No PropertyChanged signals will be send for this - property. The PassphraseRequired property should - be monitored instead. - - This property might also not always be included - since it is protected by a different security policy. - - boolean PassphraseRequired [readonly] - - If the service type is WiFi, then this property - indicates if a passphrase is required. - - If a passphrase has been set already or if no - passphrase is needed, then this property will - be set to false. - uint8 Strength [readonly] Indicates the signal strength of the service. This @@ -242,39 +208,14 @@ Properties string State [readonly] boolean AutoConnect [readwrite] If set to true, this service will auto-connect - when not other connection is available. + when no other connection is available. + + The service won't auto-connect while roaming. For favorite services it is possible to change this value to prevent or permit automatic connection attempts. - boolean SetupRequired [readonly] - - If the service is Cellular, then this property - indicates that some extra setup steps are required. - - In most cases it is required to fill in the APN - details. - - string APN [readwrite] - - If the service is Cellular, then this property - contains the APN details. - - The APN is network provider specific and even - sometimes data plan specific. Possible examples - are "isp.cingular" or "internet.t-mobile". - - string MCC [readonly] - - If the service is Cellular, then this property - contains the Mobile Country Code. - - string MNC [readonly] - - If the service is Cellular, then this property - contains the Mobile Network Code. - boolean Roaming [readonly] This property indicates if this service is roaming. @@ -301,8 +242,9 @@ Properties string State [readonly] array{string} Nameservers.Configuration [readwrite] The list of manually configured domain name - servers. Some 3G networks don't provide correct - name servers and this allows for an override. + servers. Some cellular networks don't provide + correct name servers and this allows for an + override. This array is sorted by priority and the first entry in the list represents the nameserver with @@ -317,9 +259,32 @@ Properties string State [readonly] the service. However there might be small window where name resolution might fail. + array{string} Timeservers [readonly] + + The list of currently active timeservers for this + service. If the server is not in READY or ONLINE + state than this list will be empty. + + array{string} Timeservers.Configuration [readwrite] + + The list of manually configured time servers. + + The first entry in the list represents the + timeserver with the highest priority. + + When using manual configuration this setting + is useful to override all the other timeserver + settings. This is service specific, hence only + the values for the default service are used. + + Changes to this property will result in restart + of NTP query. + array{string} Domains [readonly] - The list of currently used search domains. + The list of currently used search domains taken + from Domains.Configurations if set, otherwise a + domain name if provided by DHCP or VPNs. array{string} Domains.Configuration [readwrite] @@ -363,14 +328,16 @@ Properties string State [readonly] string Method [readonly] - Possible values are "dhcp", "manual" + Possible values are "auto", "manual", "6to4" and "off". The value "fixed" indicates an IP address that can not be modified. For example cellular networks return fixed information. - - "dhcp" is not supported currently. + The value "6to4" is returned if 6to4 tunnel + is created by connman. The tunnel can only be + created if method was set to "auto" by the + user. User cannot set the method to "6to4". string Address [readonly] @@ -384,6 +351,26 @@ Properties string State [readonly] The current configured IPv6 gateway. + string Privacy [readonly] + + Enable or disable IPv6 privacy extension + that is described in RFC 4941. The value + has only meaning if Method is set to "auto". + + Value "disabled" means that privacy extension + is disabled and normal autoconf addresses are + used. + + Value "enabled" means that privacy extension is + enabled and system prefers to use public + addresses over temporary addresses. + + Value "prefered" means that privacy extension is + enabled and system prefers temporary addresses + over public addresses. + + Default value is "disabled". + dict IPv6.Configuration [readwrite] Same values as IPv6 property. The IPv6 represents @@ -449,19 +436,19 @@ Properties string State [readonly] string Host [readonly] - VPN host IP. + VPN host IP. string Domain [readonly] - VPN Domain. + VPN Domain. string Name [readonly] - VPN provider Name. + VPN provider Name. string Type [readonly] - VPN provider type. + VPN provider type. dict Ethernet [readonly]