Namespace: extlibs

extlibs

Provides functions to maintain extension libraries on the REST server for the client. The client must have been created for a user with the rest-admin role.

Methods


list(directory) → {ResultProvider}

Lists the library resources installed under the directory on the server.
Parameters:
Name Type Argument Description
directory string <optional>
a directory containing library resources; by default, all library resources installed on the server are returned
Since:
  • 1.0
Returns:
an object whose result() function takes a success callback that receives the list of library resources installed in the directory
Type
ResultProvider

read(path) → {ResultProvider}

Reads a library resource installed on the server.
Parameters:
Name Type Description
path string the location of an installed library resource
Since:
  • 1.0
Returns:
an object whose result() function takes a success callback that receives the resource
Type
ResultProvider

remove(path)

Deletes a library resource from the server.
Parameters:
Name Type Description
path string the location of the library resource
Since:
  • 1.0

write(path, permissions, contentType, source)

Installs a library resource on the server.
Parameters:
Name Type Argument Description
path string the location for installing the library resource
permissions Array.<object> <optional>
the permissions controlling which users can read, update, or execute the library resource
contentType string the mime type for the library resource
source object | string the library resource
Since:
  • 1.0
Copyright 2014-2017 MarkLogic Corporation Documentation generated by JSDoc 3.4.3 on 2017-07-14T11:04:00-07:00 using the DocStrap template.