EntitlementApi

Provides functions for Entitlements and Permissions

TypeScript
export interface

Methods

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

Method Details

getEntitlementAccessLevelForModule

Returns Access Level of a Module

TypeScript
getEntitlementAccessLevelForModule(adaptableModule: AdaptableModule): AccessLevel;
Parameters
ParameterTypeDescription
adaptableModuleAdaptableModuleModule to Check
Returns

AccessLevel

isModuleFullEntitlement

Is Module Full

TypeScript
isModuleFullEntitlement(adaptableModule: AdaptableModule): boolean;
Parameters
ParameterTypeDescription
adaptableModuleAdaptableModuleModule to Check
Returns

boolean

isModuleHiddenEntitlement

Is Module Hidden

TypeScript
isModuleHiddenEntitlement(adaptableModule: AdaptableModule): boolean;
Parameters
ParameterTypeDescription
adaptableModuleAdaptableModuleModule to Check
Returns

boolean

isModuleReadOnlyEntitlement

Is Module ReadOnly

TypeScript
isModuleReadOnlyEntitlement(adaptableModule: AdaptableModule): boolean;
Parameters
ParameterTypeDescription
adaptableModuleAdaptableModuleModule to Check
Returns

boolean

isObjectReadonly

Is the Adaptable Object ReadOnly

TypeScript
isObjectReadonly(object: AdaptableObject): boolean;
Parameters
ParameterTypeDescription
objectAdaptableObjectObject to Check
Returns

boolean

PreviousEntitlementNextEntitlementContext