webapp

WebApp Plugin.

API Overview

API Documentation

Constants

​DEFAULT_PORT​

Signature

plugins.core.webapp.DEFAULT_PORT -> number

Type

Constant

Description

The Default Port.

​DEFAULT_SETTING​

Signature

plugins.core.webapp.DEFAULT_SETTING -> boolean

Type

Constant

Description

Whether or not the WebApp should be enabled by default.

​PREFERENCE_NAME​

Signature

plugins.core.webapp.PREFERENCE_NAME -> string

Type

Constant

Description

The Preference Name

Functions

​copyLinkToPasteboard​

Signature

plugins.core.webapp.copyLinkToPasteboard() -> None

Type

Function

Description

Copies the Hostname to the Pasteboard.

Parameters

​

Returns

​

​start​

Signature

plugins.core.webapp.start() -> WebApp

Type

Function

Description

Starts the WebApp.

Parameters

​

Returns

​

​stop​

Signature

plugins.core.webapp.stop() -> WebApp

Type

Function

Description

Stops the WebApp.

Parameters

​

Returns

​

​update​

Signature

plugins.core.webapp.update() -> None

Type

Function

Description

Starts or Stops the WebApp.

Parameters

​

Returns

​

Fields

​enabled​

Signature

plugins.core.webapp.enabled <cp.prop: boolean>

Type

Field

Description

Is true if the plugin is enabled.