Permissions
Namespace that handles all Permissions related functionality
Hierarchy
SubModule
↳ Permissions
Index
Constructors
constructor
Properties
context
securityToken
Methods
assignRole
getAllDelegates
getAssignedRoles
getAvailableRoles
getDelegatesForRole
getFeatureFromRole
isRoleAvailable
revokeRole
Object literals
rolesPerFeature
Constructors
constructor
+ new Permissions(securityToken
: SecurityToken, context
: Context): Permissions
Inherited from SubModule.constructor
Defined in src/entities/SecurityToken/SubModule.ts:10
Create a new SubModule instance
Parameters:
Returns: Permissions
Properties
Protected
context
Protected
context• context: Context
Inherited from SubModule.context
Defined in src/entities/SecurityToken/SubModule.ts:10
Protected
securityToken
Protected
securityToken• securityToken: SecurityToken
Inherited from SubModule.securityToken
Defined in src/entities/SecurityToken/SubModule.ts:8
Methods
assignRole
▸ assignRole(args
: object): Promise‹TransactionQueue‹AssignSecurityTokenRoleProcedureArgs, void››
Defined in src/entities/SecurityToken/Permissions.ts:95
Assign a role on the Security Token to a delegate
Parameters:
▪ args: object
Returns: Promise‹TransactionQueue‹AssignSecurityTokenRoleProcedureArgs, void››
getAllDelegates
▸ getAllDelegates(): Promise‹object[]›
Defined in src/entities/SecurityToken/Permissions.ts:242
Return a list of all delegates with their respective details and roles
Returns: Promise‹object[]›
getAssignedRoles
▸ getAssignedRoles(args
: object): Promise‹SecurityTokenRole[]›
Defined in src/entities/SecurityToken/Permissions.ts:136
Return the list of roles assigned to a delegate address
Parameters:
▪ args: object
Returns: Promise‹SecurityTokenRole[]›
getAvailableRoles
▸ getAvailableRoles(): Promise‹SecurityTokenRole[]›
Defined in src/entities/SecurityToken/Permissions.ts:25
Get a list of all available roles. The returned roles depend on which features are enabled, as per:
Returns: Promise‹SecurityTokenRole[]›
getDelegatesForRole
▸ getDelegatesForRole(args
: object): Promise‹object[]›
Defined in src/entities/SecurityToken/Permissions.ts:184
Return the list of delegate addresses and details that hold a specific role
Parameters:
▪ args: object
Returns: Promise‹object[]›
getFeatureFromRole
▸ getFeatureFromRole(args
: object): Promise‹Feature›
Defined in src/entities/SecurityToken/Permissions.ts:65
Return which feature is associated with the supplied role
Parameters:
▪ args: object
Returns: Promise‹Feature›
isRoleAvailable
▸ isRoleAvailable(args
: object): Promise‹boolean›
Defined in src/entities/SecurityToken/Permissions.ts:55
Return whether a certain role is available to be assigned to delegates
Parameters:
▪ args: object
Returns: Promise‹boolean›
revokeRole
▸ revokeRole(args
: object): Promise‹TransactionQueue‹AssignSecurityTokenRoleProcedureArgs, void››
Defined in src/entities/SecurityToken/Permissions.ts:117
Remove a role from a delegate
Parameters:
▪ args: object
Returns: Promise‹TransactionQueue‹AssignSecurityTokenRoleProcedureArgs, void››
Object literals
rolesPerFeature
▪ rolesPerFeature: object
Defined in src/entities/SecurityToken/Permissions.ts:279
__computed
• __computed: SecurityTokenRole[] = [ SecurityTokenRole.PercentageOwnershipRestrictionsAdministrator, ]
Defined in src/entities/SecurityToken/Permissions.ts:280
Defined in src/entities/SecurityToken/Permissions.ts:281
Defined in src/entities/SecurityToken/Permissions.ts:282
Last updated