com.nativeExtensions.saf.Document

	Property	Defined By
		androidDirectory : Document [static] [read-only] Get the Android folder.	Document
		androidUri : String [read-only] Get the Android folder Uri.	Document
		dcimCameraDirectory : Document [static] [read-only] Get the DCIM/Camera folder.	Document
		dcimCameraUri : String [read-only] Get the DCIM/Camera folder Uri.	Document
		dcimDirectory : Document [static] [read-only] Get the DCIM folder.	Document
		dcimUri : String [read-only] Get the DCIM folder Uri.	Document
		displayGallery : Boolean = false Display Gallery for getUri(), read(), readAsync(), readBytes(), readBytesAsync().	Document
		documentsDirectory : Document [static] [read-only] Get the Documents folder.	Document
		documentsUri : String [read-only] Get the Documents folder Uri.	Document
		downloadDirectory : Document [static] [read-only] Get the Download folder.	Document
		downloadUri : String [read-only] Get the Download folder Uri.	Document
		exists : Boolean [read-only] Check is Uri exists.	Document
		isDirectory : Boolean [read-only] Check Uri is directory.	Document
		isDocumentUri : Boolean [read-only] Check Uri is document Uri.	Document
		isPersistableUri : Boolean [read-only] Check is persistable Uri.	Document
		mediaAudioUri : String [read-only] Get media audio Uri.	Document
		mediaImagesUri : String [read-only] Get media images Uri.	Document
		mediaVideoUri : String [read-only] Get media video Uri.	Document
		mimeType : String [read-only] Get mime type.	Document
		name : String [read-only] Get file or directory name.	Document
		onlyUpdateUriInAsynchronousTasks : Boolean = true The Uri is only updated in asynchronous tasks (listeners).	Document
		parentDirectory : String [read-only] Get parent directory.	Document
		picturesDirectory : Document [static] [read-only] Get the Pictures folder.	Document
		picturesUri : String [read-only] Get the Pictures folder Uri.	Document
		QUri : Class [read-only] Check is Android Q Uri supported.	Document
		size : Number [read-only] Get the file size in bytes.	Document
		uri : String Document Uri.	Document

	Method	Defined By
		Document(uri:String) The constructor function for the Document class.	Document
		childExists(name:String):String Check is a file or a subdirectory exists in a directory.	Document
		childrens(includeTrashUri:Boolean = false):Array Get childrens Uri of a directory.	Document
		create(title:String = file.txt, content:String, mimeType:String = text/plain, persist:Boolean = false):void Launch SAF to create text file.	Document
		createAsync(title:String = file.txt, content:String, mimeType:String = text/plain, persist:Boolean = false):void Launch SAF to create text file totally asynchronously.	Document
		createBytes(title:String = file.txt, content:ByteArray = null, mimeType:String = text/plain, persist:Boolean = false):void Launch SAF to create file.	Document
		createBytesAsync(title:String = file.txt, content:ByteArray = null, mimeType:String = text/plain, persist:Boolean = false):void Launch SAF to create file totally asynchronously.	Document
		createBytesFromUri(title:String = image.png, content:ByteArray = null, mimeType:String = image/png, persist:Boolean = false):String Create file from Uri.	Document
		createBytesFromUriAsync(title:String = image.png, content:ByteArray = null, mimeType:String = image/png, persist:Boolean = false):void Create file from Uri asynchronously.	Document
		createBytesToGallery(title:String = null, content:ByteArray = null, mimeType:String = image/png, directory:String, mediaUri:String = null):String Create file to Gallery.	Document
		createBytesToGalleryAsync(title:String = null, content:ByteArray = null, mimeType:String = image/png, directory:String, mediaUri:String = null):void Create file to Gallery asynchronously.	Document
		createDir(title:String = dir, persist:Boolean = false):void Launch SAF to create directory.	Document
		createDirFromUri(title:String = dir, persist:Boolean = false):String Create directory from Uri.	Document
		createFromUri(title:String = file.txt, content:String, mimeType:String = text/plain, persist:Boolean = false):String Create text file from Uri.	Document
		createFromUriAsync(title:String = file.txt, content:String, mimeType:String = text/plain, persist:Boolean = false):void Create text file from Uri asynchronously.	Document
		deleteDir():void Launch SAF to delete directory.	Document
		deleteFile(mimeType:String = text/plain):void Launch SAF to delete file.	Document
		deleteFiles(mimeType:String = text/plain):void Launch SAF to delete multiple files.	Document
		deleteFromUri():Boolean Delete file or directory from Uri.	Document
		dispose():void Dispose extension context.	Document
		edit(content:String, mimeType:String = text/plain, persist:Boolean = false):void Launch SAF to edit text file.	Document
		editAsync(content:String, mimeType:String = text/plain, persist:Boolean = false):void Launch SAF to edit text file totally asynchronously.	Document
		editBytes(content:ByteArray = null, mimeType:String = text/plain, persist:Boolean = false):void Launch SAF to edit file.	Document
		editBytesAsync(content:ByteArray = null, mimeType:String = text/plain, persist:Boolean = false):void Launch SAF to edit file totally asynchronously.	Document
		editBytesFromUri(content:ByteArray = null):String Edit file from Uri.	Document
		editBytesFromUriAsync(content:ByteArray = null):void Edit file from Uri asynchronously.	Document
		editFromUri(content:String):String Edit text file from Uri.	Document
		editFromUriAsync(content:String):void Edit text file from Uri asynchronously.	Document
		galleryUri():String Get Uri from Gallery Uri (used when displayGallery = true).	Document
		getExtension(mimeType:String = text/*):String Get extension from mime type.	Document
		getFileFromBookmarkData(bookmarkData:String):File Get File from bookmark data.	Document
		getMimeTypeFromExtension(extension:String = txt):String Get mime type from file extension.	Document
		getPathFromUri():String Get file path from Uri if possible.	Document
		getUri(mimeType:String = text/*, persist:Boolean = false):void Launch SAF to get file Uri.	Document
		getUriFromDir(persist:Boolean = false):void Launch SAF to get directory Uri.	Document
		getUriMultiple(mimeType:String = text/*, persist:Boolean = false):void Launch SAF to get multiple files Uri.	Document
		read(mimeType:String = text/*, persist:Boolean = false):void Launch SAF to read text file.	Document
		readAsync(mimeType:String = text/*, persist:Boolean = false):void Launch SAF to read text file totally asynchronously.	Document
		readBytes(mimeType:String = text/*, persist:Boolean = false):void Launch SAF to read files.	Document
		readBytesAsync(mimeType:String = text/*, persist:Boolean = false):void Launch SAF to read files totally asynchronously.	Document
		readBytesFromUri():ByteArray Read file from Uri.	Document
		readBytesFromUriAsync():void Read file from Uri asynchronously.	Document
		readBytesMultiple(mimeType:String = text/*, persist:Boolean = false):void Launch SAF to read multiple files.	Document
		readBytesMultipleAsync(mimeType:String = text/*, persist:Boolean = false):void Launch SAF to read files totally asynchronously.	Document
		readFromUri():String Read text file from Uri.	Document
		readFromUriAsync():void Read text file from Uri asynchronously.	Document
		readMultiple(mimeType:String = text/*, persist:Boolean = false):void Launch SAF to read multiple text files.	Document
		readMultipleAsync(mimeType:String = text/*, persist:Boolean = false):void Launch SAF to read multiple text file totally asynchronously.	Document
		removePersistableUri():void Remove persistable Uri.	Document
		rename(title:String = file.txt):String Rename file or directory.	Document
		startAccessingSecurityScopedResource(bookmarkData:String):Boolean In an app that has adopted App Sandbox, makes the resource pointed to by a security-scoped URL available to the app.	Document
		stopAccessingSecurityScopedResource(bookmarkData:String):void In an app that adopts App Sandbox, revokes access to the resource pointed to by a security-scoped URL.	Document
		takePersistableUri():void Take persistable Uri if possible.	Document

Summary	Defined By
cancel	Dispatched when SAF is canceled.	Document
delete	Dispatched when a file or a directory is deleted.	Document
edit	Dispatched when SAF create or edit file.	Document
IOErrorEvent	Dispatched when a SAF error occurred.	Document
read	Dispatched when SAF get a file text content or an Uri.	Document
readBytes	Dispatched when SAF get a file content.	Document

	Constant	Defined By
		DCIM_CAMERA_DIRECTORY : String = DCIM/Camera [static] DCIM/camera directory	Document
		DCIM_DIRECTORY : String = DCIM [static] DCIM directory	Document
		DOCUMENTS_DIRECTORY : String = Documents [static] Documents directory	Document
		DOWNLOADS_DIRECTORY : String = Downloads [static] Downloads directory	Document
		PICTURES_DIRECTORY : String = Pictures [static] Pictures directory	Document

Property Detail

androidDirectory

property

androidDirectory:Document [read-only]

Get the Android folder.

Implementation
public static function get androidDirectory():Document

androidUri

property

androidUri:String [read-only]

Get the Android folder Uri.

Implementation
public function get androidUri():String

dcimCameraDirectory

property

dcimCameraDirectory:Document [read-only]

Get the DCIM/Camera folder.

Implementation
public static function get dcimCameraDirectory():Document

dcimCameraUri

property

dcimCameraUri:String [read-only]

Get the DCIM/Camera folder Uri.

Implementation
public function get dcimCameraUri():String

dcimDirectory

property

dcimDirectory:Document [read-only]

Get the DCIM folder.

Implementation
public static function get dcimDirectory():Document

dcimUri

property

dcimUri:String [read-only]

Get the DCIM folder Uri.

Implementation
public function get dcimUri():String

displayGallery

property

public var displayGallery:Boolean = false

Display Gallery for getUri(), read(), readAsync(), readBytes(), readBytesAsync().

         var document:Document = new Document();
         document.displayGallery = true;
         document.readBytesAsync("image/*", false, document.mediaImagesUri);

This feature doesn't use SAF.

The default value is false.

documentsDirectory

property

documentsDirectory:Document [read-only]

Get the Documents folder.

Implementation
public static function get documentsDirectory():Document

documentsUri

property

documentsUri:String [read-only]

Get the Documents folder Uri.

Implementation
public function get documentsUri():String

downloadDirectory

property

downloadDirectory:Document [read-only]

Get the Download folder.

Implementation
public static function get downloadDirectory():Document

downloadUri

property

downloadUri:String [read-only]

Get the Download folder Uri.

Implementation
public function get downloadUri():String

exists

property

exists:Boolean [read-only]

Check is Uri exists.

Implementation
public function get exists():Boolean

isDirectory

property

isDirectory:Boolean [read-only]

Check Uri is directory.

Implementation
public function get isDirectory():Boolean

isDocumentUri

property

isDocumentUri:Boolean [read-only]

Check Uri is document Uri.

Implementation
public function get isDocumentUri():Boolean

isPersistableUri

property

isPersistableUri:Boolean [read-only]

Check is persistable Uri.

Implementation
public function get isPersistableUri():Boolean

mediaAudioUri

property

mediaAudioUri:String [read-only]

Get media audio Uri.

Implementation
public function get mediaAudioUri():String

mediaImagesUri

property

mediaImagesUri:String [read-only]

Get media images Uri.

Implementation
public function get mediaImagesUri():String

mediaVideoUri

property

mediaVideoUri:String [read-only]

Get media video Uri.

Implementation
public function get mediaVideoUri():String

mimeType

property

mimeType:String [read-only]

Get mime type.

Implementation
public function get mimeType():String

name

property

name:String [read-only]

Get file or directory name.

Implementation
public function get name():String

onlyUpdateUriInAsynchronousTasks

property

public var onlyUpdateUriInAsynchronousTasks:Boolean = true

The Uri is only updated in asynchronous tasks (listeners).

The default value is true.

parentDirectory

property

parentDirectory:String [read-only]

Get parent directory.

Implementation
public function get parentDirectory():String

picturesDirectory

property

picturesDirectory:Document [read-only]

Get the Pictures folder.

Implementation
public static function get picturesDirectory():Document

picturesUri

property

picturesUri:String [read-only]

Get the Pictures folder Uri.

Implementation
public function get picturesUri():String

QUri

property

QUri:Class [read-only]

Check is Android Q Uri supported.

         var document:Document = new Document();
         document.QUri.isSupported;

Implementation
public function get QUri():Class

size

property

size:Number [read-only]

Get the file size in bytes.

Implementation
public function get size():Number

uri

property

uri:String

Document Uri.

The default value is "".

Implementation
public function get uri():String
public function set uri(value:String):void

Constructor Detail

Document

()

Constructor

public function Document(uri:String)

The constructor function for the Document class.

Parameters

uri:String — (default = "") location to open SAF

Method Detail

childExists

()

method

public function childExists(name:String):String

Check is a file or a subdirectory exists in a directory.

Parameters

name:String — file or directory name

Returns

String — Uri

childrens

()

method

public function childrens(includeTrashUri:Boolean = false):Array

Get childrens Uri of a directory.

Parameters

includeTrashUri:Boolean (default = false) — include trash Uri

Returns

Array — Array of Uri

create

()

method

 public function create(title:String = file.txt, content:String, mimeType:String = text/plain, persist:Boolean = false):void

Launch SAF to create text file.

Parameters

	`title:String` (default = `file.txt`) — file name

	`content:String` — (default = "") file content

	`mimeType:String` (default = `text/plain`) — file mime type

	`persist:Boolean` (default = `false`) — persistable Uri

createAsync

()

method

 public function createAsync(title:String = file.txt, content:String, mimeType:String = text/plain, persist:Boolean = false):void

Launch SAF to create text file totally asynchronously.

Parameters

	`title:String` (default = `file.txt`) — file name

	`content:String` — (default = "") file content

	`mimeType:String` (default = `text/plain`) — file mime type

	`persist:Boolean` (default = `false`) — persistable Uri

createBytes

()

method

 public function createBytes(title:String = file.txt, content:ByteArray = null, mimeType:String = text/plain, persist:Boolean = false):void

Launch SAF to create file.

Parameters

	`title:String` (default = `file.txt`) — file name

	`content:ByteArray` (default = `null`) — file content

	`mimeType:String` (default = `text/plain`) — file mime type

	`persist:Boolean` (default = `false`) — persistable Uri

createBytesAsync

()

method

 public function createBytesAsync(title:String = file.txt, content:ByteArray = null, mimeType:String = text/plain, persist:Boolean = false):void

Launch SAF to create file totally asynchronously.

Parameters

	`title:String` (default = `file.txt`) — file name

	`content:ByteArray` (default = `null`) — file content

	`mimeType:String` (default = `text/plain`) — file mime type

	`persist:Boolean` (default = `false`) — persistable Uri

createBytesFromUri

()

method

 public function createBytesFromUri(title:String = image.png, content:ByteArray = null, mimeType:String = image/png, persist:Boolean = false):String

Create file from Uri.

Parameters

	`title:String` (default = `image.png`) — file name

	`content:ByteArray` (default = `null`) — content

	`mimeType:String` (default = `image/png`) — file mime type

	`persist:Boolean` (default = `false`) — persistable Uri

Returns

String — Uri

createBytesFromUriAsync

()

method

 public function createBytesFromUriAsync(title:String = image.png, content:ByteArray = null, mimeType:String = image/png, persist:Boolean = false):void

Create file from Uri asynchronously.

Parameters

	`title:String` (default = `image.png`) — file name

	`content:ByteArray` (default = `null`) — content

	`mimeType:String` (default = `image/png`) — file mime type

	`persist:Boolean` (default = `false`) — persistable Uri

createBytesToGallery

()

method

 public function createBytesToGallery(title:String = null, content:ByteArray = null, mimeType:String = image/png, directory:String, mediaUri:String = null):String

Create file to Gallery.

This feature doesn't use SAF.

Parameters

	`title:String` (default = `null`) — file name, default value is "AIR_SAF"

	`content:ByteArray` (default = `null`) — file content

	`mimeType:String` (default = `image/png`) — file mime type

	`directory:String` — (default = "") possible values are DCIM_DIRECTORY, DCIM_CAMERA_DIRECTORY, DOCUMENTS_DIRECTORY, DOWNLOADS_DIRECTORY or PICTURES_DIRECTORY

	`mediaUri:String` (default = `null`) — possible values are mediaImagesUri, mediaVideoUri or mediaAudioUri, default value is mediaImagesUri

Returns

String — Uri

createBytesToGalleryAsync

()

method

 public function createBytesToGalleryAsync(title:String = null, content:ByteArray = null, mimeType:String = image/png, directory:String, mediaUri:String = null):void

Create file to Gallery asynchronously.

This feature doesn't use SAF.

Parameters

	`title:String` (default = `null`) — file name, default value is "AIR_SAF"

	`content:ByteArray` (default = `null`) — file content

	`mimeType:String` (default = `image/png`) — file mime type

	`directory:String` — (default = "") possible values are DCIM_DIRECTORY, DCIM_CAMERA_DIRECTORY, DOCUMENTS_DIRECTORY, DOWNLOADS_DIRECTORY or PICTURES_DIRECTORY

	`mediaUri:String` (default = `null`) — possible values are mediaImagesUri, mediaVideoUri or mediaAudioUri, default value is mediaImagesUri

createDir

()

method

public function createDir(title:String = dir, persist:Boolean = false):void

Launch SAF to create directory.

Parameters

	`title:String` (default = `dir`) — file name

	`persist:Boolean` (default = `false`) — persistable Uri

createDirFromUri

()

method

public function createDirFromUri(title:String = dir, persist:Boolean = false):String

Create directory from Uri.

Parameters

	`title:String` (default = `dir`) — directory name

	`persist:Boolean` (default = `false`) — persistable Uri (deprecated, do not use)

Returns

String — Uri

createFromUri

()

method

 public function createFromUri(title:String = file.txt, content:String, mimeType:String = text/plain, persist:Boolean = false):String

Create text file from Uri.

Parameters

	`title:String` (default = `file.txt`) — file name

	`content:String` — (default = "") file content

	`mimeType:String` (default = `text/plain`) — file mime type

	`persist:Boolean` (default = `false`) — persistable Uri

Returns

String — Uri

createFromUriAsync

()

method

 public function createFromUriAsync(title:String = file.txt, content:String, mimeType:String = text/plain, persist:Boolean = false):void

Create text file from Uri asynchronously.

Parameters

	`title:String` (default = `file.txt`) — file name

	`content:String` — (default = "") file content

	`mimeType:String` (default = `text/plain`) — file mime type

	`persist:Boolean` (default = `false`) — persistable Uri

deleteDir

()

method

public function deleteDir():void

Launch SAF to delete directory.

deleteFile

()

method

public function deleteFile(mimeType:String = text/plain):void

Launch SAF to delete file.

Parameters

mimeType:String (default = text/plain) — file mime type

deleteFiles

()

method

public function deleteFiles(mimeType:String = text/plain):void

Launch SAF to delete multiple files.

Parameters

mimeType:String (default = text/plain) — file mime type

deleteFromUri

()

method

public function deleteFromUri():Boolean

Delete file or directory from Uri.

Returns

Boolean

dispose

()

method

public function dispose():void

Dispose extension context.

edit

()

method

public function edit(content:String, mimeType:String = text/plain, persist:Boolean = false):void

Launch SAF to edit text file.

Parameters

	`content:String` — (default = "") file content

	`mimeType:String` (default = `text/plain`) — file mime type

	`persist:Boolean` (default = `false`) — persistable Uri

editAsync

()

method

public function editAsync(content:String, mimeType:String = text/plain, persist:Boolean = false):void

Launch SAF to edit text file totally asynchronously.

Parameters

	`content:String` — (default = "") file content

	`mimeType:String` (default = `text/plain`) — file mime type

	`persist:Boolean` (default = `false`) — persistable Uri

editBytes

()

method

public function editBytes(content:ByteArray = null, mimeType:String = text/plain, persist:Boolean = false):void

Launch SAF to edit file.

Parameters

	`content:ByteArray` (default = `null`) — file content

	`mimeType:String` (default = `text/plain`) — file mime type

	`persist:Boolean` (default = `false`) — persistable Uri

editBytesAsync

()

method

public function editBytesAsync(content:ByteArray = null, mimeType:String = text/plain, persist:Boolean = false):void

Launch SAF to edit file totally asynchronously.

Parameters

	`content:ByteArray` (default = `null`) — file content

	`mimeType:String` (default = `text/plain`) — file mime type

	`persist:Boolean` (default = `false`) — persistable Uri

editBytesFromUri

()

method

public function editBytesFromUri(content:ByteArray = null):String

Edit file from Uri.

Parameters

content:ByteArray (default = null) — file content

Returns

String — Uri

editBytesFromUriAsync

()

method

public function editBytesFromUriAsync(content:ByteArray = null):void

Edit file from Uri asynchronously.

Parameters

content:ByteArray (default = null) — file content

editFromUri

()

method

public function editFromUri(content:String):String

Edit text file from Uri.

Parameters

content:String — (default = "") file content

Returns

String — Uri

editFromUriAsync

()

method

public function editFromUriAsync(content:String):void

Edit text file from Uri asynchronously.

(iOS support)

Parameters

content:String — (default = "") file content

galleryUri

()

method

public function galleryUri():String

Get Uri from Gallery Uri (used when displayGallery = true).

Need File PermissionStatus.GRANTED when the file was created by another app.

Returns

String — Uri

getExtension

()

method

public function getExtension(mimeType:String = text/*):String

Get extension from mime type.

(iOS support)

Parameters

mimeType:String (default = text/*) — file mime type (or UTI on iOS)

Returns

String — file extension

getFileFromBookmarkData

()

method

public function getFileFromBookmarkData(bookmarkData:String):File

Get File from bookmark data.

(iOS only)

Parameters

bookmarkData:String — security-scoped bookmark data

Returns

File

getMimeTypeFromExtension

()

method

public function getMimeTypeFromExtension(extension:String = txt):String

Get mime type from file extension.

(iOS support)

Parameters

extension:String (default = txt) — file extension

Returns

String — mime type (or UTI on iOS)

getPathFromUri

()

method

public function getPathFromUri():String

Get file path from Uri if possible.

Returns

String — file path

getUri

()

method

public function getUri(mimeType:String = text/*, persist:Boolean = false):void

Launch SAF to get file Uri.

(iOS support)

Parameters

	`mimeType:String` (default = `text/*`) — file mime type

	`persist:Boolean` (default = `false`) — persistable Uri

getUriFromDir

()

method

public function getUriFromDir(persist:Boolean = false):void

Launch SAF to get directory Uri.

(iOS support)

Parameters

persist:Boolean (default = false) — persistable Uri

getUriMultiple

()

method

public function getUriMultiple(mimeType:String = text/*, persist:Boolean = false):void

Launch SAF to get multiple files Uri.

(iOS support)

Parameters

	`mimeType:String` (default = `text/*`) — file mime type

	`persist:Boolean` (default = `false`) — persistable Uri

read

()

method

public function read(mimeType:String = text/*, persist:Boolean = false):void

Launch SAF to read text file.

Parameters

	`mimeType:String` (default = `text/*`) — file mime type

	`persist:Boolean` (default = `false`) — persistable Uri

readAsync

()

method

public function readAsync(mimeType:String = text/*, persist:Boolean = false):void

Launch SAF to read text file totally asynchronously.

Parameters

	`mimeType:String` (default = `text/*`) — file mime type

	`persist:Boolean` (default = `false`) — persistable Uri

readBytes

()

method

public function readBytes(mimeType:String = text/*, persist:Boolean = false):void

Launch SAF to read files.

Parameters

	`mimeType:String` (default = `text/*`) — file mime type

	`persist:Boolean` (default = `false`) — persistable Uri

readBytesAsync

()

method

public function readBytesAsync(mimeType:String = text/*, persist:Boolean = false):void

Launch SAF to read files totally asynchronously.

Parameters

	`mimeType:String` (default = `text/*`) — file mime type

	`persist:Boolean` (default = `false`) — persistable Uri

readBytesFromUri

()

method

public function readBytesFromUri():ByteArray

Read file from Uri.

Returns

ByteArray — bytes

readBytesFromUriAsync

()

method

public function readBytesFromUriAsync():void

Read file from Uri asynchronously.

readBytesMultiple

()

method

public function readBytesMultiple(mimeType:String = text/*, persist:Boolean = false):void

Launch SAF to read multiple files.

Parameters

	`mimeType:String` (default = `text/*`) — file mime type

	`persist:Boolean` (default = `false`) — persistable Uri

readBytesMultipleAsync

()

method

public function readBytesMultipleAsync(mimeType:String = text/*, persist:Boolean = false):void

Launch SAF to read files totally asynchronously.

Parameters

	`mimeType:String` (default = `text/*`) — file mime type

	`persist:Boolean` (default = `false`) — persistable Uri

readFromUri

()

method

public function readFromUri():String

Read text file from Uri.

Returns

String — text

readFromUriAsync

()

method

public function readFromUriAsync():void

Read text file from Uri asynchronously.

readMultiple

()

method

public function readMultiple(mimeType:String = text/*, persist:Boolean = false):void

Launch SAF to read multiple text files.

Parameters

	`mimeType:String` (default = `text/*`) — file mime type

	`persist:Boolean` (default = `false`) — persistable Uri

readMultipleAsync

()

method

public function readMultipleAsync(mimeType:String = text/*, persist:Boolean = false):void

Launch SAF to read multiple text file totally asynchronously.

Parameters

	`mimeType:String` (default = `text/*`) — file mime type

	`persist:Boolean` (default = `false`) — persistable Uri

removePersistableUri

()

method

public function removePersistableUri():void

Remove persistable Uri.

rename

()

method

public function rename(title:String = file.txt):String

Rename file or directory.

Parameters

title:String (default = file.txt) — file name

Returns

String — Uri

startAccessingSecurityScopedResource

()

method

public function startAccessingSecurityScopedResource(bookmarkData:String):Boolean

In an app that has adopted App Sandbox, makes the resource pointed to by a security-scoped URL available to the app.

(iOS only)

Parameters

bookmarkData:String — security-scoped bookmark data

Returns

Boolean

stopAccessingSecurityScopedResource

()

method

public function stopAccessingSecurityScopedResource(bookmarkData:String):void

In an app that adopts App Sandbox, revokes access to the resource pointed to by a security-scoped URL.

(iOS only)

Parameters

bookmarkData:String — security-scoped bookmark data

takePersistableUri

()

method

public function takePersistableUri():void

Take persistable Uri if possible.

Event Detail

cancel

Event

Event Object Type: com.nativeExtensions.saf.DocumentEvent

Dispatched when SAF is canceled.

delete

Event

Event Object Type: com.nativeExtensions.saf.DocumentEvent

Dispatched when a file or a directory is deleted.

edit

Event

Event Object Type: com.nativeExtensions.saf.DocumentEvent

Dispatched when SAF create or edit file.

IOErrorEvent

Event

Event Object Type: flash.events.IOErrorEvent

Dispatched when a SAF error occurred.

read

Event

Event Object Type: com.nativeExtensions.saf.DocumentEvent

Dispatched when SAF get a file text content or an Uri.

readBytes

Event

Event Object Type: com.nativeExtensions.saf.DocumentEvent

Dispatched when SAF get a file content.

Constant Detail

DCIM_CAMERA_DIRECTORY

Constant

public static const DCIM_CAMERA_DIRECTORY:String = DCIM/Camera

DCIM/camera directory

DCIM_DIRECTORY

Constant

public static const DCIM_DIRECTORY:String = DCIM

DCIM directory

DOCUMENTS_DIRECTORY

Constant

public static const DOCUMENTS_DIRECTORY:String = Documents

Documents directory

DOWNLOADS_DIRECTORY

Constant

public static const DOWNLOADS_DIRECTORY:String = Downloads

Downloads directory

PICTURES_DIRECTORY

Constant

public static const PICTURES_DIRECTORY:String = Pictures

Pictures directory

Dimanche Décembre 29 2024, 01:24 AM +01:00

Android Storage Access Framework AS3 Documentation	All Packages \| All Classes \| Index \| Frames No Frames
Document	Properties \| Methods \| Events \| Constants

Package	com.nativeExtensions.saf
Class	public class Document
Inheritance	Document flash.events.EventDispatcher