LMMS
Loading...
Searching...
No Matches
juce::AndroidDocumentPermission Class Reference

#include <juce_AndroidDocument.h>

Public Member Functions

URL getUrl () const
int64 getPersistedTime () const
bool isReadPermission () const
bool isWritePermission () const

Static Public Member Functions

static void takePersistentReadWriteAccess (const URL &)
static void releasePersistentReadWriteAccess (const URL &)
static std::vector< AndroidDocumentPermissiongetPersistedPermissions ()

Private Attributes

URL url
int64 time = 0
bool read = false
bool write = false

Detailed Description

Represents a permission granted to an application to read and/or write to a particular document or tree.

This class also contains static methods to request, revoke, and query the permissions of your app. These functions are no-ops on all platforms other than Android.

@tags{Core}

Member Function Documentation

◆ getPersistedPermissions()

std::vector< AndroidDocumentPermission > juce::AndroidDocumentPermission::getPersistedPermissions ( )
static

Returns all of the permissions that have previously been granted to the app, via takePersistentReadWriteAccess();

◆ getPersistedTime()

int64 juce::AndroidDocumentPermission::getPersistedTime ( ) const
inline

The time when the permissions were persisted, in milliseconds since January 1, 1970 00:00:00.0 UTC.

◆ getUrl()

URL juce::AndroidDocumentPermission::getUrl ( ) const
inline

The url of the document with persisted permissions.

◆ isReadPermission()

bool juce::AndroidDocumentPermission::isReadPermission ( ) const
inline

True if the permission allows read access.

◆ isWritePermission()

bool juce::AndroidDocumentPermission::isWritePermission ( ) const
inline

True if the permission allows write access.

◆ releasePersistentReadWriteAccess()

void juce::AndroidDocumentPermission::releasePersistentReadWriteAccess ( const URL & )
static

Revokes persistent access to a document or tree.

◆ takePersistentReadWriteAccess()

void juce::AndroidDocumentPermission::takePersistentReadWriteAccess ( const URL & )
static

Gives your app access to a particular document or tree, even after the device is rebooted.

If you want to persist access to a folder selected through a native file chooser, make sure to pass the exact URL returned by the file picker. Do NOT call AndroidDocument::fromTree and then pass the result of getUrl to this function, as the resulting URL may differ from the result of the file picker.

Member Data Documentation

◆ read

bool juce::AndroidDocumentPermission::read = false
private

◆ time

int64 juce::AndroidDocumentPermission::time = 0
private

◆ url

URL juce::AndroidDocumentPermission::url
private

◆ write

bool juce::AndroidDocumentPermission::write = false
private

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