api_client_AccountManagement.AccountManagement
Last updated
Was this helpful?
Last updated
Was this helpful?
/ / / AccountManagement
.AccountManagement
Handles functionality related to Account Management
â–¸ freezeSecondaryAccounts(opts?): Promise<TransactionQueue<void, void, unknown[][]>>
Parameters
opts?
Returns
Promise<TransactionQueue<void, void, unknown[][]>>
Defined in
Return an Account instance from an address
Parameters
args
Object
args.address
string
Returns
Defined in
Get the free/locked POLYX balance of an Account
note can be subscribed to
Parameters
args?
Object
-
args.account
defaults to the signing Account
Returns
Defined in
Parameters
callback
Returns
Defined in
Parameters
args
Object
args.account
callback
Returns
Defined in
Return the signing Account, or null if no signing Account has been set
Returns
Defined in
Return a list that contains all the signing Accounts associated to the SDK instance's Signing Manager
throws — if there is no Signing Manager attached to the SDK
Returns
Defined in
Send an invitation to an Account to join the signing Identity as a secondary Account
Parameters
args
opts?
Returns
Defined in
â–¸ leaveIdentity(opts?): Promise<TransactionQueue<void, void, unknown[][]>>
Disassociate the signing Account from its Identity. This operation can only be done if the signing Account is a secondary Account
Parameters
opts?
Returns
Promise<TransactionQueue<void, void, unknown[][]>>
Defined in
â–¸ modifyPermissions(args, opts?): Promise<TransactionQueue<void, void, unknown[][]>>
Modify all permissions of a list of secondary Accounts associated with the signing Identity
throws if the signing Account is not the primary Account of the Identity whose secondary Account permissions are being modified
Parameters
args
opts?
Returns
Promise<TransactionQueue<void, void, unknown[][]>>
Defined in
â–¸ removeSecondaryAccounts(args, opts?): Promise<TransactionQueue<void, void, unknown[][]>>
Remove a list of secondary Accounts associated with the signing Identity
Parameters
args
opts?
Returns
Promise<TransactionQueue<void, void, unknown[][]>>
Defined in
â–¸ revokePermissions(args, opts?): Promise<TransactionQueue<void, void, unknown[][]>>
Revoke all permissions of a list of secondary Accounts associated with the signing Identity
throws if the signing Account is not the primary Account of the Identity whose secondary Account permissions are being revoked
Parameters
args
Object
args.secondaryAccounts
opts?
Returns
Promise<TransactionQueue<void, void, unknown[][]>>
Defined in
Send an Authorization Request to an Account to subsidize its transaction fees
Parameters
args
opts?
Returns
Defined in
â–¸ unfreezeSecondaryAccounts(opts?): Promise<TransactionQueue<void, void, unknown[][]>>
Unfreeze all of the secondary Accounts in the signing Identity. This will restore their permissions as they were before being frozen
Parameters
opts?
Returns
Promise<TransactionQueue<void, void, unknown[][]>>
Defined in
Freeze all of the secondary Accounts in the signing Identity. This means revoking their permission to perform any operation on the blockchain and freezing their funds until the Accounts are unfrozen via
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
â–¸ getAccount(args):
â–¸ getAccountBalance(args?): Promise<>
string |
Promise<>
â–¸ getAccountBalance(callback): Promise<>
<>
Promise<>
â–¸ getAccountBalance(args, callback): Promise<>
string |
<>
Promise<>
â–¸ getSigningAccount(): null |
null |
â–¸ getSigningAccounts(): Promise<[]>
Promise<[]>
â–¸ inviteAccount(args, opts?): Promise<TransactionQueue<, , unknown[][]>>
note this will create an which has to be accepted by the targetAccount. An or can fetch its pending Authorization Requests by calling . Also, an Account or Identity can directly fetch the details of an Authorization Request by calling
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
Promise<TransactionQueue<, , unknown[][]>>
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
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
[]
â–¸ subsidizeAccount(args, opts?): Promise<TransactionQueue<, , unknown[][]>>
note this will create an which has to be accepted by the beneficiary Account. An or can fetch its pending Authorization Requests by calling . Also, an Account or Identity can directly fetch the details of an Authorization Request by calling
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
Promise<TransactionQueue<, , unknown[][]>>
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