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


Ignore:
Timestamp:
Sep 23, 2019, 2:35:00 PM (5 years ago)
Author:
Administrator
Comment:

—

Legend:

Unmodified
Added
Removed
Modified

  • Public/Docs/CinnamonApi

    v2 v3  
    234234=== listuilanguages
    235235> **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}}}        ||
    240241||{{{id}}}    ||ID of the object to be locked.        ||
    241242||{{{ticket}}}    ||Session ticket.        ||
    242243
    243244==== Return value
    244 The {{{lockobject}}} returns {{{<success/>}}} or an {{{<error/>}}} element containing a message.
    245 
    246 ==== Description
    247 The {{{lockobject}}} command places a write lock on the object identified by the {{{id}}} parameter.
     245The {{{lock}}} command returns {{{<success/>}}} or an {{{<error/>}}} element containing a message.
     246
     247==== Description
     248The {{{lock}}} command places a write lock on the object identified by the {{{id}}} parameter.
    248249
    249250=== renderindexedosd
    … …  
    309310=== setsummary
    310311=== 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}}}        ||
    315317||{{{id}}}    ||ID of the object to be unlocked.        ||
    316318||{{{ticket}}}    ||Session ticket.        ||
    317319
    318320==== Return value
    319 The {{{unlockobject}}} command returns {{{<success/>}}} or an {{{<error/>}}} element containing a message.
    320 
    321 ==== Description
    322 The {{{unlockobject}}} command removes a write lock on the object identified by the {{{id}}} parameter.
     321The {{{unlock}}} command returns {{{<success/>}}} or an {{{<error/>}}} element containing a message.
     322
     323==== Description
     324The {{{unlock}}} command removes a write lock on the object identified by the {{{id}}} parameter.
    323325
    324326=== updatefolder