Struct pallet_roles::Module

pub struct Module<T: Trait>(_);

Implementations

impl<T: Trait> Module<T>

pub fn ensure_role_exists(role_id: u64) -> DispatchResult

Check that there is a Role with such role_id in the storage or returnRoleNotFound error.

pub fn require_role(role_id: SpaceId) -> Result<Role<T>, DispatchError>

Get Role by id from the storage or return RoleNotFound error.

pub fn ensure_role_manager(
    account: T::AccountId,
    space_id: SpaceId
) -> DispatchResult

Ensure that this account is not blocked and has ‘ManageRoles’ permission in a given space

impl<T: Trait> Module<T>

pub fn get_space_permissions_by_account(
    account: T::AccountId,
    space_id: SpaceId
) -> Vec<SpacePermission>

pub fn get_accounts_with_any_role_in_space(
    space_id: SpaceId
) -> Vec<T::AccountId>

pub fn get_space_ids_for_account_with_any_role(
    account_id: T::AccountId
) -> Vec<SpaceId>

impl<T: Trait + 'static> Module<T>

pub fn next_role_id() -> u64

The next role id.

pub fn role_by_id<K: EncodeLike<u64>>(key: K) -> Option<Role<T>>

Get role details by its id.

pub fn users_by_role_id<K: EncodeLike<u64>>(key: K) -> Vec<User<T::AccountId>>

A list of all users (account or space ids) that have this role.

pub fn role_ids_by_space_id<K: EncodeLike<SpaceId>>(key: K) -> Vec<u64>

A list of all role ids available in this space.

pub fn role_ids_by_user_in_space<KArg1, KArg2>(k1: KArg1, k2: KArg2) -> Vec<u64> where
    KArg1: EncodeLike<User<T::AccountId>>,
    KArg2: EncodeLike<SpaceId>, 

impl<T: Trait> Module<T>

Can also be called using Call.

pub fn create_role(
    origin: T::Origin,
    space_id: SpaceId,
    time_to_live: Option<T::BlockNumber>,
    content: Content,
    permissions: Vec<SpacePermission>
) -> DispatchResult

Create a new role in a space with a list of permissions. content points to the off-chain content with such additional info about this role as its name, description, color, etc. Only the space owner or a user with ManageRoles permission call this dispatch.

NOTE: Calling this function will bypass origin filters.

pub fn update_role(
    origin: T::Origin,
    role_id: u64,
    update: RoleUpdate
) -> DispatchResult

Update an existing role by its id. Only the space owner or a user with ManageRoles permission call this dispatch.

NOTE: Calling this function will bypass origin filters.

pub fn delete_role(origin: T::Origin, role_id: u64) -> DispatchResult

Delete a role from all associated storage items. Only the space owner or a user with ManageRoles permission call this dispatch.

NOTE: Calling this function will bypass origin filters.

pub fn grant_role(
    origin: T::Origin,
    role_id: u64,
    users: Vec<User<T::AccountId>>
) -> DispatchResult

Grant a role to a list of users. Only the space owner or a user with ManageRoles permission call this dispatch.

NOTE: Calling this function will bypass origin filters.

pub fn revoke_role(
    origin: T::Origin,
    role_id: u64,
    users: Vec<User<T::AccountId>>
) -> DispatchResult

Revoke a role from a list of users. Only the space owner or a user with ManageRoles permission call this dispatch.

NOTE: Calling this function will bypass origin filters.

Trait Implementations

impl<T: Trait> Callable<T> for Module<T>

type Call = Call<T>

impl<T: Clone + Trait> Clone for Module<T>

fn clone(&self) -> Module<T>

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Copy + Trait> Copy for Module<T>

impl<T: Trait> Debug for Module<T> where
    T: Debug, 

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Eq + Trait> Eq for Module<T>

impl<T: Trait> IntegrityTest for Module<T>

pub fn integrity_test()

Run integrity test.

impl<T: Trait> ModuleErrorMetadata for Module<T>

fn metadata() -> &'static [ErrorMetadata]

impl<T: Trait + Trait> OffchainWorker<<T as Trait>::BlockNumber> for Module<T>

pub fn offchain_worker(_n: BlockNumber)

This function is being called after every block import (when fully synced).

impl<T: Trait + Trait> OnFinalize<<T as Trait>::BlockNumber> for Module<T>

pub fn on_finalize(_n: BlockNumber)

The block is being finalized. Implement to have something happen.

impl<T: Trait + Trait> OnInitialize<<T as Trait>::BlockNumber> for Module<T>

pub fn on_initialize(_n: BlockNumber) -> u64

The block is being initialized. Implement to have something happen.

impl<T: Trait> OnRuntimeUpgrade for Module<T>

pub fn on_runtime_upgrade() -> u64

Perform a module upgrade.

impl<T: PartialEq + Trait> PartialEq<Module<T>> for Module<T>

fn eq(&self, other: &Module<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Module<T>) -> bool

This method tests for !=.

impl<T: Trait> PermissionChecker for Module<T>

type AccountId = T::AccountId

fn ensure_user_has_space_permission(
    user: User<Self::AccountId>,
    ctx: SpacePermissionsContext,
    permission: SpacePermission,
    error: DispatchError
) -> DispatchResult

pub fn ensure_account_has_space_permission(
    account: Self::AccountId,
    ctx: SpacePermissionsContext,
    permission: SpacePermission,
    error: DispatchError
) -> Result<(), DispatchError>

impl<T: Trait> StructuralEq for Module<T>

impl<T: Trait> StructuralPartialEq for Module<T>