This site is currently undergoing maintenance, so instances of "RelativityOne" may still be present. You may also experience 404 errors, search disruptions, and temporary style changes.

Last date modified: 2026-Oct-07

Permission Api

Represents a permission object exposed as a part of the Event Handler API. It is used to check actions allowed for an object of a specific object type in a given workspace. These functions are available under the `convenienceApi.permission` namespace.

Methods

canView() ⇒ Boolean | undefined
Returns user's permission to view object
canEdit() ⇒ Boolean | undefined
Returns user's permission to edit object
canDelete() ⇒ Boolean | undefined
Returns user's permission to delete object
canSecure() ⇒ Boolean | undefined
Returns user's permission to secure object
canAdd() ⇒ Boolean | undefined
Returns user's permission to add object
canViewAudit() ⇒ Boolean | undefined
Returns user's permission to add object

Properties Details

canView() ⇒ Boolean | undefined

Returns user's permission to view object

Returns: Boolean | undefined - whether or not the user has permission to view object

canEdit() ⇒ Boolean | undefined

Returns user's permission to edit object

Returns: Boolean | undefined - whether or not the user has permission to edit object

canDelete() ⇒ Boolean | undefined

Returns user's permission to delete object

Returns: Boolean | undefined - whether or not the user has permission to delete object

canSecure() ⇒ Boolean | undefined

Returns user's permission to secure object

Returns: Boolean | undefined - whether or not the user has permission to secure object

canAdd() ⇒ Boolean | undefined

Returns user's permission to add object

Returns: Boolean | undefined - whether or not the user has permission to add object

canViewAudit() ⇒ Boolean | undefined

Returns user's permission to add object

Returns: Boolean | undefined - whether or not the user has permission to add object

Feedback