Platform Explorer / Nuxeo Platform 6.0

Operation NuxeoDrive.SetSynchronization

Nuxeo Drive: Register / Unregister Synchronization Root

Description

Operation id NuxeoDrive.SetSynchronization
Category Services
Label Nuxeo Drive: Register / Unregister Synchronization Root
Requires
Since

Parameters

Name Description Type Required Default value
enable boolean yes  

Signature

Inputs document
Outputs void

Implementation information

Implementation class org.nuxeo.drive.operations.NuxeoDriveSetSynchronizationOperation
Contributing component org.nuxeo.drive.operations.NuxeoDriveGetRootsOperation

JSON definition

{
  "id" : "NuxeoDrive.SetSynchronization",
  "label" : "Nuxeo Drive: Register / Unregister Synchronization Root",
  "category" : "Services",
  "requires" : null,
  "description" : "If the enable parameter is true, register the input document as a synchronization root for the currently authenticated user. Unregister it otherwise.",
  "url" : "NuxeoDrive.SetSynchronization",
  "signature" : [ "document", "void" ],
  "params" : [ {
    "name" : "enable",
    "description" : "Whether to register or unregister the input document as a synchronizaiton root.",
    "type" : "boolean",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  } ]
}