OpenVeo Core server

API Docs for: 7.0.0
Show:

api

Defined in: app/server/api.js:9
Module: core

static

Summary

API manipulates the list of loaded plugins and exposes their APIs.

Item Index

Methods

Properties

Methods

addPlugin

Defined in app/server/api.js:55

Syntax

addPlugin

(
  • plugin
)

Summary

Adds a plugin to the list of plugins.

Parameters:

  • plugin Plugin

    The plugin to add

getApi

Defined in app/server/api.js:72

Syntax

getApi

(
  • name
)
PluginApi static

Summary

Gets API of a plugin.

Parameters:

  • name String

    The plugin's name

Returns:

PluginApi:

The plugin's API

getCoreApi

Defined in app/server/api.js:85

Syntax

getCoreApi

() PluginApi static

Summary

Gets core plugin's API.

Returns:

PluginApi:

The core plugin's API

getPlugin

Defined in app/server/api.js:25

Syntax

getPlugin

(
  • name
)
Plugin static

Summary

Gets a plugin by its name.

Parameters:

  • name String

    The plugin's name

Returns:

Plugin:

The plugin

getPlugins

Defined in app/server/api.js:44

Syntax

getPlugins

() Array static

Summary

Gets the list of loaded plugins.

Returns:

Array:

The list of loaded plugins

Properties

plugins

Defined in app/server/api.js:16

Syntax

plugins

Array private

Summary

The list of loaded plugins.