EntitlementOptions

Options for managing Entitlements in AdapTable, ie. which Modules are available to the User and whether as Full, ReadOnly or Hidden.

TypeScript
export interface

Properties

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

Property Details

defaultAccessLevel

AccessLevel to use when an Entitlement is not explicitly set; can be hardcoded value or a function to invoke

TypeScript
defaultAccessLevel?: AccessLevel | ((defaultAccessLevelContext: DefaultAccessLevelContext) => AccessLevel);
Default Value

'Full'

Property Value

AccessLevel| ((defaultAccessLevelContext:DefaultAccessLevelContext) =>AccessLevel)

moduleEntitlements

Returns either collection of Entitlements, or a function to invoke when an Entitlement is required

TypeScript
moduleEntitlements?: Entitlement[] | ((entitlementContext: EntitlementContext) => AccessLevel | undefined);
Property Value

Entitlement[] | ((entitlementContext:EntitlementContext) =>AccessLevel | undefined)