7633cfe9fa
This gives plugin developers a chance to finish() an info on their own in an aborted() handler and set a custom error code and displayMessage without causing a "finishing an already finished object" warning.
122 lines
3.4 KiB
C++
122 lines
3.4 KiB
C++
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
|
|
*
|
|
* Copyright 2013 - 2020, nymea GmbH
|
|
* Contact: contact@nymea.io
|
|
*
|
|
* This file is part of nymea.
|
|
* This project including source code and documentation is protected by
|
|
* copyright law, and remains the property of nymea GmbH. All rights, including
|
|
* reproduction, publication, editing and translation, are reserved. The use of
|
|
* this project is subject to the terms of a license agreement to be concluded
|
|
* with nymea GmbH in accordance with the terms of use of nymea GmbH, available
|
|
* under https://nymea.io/license
|
|
*
|
|
* GNU Lesser General Public License Usage
|
|
* Alternatively, this project may be redistributed and/or modified under the
|
|
* terms of the GNU Lesser General Public License as published by the Free
|
|
* Software Foundation; version 3. This project 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 project. If not, see <https://www.gnu.org/licenses/>.
|
|
*
|
|
* For any further details and any questions please contact us under
|
|
* contact@nymea.io or see our FAQ/Licensing Information on
|
|
* https://nymea.io/license/faq
|
|
*
|
|
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
|
|
|
|
#include "browseresult.h"
|
|
#include "thingmanager.h"
|
|
|
|
#include <QTimer>
|
|
|
|
Q_DECLARE_LOGGING_CATEGORY(dcIntegrations)
|
|
|
|
BrowseResult::BrowseResult(Thing *thing, ThingManager *thingManager, const QString &itemId, const QLocale &locale, QObject *parent, quint32 timeout):
|
|
QObject(parent),
|
|
m_thing(thing),
|
|
m_itemId(itemId),
|
|
m_locale(locale),
|
|
m_thingManager(thingManager)
|
|
{
|
|
connect(this, &BrowseResult::finished, this, &BrowseResult::deleteLater, Qt::QueuedConnection);
|
|
|
|
if (timeout > 0) {
|
|
QTimer::singleShot(timeout, this, [this] {
|
|
emit aborted();
|
|
if (!m_finished) {
|
|
finish(Thing::ThingErrorTimeout);
|
|
}
|
|
});
|
|
}
|
|
}
|
|
|
|
Thing *BrowseResult::thing() const
|
|
{
|
|
return m_thing;
|
|
}
|
|
|
|
QString BrowseResult::itemId() const
|
|
{
|
|
return m_itemId;
|
|
}
|
|
|
|
QLocale BrowseResult::locale() const
|
|
{
|
|
return m_locale;
|
|
}
|
|
|
|
BrowserItems BrowseResult::items() const
|
|
{
|
|
return m_items;
|
|
}
|
|
|
|
bool BrowseResult::isFinished() const
|
|
{
|
|
return m_finished;
|
|
}
|
|
|
|
Thing::ThingError BrowseResult::status() const
|
|
{
|
|
return m_status;
|
|
}
|
|
|
|
QString BrowseResult::displayMessage() const
|
|
{
|
|
return m_displayMessage;
|
|
}
|
|
|
|
QString BrowseResult::translatedDisplayMessage(const QLocale &locale)
|
|
{
|
|
if (!m_thingManager || !m_thing) {
|
|
return m_displayMessage;
|
|
}
|
|
|
|
return m_thingManager->translate(m_thing->pluginId(), m_displayMessage.toUtf8(), locale);
|
|
}
|
|
|
|
void BrowseResult::addItem(const BrowserItem &item)
|
|
{
|
|
m_items.append(item);
|
|
}
|
|
|
|
void BrowseResult::addItems(const BrowserItems &items)
|
|
{
|
|
m_items.append(items);
|
|
}
|
|
|
|
void BrowseResult::finish(Thing::ThingError status, const QString &displayMessage)
|
|
{
|
|
if (m_finished) {
|
|
qCWarning(dcIntegrations()) << "BrowseResult::finish() called on an already finished object.";
|
|
return;
|
|
}
|
|
m_finished = true;
|
|
m_status = status;
|
|
m_displayMessage = displayMessage;
|
|
staticMetaObject.invokeMethod(this, "finished", Qt::QueuedConnection);
|
|
}
|