OpenVeo Publish server

API Docs for: 8.0.0
Show:

ConfigurationController

Extends Controller
Module: controllers

Summary

Defines a controller to handle actions relative to configuration's routes.

Constructor

ConfigurationController

Syntax

ConfigurationController

()

Summary

Methods

getConfigurationAllAction

Syntax

getConfigurationAllAction

(
  • request
  • response
  • next
)
async

Summary

Retrieves publish plugin configurations.

Parameters:

  • request Request

    ExpressJS HTTP Request

  • response Response

    ExpressJS HTTP Response

  • next Function

    Function to defer execution to the next registered middleware

handleGoogleOAuthCodeAction

Syntax

handleGoogleOAuthCodeAction

(
  • request
  • response
  • next
)
async

Summary

Redirects action that will be called by google when the user associate our application, a code will be in the parameters.

Parameters:

  • request Request

    ExpressJS HTTP Request

    • query Object

      Request's query

      • code String
        Google authentication code
  • response Response

    ExpressJS HTTP Response

  • next Function

    Function to defer execution to the next registered middleware

saveMediasSettings

Syntax

saveMediasSettings

(
  • request
  • response
  • next
)
async

Summary

Saves medias settings.

Parameters:

  • request Request

    ExpressJS HTTP Request

    • body Object

      Request's body

      • owner String
        The id of the owner for new uploaded medias
      • group String
        The id of the group for new uploaded medias
  • response Response

    ExpressJS HTTP Response

  • next Function

    Function to defer execution to the next registered middleware

Example:

// Response example
{
  "settings" : {
    "owner": ..., // The id of the owner that will be associated to medias uploaded through the watcher
    "group": ... // The id of the content group that will be associated to medias uploaded through the watcher
  },
  "total": 1
}

saveTlsSettingsAction

Syntax

saveTlsSettingsAction

(
  • request
  • response
  • next
)
async

Summary

Saves TLS settings.

Parameters:

  • request Request

    ExpressJS HTTP Request

    • body Object

      Request's body

      • properties String
        The list of custom property ids
  • response Response

    ExpressJS HTTP Response

  • next Function

    Function to defer execution to the next registered middleware

Example:

// Response example
{
  "settings" : {
    "properties": ... // The list of custom property ids
  },
  "total": 1
}