new AccountApi()
- Version:
- 1.0
Account service.
Methods
activateAccount(callback)
Account activation Reactivate a deactivated Klaytn account.
Parameters:
| Name | Type | Description |
|---|---|---|
callback |
AccountApi~activateAccountCallback | The callback function, accepting three arguments: error, data, response data is of type: AccountSummary |
createAccount(callback)
Create basic account Create Klaytn account. Generate a Klaytn account address and random private/public key pair and get ID of public key and private key returned.
Parameters:
| Name | Type | Description |
|---|---|---|
callback |
AccountApi~createAccountCallback | The callback function, accepting three arguments: error, data, response data is of type: Account |
deactivateAccount(callback)
Account deactivation Deactivate this Klaytn account. Once the account is deactivated, the account won't be retrieved.
Parameters:
| Name | Type | Description |
|---|---|---|
callback |
AccountApi~deactivateAccountCallback | The callback function, accepting three arguments: error, data, response data is of type: AccountSummary |
deleteAccount(callback)
Delete account Delete the Klaytn account.
Parameters:
| Name | Type | Description |
|---|---|---|
callback |
AccountApi~deleteAccountCallback | The callback function, accepting three arguments: error, data, response data is of type: AccountStatus |
multisigAccountUpdate(opts, callback)
Update multisig account Update the Klaytn account to a multisig account. Your account needs to have balances to pay the transaction fee when executing the account update transaction.
Parameters:
| Name | Type | Description |
|---|---|---|
opts |
Object | Optional parameters |
callback |
AccountApi~multisigAccountUpdateCallback | The callback function, accepting three arguments: error, data, response data is of type: MultisigAccount |
retrieveAccount(callback)
Retrieve account Retrieve the Klaytn account.
Parameters:
| Name | Type | Description |
|---|---|---|
callback |
AccountApi~retrieveAccountCallback | The callback function, accepting three arguments: error, data, response data is of type: Account |
retrieveAccounts(opts, callback)
Retrieve a list of accounts. Retrieve a list of all Klaytn accounts.<p></p> ##### Size<p></p> * The query parameter `size` is optional. (Min = 1, Max = 1000, Default = 100)<br> * Returns an error when given a negative number<br> * Uses default value (`size=100`) when `size=0`<br> * Uses the maximum value (`size=1000`) when given a value higher than the maximum value.<br>
Parameters:
| Name | Type | Description |
|---|---|---|
opts |
Object | Optional parameters |
callback |
AccountApi~retrieveAccountsCallback | The callback function, accepting three arguments: error, data, response data is of type: Accounts |
retrieveAccountsByPubkey(callback)
Retrieve account by public key Retrieve a list of Klaytn accounts by public key.
Parameters:
| Name | Type | Description |
|---|---|---|
callback |
AccountApi~retrieveAccountsByPubkeyCallback | The callback function, accepting three arguments: error, data, response data is of type: AccountsByPubkey |
signTransactionIDResponse(callback)
Transaction sign Sign the transaction with a certain ID using this Klaytn account.
Parameters:
| Name | Type | Description |
|---|---|---|
callback |
AccountApi~signTransactionIDResponseCallback | The callback function, accepting three arguments: error, data, response data is of type: Signature |
Type Definitions
activateAccountCallback(error, data, response)
Callback function to receive the result of the activateAccount operation.
Parameters:
| Name | Type | Description |
|---|---|---|
error |
String | Error message, if any. |
data |
AccountSummary | The data returned by the service call. |
response |
String | The complete HTTP response. |
createAccountCallback(error, data, response)
Callback function to receive the result of the createAccount operation.
Parameters:
| Name | Type | Description |
|---|---|---|
error |
String | Error message, if any. |
data |
Account | The data returned by the service call. |
response |
String | The complete HTTP response. |
deactivateAccountCallback(error, data, response)
Callback function to receive the result of the deactivateAccount operation.
Parameters:
| Name | Type | Description |
|---|---|---|
error |
String | Error message, if any. |
data |
AccountSummary | The data returned by the service call. |
response |
String | The complete HTTP response. |
deleteAccountCallback(error, data, response)
Callback function to receive the result of the deleteAccount operation.
Parameters:
| Name | Type | Description |
|---|---|---|
error |
String | Error message, if any. |
data |
AccountStatus | The data returned by the service call. |
response |
String | The complete HTTP response. |
multisigAccountUpdateCallback(error, data, response)
Callback function to receive the result of the multisigAccountUpdate operation.
Parameters:
| Name | Type | Description |
|---|---|---|
error |
String | Error message, if any. |
data |
MultisigAccount | The data returned by the service call. |
response |
String | The complete HTTP response. |
retrieveAccountCallback(error, data, response)
Callback function to receive the result of the retrieveAccount operation.
Parameters:
| Name | Type | Description |
|---|---|---|
error |
String | Error message, if any. |
data |
Account | The data returned by the service call. |
response |
String | The complete HTTP response. |
retrieveAccountsCallback(error, data, response)
Callback function to receive the result of the retrieveAccounts operation.
Parameters:
| Name | Type | Description |
|---|---|---|
error |
String | Error message, if any. |
data |
Accounts | The data returned by the service call. |
response |
String | The complete HTTP response. |
retrieveAccountsByPubkeyCallback(error, data, response)
Callback function to receive the result of the retrieveAccountsByPubkey operation.
Parameters:
| Name | Type | Description |
|---|---|---|
error |
String | Error message, if any. |
data |
AccountsByPubkey | The data returned by the service call. |
response |
String | The complete HTTP response. |
signTransactionIDResponseCallback(error, data, response)
Callback function to receive the result of the signTransactionIDResponse operation.
Parameters:
| Name | Type | Description |
|---|---|---|
error |
String | Error message, if any. |
data |
Signature | The data returned by the service call. |
response |
String | The complete HTTP response. |