ngchmCreateServerProtocol: Create and register an NGCHM server protocol implementation.

ngchmCreateServerProtocolR Documentation

Create and register an NGCHM server protocol implementation.

Description

This function creates and registers a protocol implementation for manipulating an NGCHM server.

Usage

ngchmCreateServerProtocol(
  protocolName,
  chmFormat,
  requiredParams,
  optionalParams,
  paramValidator,
  findCollection,
  createCollection,
  installMethod,
  uninstallMethod,
  makePrivate,
  makePublic,
  setCredentials
)

Arguments

protocolName

The name of this protocol implementation.

chmFormat

The chm format required by this protocol. Defaults to original format.

requiredParams

The protocol's required parameters, if any.

optionalParams

The protocol's optional parameters, if any.

paramValidator

A function(list) for validating the parameters specified for a new server.

findCollection

A function(server,collection,path) for finding a collection.

createCollection

A function(server,collection,name) for creating a collection.

installMethod

A function(server,chm) for installing an NG-CHM.

uninstallMethod

A function(server,chmname) for uninstalling an NG-CHM.

makePrivate

A function(server,chmname) for hiding an NG-CHM.

makePublic

A function(server,chmname) for showing an NG-CHM.

setCredentials

A function(server,credentialstring) for setting credentials.


bmbroom/NGCHMR documentation built on April 18, 2022, 6:52 p.m.