Permissions
Last updated
Was this helpful?
Last updated
Was this helpful?
Namespace that handles all Permissions related functionality
↳ Permissions
Create a new SubModule instance
Parameters:
Name
Type
securityToken
context
Protected contextProtected securityTokenAssign a role on the Security Token to a delegate
Parameters:
â–ª args: object
Name
Type
delegateAddress
string
description
string
role
▸ getAllDelegates(): Promise‹object[]›
Return a list of all delegates with their respective details and roles
Returns: Promise‹object[]›
Return the list of roles assigned to a delegate address
Parameters:
â–ª args: object
Name
Type
delegateAddress
string
Get a list of all available roles. The returned roles depend on which features are enabled, as per:
Feature
Roles
Permissions
Permissions Administrator
Tokenholders
Tokenholders Administrator
Dividends
Dividends Administrator, Dividends Operator
TokenholderCountRestrictions
Tokenholder Count Restrictions Administrator
PercentageOwnershipRestrictions
Percentage Ownership Restrictions Administrator
▸ getDelegatesForRole(args: object): Promise‹object[]›
Return the list of delegate addresses and details that hold a specific role
Parameters:
â–ª args: object
Name
Type
role
Returns: Promise‹object[]›
Return which feature is associated with the supplied role
Parameters:
â–ª args: object
Name
Type
role
▸ isRoleAvailable(args: object): Promise‹boolean›
Return whether a certain role is available to be assigned to delegates
Parameters:
â–ª args: object
Name
Type
role
Returns: Promise‹boolean›
Remove a role from a delegate
Parameters:
â–ª args: object
Name
Type
delegateAddress
string
role
+ new Permissions(securityToken: , context: ):
Inherited from .
Defined in
Returns:
• context:
Inherited from .
Defined in
• securityToken:
Inherited from .
Defined in
▸ assignRole(args: object): Promise‹‹, void››
Defined in
Returns: Promise‹‹, void››
Defined in
▸ getAssignedRoles(args: object): Promise‹[]›
Defined in
Returns: Promise‹[]›
▸ getAvailableRoles(): Promise‹[]›
Defined in
Returns: Promise‹[]›
Defined in
▸ getFeatureFromRole(args: object): Promise‹›
Defined in
Returns: Promise‹›
Defined in
▸ revokeRole(args: object): Promise‹‹, void››
Defined in
Returns: Promise‹‹, void››
Defined in
• __computed: [] = [ SecurityTokenRole.PercentageOwnershipRestrictionsAdministrator, ]
Defined in
Defined in
Defined in
Defined in
Defined in