Class IncrementalHomeRecorder
Defined in: IncrementalHomeRecorder.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
IncrementalHomeRecorder(application, configuration)
A home recorder able to save the application homes incrementally by sending undoable edits
to a server supporting home edits.
|
| Method Attributes | Method Name and Description |
|---|---|
|
addHome(home, homeController)
Adds a home to be incrementally saved by this recorder.
|
|
|
configure(configuration)
Configures this incremental recorder's behavior.
|
|
|
Gets the home properties that are tracked and potentially written by this recorder.
|
|
|
readHome(homeName, observer)
Reads a home with this recorder.
|
|
|
removeHome(home)
Removes a home previously added with
addHome. |
|
|
sendUndoableEdits(home)
Sends to the server all the currently waiting edits for the given home.
|
Class Detail
IncrementalHomeRecorder(application, configuration)
A home recorder able to save the application homes incrementally by sending undoable edits
to a server supporting home edits.
Author: Renaud Pawlak, Emmanuel Puybaret, Louis Grignon.
Author: Renaud Pawlak, Emmanuel Puybaret, Louis Grignon.
- Parameters:
- {HomeApplication} application
- {{readHomeURL: string|writeHomeEditsURL: string|closeHomeURL: string|writeResourceURL: string|readResourceURL: string|pingURL: string|autoWriteDelay: number|trackedHomeProperties: string[]|autoWriteTrackedStateChange: boolean|writingObserver: {writeStarted: Function|writeSucceeded: Function|writeFailed: Function|connectionFound: Function|connectionLost: Function} }} configuration Optional
- the recorder configuration
Method Detail
addHome(home, homeController)
Adds a home to be incrementally saved by this recorder.
- Parameters:
- {Home} home
- {HomeController} homeController
configure(configuration)
Configures this incremental recorder's behavior.
- Parameters:
- {Object} configuration
- an object containing configuration fields
getTrackedHomeProperties()
Gets the home properties that are tracked and potentially written by this recorder.
readHome(homeName, observer)
Reads a home with this recorder.
- Parameters:
- {string} homeName
- the home name on the server
or the URL of the home if
readHomeURLservice is missing - {{homeLoaded: function|homeError: function|progression: function}} observer
- callbacks used to follow the reading of the home
removeHome(home)
Removes a home previously added with
addHome.
- Parameters:
- {Home} home
sendUndoableEdits(home)
Sends to the server all the currently waiting edits for the given home.
- Parameters:
- {Home} home
