LockCodeAquire
  • 1 Minute to read
  • Dark
    Light
  • PDF

LockCodeAquire

  • Dark
    Light
  • PDF

Article summary

Locks a project, preventing any user other than the user doing the locking from accessing the project in any way.

KeyValue(s)Description
method"LockCodeAcquire"Locks a project, preventing any user other than the user doing the locking from accessing the project in any way.
message"message to display"Added in 6.6.20
Message to display to a user who tries to access the project whilst it is locked.
project
"project to lock"

Lock a project by calling LockCodeAcquire

{
  "method": "LockCodeAcquire",
  "project": "BikeData3"
}

Unlock a project by calling LockCodeRelease:

{
  "method": "LockCodeRelease",
  "project": "BikeData3",
  "newInstance": true
}

NOTE: If "newInstance" = true, then all users will be forced to reconnect to the project.



Was this article helpful?