Typedef

Static Public Summary
public	ApplicationData: Object Application Data
public	ApplicationOptions: Object Application Options
public	ApplicationSession: Object Application Session
public	AuthAdapter: Object TODO: typedef
public	AuthAdapterConfig: Object TODO: typedef
public	AuthForm: Object
public	AuthProviderContract: Object Auth Service Contract TODO: typedef
public	AuthServiceOptions: Object Auth Service Options
public	AuthSettings: Object
public	BasicApplicationOptions: Object Basic Application Options
public	ClipboardData: Object Clipboard Data
public	CoreConfig: Object TODO: typedef
public	CoreOptions: Object Core Options
public	CoreProviderClipboardContract: Object Core Provider Clipboard Contract TODO: typedef
public	CoreProviderDOMContract: Object Core Provider Theme Contract TODO: typedef
public	CoreProviderDnDContract: Object Core Provider DnD Contract TODO: typedef
public	CoreProviderLocaleContract: Object Core Provider Locale Contract TODO: typedef
public	CoreProviderMiddlewareContract: Object Core Provider Middleware Contract TODO: typedef
public	CoreProviderOptions: Object Core Provider Options
public	CoreProviderPackagesContract: Object Core Provider Packages Contract TODO: typedef
public	CoreProviderSessionContract: Object Core Provider Session Contract TODO: typedef
public	CoreProviderSoundContract: Object Core Provider Sound Contract TODO: typedef
public	CoreProviderThemeContract: Object Core Provider Theme Contract TODO: typedef
public	CoreProviderTrayContract: Object Core Provider Tray Contract TODO: typedef
public	CoreProviderWindowContract: Object Core Provider Window Contract TODO: typedef
public	CoreUserData: Object User Data
public	DeskopOptions: Object Desktop Options
public	DeskopProviderContract: Object Desktop Service Contract TODO: typedef
public	DesktopContextMenuEntry: Object TODO: typedef
public	DesktopIconViewSettings: Object
public	DesktopSettings: Object TODO: typedef
public	DesktopViewportRectangle: Object Desktop Viewport Rectangle
public	DraggableInstance: Object
public	DraggableOptions: Object
public	DroppableInstance: Object
public	DroppableOptions: Object
public	FilesystemAdapterMethods: Object Filesystem Adapter Methods TODO: typedef
public	FilesystemMountpoint: Object VFS Mountpoint
public	FilesystemMountpointAttributes: Object VFS Mountpoint attributes
public	FilesystemOptions: Object Filesystem Options
public	LoginOptions: Object Login Options
public	MiddlewareData: Object Middleware Data
public	NormalizedEventPosition: Object
public	NotificationOptions: Object Notification Options
public	PackageLaunchOptions: Object Package Launch Options
public	PackageMetadata: Object A package metadata
public	PackageReference: Object A registered package reference
public	PreloaderEntry: Object
public	PreloaderEntryElement: HTMLScriptElement \| HTMLLinkElement
public	PreloaderResult: Object
public	SettingsAdapter: Object TODO: typedef
public	SettingsAdapterConfiguration: Object TODO: typedef
public	SettingsOptions: Object Settings Options
public	SettingsProviderContract: Object Settings Service Contract TODO: typedef
public	SettingsServiceOptions: Object TODO: typedef
public	TrayEntry: Object Tray Icon Entry
public	TrayEntryData: Object Tray Icon Data
public	URLResolverOptions: Object
public	VFSDownloadOptions: Object VFS Download Options
public	VFSFile: Object VFS File Object
public	VFSMethodOptions: Object VFS Method Options
public	VFSServiceContract: Object VFS Service Contract TODO: typedef
public	VFSServiceFilesystemContract: Object Filesytem Service Contract TODO: typedef
public	VFSServiceOptions: Object VFS Service Options
public	WebsocketOptions: Object Websocket options
public	WindowAttributes: Object Window attributes definition
public	WindowDimension: Object Window dimension definition
public	WindowOptions: Object Window options definition
public	WindowPosition: Object Window position definition
public	WindowSession: Object Window session
public	WindowState: Object Window state definition

