Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
QContactsPermission Class Reference

Access the user's contacts. More...

#include <qpermissions.h>

+ Collaboration diagram for QContactsPermission:

Public Types

enum  AccessMode : quint8 { ReadOnly , ReadWrite }
 This enum is used to control access to the contacts data. More...
 

Public Member Functions

Q_CORE_EXPORT void setAccessMode (AccessMode mode)
 Sets whether the request is for read-write (mode == AccessMode::ReadWrite) or read-only (mode == AccessMode::ReadOnly) access to the contacts.
 
Q_CORE_EXPORT AccessMode 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.
 

Detailed Description

Access the user's contacts.

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

Definition at line 154 of file qpermissions.h.

Member Enumeration Documentation

◆ AccessMode

enum QContactsPermission::AccessMode : quint8

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

\value ReadOnly Read-only access to the contacts data (the default). \value ReadWrite Read and write access to the contacts data.

See also
setAccessMode, accessMode
Enumerator
ReadOnly 
ReadWrite 

Definition at line 158 of file qpermissions.h.

Member Function Documentation

◆ accessMode()

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.

Definition at line 593 of file qpermissions.cpp.

◆ setAccessMode()

void QContactsPermission::setAccessMode ( AccessMode mode)

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

Definition at line 584 of file qpermissions.cpp.

The documentation for this class was generated from the following files: