Class UsersWhoCan

Hierarchy

Policy
- UsersWhoCan

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new UsersWhoCan(__namedParameters: ["show" | "create" | "edit" | "replace" | "delete", string]): UsersWhoCan

Overrides Policy.constructor
- Defined in src/app/policy-types/users-who-can.ts:6
Parameters
- __namedParameters: ["show" | "create" | "edit" | "replace" | "delete", string]
Returns UsersWhoCan

Properties

action_name

action_name: ActionName

params

params: any

target_collection_name

target_collection_name: string

Static type_name

type_name: string = "users-who-can"

Methods

_getRestrictingQuery

_getRestrictingQuery(context: Context): Promise<AllowAll | DenyAll>

Overrides Policy._getRestrictingQuery
- Defined in src/app/policy-types/users-who-can.ts:20
Parameters
- context: Context
Returns Promise<AllowAll | DenyAll>

check

check(context: Context, sealious_response?: SealiousResponse): Promise<PolicyDecision | null>

Inherited from Policy.check
- Defined in src/chip-types/policy.ts:43
Parameters
- context: Context
- Optional sealious_response: SealiousResponse
Returns Promise<PolicyDecision | null>

checkerFunction

checkerFunction(context: Context): Promise<null | { allowed: boolean; reason: string }>

Overrides Policy.checkerFunction
- Defined in src/app/policy-types/users-who-can.ts:28
Parameters
- context: Context
Returns Promise<null | { allowed: boolean; reason: string }>

getPolicy

getPolicy(app: App): Policy

- Defined in src/app/policy-types/users-who-can.ts:13
Parameters
- app: App
Returns Policy

getRestrictingQuery

getRestrictingQuery(context: Context): Promise<Query>

Inherited from Policy.getRestrictingQuery
- Defined in src/chip-types/policy.ts:36
Parameters
- context: Context
Returns Promise<Query>

isItemSensitive

isItemSensitive(): Promise<boolean>

Overrides Policy.isItemSensitive
- Defined in src/app/policy-types/users-who-can.ts:43
Returns Promise<boolean>

Static allow

allow(reason: string): { allowed: boolean; reason: string }

Inherited from Policy.allow
- Defined in src/chip-types/policy.ts:75
Parameters
- reason: string
Returns { allowed: boolean; reason: string }
- allowed: boolean
- reason: string

Static deny

deny(reason: string): { allowed: boolean; reason: string }

Inherited from Policy.deny
- Defined in src/chip-types/policy.ts:79
Parameters
- reason: string
Returns { allowed: boolean; reason: string }
- allowed: boolean
- reason: string

Static fromDefinition

fromDefinition(definition: PolicyDefinition): Policy

Inherited from Policy.fromDefinition
- Defined in src/chip-types/policy.ts:60
Parameters
- definition: PolicyDefinition
Returns Policy

Generated using TypeDoc