Skip to content

Latest commit

 

History

History
316 lines (278 loc) · 53.8 KB

working-with-the-air-apis.md

File metadata and controls

316 lines (278 loc) · 53.8 KB

Working with the AIR APIs

Adobe® AIR® includes functionality that is not available to SWF content running in Adobe® Flash® Player.

ActionScript 3.0 Developers

The Adobe AIR APIs are documented in the following two books:

HTML Developers

If you're building HTML-based AIR applications, the APIs that are available to you in JavaScript via the AIRAliases.js file (see Accessing AIR API classes from JavaScript) are documented in the following two books:

AIR-specific ActionScript 3.0 classes

The following table contains runtime classes are specific to Adobe AIR. They are not available to SWF content running in Adobe® Flash® Player in the browser.

HTML Developers

The classes that are available to you in JavaScript via the AIRAliases.js file are listed in Adobe AIR API Reference for HTML Developers.

Class ActionScript 3.0 Package Added in AIR version
ARecord flash.net.dns 2.0
AAAARecord flash.net.dns 2.0
ApplicationUpdater air.update 1.5
ApplicationUpdaterUI air.update 1.5
AudioPlaybackMode flash.media 3.0
AutoCapitalize flash.text 3.0
BrowserInvokeEvent flash.events 1.0
CameraPosition flash.media 3.0
CameraRoll flash.media 2.0
CameraRollBrowseOptions flash.media 3.0
CameraUI flash.media 2.5
CertificateStatus flash.security 2.0
CompressionAlgorithm flash.utils 1.0
DatagramSocket flash.net 2.0
DatagramSocketDataEvent flash.events 2.0
DNSResolver flash.net.dns 2.0
DNSResolverEvent flash.events 2.0
DockIcon flash.desktop 1.0
DownloadErrorEvent air.update.events 1.5
DRMAuthenticateEvent flash.events 1.0
DRMDeviceGroup flash.net.drm 3.0
DRMDeviceGroupErrorEvent flash.net.drm 3.0
DRMDeviceGroupEvent flash.net.drm 3.0
DRMManagerError flash.errors 1.5
EncryptedLocalStore flash.data 1.0
ExtensionContext flash.external 2.5
File flash.filesystem 1.0
FileListEvent flash.events 1.0
FileMode flash.filesystem 1.0
FileStream flash.filesystem 1.0
FocusDirection flash.display 1.0
GameInput flash.ui 3.0
GameInputControl flash.ui 3.0
GameInputControlType flash.ui 3.6 and earlier; dropped, as of 3.7
GameInputDevice flash.ui 3.0
GameInputEvent flash.ui 3.0
GameInputFinger flash.ui 3.6 and earlier; dropped, as of 3.7
GameInputHand flash.ui 3.6 and earlier; dropped, as of 3.7
Geolocation flash.sensors 2.0
GeolocationEvent flash.events 2.0
HTMLHistoryItem flash.html 1.0
HTMLHost flash.html 1.0
HTMLLoader flash.html 1.0
HTMLPDFCapability flash.html 1.0
HTMLSWFCapabiltiy flash.html 2.0
HTMLUncaughtScriptExceptionEvent flash.events 1.0
HTMLWindowCreateOptions flash.html 1.0
Icon flash.desktop 1.0
IFilePromise flash.desktop 2.0
ImageDecodingPolicy flash.system 2.6
InteractiveIcon flash.desktop 1.0
InterfaceAddress flash.net 2.0
InvokeEvent flash.events 1.0
InvokeEventReason flash.desktop 1.5.1
IPVersion flash.net 2.0
IURIDereferencer flash.security 1.0
LocationChangeEvent flash.events 2.5
MediaEvent flash.events 2.5
MediaPromise flash.media 2.5
MediaType flash.media 2.5
MXRecord flash.net.dns 2.0
NativeApplication flash.desktop 1.0
NativeDragActions flash.desktop 1.0
NativeDragEvent flash.events 1.0
NativeDragManager flash.desktop 1.0
NativeDragOptions flash.desktop 1.0
NativeMenu flash.display 1.0
NativeMenuItem flash.display 1.0
NativeProcess flash.desktop 2.0
NativeProcessExitEvent flash.events 2.0
NativeProcessStartupInfo flash.desktop 2.0
NativeWindow flash.display 1.0
NativeWindowBoundsEvent flash.events 1.0
NativeWindowDisplayState flash.display 1.0
NativeWindowDisplayStateEvent flash.events 1.0
NativeWindowInitOptions flash.display 1.0
NativeWindowRenderMode flash.display 3.0
NativeWindowResize flash.display 1.0
NativeWindowSystemChrome flash.display 1.0
NativeWindowType flash.display 1.0
NetworkInfo flash.net 2.0
NetworkInterface flash.net 2.0
NotificationType flash.desktop 1.0
OutputProgressEvent flash.events 1.0
PaperSize flash.printing 2.0
PrintMethod flash.printing 2.0
PrintUIOptions flash.printing 2.0
PTRRecord flash.net.dns 2.0
ReferencesValidationSetting flash.security 1.0
ResourceRecord flash.net.dns 2.0
RevocationCheckSettings flash.security 1.0
Screen flash.display 1.0
ScreenMouseEvent flash.events 1.0
SecureSocket flash.net 2.0
SecureSocketMonitor air.net 2.0
ServerSocket flash.net 2.0
ServerSocketConnectEvent flash.events 2.0
ServiceMonitor air.net 1.0
SignatureStatus flash.security 1.0
SignerTrustSettings flash.security 1.0
SocketMonitor air.net 1.0
SoftKeyboardType flash.text 3.0
SQLCollationType flash.data 1.0
SQLColumnNameStyle flash.data 1.0
SQLColumnSchema flash.data 1.0
SQLConnection flash.data 1.0
SQLError flash.errors 1.0
SQLErrorEvent flash.events 1.0
SQLErrorOperation flash.errors 1.0
SQLEvent flash.events 1.0
SQLIndexSchema flash.data 1.0
SQLMode flash.data 1.0
SQLResult flash.data 1.0
SQLSchema flash.data 1.0
SQLSchemaResult flash.data 1.0
SQLStatement flash.data 1.0
SQLTableSchema flash.data 1.0
SQLTransactionLockType flash.data 1.0
SQLTriggerSchema flash.data 1.0
SQLUpdateEvent flash.events 1.0
SQLViewSchema flash.data 1.0
SRVRecord flash.net.dns 2.0
StageAspectRatio flash.display 2.0
StageOrientation flash.display 2.0
StageOrientationEvent flash.events 2.0
StageText flash.text 3.0
StageTextInitOptions flash.text 3.0
StageWebView flash.media 2.5
StatusFileUpdateErrorEvent air.update.events 1.5
StatusFileUpdateEvent air.update.events 1.5
StatusUpdateErrorEvent air.update.events 1.5
StatusUpdateEvent air.update.events 1.5
StorageVolume flash.filesystem 2.0
StorageVolumeChangeEvent flash.events 2.0
StorageVolumeInfo flash.filesystem 2.0
SystemIdleMode flash.desktop 2.0
SystemTrayIcon flash.desktop 1.0
TouchEventIntent flash.events 3.0
UpdateEvent air.update.events 1.5
Updater flash.desktop 1.0
URLFilePromise air.desktop 2.0
URLMonitor air.net 1.0
URLRequestDefaults flash.net 1.0
XMLSignatureValidator flash.security 1.0

