package
5.13.0+incompatible
Repository: https://github.com/documize/community.git
Documentation: pkg.go.dev
# Functions
ContainsPermission checks if action matches one of the required actions?.
DecodeUserCategoryPermissions returns a flat, usable permission summary record from multiple user permission records for a given category.
DecodeUserDocumentPermissions returns a flat, usable permission summary record from multiple user permission records for a given document.
DecodeUserPermissions returns a flat, usable permission summary record from multiple user permission records for a given space.
EncodeCategoryRecord creates standard permission record representing user permissions for a category.
EncodeDocumentRecord creates standard permission record representing user permissions for a document.
EncodeRecord creates standard permission record representing user permissions for a space.
EncodeUserCategoryPermissions returns multiple user permission records for a given document, using flat permission summary record.
EncodeUserDocumentPermissions returns multiple user permission records for a given document, using flat permission summary record.
EncodeUserPermissions returns multiple user permission records for a given space, using flat permission summary record.
HasAnyCategoryPermission returns true if user has at least one permission.
HasAnyDocumentPermission returns true if user has at least one permission.
HasAnyPermission returns true if user has at least one permission.
# Constants
CategoryView action means you can view a category and documents therein.
DocumentAdd action means you can create/upload documents to a space.
DocumentApprove means you can approve a change to a document.
DocumentCopy means you can copy documents within and between spaces.
DocumentDelete means you can delete documents in a space.
DocumentEdit action means you can edit documents in a space.
DocumentLifecycle means you can move a document between DRAFT/LIVE/ARCHIVE states.
DocumentMove means you can move documents between spaces.
DocumentTemplate means you can create, edit and delete document templates and content blocks.
DocumentVersion means you can manage document versions.
GroupPermission means permission is assigned to a group.
LocationCategory means category is being permissioned.
LocationDocument means document is being permissioned.
LocationSpace means space is being permissioned.
ScopeRow identifies row in table is being protected.
SpaceManage action means you can add, remove users, set permissions, but not delete that space.
SpaceOwner action means you can delete a space and do all SpaceManage functions.
SpaceView action means you can view a space and documents therein.
UserPermission means permission is assigned to a user.
# Structs
CategoryRecord represents space permissions for a user on a category.
CategoryViewRequestModel represents who should be allowed to see a category.
DocumentRecord represents space permissions for a user on a document.
Permission represents a permission for a space and is persisted to the database.
Record represents space permissions for a user on a space.
SpaceRequestModel details which users have what permissions on a given space.
# Type aliases
Action details type of action.
LocationType tells us the entity being permissioned.
ScopeType details at what level data is being protected, e.g.
WhoType tell us if permission record represents user or group.