Role Permissions Helper

class AzuracastPy.models.administration.role.PermissionsHelper(_role)

Provides functions for interacting with a role’s permissions.

__init__(_role): Initializes a PermissionsHelper object.

Note

This class should not be initialized directly. Instead, obtain an instance via: role.permission.

add_global(*args: GlobalPermissions)

Adds one or more global permissions to the role.

Parameters:: args – The permission(s) to be added to the role. All arguments must be from the GlobalPermissions enum.

Usage:

from AzuracastPy.enums import GlobalPermissions

admin.permission.add_global(GlobalPermissions.ADMINISTER_ALL)

admin.permission.add_global(
    GlobalPermissions.ADMINISTER_ALL,
    GlobalPermissions.ADMINISTER_BACKUPS
)

remove_global(*args: GlobalPermissions)

Removes one or more global permissions from the role.

Parameters:: args – The permission(s) to be removed from the role. All arguments must be from the GlobalPermissions enum.

Usage:

from AzuracastPy.enums import GlobalPermissions

admin.permission.remove_global(GlobalPermissions.ADMINISTER_ALL)

admin.permission.remove_global(
    GlobalPermissions.ADMINISTER_ALL,
    GlobalPermissions.ADMINISTER_BACKUPS
)