TransferRestrictionBase
Last updated
Was this helpful?
Last updated
Was this helpful?
Base class for managing Transfer Restrictions
â–ª T:
Namespace‹›
↳ TransferRestrictionBase
↳
↳
Protected
context• context: Context
Inherited from void
Optional
exemptedIds• exemptedIds? : string[]
array of Scope/Identity IDs that are exempted from the Restriction
Protected
parentInherited from void
Protected
Abstract
type• type: T
Add a Transfer Restriction of the corresponding type to this Asset
note
the result is the total amount of restrictions after the procedure has run
Parameters:
args
opts?
Retrieve all active Transfer Restrictions of the corresponding type
note
there is a maximum number of restrictions allowed across all types. The availableSlots
property of the result represents how many more restrictions can be added before reaching that limit
Removes all Transfer Restrictions of the corresponding type from this Asset
note
the result is the total amount of restrictions after the procedure has run
Parameters:
opts?
Sets all Transfer Restrictions of the corresponding type on this Asset
note
the result is the total amount of restrictions after the procedure has run
Parameters:
args
opts?
Defined in
Defined in
note
if the Asset requires investor uniqueness, Scope IDs are used. Otherwise, we use Identity IDs. More on Scope IDs and investor uniqueness and
• parent:
Defined in
Defined in
â–¸ addRestriction(args
: ‹T›, opts?
: ): Promise‹‹BigNumber››
Defined in
note
this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it
‹T›
Returns: Promise‹‹BigNumber››
▸ get(): Promise‹‹T››
Defined in
Returns: Promise‹‹T››
â–¸ removeRestrictions(opts?
: ): Promise‹‹BigNumber››
Defined in
note
this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it
Returns: Promise‹‹BigNumber››
â–¸ setRestrictions(args
: ‹T›, opts?
: ): Promise‹‹BigNumber››
Defined in
note
this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it
‹T›
Returns: Promise‹‹BigNumber››