handle2 methods, 5 fields

DocumentGrant

Authorization over a document. Holding the handle (or its encoded string) is the access.

Obtained from: datumhue.documents.decode_grant, Document:grant
Accepted by: datumhue.documents.open

The examples on this page start from:

lua

local doc = datumhue.documents.create({ scope = "network" })
local grant = doc:grant({ mode = "write" })

Fields 5

Field	Type	Access	Description
`scope`	documents.Scope	read-only	The scope of the document the grant opens.
`mode`	documents.GrantMode	read-only	The access level the grant confers.
`prefix`	string	read-only	The key subtree the grant is narrowed to; empty for the whole document.
`expires_at`	integer?	read-only	Expiry as a UNIX-microseconds timestamp; nil when the grant never expires.
`bearer`	boolean	read-only	Whether holding the encoded string alone confers the authority.

Methods 2

DocumentGrant:delegate

method

DocumentGrant:delegate(opts: documents.GrantOptions) -> DocumentGrant

A narrower grant made from this one, without opening the document. Only a grant to a network document delegates. Only this grant's receiver can delegate (bearer grants: anyone holding them). Raises on any attempted widening, and on the last grant a line can hold. Grants made each from the one before form a line that holds eight from a network document documents.create made and seven from a named or communal one; a grant past them could not sync.

Example

local narrower = grant:delegate({
    mode = "read",
    prefix = "public/",
    valid_days = 7,
})
print(narrower:encode())

opts documents.GrantOptions options 4 keys

Key	Type	Default	Description
to	string	a bearer grant: anyone holding the encoded string holds its authority	Receiver identity key the grant is bound to.
mode	"read" \| "write"	"read"	Never wider than the granting handle's own mode.
prefix	string	the granting handle's own subtree	Narrow the grant to this key subtree.
valid_days	integer	30 days; a local grant never expires	Days the grant lasts, counted from an hour before now. It never outlasts the granting handle's own access.

In the guide: Messages, events and shared state

DocumentGrant:encode

method

DocumentGrant:encode() -> string

The transport form, for any channel (messaging, a file, a QR code). Opaque; decode with documents.decode_grant.

In the guide: Messages, events and shared state

`/` or `Ctrl` `K`	Search
`↑` `↓` `Enter`	Pick a result
`Tab`	Next result filter
`j` `k`	Next or previous entry
`[` `]`	Previous or next page
`y`	Copy a link to the current entry
`?`	These shortcuts
`Esc`	Close

DocumentGrant

Fields 5

Methods 2

DocumentGrant:delegate

DocumentGrant:encode

Try

Recently viewed

Settings

Keyboard shortcuts

On this page