Changes

Page history
Update generated documentation authored by Mateusz Tyszczak's avatar Mateusz Tyszczak
Show whitespace changes
Inline Side-by-side
interfaces/IBeekeeperSession.md
View page @ a45ef824
...@@ -2,12 +2,16 @@ ...@@ -2,12 +2,16 @@
# Interface: IBeekeeperSession # Interface: IBeekeeperSession
Defined in: [src/detailed/interfaces.ts:197](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/a74bad9a396b3e773a554a847dc3b72c3f7ee98d/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L197)
## Methods ## Methods
### close() ### close()
> **close**(): [`IBeekeeperInstance`](./IBeekeeperInstance) > **close**(): [`IBeekeeperInstance`](./IBeekeeperInstance)
Defined in: [src/detailed/interfaces.ts:279](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/a74bad9a396b3e773a554a847dc3b72c3f7ee98d/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L279)
Locks all of the unlocked wallets, closes them, closes this session and makes it unusable Locks all of the unlocked wallets, closes them, closes this session and makes it unusable
#### Returns #### Returns
...@@ -20,10 +24,6 @@ Beekeeper instance owning the closed session ...@@ -20,10 +24,6 @@ Beekeeper instance owning the closed session
on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.) on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
#### Defined in
[src/detailed/interfaces.ts:279](https://gitlab.syncad.com/hive/hive/-/blob/4cd3fc3d23f4074be91a11f00a7a6035405faaf8/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L279)
*** ***
### createWallet() ### createWallet()
...@@ -32,6 +32,8 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo ...@@ -32,6 +32,8 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
> **createWallet**(`name`, `password`?): `Promise`\<[`IWalletCreated`](./IWalletCreated)\> > **createWallet**(`name`, `password`?): `Promise`\<[`IWalletCreated`](./IWalletCreated)\>
Defined in: [src/detailed/interfaces.ts:237](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/a74bad9a396b3e773a554a847dc3b72c3f7ee98d/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L237)
Creates a new Beekeeper wallet object owned by this session Creates a new Beekeeper wallet object owned by this session
##### Parameters ##### Parameters
...@@ -58,14 +60,12 @@ the created unlocked Beekeeper wallet object ...@@ -58,14 +60,12 @@ the created unlocked Beekeeper wallet object
on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.) on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
##### Defined in
[src/detailed/interfaces.ts:237](https://gitlab.syncad.com/hive/hive/-/blob/4cd3fc3d23f4074be91a11f00a7a6035405faaf8/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L237)
#### Call Signature #### Call Signature
> **createWallet**(`name`, `password`, `isTemporary`): `Promise`\<[`IWalletCreated`](./IWalletCreated)\> > **createWallet**(`name`, `password`, `isTemporary`): `Promise`\<[`IWalletCreated`](./IWalletCreated)\>
Defined in: [src/detailed/interfaces.ts:250](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/a74bad9a396b3e773a554a847dc3b72c3f7ee98d/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L250)
Creates a new Beekeeper wallet object owned by this session Creates a new Beekeeper wallet object owned by this session
##### Parameters ##### Parameters
...@@ -98,16 +98,14 @@ the created unlocked Beekeeper wallet object ...@@ -98,16 +98,14 @@ the created unlocked Beekeeper wallet object
on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.) on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
##### Defined in
[src/detailed/interfaces.ts:250](https://gitlab.syncad.com/hive/hive/-/blob/4cd3fc3d23f4074be91a11f00a7a6035405faaf8/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L250)
*** ***
### getInfo() ### getInfo()
> **getInfo**(): [`IBeekeeperInfo`](./IBeekeeperInfo) > **getInfo**(): [`IBeekeeperInfo`](./IBeekeeperInfo)
Defined in: [src/detailed/interfaces.ts:205](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/a74bad9a396b3e773a554a847dc3b72c3f7ee98d/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L205)
Retrieves the current session info Retrieves the current session info
#### Returns #### Returns
...@@ -120,16 +118,14 @@ Current session information ...@@ -120,16 +118,14 @@ Current session information
on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.) on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
#### Defined in
[src/detailed/interfaces.ts:205](https://gitlab.syncad.com/hive/hive/-/blob/4cd3fc3d23f4074be91a11f00a7a6035405faaf8/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L205)
*** ***
### hasWallet() ### hasWallet()
> **hasWallet**(`name`): `boolean` > **hasWallet**(`name`): `boolean`
Defined in: [src/detailed/interfaces.ts:216](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/a74bad9a396b3e773a554a847dc3b72c3f7ee98d/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L216)
Checks if wallet with given name exists Checks if wallet with given name exists
#### Parameters #### Parameters
...@@ -150,16 +146,14 @@ name of the wallet ...@@ -150,16 +146,14 @@ name of the wallet
on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.) on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
#### Defined in
[src/detailed/interfaces.ts:216](https://gitlab.syncad.com/hive/hive/-/blob/4cd3fc3d23f4074be91a11f00a7a6035405faaf8/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L216)
*** ***
### listWallets() ### listWallets()
> **listWallets**(): [`IBeekeeperWallet`](./IBeekeeperWallet)[] > **listWallets**(): [`IBeekeeperWallet`](./IBeekeeperWallet)[]
Defined in: [src/detailed/interfaces.ts:225](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/a74bad9a396b3e773a554a847dc3b72c3f7ee98d/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L225)
Lists all of the opened wallets Lists all of the opened wallets
#### Returns #### Returns
...@@ -172,16 +166,14 @@ array of opened Beekeeper wallets (either unlocked or locked) ...@@ -172,16 +166,14 @@ array of opened Beekeeper wallets (either unlocked or locked)
on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.) on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
#### Defined in
[src/detailed/interfaces.ts:225](https://gitlab.syncad.com/hive/hive/-/blob/4cd3fc3d23f4074be91a11f00a7a6035405faaf8/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L225)
*** ***
### lockAll() ### lockAll()
> **lockAll**(): [`IBeekeeperWallet`](./IBeekeeperWallet)[] > **lockAll**(): [`IBeekeeperWallet`](./IBeekeeperWallet)[]
Defined in: [src/detailed/interfaces.ts:270](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/a74bad9a396b3e773a554a847dc3b72c3f7ee98d/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L270)
Locks all of the unlocked wallets owned by this session Locks all of the unlocked wallets owned by this session
#### Returns #### Returns
...@@ -194,16 +186,14 @@ array of the locked Beekeeper wallets ...@@ -194,16 +186,14 @@ array of the locked Beekeeper wallets
on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.) on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
#### Defined in
[src/detailed/interfaces.ts:270](https://gitlab.syncad.com/hive/hive/-/blob/4cd3fc3d23f4074be91a11f00a7a6035405faaf8/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L270)
*** ***
### openWallet() ### openWallet()
> **openWallet**(`name`): [`IBeekeeperWallet`](./IBeekeeperWallet) > **openWallet**(`name`): [`IBeekeeperWallet`](./IBeekeeperWallet)
Defined in: [src/detailed/interfaces.ts:261](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/a74bad9a396b3e773a554a847dc3b72c3f7ee98d/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L261)
Opens Beekeeper wallet object owned by this session Opens Beekeeper wallet object owned by this session
#### Parameters #### Parameters
...@@ -223,7 +213,3 @@ the opened Beekeeper wallet object (may be unlocked if it has been previously un ...@@ -223,7 +213,3 @@ the opened Beekeeper wallet object (may be unlocked if it has been previously un
#### Throws #### Throws
on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.) on any beekeeper API-related error (error parsing response, invalid input, timeout error, fs sync error etc.)
#### Defined in
[src/detailed/interfaces.ts:261](https://gitlab.syncad.com/hive/hive/-/blob/4cd3fc3d23f4074be91a11f00a7a6035405faaf8/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L261)