osb/doc/lua/commandprocessor.md

8 lines
563 B
Markdown
Raw Normal View History

2023-06-20 04:33:09 +00:00
The command processor has a single binding for performing admin checks, available on the *CommandProcessor* table.
---
#### `String` CommandProcessor.adminCheck(`ConnectionId` connectionId, `String` actionDescription)
Checks whether the specified connection id is authorized to perform admin actions and returns `nil` if authorization is succesful. If unauthorized, returns a `String` error message to display to the client requesting the action, which may include the specified action description, such as "Insufficient privileges to do the time warp again."