References

summary
public	C Application Base class for an Application
public	C Auth Handles Authentication
public	C BasicApplication Basic Application Helper
public	C Clipboard Clipboard Manager
public	C Core Main Core class for OS.js service providers and bootstrapping.
public	C Desktop Desktop Class
public	C Filesystem Filesystem Class that manages filesystems and adapters
public	C Login OS.js Login UI
public	C Middleware Middleware Manager
public	C Notification Notification Implementation
public	C Notifications Notification Factory
public	C Packages Package Manager
public	C Search Search Service
public	C Session Session Handler
public	C Settings OS.js Settings Manager
public	C Splash Splash Screen UI
public	C Tray Tray Handler
public	C Websocket Application Socket
public	C WindowBehavior Default Window Behavior
public	C Window Window Implementation
public	F capabilities(path: string \| VFSFile, options: VFSMethodOptions): Promise<object[]> Get vfs capabilities
public	F copy(from: string \| VFSFile, to: string \| VFSFile, options: VFSMethodOptions): Promise<boolean> Copies a file or directory (move)
public	F download(path: string \| VFSFile, options: VFSDownloadOptions): Promise<any> Initiates a native browser download of the file
public	F exists(path: string \| VFSFile, options: VFSMethodOptions): Promise<boolean> Checks if path exists
public	F mkdir(path: string \| VFSFile, options: VFSMethodOptions): Promise<boolean> Creates a directory
public	F readdir(path: string \| VFSFile, options: VFSMethodOptions): Promise<object[]> Read a directory
public	F readfile(path: string \| VFSFile, type: string, options: VFSMethodOptions): Promise<ArrayBuffer> Reads a file
public	F rename(from: string \| VFSFile, to: string \| VFSFile, options: VFSMethodOptions): Promise<boolean> Renames a file or directory (move)
public	F search(root: string \| VFSFile, pattern: string, options: VFSMethodOptions): Promise<object[]> Searches for files and folders
public	F stat(path: string \| VFSFile, options: VFSMethodOptions): Promise<object> Gets the stats of the file or directory
public	F touch(path: string \| VFSFile): Promise<boolean> Touches a file
public	F unlink(path: string \| VFSFile, options: VFSMethodOptions): Promise<boolean> Removes a file or directory
public	F url(path: string \| VFSFile, options: VFSMethodOptions): Promise<string> Gets an URL to a resource defined by file
public	F writefile(path: string \| VFSFile, data: ArrayBuffer \| Blob \| string, options: VFSMethodOptions): Promise<number> Writes a file
public	V move(from: string \| VFSFile, to: string \| VFSFile, options: VFSMethodOptions): Promise<boolean>: * Alias of 'rename'
public	T ApplicationData: Object Application Data
public	T ApplicationOptions: Object Application Options
public	T ApplicationSession: Object Application Session
public	T AuthAdapter: Object TODO: typedef
public	T AuthAdapterConfig: Object TODO: typedef
public	T AuthForm: Object
public	T AuthSettings: Object
public	T BasicApplicationOptions: Object Basic Application Options
public	T ClipboardData: Object Clipboard Data
public	T CoreConfig: Object TODO: typedef
public	T CoreOptions: Object Core Options
public	T CoreUserData: Object User Data
public	T DeskopOptions: Object Desktop Options
public	T DesktopContextMenuEntry: Object TODO: typedef
public	T DesktopIconViewSettings: Object
public	T DesktopSettings: Object TODO: typedef
public	T DesktopViewportRectangle: Object Desktop Viewport Rectangle
public	T FilesystemAdapterMethods: Object Filesystem Adapter Methods TODO: typedef
public	T FilesystemMountpoint: Object VFS Mountpoint
public	T FilesystemMountpointAttributes: Object VFS Mountpoint attributes
public	T FilesystemOptions: Object Filesystem Options
public	T LoginOptions: Object Login Options
public	T MiddlewareData: Object Middleware Data
public	T NotificationOptions: Object Notification Options
public	T PackageLaunchOptions: Object Package Launch Options
public	T PackageMetadata: Object A package metadata
public	T PackageReference: Object A registered package reference
public	T SettingsAdapter: Object TODO: typedef
public	T SettingsAdapterConfiguration: Object TODO: typedef
public	T SettingsOptions: Object Settings Options
public	T TrayEntry: Object Tray Icon Entry
public	T TrayEntryData: Object Tray Icon Data
public	T VFSDownloadOptions: Object VFS Download Options
public	T VFSFile: Object VFS File Object
public	T VFSMethodOptions: Object VFS Method Options
public	T WebsocketOptions: Object Websocket options
public	T WindowAttributes: Object Window attributes definition
public	T WindowDimension: Object Window dimension definition
public	T WindowOptions: Object Window options definition
public	T WindowPosition: Object Window position definition
public	T WindowSession: Object Window session
public	T WindowState: Object Window state definition