Static Public

public ApplicationData: Object source

Application Data

Properties:

Name	Type	Attribute	Description
args	{foo: *}		Launch arguments
options	ApplicationOptions	optional	Options
metadata	PackageMetadata	optional	Package Metadata

public ApplicationOptions: Object source

Application Options

Properties:

Name	Type	Attribute	Description
settings	object	optional	Initial settings
restore	object	optional	Restore data
windowAutoFocus	boolean	optional default: true	Auto-focus first created window
sessionable	boolean	optional default: true	Allow session storage

public ApplicationSession: Object source

Application Session

Properties:

Name	Type	Attribute	Description
args	{foo: string}
name	string
windows	WindowSession[]

public AuthAdapter: Object source

TODO: typedef

public AuthAdapterConfig: Object source

TODO: typedef

public AuthForm: Object source

Properties:

Name	Type	Attribute	Description
username	string	optional
password	string	optional

public AuthProviderContract: Object source

Auth Service Contract TODO: typedef

Properties:

Name	Type	Attribute	Description
show	Function
login	Function
logout	Function
user	Function

public AuthServiceOptions: Object source

Auth Service Options

public AuthSettings: Object source

Properties:

Name	Type	Attribute	Description
adapter	AuthAdapterCallback \| AuthAdapter	optional	Adapter to use
login	LoginAdapterCallback \| Login	optional	Login Adapter to use
config	AuthAdapterConfig	optional	Adapter configuration

public BasicApplicationOptions: Object source

Basic Application Options

Properties:

Name	Type	Attribute	Description
mimeTypes	string[]	optional	What MIME types to support (all/fallback)
loadMimeTypes	string[]	optional	What MIME types to support on load
saveMimeTypes	string[]	optional	What MIME types to support on save
defaultFilename	string	optional	Default filename of a new file

public ClipboardData: Object source

Clipboard Data

Properties:

Name	Type	Attribute	Description
type	string	optional	Optional data type
data	*

public CoreConfig: Object source

TODO: typedef

public CoreOptions: Object source

Core Options

Properties:

Name	Type	Attribute	Description
root	Element	optional	The root DOM element for elements
resourceRoot	Element	optional	The root DOM element for resources
classNames	String[]	optional	List of class names to apply to root dom element
splash	SplashCallback \| Splash	optional	Custom callback function for creating splash screen

public CoreProviderClipboardContract: Object source

Core Provider Clipboard Contract TODO: typedef

Properties:

Name	Type	Attribute	Description
clear	Function	optional
set	Function	optional
has	Function	optional
get	Function	optional

public CoreProviderDOMContract: Object source

Core Provider Theme Contract TODO: typedef

Properties:

Name	Type	Attribute	Description
script	Function
style	Function

public CoreProviderDnDContract: Object source

Core Provider DnD Contract TODO: typedef

Properties:

Name	Type	Attribute	Description
draggable	Function
droppable	Function

public CoreProviderLocaleContract: Object source

Core Provider Locale Contract TODO: typedef

Properties:

Name	Type	Attribute	Description
format	Function
translate	Function
translatable	Function
translatableFlat	Function
getLocale	Function
setLocale	Function

public CoreProviderMiddlewareContract: Object source

Core Provider Middleware Contract TODO: typedef

Properties:

Name	Type	Attribute	Description
add	Function	optional
get	Function	optional

public CoreProviderOptions: Object source

Core Provider Options

Properties:

Name	Type	Attribute	Description
windowBehavior	Function	optional	Custom Window Behavior
locales	Object	optional	Override locales

public CoreProviderPackagesContract: Object source

Core Provider Packages Contract TODO: typedef

Properties:

Name	Type	Attribute	Description
launch	Function	optional
register	Function	optional
addPackages	Function	optional
getPackages	Function	optional
getCompatiblePackages	Function	optional
running	Function	optional

public CoreProviderSessionContract: Object source

Core Provider Session Contract TODO: typedef

Properties:

Name	Type	Attribute	Description
save	Function
load	Function

