Packagecom.distriqt.extension.expansionfiles
Interfacepublic interface OBBUtils extends flash.events.IEventDispatcher


Public Methods
 MethodDefined By
  
getMountedPath(file:ExpansionFile):String
Check the mounted path of an Opaque Binary Blob (OBB) file.
OBBUtils
  
isMounted(file:ExpansionFile):Boolean
Check whether an Opaque Binary Blob (OBB) is mounted or not.
OBBUtils
  
mount(file:ExpansionFile, key:String = null):Boolean
Mount an Opaque Binary Blob (OBB) file.
OBBUtils
  
unmount(file:ExpansionFile, force:Boolean = false):Boolean
Unmount an Opaque Binary Blob (OBB) file asynchronously.
OBBUtils
Events
 Event Summary Defined By
  
obb:state:changed
 Dispatched when the storage mount state of an expansion file is changed, including operations such as mounting, unmounting and any error states that may have occurred.OBBUtils
Method Detail
getMountedPath()method
public function getMountedPath(file:ExpansionFile):String

Check the mounted path of an Opaque Binary Blob (OBB) file. This will give you the path to where you can obtain access to the internals of the OBB.

Parameters

file:ExpansionFile

Returns
String —
isMounted()method 
public function isMounted(file:ExpansionFile):Boolean

Check whether an Opaque Binary Blob (OBB) is mounted or not.

Parameters

file:ExpansionFile

Returns
Boolean — true if OBB is mounted; false if not mounted or on error
mount()method 
public function mount(file:ExpansionFile, key:String = null):Boolean

Mount an Opaque Binary Blob (OBB) file. If a key is specified, it is supplied to the mounting process to be used in any encryption used in the OBB.

Note: you can only mount OBB files for which the OBB tag on the file matches a package ID that is owned by the calling program's UID. That is, shared UID applications can attempt to mount any other application's OBB that shares its UID.

Parameters

file:ExpansionFile — The expansion file to mount
 
key:String (default = null) — Secret key used to encrypt the OBB; may be null if no encryption was used on the OBB

Returns
Boolean — whether the mount call was successfully queued or not
unmount()method 
public function unmount(file:ExpansionFile, force:Boolean = false):Boolean

Unmount an Opaque Binary Blob (OBB) file asynchronously. If the force flag is true, it will kill any application needed to unmount the given OBB (even the calling application).

Parameters

file:ExpansionFile — The expansion file to unmount
 
force:Boolean (default = false)

Returns
Boolean — whether the unmount call was successfully queued or not
Event Detail
obb:state:changed Event
Event Object Type: com.distriqt.extension.expansionfiles.events.OBBUtilsEvent
OBBUtilsEvent.type property = com.distriqt.extension.expansionfiles.events.OBBUtilsEvent.STATE_CHANGED

Dispatched when the storage mount state of an expansion file is changed, including operations such as mounting, unmounting and any error states that may have occurred.

The state will contain information about the state of the expansion file and the file variable will detail the particular file that this event references.





Wed Apr 26 2023, 09:13 PM +10:00