qohoswant.cpp

Go to the documentation of this file.

// Copyright (C) 2026 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
 
#include "qohoswant_p.h"
 
QT_BEGIN_NAMESPACE
 
namespace QtOhosAppKit {
 
/*!
    \enum QtOhosAppKit::WantFlag
    \since 5.12.12
 
    WantFlag specifies how the Want will be handled.
    See \l {https://developer.huawei.com/consumer/en/doc/harmonyos-references-V5/js-apis-ability-wantconstant-V5#flags}
    {Flags}.
 
    \value AuthReadUriPermission Grants the permission to read the URI.
    \value AuthWriteUriPermission Grants the permission to write data to the URI.
    \value InstallOnDemand Ability will be installed if it has not been installed.
*/
 
/*!
    \class QtOhosAppKit::Want
    \inmodule QtOhosAppKit
    \since 5.12.12
    \brief Want wraps Ohos \l {https://developer.huawei.com/consumer/en/doc/harmonyos-guides-V5/want-V5}
    {Want} class.
 
    It keeps information that can be transmitted between applications. One of the usage scenarios of
    Want is a parameter of starting an ability or starting application process.
 
    \sa startAbility()
    \sa startAppProcess()
*/
 
/*!
    \variable QtOhosAppKit::Want::deviceId
    \brief Represents the device Id on which Ability is to be performed.
    See \l {https://developer.huawei.com/consumer/en/doc/harmonyos-references-V5/js-apis-app-ability-want-V5}
    {Device Id}.
*/
 
/*!
    \variable QtOhosAppKit::Want::bundleName
    \brief Represents an application bundle name.
    See \l {https://developer.huawei.com/consumer/en/doc/harmonyos-references-V5/js-apis-app-ability-want-V5}
    {Bundle Name}.
*/
 
/*!
    \variable QtOhosAppKit::Want::moduleName
    \brief Represents the module name.
    See \l {https://developer.huawei.com/consumer/en/doc/harmonyos-references-V5/js-apis-app-ability-want-V5}
    {Module Name}.
*/
 
/*!
    \variable QtOhosAppKit::Want::abilityName
    \brief Represents the name of Ability to be started.
    See \l {https://developer.huawei.com/consumer/en/doc/harmonyos-references-V5/js-apis-app-ability-want-V5}
    {Ability Name}.
*/
 
/*!
    \variable QtOhosAppKit::Want::uri
    \brief Represents the type of pending data.
    See \l {https://developer.huawei.com/consumer/en/doc/harmonyos-references-V5/js-apis-app-ability-want-V5}
    {Uri}.
*/
 
/*!
    \variable QtOhosAppKit::Want::type
    \brief Represents the MIME type of the file to open for example 'text/xml', 'image/ * ', etc.
    See \l {https://developer.huawei.com/consumer/en/doc/harmonyos-references-V5/js-apis-app-ability-want-V5}
    {Type}.
*/
 
/*!
    \variable QtOhosAppKit::Want::action
    \brief Represents the general operations to be performed, for example: viewing, sharing,
    application details.
    See \l {https://developer.huawei.com/consumer/en/doc/harmonyos-references-V5/js-apis-app-ability-want-V5}
    {Action}.
*/
 
/*!
    \variable QtOhosAppKit::Want::entities
    \brief Represents the additional category information of the target Ability for example:
    browser, video player.
    See \l {https://developer.huawei.com/consumer/en/doc/harmonyos-references-V5/js-apis-app-ability-want-V5}
    {Entities}.
*/
 
/*!
    \variable QtOhosAppKit::Want::flags
    \brief Represents the way to deal with Want.
    See \l {https://developer.huawei.com/consumer/en/doc/harmonyos-references-V5/js-apis-app-ability-want-V5}
    {Flags}.
 
    \sa WantFlag
*/
 
/*!
    \variable QtOhosAppKit::Want::parameters
    \brief Represents the list of parameters in the Want object.
    See \l {https://developer.huawei.com/consumer/en/doc/harmonyos-references-V5/js-apis-app-ability-want-V5}
    {Parameters}.
*/
 
/*!
    \variable QtOhosAppKit::Want::fds
    \brief Represents the file descriptor map in the Want object.
    When serialized for startAbility(), each entry is passed to the platform
    using the fixed HarmonyOS file descriptor parameter format:
    \code
    parameters[key] = { "type": "FD", "value": fd }
    \endcode
    Use application-specific keys, for example a reverse-DNS prefix, and avoid
    using the same key in both fds and parameters.
    See \l {https://developer.huawei.com/consumer/en/doc/harmonyos-references/js-apis-app-ability-want}
    {Fds}.
*/
 
/*!
    \class QtOhosAppKit::WantInfo
    \inmodule QtOhosAppKit
    \since 5.12.12
 
    \brief The WantInfo class is to represent Ohos want type.
*/
 
/*!
    \class QtOhosAppKit::WantInfo::ContactInfo
    \brief The ContactInfo struct represents contact information extracted from a Want.
 
    This struct is used to hold the contact type and contact ID when the application
    is launched to handle a contact-related action.
*/
 
/*!
    \fn QtOhosAppKit::Want QtOhosAppKit::WantInfo::want() const = 0;
 
    Return associated with this instance Want object.
*/
 
/*!
    \fn virtual std::optional<QList<std::shared_ptr<QtOhosAppKit::ShareKit::SharedRecord>>> QtOhosAppKit::WantInfo::tryGetSharedRecordsFromShareKit() const = 0
 
    Tries to get shared records from assosiated want. The shared data is expected to be stored in the want parameters.
    Shared records are delivered on an application start or while the application is already running. Returns an empty optional if no such data found.
    See \l {https://developer.huawei.com/consumer/en/doc/harmonyos-references/share-system-share#section661613319216}
    {systemShare.getSharedData}.
 
    \sa QtOhosAppKit::AbilityContext::newWantInfoReceived(std::shared_ptr<QtOhosAppKit::WantInfo> wantInfo)
    \sa std::shared_ptr<QtOhosAppKit::WantInfo> QtOhosAppKit::AppContext::appLaunchWantInfo()
*/
 
/*!
    \fn virtual std::optional<QtOhosAppKit::WantInfo::ContactInfo> QtOhosAppKit::WantInfo::tryGetContactInfo() const = 0
 
    Tries to get contact information from the associated Want. Returns an empty optional if no
    contact information is found.
    See \l {https://developer.huawei.com/consumer/en/doc/harmonyos-references/share-system-share#section19799132782117}
    {systemShare.getContactInfo}.
 
    \sa QtOhosAppKit::AbilityContext::newWantInfoReceived(std::shared_ptr<QtOhosAppKit::WantInfo> wantInfo)
    \sa std::shared_ptr<QtOhosAppKit::WantInfo> QtOhosAppKit::AppContext::appLaunchWantInfo()
*/
 
WantInfo::WantInfo() = default;
 
WantInfo::~WantInfo() = default;
 
}
 
QT_END_NAMESPACE