com.nativeExtensions.saf.DocumentLegacy

	Property	Defined By
		androidUri : String [static] [read-only] Get the Android folder Uri.	DocumentLegacy
		dcimCameraUri : String [static] [read-only] Get the DCIM/Camera folder Uri.	DocumentLegacy
		dcimUri : String [static] [read-only] Get the DCIM folder Uri.	DocumentLegacy
		displayGallery : Boolean = false [static] Display Gallery for getUri(), read(), readAsync(), readBytes(), readBytesAsync().	DocumentLegacy
		documentsUri : String [static] [read-only] Get the Documents folder Uri.	DocumentLegacy
		downloadUri : String [static] [read-only] Get the Download folder Uri.	DocumentLegacy
		mediaAudioUri : String [static] [read-only] Get media audio Uri.	DocumentLegacy
		mediaImagesUri : String [static] [read-only] Get media images Uri.	DocumentLegacy
		mediaVideoUri : String [static] [read-only] Get media video Uri.	DocumentLegacy
		picturesUri : String [static] [read-only] Get the Pictures folder Uri.	DocumentLegacy
		QUri : Class [static] [read-only] Check is Android Q Uri supported.	DocumentLegacy

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

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

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

Property Detail

androidUri

property

androidUri:String [read-only]

Get the Android folder Uri.

Implementation
public static function get androidUri():String

dcimCameraUri

property

dcimCameraUri:String [read-only]

Get the DCIM/Camera folder Uri.

Implementation
public static function get dcimCameraUri():String

dcimUri

property

dcimUri:String [read-only]

Get the DCIM folder Uri.

Implementation
public static function get dcimUri():String

displayGallery

property

public static var displayGallery:Boolean = false

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

         DocumentLegacy.displayGallery = true;
         DocumentLegacy.readBytesAsync("image/*", false, DocumentLegacy.mediaImagesUri);

This feature doesn't use SAF.

The default value is false.

documentsUri

property

documentsUri:String [read-only]

Get the Documents folder Uri.

Implementation
public static function get documentsUri():String

downloadUri

property

downloadUri:String [read-only]

Get the Download folder Uri.

Implementation
public static function get downloadUri():String

mediaAudioUri

property

mediaAudioUri:String [read-only]

Get media audio Uri.

Implementation
public static function get mediaAudioUri():String

mediaImagesUri

property

mediaImagesUri:String [read-only]

Get media images Uri.

Implementation
public static function get mediaImagesUri():String

mediaVideoUri

property

mediaVideoUri:String [read-only]

Get media video Uri.

Implementation
public static function get mediaVideoUri():String

picturesUri

property

picturesUri:String [read-only]

Get the Pictures folder Uri.

Implementation
public static function get picturesUri():String

QUri

property

QUri:Class [read-only]

Check is Android Q Uri supported.

         DocumentLegacy.QUri.isSupported;

Implementation
public static function get QUri():Class

Method Detail

childExists

()

method

public static function childExists(uri:String, _name:String):String

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

Parameters

	`uri:String`

	`_name:String` — file or directory name

Returns

String — Uri

childrens

()

method

public static function childrens(uri:String, includeTrashUri:Boolean = false):Array

Get childrens Uri of a directory.

Parameters

	`uri:String`

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

Returns

Array — Array of Uri

create

()

method

 public static function create(title:String = file.txt, content:String, mimeType:String = text/plain, persist:Boolean = false, uri:String):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

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

createAsync

()

method

 public static function createAsync(title:String = file.txt, content:String, mimeType:String = text/plain, persist:Boolean = false, uri:String):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

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

createBytes

()

method

 public static function createBytes(title:String = file.txt, content:ByteArray = null, mimeType:String = text/plain, persist:Boolean = false, uri:String):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

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

createBytesAsync

()

method

 public static function createBytesAsync(title:String = file.txt, content:ByteArray = null, mimeType:String = text/plain, persist:Boolean = false, uri:String):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

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

createBytesFromUri

()

method

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

Create file from Uri.

Parameters

	`uri:String`

	`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 static function createBytesFromUriAsync(uri:String, title:String = image.png, content:ByteArray = null, mimeType:String = image/png, persist:Boolean = false):void

Create file from Uri asynchronously.

Parameters

	`uri:String`

	`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 static 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 static 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 static function createDir(title:String = dir, persist:Boolean = false, uri:String):void

Launch SAF to create directory.

Parameters

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

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

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

createDirFromUri

()

method

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

Create directory from Uri.

Parameters

	`uri:String`

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

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

Returns

String — Uri

createFromUri

()

method

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

Create text file from Uri.

Parameters

	`uri:String`

	`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 static function createFromUriAsync(uri:String, title:String = file.txt, content:String, mimeType:String = text/plain, persist:Boolean = false):void

Create text file from Uri asynchronously.

Parameters

	`uri:String`

	`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 static function deleteDir(uri:String):void

Launch SAF to delete directory.

Parameters

uri:String

deleteFile

()

method

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

Launch SAF to delete file.

Parameters

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

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

deleteFiles

()

method

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

Launch SAF to delete multiple files.

Parameters

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

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

deleteFromUri

()

method

public static function deleteFromUri(uri:String):Boolean

Delete file or directory from Uri.

Parameters

uri:String

Returns

Boolean

dispose

()

method

public static function dispose():void

Dispose extension context.

edit

()

method

