Changes between Version 1 and Version 2 of Public/Docs/CinnamonApi

Timestamp:

Sep 11, 2019, 11:41:19 AM (5 years ago)

Author:

Administrator

Comment:

—

Public/Docs/CinnamonApi

@@ -235 +235 @@
 > **NOTE:** This API method will be replaced by a future, global session configuration transfer instead of individual methods. 
 === lockobject
+==== Parameters
+||=**Field** =||=**Value** =||
+||{{{command}}}    ||{{{lockobject}}}        ||
+||{{{id}}}    ||ID of the object to be locked.        ||
+||{{{ticket}}}    ||Session ticket.        ||
+
+==== Return value
+The {{{lockobject}}} returns {{{<success/>}}} or an {{{<error/>}}} element containing a message.
+
+==== Description
+The {{{lockobject}}} command places a write lock on the object identified by the {{{id}}} parameter.
+
 === renderindexedosd
 > **NOTE:** New in build 117. 
@@ -274 +286 @@
 === setchangedstatus
 === setcontent
+==== Parameters
+||=**Field** =||=**Value** =||
+||{{{command}}}    ||{{{setcontent}}}        ||
+||{{{id}}}    ||ID of the object whose content is to be uploaded.        ||
+||{{{format}}}    ||System name of the format whose content is to be uploaded.        ||
+||{{{ticket}}}    ||Session ticket to disconnect.        ||
+
+==== Return value
+The {{{setcontent}}} command command returns {{{<success/>}}} or an {{{<error/>}}} element containing a message.
+
+{{{#!comment
+TODO: to be documented what can go wrong (wrong id etc.).
+}}}
+
+==== Description
+The {{{setcontent}}} command uploads content of the format identified by {{{format}}} to an existing object identified by its {{{id}}}. {{{setcontent}}} sends the file content stream to the server.
+
+
 === setmeta
 === setmetaset
@@ -280 +310 @@
 === setsysmeta
 === unlockobject
+==== Parameters
+||=**Field** =||=**Value** =||
+||{{{command}}}    ||{{{unlockobject}}}        ||
+||{{{id}}}    ||ID of the object to be unlocked.        ||
+||{{{ticket}}}    ||Session ticket.        ||
+
+==== Return value
+The {{{unlockobject}}} command returns {{{<success/>}}} or an {{{<error/>}}} element containing a message.
+
+==== Description
+The {{{unlockobject}}} command removes a write lock on the object identified by the {{{id}}} parameter.
+
 === updatefolder
 === updatelink