Class Index | File Index

Classes


Class gui.MetadataController


Defined in: MetadataController.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
gui.MetadataController(session, inputMemberId)
Field Summary
Field Attributes Field Name and Description
<static>  
gui.MetadataController.signalMetadataChanged
Method Summary
Method Attributes Method Name and Description
 
destroy(callback,)
 
getMetadata(property)
Returns the value of the requested document metadata field
<inner>  
<inner>  
 
setMetadata(setProperties, removedProperties)
Sets the metadata fields from the given properties map.
 
subscribe(eventid, cb)
 
unsubscribe(eventid, cb)
Class Detail
gui.MetadataController(session, inputMemberId)
Parameters:
{!ops.Session} session
{!string} inputMemberId
Field Detail
<static> gui.MetadataController.signalMetadataChanged
Method Detail
{undefined} destroy(callback,)
Parameters:
{!function(!Error=):undefined} callback,
passing an error object in case of error
Returns:
{undefined}

{?string} getMetadata(property)
Returns the value of the requested document metadata field
Parameters:
{!string} property
A namespace-prefixed field name, for example dc:creator
Returns:
{?string}

<inner> {!boolean} isWriteableMetadata(property)
Parameters:
{!string} property
Returns:
{!boolean}

<inner> {undefined} onMetadataUpdated(changes)
Parameters:
{!Object} changes
Returns:
{undefined}

{undefined} setMetadata(setProperties, removedProperties)
Sets the metadata fields from the given properties map. Avoid setting certain fields since they are automatically set: dc:creator dc:date meta:editing-cycles If you do wish to externally set these fields, try getting the master session to inject operations into the timeline with the relevant properties. The following properties are never used and will be removed for semantic consistency from the document: meta:editing-duration meta:document-statistic Setting any of the above mentioned fields using this method will have no effect.
Parameters:
{?Object.} setProperties
A flat object that is a string->string map of field name -> value.
{?Array.|undefined=} removedProperties
An array of metadata field names (prefixed).
Returns:
{undefined}

{undefined} subscribe(eventid, cb)
Parameters:
{!string} eventid
{!Function} cb
Returns:
{undefined}

{undefined} unsubscribe(eventid, cb)
Parameters:
{!string} eventid
{!Function} cb
Returns:
{undefined}

Documentation generated by JsDoc Toolkit 2.4.0 on Thu Aug 06 2015 04:10:40 GMT+0200 (MESZ)