api_client_AccountManagement.AccountManagement
Class: AccountManagement
Handles functionality related to Account Management
Table of contents
Methods
Methods
freezeSecondaryAccounts
▸ freezeSecondaryAccounts(opts?
): Promise
<TransactionQueue
<void
, void
, unknown
[][]>>
Parameters
Returns
Promise
<TransactionQueue
<void
, void
, unknown
[][]>>
Defined in
getAccount
Return an Account instance from an address
Parameters
Returns
Defined in
getAccountBalance
Get the free/locked POLYX balance of an Account
note
can be subscribed to
Parameters
Returns
Defined in
Parameters
Returns
Defined in
Parameters
Returns
Defined in
getSigningAccount
Return the signing Account, or null if no signing Account has been set
Returns
Defined in
getSigningAccounts
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
inviteAccount
Send an invitation to an Account to join the signing Identity as a secondary Account
Parameters
Returns
Defined in
leaveIdentity
▸ 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
Returns
Promise
<TransactionQueue
<void
, void
, unknown
[][]>>
Defined in
modifyPermissions
▸ 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
Returns
Promise
<TransactionQueue
<void
, void
, unknown
[][]>>
Defined in
removeSecondaryAccounts
▸ removeSecondaryAccounts(args
, opts?
): Promise
<TransactionQueue
<void
, void
, unknown
[][]>>
Remove a list of secondary Accounts associated with the signing Identity
Parameters
Returns
Promise
<TransactionQueue
<void
, void
, unknown
[][]>>
Defined in
revokePermissions
▸ 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
Returns
Promise
<TransactionQueue
<void
, void
, unknown
[][]>>
Defined in
subsidizeAccount
Send an Authorization Request to an Account to subsidize its transaction fees
Parameters
Returns
Defined in
unfreezeSecondaryAccounts
▸ 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
Returns
Promise
<TransactionQueue
<void
, void
, unknown
[][]>>
Defined in
Last updated