Entitlements API

Provides access to the Entitlements section of Adaptable State.

Entitlements API Methods

MethodDescription
addEntitlement(entitlement)Adds new Entitlement to Entitlement section of Adaptable State
addEntitlements(entitlements)Adds array of Entitlements to Entitlement section of Adaptable State
createEntitlement(adaptableFunction, accessLevel)Creates new Entitlement and adds it to Entitlement section of Adaptable State
deleteEntitlement(adaptableFunction)Deletes an existing Entitlement
editEntitlement(adaptableFunction, accessLevel)Edits an existing Entitlement
getEntitlementAccessLevelByFunction(adaptableFunction)Retrieves the Entitlement Access Level for a given Adaptable Function
getEntitlementState()Returns everything in the Entitlement section of AdapTable state
isFunctionFullEntitlement(adaptableFunction)Returns true if given function has AccessLevel of 'Full'
isFunctionHiddenEntitlement(adaptableFunctionName)Returns true if given function has AccessLevel of 'Hidden'
isFunctionReadOnlyEntitlement(adaptableFunction)Returns true if given function has AccessLevel of 'ReadOnly'

See API documentation for full details of all available functions with lists of parameters

More Information