diff options
author | Maurice Kalinowski <maurice.kalinowski@qt.io> | 2016-06-20 15:36:29 +0200 |
---|---|---|
committer | Maurice Kalinowski <maurice.kalinowski@qt.io> | 2016-07-06 12:44:13 +0000 |
commit | 529b126c93d854b661b645fc4897b6a4631404c4 (patch) | |
tree | 364e5aaab021339bb54990ff73a639dfe5287b83 | |
parent | cb3910f7afaa48fb6093c784a83fa89486236c2b (diff) |
WinRT: Add documentation
Change-Id: Icc549a858b3360c801e89d7fc6f3f51b790b9a26
Task-number: QTBUG-50550
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Oliver Wolff <oliver.wolff@qt.io>
-rw-r--r-- | src/purchasing/doc/src/gettingstarted-cpp.qdoc | 5 | ||||
-rw-r--r-- | src/purchasing/doc/src/qtpurchasing-overview.qdoc | 1 | ||||
-rw-r--r-- | src/purchasing/doc/src/windowsstore.qdoc | 104 |
3 files changed, 108 insertions, 2 deletions
diff --git a/src/purchasing/doc/src/gettingstarted-cpp.qdoc b/src/purchasing/doc/src/gettingstarted-cpp.qdoc index a226866..a101de5 100644 --- a/src/purchasing/doc/src/gettingstarted-cpp.qdoc +++ b/src/purchasing/doc/src/gettingstarted-cpp.qdoc @@ -33,8 +33,9 @@ This guide assumes that you have registered the in-app products for your application in the external store. For more information about registering - products, see \l{Registering Products in Google Play} and - \l{Registering Products in App Store} + products, see \l{Registering Products in Google Play}, + \l{Registering Products in App Store}, and + \l{Registering Products in Windows Store}. \section1 Preparing the Application diff --git a/src/purchasing/doc/src/qtpurchasing-overview.qdoc b/src/purchasing/doc/src/qtpurchasing-overview.qdoc index 19810e4..322888e 100644 --- a/src/purchasing/doc/src/qtpurchasing-overview.qdoc +++ b/src/purchasing/doc/src/qtpurchasing-overview.qdoc @@ -59,6 +59,7 @@ \list \li \l{Registering Products in Google Play} \li \l{Registering Products in App Store} + \li \l{Registering Products in Windows Store} \endlist \section2 Writing the Code diff --git a/src/purchasing/doc/src/windowsstore.qdoc b/src/purchasing/doc/src/windowsstore.qdoc new file mode 100644 index 0000000..bd7e001 --- /dev/null +++ b/src/purchasing/doc/src/windowsstore.qdoc @@ -0,0 +1,104 @@ +/**************************************************************************** +** +** Copyright (C) 2016 The Qt Company Ltd. +** Contact: http://www.qt.io/licensing/ +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see http://www.qt.io/terms-conditions. For further +** information use the contact form at http://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: http://www.gnu.org/copyleft/fdl.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + + \page qtpurchasing-windowsstore.html + \title Registering Products in Windows Store + \brief A short guide to registering in-app products in Windows Store. + + This guide provides a brief introduction to registering an application + and its in-app products on Windows Store. + + In-App purchasing for WinRT differentiates between two modes: + \list + \li \c{Simulation}: All Windows Store interaction is emulated and controlled + via a configuration XML file. A project containing this file will fail + certification and cannot be published. + \li \c{Store interaction}: The application talks to the Windows Store + directly without any layer in between. This binary can neither be side-loaded + nor tested locally. The user has to retrieve the app through the Windows + Store itself. + \endlist + + \section1 Using the Simulation Mode + + During the development process it is not allowed to interact with the Windows + Store directly. Instead, an XML file has to be used, describing the available + in-app products and the license of the application itself. Go to the + \l{https://msdn.microsoft.com/en-us/library/windows/apps/windows.applicationmodel.store.currentappsimulator.aspx}{MSDN documentation} + for more information on the format of this XML file. + + This XML file has to be added to the root directory of the application + resources and named \b{QtStoreSimulation.xml}. + + \section1 Using the Windows Store + \section2 Adding In-App Products to Windows Store + In order to access in-app products from your application, you must register + them to the Windows Store. Go the the \uicontrol{IAPs} page and click + \uicontrol{Create a new IAP}. + + Fill out the following information about your product: + \list + \li \uicontrol{Product type} – Choose either \uicontrol{Consumable} or + \uicontrol{Durable} depending on the type of the in-app product. Note that + you will \b{not} be able to change this later. + \li \uicontrol{Product ID} – An identifier that is used to access the + product from your code. + \li \uicontrol{Pricing and Availability} – Price for the product and + the geographical areas where it is available. + \endlist + + In-app products will be available once you have published the application. + + \section2 Publishing Your Application + + In order to test in-app purchases in your application, you first have to + publish it. To limit the users who can access the application before it is + ready for production, it can be published as either alpha or beta. + + \section1 Platform Notes + + The Windows Store provides a way to set an application into trial mode and + buy the application itself via in-app purchases. To reflect this + functionality, the WinRT backend uses the \b{app} keyword as an + \l{QInAppProduct::identifier}{identifier}. If a product query for \b{app} + succeeds, the current license is valid. The + \l{QInAppProduct::title()}{product name} itself will provide information on + the license state of the app and can have the following content: + + \list + \li \c{Trial period}: The app is in trial mode and can be purchased. + \li \c{Fully licensed}: The app has been bought. + \endlist + + If a product query for \b{app} fails, then either the trial has expired + or the license is invalid. Your app should check for this product and react + accordingly, for instance by showing a dialog to the user. + +*/ + |