Ubuntu.Connectivity NetworkingStatus

Overall system networking status.

Import Statement: import .

Properties

Detailed Description

This is the top-level class for accessing networking information.

This class inherits the Qt C++ ubuntu::connectivity::NetworkingStatus and provides two utility properties online and limitedBandwith for easier QML usage.

This object is exposed as a singleton.

note: Using this component in confined application requires connectivity policy group.

/*
 * Copyright (C) 2014 Canonical Ltd.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License version 3,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
import QtQuick 2.0
import Ubuntu.Components 0.1
import Ubuntu.Connectivity 1.0
MainView {
    id: root
    objectName: "mainView"
    applicationName: "Connectivity"
    width: units.gu(100)
    height: units.gu(75)
    property real margins: units.gu(2)
    property real buttonWidth: units.gu(9)
    property var statusMap: ["Offline", "Connecting", "Online"]
    Connections {
        target: Connectivity
        // full status can be retrieved from the base C++ class
        // status property
        onStatusChanged: console.log("Status: " + statusMap[Connectivity.status])
        onOnlineChanged: console.log("Online: " + Connectivity.online)
    }
    Page {
        title: i18n.tr("Networking Status")
        Column {
            anchors.centerIn: parent
            Label {
                // use the online property
                text: Connectivity.online ? "Online" : "Not online"
                fontSize: "large"
            }
            Label {
                // use the status property
                text: "Status: " + statusMap[Connectivity.status]
                fontSize: "large"
            }
            Label {
                // use the limitedBandwith property
                text: Connectivity.limitedBandwith ? "Bandwith limited" : "Bandwith not limited"
                fontSize: "large"
            }
        }
    }
}

Property Documentation

limitations : Limitations
limitedBandwith : bool

true if Internet connection is bandwith limited.

shorthand for C++:

networkingStatus->limitations().contains(NetworkingStatus::Limitations::Bandwith)
online : bool

true if system has Internet connection.

shorthand for C++:

networkingStatus->status() == NetworkingStatus::Online
status : Status

status property of the base C++ class.

onStatusChanged: {
    if (status === NetworkingStatus::Offline)
        ;
    else if (status === NetworkingStatus::Connecting)
        ;
    else if (status === NetworkingStatus::Online)
        ;
}