Class Policy

Hierarchy

Policy
- Not
- ReducingPolicy
- Public
- If
- LoggedIn
- Noone
- Owner
- Roles
- SameAnon
- gSameAsForResourceInField
- Super
- Themselves
- UserReferencedInField
- UsersWhoCan

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Policy(params?: any): Policy

- Defined in src/chip-types/policy.ts:19
Parameters
- Default value params: any = {}
Returns Policy

Properties

params

params: any

Static type_name

type_name: string

Methods

Protected Abstract _getRestrictingQuery

_getRestrictingQuery(context: Context): Promise<Query>

- Defined in src/chip-types/policy.ts:34
Parameters
- context: Context
Returns Promise<Query>

check

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

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

Abstract checkerFunction

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

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

getRestrictingQuery

getRestrictingQuery(context: Context): Promise<Query>

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

isItemSensitive

isItemSensitive(): Promise<boolean>

- Defined in src/chip-types/policy.ts:30
Returns Promise<boolean>

Static allow

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

- 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 }

- 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

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

Generated using TypeDoc