Class ops.Session
Defined in: Session.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
ops.Session(odfCanvas)
An editing session and what belongs to it.
|
| Method Attributes | Method Name and Description |
|---|---|
|
close(callback,)
|
|
|
destroy(callback,)
|
|
|
enqueue(ops)
Controller sends operations to this method.
|
|
| <inner> |
forwardBatchEnd(args)
Forward the router's batch end signal on to the document
|
| <inner> |
forwardBatchStart(args)
Forward the router's batch start signal on to the document
|
| <inner> |
init()
|
|
setOperationFactory(opFactory)
|
|
|
setOperationRouter(opRouter)
|
Class Detail
ops.Session(odfCanvas)
An editing session and what belongs to it.
- Parameters:
- {!odf.OdfCanvas} odfCanvas
Method Detail
{undefined}
close(callback,)
- Parameters:
- {!function(!Object=)} callback,
- passing an error object in case of error
- Returns:
- {undefined}
{undefined}
destroy(callback,)
- Parameters:
- {!function(!Error=)} callback,
- passing an error object in case of error
- Returns:
- {undefined}
{undefined}
enqueue(ops)
Controller sends operations to this method.
- Parameters:
- {!Array.} ops
- Returns:
- {undefined}
<inner>
{undefined}
forwardBatchEnd(args)
Forward the router's batch end signal on to the document
- Parameters:
- {*} args
- Returns:
- {undefined}
<inner>
{undefined}
forwardBatchStart(args)
Forward the router's batch start signal on to the document
- Parameters:
- {*} args
- Returns:
- {undefined}
{!ops.OdtDocument}
getOdtDocument()
- Returns:
- {!ops.OdtDocument}
{!ops.OperationFactory}
getOperationFactory()
- Returns:
- {!ops.OperationFactory}
<inner>
{undefined}
init()
- Returns:
- {undefined}
setOperationFactory(opFactory)
- Parameters:
- {!ops.OperationFactory} opFactory
{undefined}
setOperationRouter(opRouter)
- Parameters:
- {!ops.OperationRouter} opRouter
- Returns:
- {undefined}
