Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Acl

Creates a new Acl object, with an empty rule set for an object

Hierarchy

  • Acl

Index

Constructors

Properties

read: Permission = ...

The read permission of the object

write: Permission = ...

The write permission of the object

Methods

  • Allows the given user or rule to read the object

    Parameters

    Returns Acl

    this acl object

  • Allows the given user or rule to write the object

    Parameters

    Returns Acl

    this acl object

  • clear(): void
  • Removes all acl rules, read and write access is public afterwards

    Returns void

  • Copies permissions from another ACL

    Parameters

    • acl: Acl

      The ACL to copy from

    Returns Acl

  • Deletes any read allow/deny rule for the given user or role

    Parameters

    Returns Acl

    this acl object

  • Deletes any write allow/deny rule for the given user or role

    Parameters

    Returns Acl

    this acl object

  • Denies the given user or rule to read the object

    Parameters

    Returns Acl

    this acl object

  • Denies the given user or rule to write the object

    Parameters

    Returns Acl

    this acl object

  • Sets the acl rules form JSON

    Parameters

    • json: JsonMap

      The json encoded acls

    Returns void

  • isPublicReadAllowed(): boolean
  • Gets whenever all users and roles have the permission to read the object

    Returns boolean

    true If public access is allowed

  • isPublicWriteAllowed(): boolean
  • Gets whenever all users and roles have the permission to write the object

    Returns boolean

    true If public access is allowed

  • Checks whenever the user or role is explicit allowed to read the object

    Parameters

    Returns boolean

    true if read access is explicitly allowed for the given user or role

  • Checks whenever the user or role is explicit denied to read the object

    Parameters

    Returns boolean

    true if read access is explicitly denied for the given user or role

  • Checks whenever the user or role is explicit allowed to write the object

    Parameters

    Returns boolean

    true if write access is explicitly allowed for the given user or role

  • Checks whenever the user or role is explicit denied to write the object

    Parameters

    Returns boolean

    true if write access is explicitly denied for the given user or role

  • setPublicReadAllowed(): void
  • Sets whenever all users and roles should have the permission to read the object

    Note: All other allow read rules will be removed.

    Returns void

  • setPublicWriteAllowed(): void
  • Sets whenever all users and roles should have the permission to write the object

    Note: All other allow write rules will be removed.

    Returns void

  • A JSON representation of the set of rules

    Returns JsonMap

Generated using TypeDoc