api_entities_Asset_TransferRestrictions_TransferRestrictionBase.TransferRestrictionBase
Previousapi_entities_Asset_TransferRestrictions_Percentage.PercentageNextapi_entities_AuthorizationRequest.AuthorizationRequest
Last updated
Was this helpful?
Last updated
Was this helpful?
/ / / TransferRestrictionBase
.TransferRestrictionBase
Base class for managing Transfer Restrictions
T
Namespace<>
↳ TransferRestrictionBase
↳↳
↳↳
▸ addRestriction(args, opts?): Promise<TransactionQueue<BigNumber, BigNumber, unknown[][]>>
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
AddRestrictionParams<T>
opts?
Returns
Promise<TransactionQueue<BigNumber, BigNumber, unknown[][]>>
Defined in
▸ get(): Promise<GetReturnType<T>>
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
Returns
Promise<GetReturnType<T>>
Defined in
▸ removeRestrictions(opts?): Promise<TransactionQueue<BigNumber, BigNumber, unknown[][]>>
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?
Returns
Promise<TransactionQueue<BigNumber, BigNumber, unknown[][]>>
Defined in
▸ setRestrictions(args, opts?): Promise<TransactionQueue<BigNumber, BigNumber, unknown[][]>>
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
SetRestrictionsParams<T>
opts?
Returns
Promise<TransactionQueue<BigNumber, BigNumber, unknown[][]>>
Defined in
extends
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
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
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