aboutsummaryrefslogtreecommitdiff
path: root/doc/design-api
diff options
context:
space:
mode:
Diffstat (limited to 'doc/design-api')
-rw-r--r--doc/design-api13
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/design-api b/doc/design-api
index 39d160b..0af6862 100644
--- a/doc/design-api
+++ b/doc/design-api
@@ -61,6 +61,19 @@ Object API
display, or undef on error. On error, the caller should call error()
to get the error text.
+ default_check(PRINCIPAL)
+
+ Applies the default authorization rules for this object type, if any,
+ and returns 1 if those default authorization rules allow access. If
+ there are no authorization rules or if they don't allow access,
+ returns 0. On error, returns undef; the caller should call error() to
+ get the error text.
+
+ error()
+
+ Returns the error text from the last failed get(), store(), show(), or
+ default_check() call.
+
ACL API
new()