OpenVeo Publish server

API Docs for: 8.0.0
Show:

PublishPlugin

Summary

Defines the Publish Plugin that will be loaded by the core application.

Item Index

Properties

Methods

init

Syntax

init

(
  • callback
)
async

Summary

Prepares plugin by creating required database indexes.

This is automatically called by core application after plugin is loaded.

Parameters:

  • callback Function

    Function to call when it's done with :

    • Error An error if something went wrong, null otherwise

setListeners

Syntax

setListeners

() private

Summary

Sets listeners on events.

start

Syntax

start

(
  • callback
)
async

Summary

Starts the watcher when plugin is ready.

This is automatically called by core application after plugin is initialized.

TODO: When a cache mechanism will be implemented, Publish settings will have to be pulled from cache.

Parameters:

  • callback Function

    Function to call when it's done with :

    • Error An error if something went wrong, null otherwise

Properties

api

Syntax

api

PluginApi final

Summary

Publish APIs.

router

Syntax

router

Router final

Summary

Publish public router.

router

Syntax

router

Router final

Summary

Publish private router.

router

Syntax

router

Router final

Summary

Publish web service router.