- Qt 6.8
- Qt Core
- C++ Classes
- QContactsPermission
- Qt 6.8.3 Reference Documentation

# QContactsPermission Class

Access the user's contacts. More...

Header: | `#include <QPermissions>`
CMake: | `find_package(Qt6 REQUIRED COMPONENTS Core)` `target_link_libraries(mytarget PRIVATE Qt6::Core)`
qmake: | `QT += core`
Since: | Qt 6.5

- List of all members, including inherited members

## Public Types

enum | AccessMode { ReadOnly, ReadWrite }

## Public Functions

QContactsPermission::AccessMode | accessMode() const
void | setAccessMode(QContactsPermission::AccessMode mode)

## Detailed Description

By default the request is for read-only access. Use setAccessMode() to override the default.

### Requirements

To request this permission at runtime, the following platform specific usage declarations have to be made at build time:

Platform | Type |
--- | --- | ---
Apple | Usage description | `NSContactsUsageDescription`
Android | `uses-permission` | `android.permission.READ_CONTACTS`. `android.permission.WRITE_CONTACTS` if QContactsPermission::accessMode() is set to AccessMode::ReadWrite.

Please see the individual usage declaration types for how to add them to your project.

See also QPermission, QCoreApplication::requestPermission(), QCoreApplication::checkPermission(), and Application Permissions.

## Member Type Documentation

### enum QContactsPermission::AccessMode

This enum is used to control access to the contacts data.

Constant | Value | Description
--- | --- | ---
`QContactsPermission::ReadOnly` | `0` | Read-only access to the contacts data (the default).
`QContactsPermission::ReadWrite` | `1` | Read and write access to the contacts data.

See also setAccessMode and accessMode.

## Member Function Documentation

### QContactsPermission::AccessMode QContactsPermission::accessMode() const

Returns AccessMode::ReadWrite when the request is for read-write and AccessMode::ReadOnly when it is for read-only access to the contacts.

See also setAccessMode().

### void QContactsPermission::setAccessMode(QContactsPermission::AccessMode mode)

Sets whether the request is for read-write (mode == AccessMode::ReadWrite) or read-only (mode == AccessMode::ReadOnly) access to the contacts.

See also accessMode().