Platform Explorer / Nuxeo Platform LTS 2019 10.10

Operation Seam.PushDocument (Push to Seam Context)

Description

Push the current input document into Seam context. Returns back the document.
Operation id Seam.PushDocument
AliasesWebUI.PushDocumentToSeamContext
Category User Interface
Label Push to Seam Context
Requires Seam
Since

Parameters

Name Description Type Required Default value
name string yes  
scope string yes session, conversation, page, event 

Signature

Inputs document
Outputs document

Implementation Information

JSON Definition

{
  "id" : "Seam.PushDocument",
  "aliases" : [ "WebUI.PushDocumentToSeamContext" ],
  "label" : "Push to Seam Context",
  "category" : "User Interface",
  "requires" : "Seam",
  "description" : "Push the current input document into Seam context. Returns back the document.",
  "url" : "Seam.PushDocument",
  "signature" : [ "document", "document" ],
  "params" : [ {
    "name" : "name",
    "description" : "",
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "scope",
    "description" : "",
    "type" : "string",
    "required" : true,
    "widget" : "Option",
    "order" : 0,
    "values" : [ "session", "conversation", "page", "event" ]
  } ]
}