public CoreProviderSoundContract: Object source

Core Provider Sound Contract TODO: typedef

Properties:

Name	Type	Attribute	Description
resource	Function
play	Function

public CoreProviderThemeContract: Object source

Core Provider Theme Contract TODO: typedef

Properties:

Name	Type	Attribute	Description
resource	Function
icon	Function

public CoreProviderTrayContract: Object source

Core Provider Tray Contract TODO: typedef

Properties:

Name	Type	Attribute	Description
create	Function	optional
remove	Function	optional
list	Function	optional
has	Function	optional

public CoreProviderWindowContract: Object source

Core Provider Window Contract TODO: typedef

Properties:

Name	Type	Attribute	Description
create	Function
list	Function
last	Function

public CoreUserData: Object source

User Data

Properties:

Name	Type	Attribute	Description
username	string
id	number	optional
groups	string[]	optional default: []

public DeskopOptions: Object source

Desktop Options

Properties:

Name	Type	Attribute	Description
contextmenu	object[]	optional default: {}	Default Context menu items

public DeskopProviderContract: Object source

Desktop Service Contract TODO: typedef

Properties:

Name	Type	Attribute	Description
setKeyboardContext	Function
openContextMenu	Function
addContextMenuEntries	Function
applySettings	Function
createDropContextMenu	Function
getRect	Function

public DesktopContextMenuEntry: Object source

TODO: typedef

public DesktopIconViewSettings: Object source

public DesktopSettings: Object source

TODO: typedef

Properties:

Name	Type	Attribute	Description
iconview	DesktopIconViewSettings	optional

public DesktopViewportRectangle: Object source

Desktop Viewport Rectangle

Properties:

Name	Type	Attribute	Description
left	number
top	number
right	number
bottom	number

public DraggableInstance: Object source

Properties:

Name	Type	Attribute	Description
destroy	Function

public DraggableOptions: Object source

Properties:

Name	Type	Attribute	Description
type	string	optional default: application/json	Content Type
effect	string	optional default: move	DnD effect (cursor)
ondragstart	DraggableEvent	optional	Callback to event (ev) => {}
ondragend	DraggableEvent	optional	Callback to event (ev) => {}
setDragImage	DraggableEvent	optional	Set custom drag image (browser dependent)

public DroppableInstance: Object source

Properties:

Name	Type	Attribute	Description
destroy	Function

public DroppableOptions: Object source

Properties:

Name	Type	Attribute	Description
type	string	optional default: application/json	Content Type
effect	string	optional default: move	DnD effect (cursor)
ondragenter	DroppableEvent	optional	Callback to event (ev) => {}
ondragover	DroppableEvent	optional	Callback to event (ev) => {}
ondragleave	DroppableEvent	optional	Callback to event (ev) => {}
ondrop	DroppedEvent	optional	Callback to event (ev, data, files) => {}
strict	boolean	optional default: false	Drop element must match exactly

public FilesystemAdapterMethods: Object source

Filesystem Adapter Methods TODO: typedef

Properties:

Name	Type	Attribute	Description
capabilities	Function
readdir	Function
readfile	Function
writefile	Function
copy	Function
move	Function
rename	Function
mkdir	Function
unlink	Function
exists	Function
stat	Function
url	Function
download	Function
search	Function
touch	Function

public FilesystemMountpoint: Object source

VFS Mountpoint

Properties:

Name	Type	Attribute	Description
name	string		Name
label	string		Label
adapter	string		Adater name
root	string	optional	System adapter root
enabled	boolean	optional default: true	Enabled state
attributes	FilesystemMountpointAttributes	optional	Attributes

public FilesystemMountpointAttributes: Object source

VFS Mountpoint attributes

Properties:

Name	Type	Attribute	Description
visibility	string	optional default: 'global'	Visibility in UI
local	boolean	optional default: true	Local filesystem ?
searchable	boolean	optional default: true	If can be searched
readOnly	boolean	optional default: false	Readonly

public FilesystemOptions: Object source

Filesystem Options

Properties:

