Home Reference Source

import CoreServiceProvider from '@osjs/client/src/providers/core.js'

public class | source

CoreServiceProvider

Extends:

@osjs/common~ServiceProvider → CoreServiceProvider

OS.js Core Service Provider

Constructor Summary

Public Constructor
public	constructor(core: Core, options: CoreProviderOptions)

Member Summary

Public Members
public	clipboard: Clipboard
public	middleware: Middleware
public	pm: Packages
public	session: Session
public	tray: Tray

Method Summary

Public Methods
public	createClipboardContract(): CoreProviderClipboardContract Provides Clipboard contract
public	createDOMContract(): CoreProviderDOMContract Provides DOM contract
public	createDnDContract(): CoreProviderDnDContract Provides DnD contract
public	createGlobalApi(): * Expose some internals to global
public	createLocaleContract(): CoreProviderLocaleContract Provides localization contract
public	createMiddlewareContract(): CoreProviderMiddlewareContract Provides Middleware contract
public	createPackagesContract(): CoreProviderPackagesContract Provides Packages contract
public	createSessionContract(): CoreProviderSessionContract Provides Session contract
public	createSoundsContract(): CoreProviderSoundContract Provides Sounds contract
public	createThemeContract(): CoreProviderThemeContract Provides Theme contract
public	createTrayContract(): CoreProviderTrayContract Provides Tray contract
public	createWindowContract(): CoreProviderWindowContract Provides window contract
public	destroy() Destroys provider
public	init(): Promise<undefined> Initializes provider
public	provides(): string Get a list of services this provider registers
public	registerContracts() Registers contracts
public	start(): Promise<undefined> Starts provider

Private Methods
private	_onDistChanged(filename: string) Event when dist changes from a build or deployment
private	_onPackageChanged(name: string) Event when package dist changes from a build or deployment

Public Constructors

public constructor(core: Core, options: CoreProviderOptions) source

Params:

Name	Type	Attribute	Description
core	Core		OS.js Core
options	CoreProviderOptions	optional default: {}	Arguments

Public Members

public clipboard: Clipboard source

public middleware: Middleware source

public pm: Packages source

public session: Session source

public tray: Tray source

Public Methods

public createClipboardContract(): CoreProviderClipboardContract source

Provides Clipboard contract

Return:

CoreProviderClipboardContract

public createDOMContract(): CoreProviderDOMContract source

Provides DOM contract

Return:

CoreProviderDOMContract

public createDnDContract(): CoreProviderDnDContract source

Provides DnD contract

Return:

CoreProviderDnDContract

public createGlobalApi(): * source

Expose some internals to global

Return:

*

public createLocaleContract(): CoreProviderLocaleContract source

Provides localization contract

Return:

CoreProviderLocaleContract

public createMiddlewareContract(): CoreProviderMiddlewareContract source

Provides Middleware contract

Return:

CoreProviderMiddlewareContract

public createPackagesContract(): CoreProviderPackagesContract source

Provides Packages contract

Return:

CoreProviderPackagesContract

public createSessionContract(): CoreProviderSessionContract source

Provides Session contract

Return:

CoreProviderSessionContract

public createSoundsContract(): CoreProviderSoundContract source

Provides Sounds contract

Return:

CoreProviderSoundContract

public createThemeContract(): CoreProviderThemeContract source

Provides Theme contract

Return:

CoreProviderThemeContract

public createTrayContract(): CoreProviderTrayContract source

Provides Tray contract

Return:

CoreProviderTrayContract

public createWindowContract(): CoreProviderWindowContract source

Provides window contract

Return:

CoreProviderWindowContract

public destroy() source

Destroys provider

public init(): Promise<undefined> source

Initializes provider

Return:

Promise<undefined>

public provides(): string source

Get a list of services this provider registers

Return:

public registerContracts() source

Registers contracts

public start(): Promise<undefined> source

Starts provider

Return:

Promise<undefined>

Private Methods

private _onDistChanged(filename: string) source

Event when dist changes from a build or deployment

Params:

Name	Type	Attribute	Description
filename	string		The resource filename

private _onPackageChanged(name: string) source

Event when package dist changes from a build or deployment

Params:

Name	Type	Attribute	Description
name	string		The package name