adapters/auth

summary
public	F localStorageAuth(core: Core, options: object) LocalStorage Auth adapter
public	F serverAuth(core: Core, options: object): {"register": , "login": , "logout": *} Server Auth adapter

adapters/settings

summary
public	F localStorageSettings(core: Core, options: object): * LocalStorage Settings adapter
public	F serverSettings(core: Core, options: object) Server Settings adapter

adapters/ui

summary
public	C DesktopIconView Desktop Icon View
public	F create(options: , login: , startHidden: , $container: ): * Login UI Adapter
public	F create(core: , $element: ): * Search UI Adapter

adapters/vfs

summary
public	F adapter(core: Core, options: object): {"readdir": *} Application VFS adapter
public	F adapter(core: Core, options: object): * System VFS adapter
public	V nullAdapter(core: Core, options: object): {"capabilities": , "readdir": , "readfile": , "writefile": , "copy": , "rename": , "mkdir": , "unlink": , "exists": , "stat": , "url": , "mount": , "unmount": , "search": , "touch": *} Null VFS adapter

providers

summary
public	C AuthServiceProvider OS.js Auth Service Provider
public	C CoreServiceProvider OS.js Core Service Provider
public	C DesktopServiceProvider OS.js Desktop Service Provider
public	C NotificationServiceProvider OS.js Notification Service Provider
public	C SettingsServiceProvider OS.js Settings Service Provider
public	C VFSServiceProvider OS.js Virtual Filesystem Service Provider
public	T AuthProviderContract: Object Auth Service Contract TODO: typedef
public	T AuthServiceOptions: Object Auth Service Options
public	T CoreProviderClipboardContract: Object Core Provider Clipboard Contract TODO: typedef
public	T CoreProviderDOMContract: Object Core Provider Theme Contract TODO: typedef
public	T CoreProviderDnDContract: Object Core Provider DnD Contract TODO: typedef
public	T CoreProviderLocaleContract: Object Core Provider Locale Contract TODO: typedef
public	T CoreProviderMiddlewareContract: Object Core Provider Middleware Contract TODO: typedef
public	T CoreProviderOptions: Object Core Provider Options
public	T CoreProviderPackagesContract: Object Core Provider Packages Contract TODO: typedef
public	T CoreProviderSessionContract: Object Core Provider Session Contract TODO: typedef
public	T CoreProviderSoundContract: Object Core Provider Sound Contract TODO: typedef
public	T CoreProviderThemeContract: Object Core Provider Theme Contract TODO: typedef
public	T CoreProviderTrayContract: Object Core Provider Tray Contract TODO: typedef
public	T CoreProviderWindowContract: Object Core Provider Window Contract TODO: typedef
public	T DeskopProviderContract: Object Desktop Service Contract TODO: typedef
public	T SettingsProviderContract: Object Settings Service Contract TODO: typedef
public	T SettingsServiceOptions: Object TODO: typedef
public	T VFSServiceContract: Object VFS Service Contract TODO: typedef
public	T VFSServiceFilesystemContract: Object Filesytem Service Contract TODO: typedef
public	T VFSServiceOptions: Object VFS Service Options

utils