Name	Type	Attribute	Description
adapters	{name: FilesystemAdapterWrapper}	optional	Adapter registry
mounts	FilesystemMountpoint[]	optional	Mountpoints

public LoginOptions: Object source

Properties:

Name	Type	Attribute	Description
title	string	optional	Title
fields	object[]	optional	Fields

public MiddlewareData: Object source

Middleware Data

Properties:

Name	Type	Attribute	Description
group	string	optional	Middleware group

public NormalizedEventPosition: Object source

Properties:

Name	Type	Attribute	Description
clientX	number
clientY	number
touch	boolean
target	Element

public NotificationOptions: Object source

Notification Options

Properties:

Name	Type	Attribute	Description
title	string		Title
message	string		Message
sound	string	optional default: message	Sound to play
icon	string	optional	Icon source
timeout	number	optional default: 5000	Timeout value (0=infinite)
className	string	optional	Adds a DOM class name to notification

public PackageLaunchOptions: Object source

Package Launch Options

Properties:

Name	Type	Attribute	Description
forcePreload	boolean	optional default: false	Force preload reloading

public PackageMetadata: Object source

A package metadata

Properties:

Name	Type	Attribute	Description
name	string		The package name
category	string	optional	Package category
icon	string	optional	Package icon
singleton	boolean	optional	If only one instance allowed
autostart	boolean	optional	Autostart on boot
hidden	boolean	optional	Hide from launch menus etc.
server	string	optional	Server script filename
groups	string[]	optional	Only available for users in this group
files	Object[] \| string[]	optional	Files to preload
title	{key: string}		A map of locales and titles
description	{key: string}		A map of locales and titles

public PackageReference: Object source

A registered package reference

Properties:

Name	Type	Attribute	Description
metadata	PackageMetadata		Package metadata
callback	Function		Callback to instanciate

public PreloaderEntry: Object source

Properties:

Name	Type	Attribute	Description
success	boolean
el	PreloaderEntryElement	optional
entry	string	optional
error	string	optional

public PreloaderEntryElement: HTMLScriptElement | HTMLLinkElement source

public PreloaderResult: Object source

Properties:

Name	Type	Attribute	Description
errors	string[]
elements	{string: PreloaderEntryElement}

public SettingsAdapter: Object source

TODO: typedef

public SettingsAdapterConfiguration: Object source

TODO: typedef

public SettingsOptions: Object source

Settings Options

Properties:

Name	Type	Attribute	Description
adapter	SettingsAdapterCallback \| SettingsAdapter	optional	Adapter to use
config	SettingsAdapterConfiguration	optional	Adapter configuration

public SettingsProviderContract: Object source

Settings Service Contract TODO: typedef

Properties:

Name	Type	Attribute	Description
save	Function
load	Function
clear	Function
set	Function
get	Function

public SettingsServiceOptions: Object source

TODO: typedef

Properties:

Name	Type	Attribute	Description
config	Object	optional

public TrayEntry: Object source

Tray Icon Entry

Properties:

Name	Type	Attribute	Description
entry	TrayEntryData		The given entry data
update	Function		Updates entry with given data
destroy	Function		Destroy the entry

public TrayEntryData: Object source

Tray Icon Data

Properties:

Name	Type	Attribute	Description
key	string	optional	Used as internal index for tray entry
icon	string	optional	Icon source
title	string	optional	The title and tooltip
onclick	Function	optional	The callback function for clicks
oncontextmenu	Function	optional	The callback function for contextmenu

public URLResolverOptions: Object source

Properties:

Name	Type	Attribute	Description
type	string	optional	URL type (ws/http)
boolean	string	optional	Add prefix to URL

public VFSDownloadOptions: Object source

VFS Download Options

Properties:

Name	Type	Attribute	Description
readfile	boolean	optional	Set to false to force backend fetch

public VFSFile: Object source

VFS File Object

Properties:

Name	Type	Attribute	Description
path	string
filename	string	optional
isDirectory	boolean	optional
isFile	boolean	optional
mime	string	optional
stat	object	optional

public VFSMethodOptions: Object source

