class RoleApi

package api.backend

implements SwitchContext

@:directlyUsed@:build(api.macro.PHPInterface.build())@:autoBuild(api.macro.PHPInterface.build())@:build(safety.macro.SafeAst.build())@:keep

Users can be given one or more roles. A role holds the rights of a user.

Constructor

@:keepnew (role:Role)

Variables

@:keepread onlydeactivateUsers:Bool

Can deactivate users

@:keepread onlyid:Int

The database id

@:keepread onlyinviteUsers:Bool

Can invite new users

@:keepread onlymodifyAllSettings:Bool

Can modify all settings in the settings panel of an entry

@:keepread onlymodifySettings:Array<String>

Can modify specific settings of the settings panel of an entry

@:keepread onlymodifyUsers:Bool

Can modify existing users

@:keepread onlyname:String

The role name

@:keepread onlyoverwriteFiles:Bool

The user can overwrite existing files

@:keepread onlyviewSettings:Array<String>

Can view specific settings of the settings panel of an entry

@:keepread onlyviewUsers:Bool

Can view users

Methods

@:keepallowAllModifyingRights ():RoleApi

Allow the role to update, publish, remove and create all entries in all projects

@:keepallowAllViewingRights ():RoleApi

Allow the role to view and explore all entries in all projects

@:keepallowContentRight (project:ProjectApi, types:Array<String>, ?entries:Array<EntryApi>):RoleApi

Allow some rights in a specific project.

Argument types must contain one or more of these rights: view, explore, update, publish, remove, create

The entries argument can optionally contain one or more entries to which these rights apply.

@:keepdenyAllModifyingRights ():RoleApi

Deny the role to update, publish, remove and create all entries in all projects

@:keepdenyAllViewingRights ():RoleApi

Deny the role to view and explore all entries in all projects

@:keepdenyContentRight (project:ProjectApi, types:Array<String>, ?entries:Array<EntryApi>):RoleApi

Disallow some rights in a specific project.

Argument types must contain one or more of these rights: view, explore, update, publish, remove, create

The entries argument can optionally contain one or more entries to which these rights apply.

@:keepsetDeactivateUsers (deactivateUsers:Bool):RoleApi

Set deactivate users

@:keepsetInviteUsers (inviteUsers:Bool):RoleApi

Set can invite users

@:keepsetLanguageForModifyRights (project:ProjectApi, language:Null<String>):RoleApi

Modify rights can be restricted to one language, or all languages per project.

If language is set to null, all languages are allowed.

The given project must have rights set, or this call will have no effect.

@:keepsetModifyAllSettings (modifyAllSettings:Bool):RoleApi

Set modify all settings in the settings panel of an entry

@:keepsetModifySettings (settings:Array<String>):RoleApi

Set the modify specific settings of the settings panel of an entry

@:keepsetModifyUsers (modifyUsers:Bool):RoleApi

Set can modify existing users

@:keepsetName (name:String):RoleApi

The the name of the role

@:keepsetOverwriteFiles (overwriteFiles:Bool):RoleApi

Set whether the user can overwrite existing files

@:keepsetViewSettings (settings:Array<String>):RoleApi

Set view specific settings of the settings panel of an entry

@:keepsetViewUsers (viewUsers:Bool):RoleApi

Set can view users