public static function edit(content:String, mimeType:String = text/plain, persist:Boolean = false, uri:String):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

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

editAsync

()

method

 public static function editAsync(content:String, mimeType:String = text/plain, persist:Boolean = false, uri:String):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

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

editBytes

()

method

 public static function editBytes(content:ByteArray = null, mimeType:String = text/plain, persist:Boolean = false, uri:String):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

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

editBytesAsync

()

method

 public static function editBytesAsync(content:ByteArray = null, mimeType:String = text/plain, persist:Boolean = false, uri:String):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

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

editBytesFromUri

()

method

public static function editBytesFromUri(uri:String, content:ByteArray = null):String

Edit file from Uri.

Parameters

	`uri:String`

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

Returns

String — Uri

editBytesFromUriAsync

()

method

public static function editBytesFromUriAsync(uri:String, content:ByteArray = null):void

Edit file from Uri asynchronously.

Parameters

	`uri:String`

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

editFromUri

()

method

public static function editFromUri(uri:String, content:String):String

Edit text file from Uri.

Parameters

	`uri:String`

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

Returns

String — Uri

editFromUriAsync

()

method

public static function editFromUriAsync(uri:String, content:String):void

Edit text file from Uri asynchronously.

(iOS support)

Parameters

	`uri:String`

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

exists

()

method

public static function exists(uri:String):Boolean

Check is Uri exists.

Parameters

uri:String

Returns

Boolean

galleryUri

()

method

public static function galleryUri(uri:String):String

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

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

Parameters

uri:String

Returns

String — Uri

getExtension

()

method

public static 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 static function getFileFromBookmarkData(bookmarkData:String):File

Get File from bookmark data.

(iOS only)

Parameters

bookmarkData:String — security-scoped bookmark data

Returns

File

getMimeTypeFromExtension

()

method

public static 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)

getMimeTypeFromUri

()

method

public static function getMimeTypeFromUri(uri:String):String

Get mime type from Uri.

Parameters

uri:String

Returns

String — mime type

getPathFromUri

()

method

public static function getPathFromUri(uri:String):String

Get file path from Uri if possible.

Parameters

uri:String

Returns

String — file path

getUri

()

method

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

Launch SAF to get file Uri.

(iOS support)

Parameters

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

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

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

getUriFromDir

()

method

public static function getUriFromDir(persist:Boolean = false, uri:String):void

Launch SAF to get directory Uri.

(iOS support)

Parameters

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

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

getUriMultiple

()

method

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

Launch SAF to get multiple files Uri.

(iOS support)

Parameters

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

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

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

isDirectory

()

method

public static function isDirectory(uri:String):Boolean

Check Uri is directory.

Parameters

uri:String

Returns

Boolean

isDocumentUri

()

method

public static function isDocumentUri(uri:String):Boolean

Check Uri is document Uri.

Parameters

uri:String

Returns

Boolean

isPersistableUri

()

method

public static function isPersistableUri(uri:String):Boolean

Check is persistable Uri.

Parameters

uri:String

Returns

Boolean

name

()

method

public static function name(uri:String):String

Get file or directory name.

Parameters

uri:String

Returns

String — file name

parentDirectory

()

method

public static function parentDirectory(uri:String):String

Get parent directory.

Parameters

uri:String

Returns

String — Uri

read

()

method

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

Launch SAF to read text file.

Parameters

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

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

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

readAsync

()

method

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

Launch SAF to read text file totally asynchronously.

Parameters

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

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

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

readBytes

()

method

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

Launch SAF to read files.

Parameters

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

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

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

readBytesAsync

()

method

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

Launch SAF to read files totally asynchronously.

Parameters

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

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

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

readBytesFromUri

()

method

public static function readBytesFromUri(uri:String):ByteArray

Read file from Uri.

Parameters

uri:String

Returns

ByteArray — bytes

readBytesFromUriAsync

()

method

public static function readBytesFromUriAsync(uri:String):void

Read file from Uri asynchronously.

Parameters

uri:String

readBytesMultiple

()

method

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

Launch SAF to read multiple files.

Parameters

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

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

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

readBytesMultipleAsync

()

method

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

Launch SAF to read files totally asynchronously.

Parameters

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

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

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

readFromUri

()

method

public static function readFromUri(uri:String):String

Read text file from Uri.

Parameters

uri:String

Returns

String — text

readFromUriAsync

()

method

public static function readFromUriAsync(uri:String):void

Read text file from Uri asynchronously.

Parameters

uri:String

readMultiple

()

method

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

Launch SAF to read multiple text files.

Parameters

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

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

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

readMultipleAsync

()

method

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

Launch SAF to read multiple text file totally asynchronously.

Parameters

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

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

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

removePersistableUri

()

method

public static function removePersistableUri(uri:String):void

Remove persistable Uri.

Parameters

uri:String

rename

()

method

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

Rename file or directory.

Parameters

	`uri:String`

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

Returns

String — Uri

size

()

method

public static function size(uri:String):Number

Get the file size in bytes.

Parameters

uri:String

Returns

Number — file size

startAccessingSecurityScopedResource

()

method

public static 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 static 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 static function takePersistableUri(uri:String):void

Take persistable Uri if possible.

Parameters

uri:String

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
DocumentLegacy	Properties \| Methods \| Events \| Constants

Package	com.nativeExtensions.saf
Class	public class DocumentLegacy
Inheritance	DocumentLegacy Object