VFS Method Options

TODO: typedef

public VFSServiceContract: Object source

VFS Service Contract TODO: typedef

Properties:

Name	Type	Attribute	Description
readdir	Function
readfile	Function
writefile	Function
copy	Function
move	Function
rename	Function
mkdir	Function
unlink	Function
exists	Function
stat	Function
url	Function
download	Function
search	Function
touch	Function

public VFSServiceFilesystemContract: Object source

Filesytem Service Contract TODO: typedef

Properties:

Name	Type	Attribute	Description
basename	Function
pathname	Function
pathJoin	Function
icon	Function
mountpoints	Function
mount	Function
unmount	Function
addMountpoint	Function

public VFSServiceOptions: Object source

VFS Service Options

Properties:

Name	Type	Attribute	Description
adapters	{name: FilesystemAdapter}	optional default: {}
mountpoints	FilesystemMountpoint[]	optional default: []

public WebsocketOptions: Object source

Websocket options

Properties:

Name	Type	Attribute	Description
reconnect	boolean	optional default: true	Enable reconnection
interval	number	optional default: 1000	Reconnect interval
open	boolean	optional default: true	Immediately open socket after creation

public WindowAttributes: Object source

Window attributes definition

Properties:

Name	Type	Attribute	Description
classNames	string[]	optional default: []	A list of class names
ontop	boolean	optional default: false	If always on top
gravity	string	optional	Gravity (center/top/left/right/bottom or any combination)
resizable	boolean	optional default: true	If resizable
focusable	boolean	optional default: true	If focusable
maximizable	boolean	optional default: true	If window if maximizable
minimizable	boolean	optional default: true	If minimizable
moveable	boolean	optional default: true	If moveable
closeable	boolean	optional default: true	If closeable
header	boolean	optional default: true	Show header
controls	boolean	optional default: true	Show controls
visibility	string	optional default: global	Global visibility, 'restricted' to hide from window lists etc.
clamp	boolean	optional default: true	Clamp the window position upon creation
droppable	boolean	optional default: true	If window should have the default drop action
minDimension	WindowDimension	optional	Minimum dimension
maxDimension	WindowDimension	optional	Maximum dimension
mediaQueries	{name: string}	optional	A map of matchMedia to name

public WindowDimension: Object source

Window dimension definition

Properties:

Name	Type	Attribute	Description
width	number		Width in pixels (or float for percentage in setters)
height	number		Height in pixels (or float for percentage in setters)

public WindowOptions: Object source

Window options definition

Properties:

Name	Type	Attribute	Description
id	string		Window Id (not globaly unique)
title	string	optional	Window Title
icon	string	optional	Window Icon
parent	Window	optional	The parent Window reference
template	string \| Function	optional	The Window HTML template (or function with signature (el, win) for programatic construction)
ondestroy	Function	optional	A callback function when window destructs to interrupt the procedure
position	WindowPosition \| string	optional	Window position
dimension	WindowDimension	optional	Window dimension
attributes	WindowAttributes	optional	Apply Window attributes
state	WindowState	optional	Apply Window state

public WindowPosition: Object source

Window position definition

Properties:

Name	Type	Attribute	Description
left	number		Left in pixels (or float for percentage in setters)
top	number		Top in pixels (or float for percentage in setters)

public WindowSession: Object source

Window session

Properties:

Name	Type	Attribute	Description
id	number
maximized	boolean
minimized	boolean
position	WindowPosition
dimension	WindowDimension

public WindowState: Object source

Window state definition

Properties:

Name	Type	Attribute	Description
title	string		Title
icon	string		Icon
moving	boolean	optional default: false	If moving
resizing	boolean	optional default: false	If resizing
loading	boolean	optional default: false	If loading
focused	boolean	optional default: false	If focused
maximized	boolean	optional default: false	If maximized
mimimized	boolean	optional default: false	If mimimized
modal	boolean	optional default: false	If modal to the parent
zIndex	number	optional default: 10	The z-index (auto calculated)
position	WindowPosition	optional	Position
dimension	WindowDimension	optional	Dimension