summaryrefslogtreecommitdiffstats
path: root/src/corelib/kernel/qapplicationpermission.qdoc
blob: 7e2bcaad9106ae3f2c288e2583a9131ce576ee94 (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
93
94
95
96
97
98
99
100
/****************************************************************************
**
** 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$
**
****************************************************************************/

/*!
    \namespace QApplicationPermission

    \brief The QApplicationPermission namespace contains enums for app permission
    types and results.

    This namespace's enums are used by \l {QCoreApplication::requestPermission()} and
    \l {QCoreApplication::checkPermission()}.
*/

/*!
    \enum QApplicationPermission::PermissionType

    Predefined sets of permission values.

    \value Camera Access the camera for taking pictures or videos and configuring
           the camera settings. Maps to "android.permission.CAMERA" on Android.
    \value Microphone Access the microphone, receive the sound signal (e.g. to
           analyze or record it). Maps to \c "android.permission.RECORD_AUDIO"
           on Android.
    \value Location Access approximate location provider (wifi, cell tower).
           Maps to \c "android.permission.ACCESS_COARSE_LOCATION" on Android.
    \value PreciseLocation Location Access accurate location provider (satellite).
           Maps to \c "android.permission.ACCESS_FINE_LOCATION" on Android.
    \value PreciseBackgroundLocation Access the precise location services when
           the app is in the background. Maps to
           \c "android.permission.ACCESS_BACKGROUND_LOCATION" on Android, and
           implies \l PreciseLocation.
    \value BackgroundLocation Access the approximate location services when
           the app is in the background. Maps to
           \c "android.permission.ACCESS_BACKGROUND_LOCATION" on Android, and
           implies \l Location.
    \value BodySensors Access body sensors such as a heart rate sensor.
           Maps to \c "android.permission.BODY_SENSORS" on Android.
    \value PhysicalActivity Access to data about physical activity and body
           movements. Maps to \c "android.permission.ACTIVITY_RECOGNITION"
           on Android.
    \value Contacts Read and write user contacts. Maps to
           \c "android.permission.READ_CONTACTS" and \c "android.permission.WRITE_CONTACTS"
           on Android.
    \value Storage Access device storage with read and write permissions.
           Maps to \c "android.permission.READ_EXTERNAL_STORAGE" and
           \c "android.permission.WRITE_EXTERNAL_STORAGE"on Android.
    \value Calendar Read and write the user's calendar.
           Maps to \c "android.permission.READ_CALENDAR" and
            \c "android.permission.WRITE_CALENDAR" on Android.

    \omitvalue Bluetooth

    \note Both Android and iOS require the native permission values to be added
    to the \c AndroidManifest.xml and \c info.plist respectively. For more
    information on Android permissions, see \c {Qt Creator: Editing Manifest Files}.
    For more information on iOS \c info.plist, see
    \l {Information Property List Files}.

    \since 6.2
    \sa QCoreApplication::requestPermission(), QCoreApplication::checkPermission()
*/

/*!
    \enum QApplicationPermission::PermissionResult

    The result values for a permission check or request.

    \value Authorized The permission is authorized.
    \value Denied The permission is denied.
    \value Restricted The permission state is denied and cannot be changed due
           to restrictions from the system.
    \value Undetermined The permission state is not yet known.

    \since 6.2
    \sa QCoreApplication::requestPermission(), QCoreApplication::checkPermission()
*/