ISharePermissionType
in
Tags
Attributes
- #[Implementable]
- $since: '35.0.0'
Table of Contents
Methods
- getDisplayName() : non-empty-string
- Returns a user friendly display name for this permission.
- getHint() : non-empty-string|null
- Returns a user friendly hint for this permission.
- getPriority() : int<1, 100>
- Returns a priority used for sorting the permissions for the user interface.
- isEnabledByDefault() : bool
- Whether this permission is enabled by default or not.
Methods
getDisplayName()
Returns a user friendly display name for this permission.
public
getDisplayName(IFactory $l10nFactory) : non-empty-string
Parameters
- $l10nFactory : IFactory
Tags
Return values
non-empty-stringgetHint()
Returns a user friendly hint for this permission.
public
getHint(IFactory $l10nFactory) : non-empty-string|null
Parameters
- $l10nFactory : IFactory
Tags
Return values
non-empty-string|nullgetPriority()
Returns a priority used for sorting the permissions for the user interface.
public
getPriority() : int<1, 100>
A higher value means the permission will be shown further up in the list of permissions.
Tags
Return values
int<1, 100>isEnabledByDefault()
Whether this permission is enabled by default or not.
public
isEnabledByDefault() : bool