Permission

Namespace: uModLibraries

Assembly: uMod.Core.dll

Inheritance ObjectLibrary Permission

Implements ILibrary, ISingleton

Summary

A library providing a unified permissions system

Constructors

Name

Summary

Permission (IApplication)

Properties

Name

Summary

IsLoaded

Methods

Name

Summary

AddUserGroup (String, String)

Set the group to which the specified player belongs

CleanUp ()

Cleans invalid user ID entries

CreateGroup (String, String, Int32, String)

Creates the specified group

Export (String)

Exports user/group data to json

GetGroupParent (String)

Gets the parent of the specified group

GetGroupPermissionGroup (String, String)

Returns the parent group that the specified permission belongs to

GetGroupPermissions (String, Boolean)

Returns the permissions which the specified group has, with optional transversing of parent groups

GetGroupRank (String)

Returns the rank of the specified group

GetGroups ()

Returns existing groups

GetGroupTitle (String)

Returns the title of the specified group

GetPermissionGroups (String)

GetPermissions ()

Returns the permissions which are registered

GetPermissions (IPlugin)

GetPermissionUsers (String)

GetUserGroups (String)

Returns the group to which the specified player belongs

GetUserPermissionGroup (String, String)

Returns the group that a specified player permission is inherited from

GetUserPermissions (String)

Returns the permissions which the specified player has

GetUsersInGroup (String)

Returns users in that group

GrantGroupPermission (String, String, IPlugin)

Grant the specified permission to the specified group

GrantUserPermission (String, String, IPlugin)

Grants the specified permission to the specified player

GroupExists (String)

Returns if the specified group exists or not

GroupHasPermission (String, String)

Returns if the specified group has the specified permission or not

GroupsHavePermission (HashSet<String>, String)

Returns if the specified group has the specified permission or not

IsGroupPermissionInherited (String, String)

Checks if specified permission belongs to group or parent group

IsUserPermissionInherited (String, String)

Returns if the specified player permission is inherited from a group

MigrateGroup (String, String)

Migrate permissions from one group to another

PermissionExists (String, IPlugin)

Returns if the specified permission exists or not

RegisterPermission (String, IPlugin)

Registers the specified permission

RegisterValidate (Func<String, Boolean>)

Register user ID validation

RemoveGroup (String)

Removes the specified group

RemoveUserGroup (String, String)

Set the group to which the specified player belongs

RenameGroup (String, String)

Rename group

RevokeGroupPermission (String, String)

Revokes the specified permission from the specified player

RevokeUserPermission (String, String)

Revokes the specified permission from the specified player

SaveData ()

Saves all permissions data to the data files

SaveGroups ()

Saves groups permissions data to the data file

SaveUsers ()

Saves users permissions data to the data file

SetGroupParent (String, String)

Sets the parent of the specified group

SetGroupRank (String, Int32)

Sets the rank of the specified group

SetGroupTitle (String, String)

Sets the title of the specified group

UnregisterPermission (String, IPlugin)

Unregisters the specified permission

UpdateNickname (String, String)

Updates the player name

UserExists (String)

Determines if the specified player exists

UserHasAnyGroup (String)

Check if user has a group

UserHasGroup (String, String)

Get if the player belongs to given group

UserHasPermission (String, String)

Returns if the specified player has the specified permission

UserIdValid (String)

Determines if the specified player ID is valid