Class Plugin

Plugin Class

Constructors

constructor

new Plugin(o: Plugin | PluginCfg): Plugin
Plugin constructor
Parameters
- o: Plugin | PluginCfg
Returns Plugin
- Defined in saltcorn-data/models/plugin.ts:45

Properties

`Optional`configuration

configuration?: any

`Optional`deploy_private_key

deploy_private_key?: string

`Optional`description

description?: string

`Optional`documentation_link

documentation_link?: string

`Optional`has_auth

has_auth?: boolean

`Optional`has_theme

has_theme?: boolean

`Optional`id

id?: number

location

location: string

name

name: string

source

source: PluginSourceType

`Optional`unsafe

unsafe?: boolean

`Optional`version

version?: string | number

Accessors

`Static`local_store_entries_exists

get local_store_entries_exists(): boolean
Returns boolean
- Defined in saltcorn-data/models/plugin.ts:174

`Static`local_store_entries_filepath

get local_store_entries_filepath(): string
Returns string
- Defined in saltcorn-data/models/plugin.ts:171

Methods

delete

delete(): Promise<void>
Delete plugin

Returns Promise<void>
- Defined in saltcorn-data/models/plugin.ts:106

dependant_views

dependant_views(): Promise<string[]>
List of views relay on this plugin

Returns Promise<string[]>
- Defined in saltcorn-data/models/plugin.ts:139

ready_for_mobile

ready_for_mobile(): boolean
Returns boolean
- Defined in saltcorn-data/models/plugin.ts:156

upgrade_version

upgrade_version(
requirePlugin: (arg0: Plugin, arg1: boolean) => Plugin,
newVersion?: string,
): Promise<void>
Upgrade plugin version
Parameters
- requirePlugin: (arg0: Plugin, arg1: boolean) => Plugin
- OptionalnewVersion: string
Returns Promise<void>
- Defined in saltcorn-data/models/plugin.ts:118

upsert

upsert(): Promise<void>
Update or Insert plugin

Returns Promise<void>
- Defined in saltcorn-data/models/plugin.ts:85

`Static`find

find(where?: Where): Promise<Plugin[]>
Find plugins
Parameters
- Optionalwhere: Where
  where object
Returns Promise<Plugin[]>
returns plugins list
- Defined in saltcorn-data/models/plugin.ts:75

`Static`findOne

findOne(where: Where): Promise<Plugin | null>
Find one plugin
Parameters
- where: Where
  where object
Returns Promise<Plugin | null>
return existing plugin or new plugin
- Defined in saltcorn-data/models/plugin.ts:65

`Static`get_cached_plugins

get_cached_plugins(): Plugin[]
Returns Plugin[]
- Defined in saltcorn-data/models/plugin.ts:164

`Static`is_fixed_plugin

is_fixed_plugin(name: string): boolean
check if plugin is base-plugin or sbadmin2
Parameters
- name: string
Returns boolean
- Defined in saltcorn-data/models/plugin.ts:306

`Static`read_local_store_entries

read_local_store_entries(): Promise<any>
Returns Promise<any>
- Defined in saltcorn-data/models/plugin.ts:177

`Static`store_by_name

store_by_name(name: string, endpoint?: string): Promise<Plugin | null>
Parameters
- name: string
- Optionalendpoint: string
Returns Promise<Plugin | null>
- Defined in saltcorn-data/models/plugin.ts:282

`Static`store_plugins_available

store_plugins_available(msgs?: string[]): Promise<Plugin[]>
List plugins available in store
Parameters
- Optionalmsgs: string[]
  optional packages/plugins-loader/plugin_installer.jsmessages array
Returns Promise<Plugin[]>
- Defined in saltcorn-data/models/plugin.ts:187

`Static`store_plugins_available_from_store

store_plugins_available_from_store(endpoint?: string): Promise<Plugin[]>
Parameters
- Optionalendpoint: string
Returns Promise<Plugin[]>
- Defined in saltcorn-data/models/plugin.ts:254