summaryrefslogtreecommitdiffstats
path: root/examples/demos/hangman/doc/src/iosclasses.qdoc
blob: f717352ed3a95615b64a19598bda980fd87550fb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
/****************************************************************************
**
** Copyright (C) 2021 The Qt Company Ltd.
** Contact: https://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 https://www.qt.io/terms-conditions. For further
** information use the contact form at https://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: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
   \page qtpurchasing-iosclasses.html
   \title Demo iOS Classes
   \brief IOS classes are used in the purchasing demo to enable purchasing in iOS.
   \ingroup qtpurchasing-examples

   \section1 Classes
   \table
      \row
         \li \l IosInAppPurchaseProduct
         \li A product registered in the store.
      \row
         \li \l IosInAppPurchaseTransaction
         \li Contains information about a transaction in the external app store.
      \row
         \li \l IosInAppPurchaseBackend
         \li Comminucates with external store.
   \endtable

   Check out \l {Base Classes} which include InAppProduct, InAppStore,
   InAppTransaction and InAppPurchaseBackend

   \section1 IosInAppPurchaseProduct

   IosInAppPurchaseProduct adds purchase() for initializing purchasing process.

   \section1 IosInAppPurchaseTransaction

   IosInAppPurchaseTransaction adds new parameters and return types.
   Transaction error handling is implemented on IosInAppPurchaseTransaction's
   constructor. The class has the finalize() function that finalizes the transaction.

   \section1 IosInAppPurchaseBackend

   IosInAppPurchaseBackend uses \b Objective-C language to communicate with the App
   Store.

   \section2 Initializing the products

   This class shows the product's information on the store page.

   \list 1
      \li IosInAppPurchaseBackend is called from InAppStore::setupBackend().
      \li At initialization IosInAppPurchaseBackend creates InAppPurchaseManager with
         Objective-C.
      \li InAppStore::registerProduct(productType, &identifier) function is called and
         queryProduct() is executed in the back end.
      \li Objective-C function requestProductData:() is called and will make \l{https://developer.apple.com/documentation/storekit/skproductsrequest}{SKProductRequest}.
      \li After SKProductRequest is finished and product objects has been
         created in Objective-C productsRequest:(), products will be registered
         by the IosInAppPurchaseBackend::registerProduct() function.
      \li Signal productQueryDone() will be emitted and the item's information will be
         visible on the application's store page.
   \endlist

   \section2 Purchasing process

   \list 1
      \li The user presses one of the products on the applications store page.
      \li \c IosInAppPurchaseProduct::purchase() function is called and payment is added to
      the \c SKPaymentQueue in the Objective-C function paymentQueue:() in
      IosInAppPurchaseBackend.
      \li Purchase confirmation pop-up is launched for the user.
   \endlist
*/