Changes between Version 2 and Version 3 of Public/Docs/CinnamonApi
- Timestamp:
- Sep 23, 2019, 2:35:00 PM (5 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
Public/Docs/CinnamonApi
v2 v3 234 234 === listuilanguages 235 235 > **NOTE:** This API method will be replaced by a future, global session configuration transfer instead of individual methods. 236 === lockobject 237 ==== Parameters 238 ||=**Field** =||=**Value** =|| 239 ||{{{command}}} ||{{{lockobject}}} || 236 === lock 237 > **NOTE:** The {{{lock}}} command ist wrapped with the {{{lockobject}}} method in the {{{NativeApiServerConnector.ServerCommandSession}}} class, because {{{lock}}} is a reserved word in C#. 238 ==== Parameters 239 ||=**Field** =||=**Value** =|| 240 ||{{{command}}} ||{{{lock}}} || 240 241 ||{{{id}}} ||ID of the object to be locked. || 241 242 ||{{{ticket}}} ||Session ticket. || 242 243 243 244 ==== Return value 244 The {{{lock object}}}returns {{{<success/>}}} or an {{{<error/>}}} element containing a message.245 246 ==== Description 247 The {{{lock object}}} command places a write lock on the object identified by the {{{id}}} parameter.245 The {{{lock}}} command returns {{{<success/>}}} or an {{{<error/>}}} element containing a message. 246 247 ==== Description 248 The {{{lock}}} command places a write lock on the object identified by the {{{id}}} parameter. 248 249 249 250 === renderindexedosd … … 309 310 === setsummary 310 311 === setsysmeta 311 === unlockobject 312 ==== Parameters 313 ||=**Field** =||=**Value** =|| 314 ||{{{command}}} ||{{{unlockobject}}} || 312 === unlock 313 > **NOTE:** The {{{unlock}}} command ist wrapped with the {{{unlockobject}}} method in the {{{NativeApiServerConnector.ServerCommandSession}}} class for symmetry reasons with the {{{lock}}} command, because {{{lock}}} is a reserved word in C#. 314 ==== Parameters 315 ||=**Field** =||=**Value** =|| 316 ||{{{command}}} ||{{{unlock}}} || 315 317 ||{{{id}}} ||ID of the object to be unlocked. || 316 318 ||{{{ticket}}} ||Session ticket. || 317 319 318 320 ==== Return value 319 The {{{unlock object}}} command returns {{{<success/>}}} or an {{{<error/>}}} element containing a message.320 321 ==== Description 322 The {{{unlock object}}} command removes a write lock on the object identified by the {{{id}}} parameter.321 The {{{unlock}}} command returns {{{<success/>}}} or an {{{<error/>}}} element containing a message. 322 323 ==== Description 324 The {{{unlock}}} command removes a write lock on the object identified by the {{{id}}} parameter. 323 325 324 326 === updatefolder