Entitlements Technical Reference


Entitlement Options

Options for managing Adaptable permissioning

PropertyTypeDescriptionDefault
defaultAccessLevelAccessLevel| ((defaultAccessLevelContext:DefaultAccessLevelContext) =>AccessLevel)AccessLevel to use when an Entitlement is not explicitly set; can be hardcoded value or a function to invoke'Full'
moduleEntitlementsEntitlement[] | ((entitlementContext:EntitlementContext) =>AccessLevel | undefined)Returns either collection of Entitlements, or a function to invoke when an Entitlement is required

Entitlement API

Entitlement API Section of Adaptable API - Provides run-time access to Entitlements

MethodReturnsDescription
getEntitlementAccessLevelForModule(adaptableModule)AccessLevelReturns Access Level of a Module
isModuleFullEntitlement(adaptableModule)booleanIs Module Full
isModuleHiddenEntitlement(adaptableModule)booleanIs Module Hidden
isModuleReadOnlyEntitlement(adaptableModule)booleanIs Module ReadOnly
isObjectReadonly(object)booleanIs the Adaptable Object ReadOnly