EntityAccessRules class

Rules to access entities. Used by APIServer responses.

Inheritance

• Object
• EntityRules<EntityAccessRules>
• EntityAccessRules

Implementers

• EntityAccessRulesCached

Constructors

EntityAccessRules({EntityAccessRuleType? ruleType, Type? entityType, List<String>? entityFields, List<EntityAccessRules>? rules, EntityAccessRulesCondition? condition, EntityAccessRulesMasker? masker})

const

EntityAccessRules.allow(Type entityType, {List<String>? entityFields, EntityAccessRulesCondition? condition})

const

EntityAccessRules.allowFields(Type entityType, List<String> entityFields, {EntityAccessRulesCondition? condition})

const

EntityAccessRules.block(Type entityType, {List<String>? entityFields, EntityAccessRulesCondition? condition})

const

EntityAccessRules.blockFields(Type entityType, List<String> entityFields, {EntityAccessRulesCondition? condition})

const

EntityAccessRules.group(List<EntityAccessRules> rules)

const

EntityAccessRules.mask(Type entityType, {List<String>? entityFields, EntityAccessRulesCondition? condition, EntityAccessRulesMasker? masker})

const

EntityAccessRules.maskFields(Type entityType, List<String> entityFields, {EntityAccessRulesCondition? condition, EntityAccessRulesMasker? masker})

const

Properties

cached → EntityAccessRules

no setter

condition → EntityAccessRulesCondition?

final

entityFields → List<String>?

final

entityType → Type?

final

hashCode → int

The hash code for this object.

no setter, override

isInnocuous → bool

Returns true if this instance is equivalent to innocuous instance (no resolution rules to apply).

no setter, override

isValid → bool

Return true if this instance rules are valid.

no setter, override

masker → EntityAccessRulesMasker?

final

rules → List<EntityAccessRules>?

final

ruleType → EntityAccessRuleType?

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

applyMask<O extends Object, V>(O object, String field, V value, {EntityAccessRulesContext? context, Type? type}) → V

copyWith({EntityAccessRuleType? ruleType, Type? entityType, List<String>? entityFields, List<EntityAccessRules>? rules, EntityAccessRulesCondition? condition}) → EntityAccessRules

hasRuleForEntityType(Type type) → bool

hasRuleForEntityTypeField(Type type) → bool

hasRuleType(List<EntityAccessRuleType> ruleTypes) → bool

isAllowedEntityType(Type type) → bool?

isAllowedEntityTypeField(Type type, String field, {EntityAccessRulesContext? context}) → bool?

isMaskedEntityTypeField(Type type, String field, {EntityAccessRulesContext? context, bool direct = false}) → bool?

merge(EntityAccessRules? other) → EntityAccessRules

Merges this rules with other rules.

override

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

simplified() → EntityAccessRules

toJson() → Map<String, Object?>

override

toJsonEncodable(APIRequest apiRequest, ToEncodableJsonProvider encodableJsonProvider, Object o) → ToEncodableJson?

toString() → String

A string representation of this object.

override

totalRules() → int

Returns the total number of applicable rules, including nested rules when present.

validate() → void

Validates this instances rules. See isValid.

override

Operators

operator ==(Object other) → bool

The equality operator.

override

Static Methods

defaultMask<O extends Object, V>(EntityAccessRulesContext? context, O object, String field, V value) → V

Constants

innocuous → const EntityAccessRules

A const instance without any resolution rules to apply.