juce::AndroidDocumentPermission Class Reference

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

#include "juce_AndroidDocument.h"

Public Member Functions
URL	getUrl () const
	The url of the document with persisted permissions.
int64	getPersistedTime () const
	The time when the permissions were persisted, in milliseconds since January 1, 1970 00:00:00.0 UTC.
bool	isReadPermission () const
	True if the permission allows read access.
bool	isWritePermission () const
	True if the permission allows write access.

Static Public Member Functions
static void	takePersistentReadWriteAccess (const URL &)
	Gives your app access to a particular document or tree, even after the device is rebooted.
static void	releasePersistentReadWriteAccess (const URL &)
	Revokes persistent access to a document or tree.
static std::vector< AndroidDocumentPermission >	getPersistedPermissions ()
	Returns all of the permissions that have previously been granted to the app, via takePersistentReadWriteAccess();.

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}

Definition at line 169 of file juce_AndroidDocument.h.

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();.

Definition at line 761 of file juce_AndroidDocument_android.cpp.

getPersistedTime()

int64 juce::AndroidDocumentPermission::getPersistedTime

(

)

const

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

Definition at line 176 of file juce_AndroidDocument.h.

getUrl()

URL juce::AndroidDocumentPermission::getUrl

(

)

const

The url of the document with persisted permissions.

Definition at line 173 of file juce_AndroidDocument.h.

isReadPermission()

bool juce::AndroidDocumentPermission::isReadPermission

(

)

const

True if the permission allows read access.

Definition at line 179 of file juce_AndroidDocument.h.

isWritePermission()

bool juce::AndroidDocumentPermission::isWritePermission

(

)

const

True if the permission allows write access.

Definition at line 182 of file juce_AndroidDocument.h.

releasePersistentReadWriteAccess()

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

static

Revokes persistent access to a document or tree.

Definition at line 754 of file juce_AndroidDocument_android.cpp.

takePersistentReadWriteAccess()

void juce::AndroidDocumentPermission::takePersistentReadWriteAccess ( const URL &  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.

Definition at line 747 of file juce_AndroidDocument_android.cpp.

---

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

• juce_core/files/juce_AndroidDocument.h
• juce_core/native/juce_AndroidDocument_android.cpp