summary
public	C Preloader The Preloader loads styles and scripts
public	F invertHex(hex: string): string Inverts a HEX color
public	F applyBackgroundStyles(core: , background: ) Creates a set of styles based on background settings
public	F createPanelSubtraction(panel: , panels: ): * Creates a rectangle with the realestate panels takes up
public	F isDroppingImage(data: *): boolean Check if droppable data contains image
public	F validVfsDrop(data: *): boolean Check if droppable data is a VFS type
public	F draggable(el: Element, options: DraggableOptions): DraggableInstance Creates a "draggable" element
public	F droppable(el: Element, options: DroppableOptions): DroppableInstance Creates a "droppable" element
public	F createCssText(obj: object): string Serialize an object to CSS
public	F createNativeNotification(options: object, onclick: Function): Promise<window.Notification> Creates a native notification
public	F escapeHtml(text: string): string Escape text so it is "safe" for HTML usage
public	F handleTabOnTextarea(ev: Event) Inserts a tab in the given event target
public	F playSound(src: string, options: object): Promise<HTMLAudioElement> Plays a sound
public	F script(root: Element, src: string, options: Object): Promise<StyleElement> Creates a new Script DOM element
public	F style(root: Element, src: string): Promise<ScriptElement> Creates a new CSS DOM element
public	F supportedMedia(): object Gets supported media types
public	F fetch(url: string, options: Options, type: string): Promise<*> Make a HTTP request
public	F doubleTap(timeout: number): Function Creates a double-tap event handler
public	F getEvent(ev: Event): NormalizedEventPosition Normalizes event input (position)
public	F matchKeyCombo(combo: string, ev: Event): boolean Checks if keycombo matches
public	F browserLocale(nav: object): string Returns the navigator language
public	F format(date: Date, fmt: string): string Formats a given Date to a specified format
public	F getLocale(core: Core, key: string): object Gest the set localization
public	F translatable(k: string, Format: ...args): Function Translates a given tree of locales.
public	F translatableFlat(list: object, defaultValue: string): string Translates a given flat tree of locales
private	F translate(list: object, ul: string, dl: string, k: string, args: ...*): string Translates a key + arguments from a tree of translations
public	F urlResolver(configuration: CoreConfig): * Resolves an URL
public	F basename(path: string): string Get basename of a file
public	F createFileIter(stat: object): object Creates a file iter for scandir
public	F createWatchEvents(method: , args: ): object[] Creates a list of VFS events to simulate server-side file watching
public	F filterMountByGroups(userGroups: *): boolean Filters a mountpoint by user groups
public	F getFileIcon(file: object): string \| object Gets an icon from file stat
public	F humanFileSize(bytes: Number, si: Boolean): string Converts a number (bytez) into human-readable string
public	F parentDirectory(path: string): string Get parent directory
public	F parseMountpointPrefix(str: string): string Gets prefix from vfs path
public	F pathJoin(args: string[]): string Joins paths
public	F transformArrayBuffer(ab: ArrayBuffer, mime: string, type: string): DOMString \| string \| Blob \| ArrayBuffer Transform an ArrayBuffer
public	F transformReaddir(root: object, options: object): Object[] Transforms a readdir result
public	F createDOMAttributes(id: string, state: WindowState, attributes: WindowAttributes): object Creates data attributes for window DOM
public	F createDOMStyles(state: WindowState, attributes: WindowAttributes): object Creates styles for window DOM
public	F loadOptionsFromConfig(config: , appName: , windowId: ): Loads [certain] window options from configuration
public	V supportsPassive: boolean: * Checks if passive events is supported
public	V supportsTransition: boolean: * Gets if CSS transitions is supported
public	V clientLocale(defaultLocale: string): string: * Figures out what locale the browser is running as
public	T DraggableInstance: Object
public	T DraggableOptions: Object
public	T DroppableInstance: Object
public	T DroppableOptions: Object
public	T NormalizedEventPosition: Object
public	T PreloaderEntry: Object
public	T PreloaderEntryElement: HTMLScriptElement \| HTMLLinkElement
public	T PreloaderResult: Object
public	T URLResolverOptions: Object

Directories