Flash Player classes with AIR-specific functionality

The following classes are available to SWF content running in the browser, but AIR provides additional properties or methods:

Package Class Property, method, or event Added in AIR version
flash.desktop Clipboard supportsFilePromise 2.0
ClipboardFormats BITMAP_FORMAT 1.0
FILE_LIST_FORMAT 1.0
FILE_PROMISE_LIST_FORMAT 2.0
URL_FORMAT 1.0
flash.display LoaderInfo childSandboxBridge 1.0
parentSandboxBridge 1.0
Stage assignFocus() 1.0
autoOrients 2.0
deviceOrientation 2.0
nativeWindow 1.0
orientation 2.0
orientationChange event 2.0
orientationChanging event 2.0
setAspectRatio 2.0
setOrientation 2.0
softKeyboardRect 2.6
supportedOrientations 2.6
supportsOrientationChange 2.0
NativeWindow owner 2.6
listOwnedWindows 2.6
NativeWindowInitOptions owner 2.6
flash.events Event CLOSING 1.0
DISPLAYING 1.0
PREPARING 2.6
EXITING 1.0
HTML_BOUNDS_CHANGE 1.0
HTML_DOM_INITIALIZE 1.0
HTML_RENDER 1.0
LOCATION_CHANGE 1.0
NETWORK_CHANGE 1.0
STANDARD_ERROR_CLOSE 2.0
STANDARD_INPUT_CLOSE 2.0
STANDARD_OUTPUT_CLOSE 2.0
USER_IDLE 1.0
USER_PRESENT 1.0
HTTPStatusEvent HTTP_RESPONSE_STATUS 1.0
responseHeaders 1.0
responseURL 1.0
KeyboardEvent commandKey 1.0
controlKey 1.0
flash.net FileReference extension 1.0
httpResponseStatus event 1.0
uploadUnencoded() 1.0
NetStream drmAuthenticate event 1.0
onDRMContentData event 1.5
preloadEmbeddedData() 1.5
resetDRMVouchers() 1.0
setDRMAuthenticationCredentials() 1.0
URLRequest authenticate 1.0
cacheResponse 1.0
followRedirects 1.0
idleTimeout 2.0
manageCookies 1.0
useCache 1.0
userAgent 1.0
URLStream httpResponseStatus event 1.0
flash.printing PrintJob active 2.0
copies 2.0
firstPage 2.0
isColor 2.0
jobName 2.0
lastPage 2.0
maxPixelsPerInch 2.0
paperArea 2.0
printableArea 2.0
printer 2.0
printers 2.0
selectPaperSize() 2.0
showPageSetupDialog() 2.0
start2() 2.0
supportsPageSetupDialog 2.0
terminate() 2.0
PrintJobOptions pixelsPerInch 2.0
printMethod 2.0
flash.system Capabilities languages 1.1
LoaderContext allowLoadBytesCodeExecution 1.0
Security APPLICATION 1.0
flash.ui KeyLocation D_PAD 2.5

Most of these new properties and methods are available only to content in the AIR application security sandbox. However, the new members in the URLRequest classes are also available to content running in other sandboxes.

The ByteArray.compress() and ByteArray.uncompress() methods each include a new algorithm parameter, allowing you to choose between deflate and zlib compression. This parameter is available only to content running in AIR.

AIR-specific Flex components

The following Adobe® Flex™ MX components are available when developing content for Adobe AIR:

Additionally, Flex 4 includes the following spark AIR components:

For more information about the AIR Flex components, see Using the Flex AIR components.