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 @ 831efad8
......@@ -2,16 +2,12 @@
# Interface: IBeekeeperSession
Defined in: [src/detailed/interfaces.ts:197](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/ed702f86d3a1ae567b2d2e1d0d7240a187223964/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L197)
## Methods
### close()
> **close**(): [`IBeekeeperInstance`](./IBeekeeperInstance)
Defined in: [src/detailed/interfaces.ts:279](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/ed702f86d3a1ae567b2d2e1d0d7240a187223964/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L279)
Locks all of the unlocked wallets, closes them, closes this session and makes it unusable
#### Returns
......@@ -24,6 +20,10 @@ Beekeeper instance owning the closed session
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/programs/beekeeper/beekeeper_wasm/-/blob/25efa2eeae885a5354e59e1097c6483fd46dede6/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L279)
***
### createWallet()
......@@ -32,8 +32,6 @@ on any beekeeper API-related error (error parsing response, invalid input, timeo
> **createWallet**(`name`, `password`?): `Promise`\<[`IWalletCreated`](./IWalletCreated)\>
Defined in: [src/detailed/interfaces.ts:237](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/ed702f86d3a1ae567b2d2e1d0d7240a187223964/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L237)
Creates a new Beekeeper wallet object owned by this session
##### Parameters
......@@ -60,12 +58,14 @@ the created unlocked Beekeeper wallet object
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/programs/beekeeper/beekeeper_wasm/-/blob/25efa2eeae885a5354e59e1097c6483fd46dede6/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L237)
#### Call Signature
> **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/ed702f86d3a1ae567b2d2e1d0d7240a187223964/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L250)
Creates a new Beekeeper wallet object owned by this session
##### Parameters
......@@ -98,14 +98,16 @@ the created unlocked Beekeeper wallet object
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/programs/beekeeper/beekeeper_wasm/-/blob/25efa2eeae885a5354e59e1097c6483fd46dede6/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L250)
***
### getInfo()
> **getInfo**(): [`IBeekeeperInfo`](./IBeekeeperInfo)
Defined in: [src/detailed/interfaces.ts:205](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/ed702f86d3a1ae567b2d2e1d0d7240a187223964/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L205)
Retrieves the current session info
#### Returns
......@@ -118,14 +120,16 @@ Current session information
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/programs/beekeeper/beekeeper_wasm/-/blob/25efa2eeae885a5354e59e1097c6483fd46dede6/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L205)
***
### hasWallet()
> **hasWallet**(`name`): `boolean`
Defined in: [src/detailed/interfaces.ts:216](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/ed702f86d3a1ae567b2d2e1d0d7240a187223964/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L216)
Checks if wallet with given name exists
#### Parameters
......@@ -146,14 +150,16 @@ name of the wallet
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/programs/beekeeper/beekeeper_wasm/-/blob/25efa2eeae885a5354e59e1097c6483fd46dede6/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L216)
***
### listWallets()
> **listWallets**(): [`IBeekeeperWallet`](./IBeekeeperWallet)[]
Defined in: [src/detailed/interfaces.ts:225](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/ed702f86d3a1ae567b2d2e1d0d7240a187223964/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L225)
Lists all of the opened wallets
#### Returns
......@@ -166,14 +172,16 @@ 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.)
#### Defined in
[src/detailed/interfaces.ts:225](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/25efa2eeae885a5354e59e1097c6483fd46dede6/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L225)
***
### lockAll()
> **lockAll**(): [`IBeekeeperWallet`](./IBeekeeperWallet)[]
Defined in: [src/detailed/interfaces.ts:270](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/ed702f86d3a1ae567b2d2e1d0d7240a187223964/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L270)
Locks all of the unlocked wallets owned by this session
#### Returns
......@@ -186,14 +194,16 @@ array of the locked Beekeeper wallets
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/programs/beekeeper/beekeeper_wasm/-/blob/25efa2eeae885a5354e59e1097c6483fd46dede6/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L270)
***
### openWallet()
> **openWallet**(`name`): [`IBeekeeperWallet`](./IBeekeeperWallet)
Defined in: [src/detailed/interfaces.ts:261](https://gitlab.syncad.com/hive/hive/programs/beekeeper/beekeeper_wasm/-/blob/ed702f86d3a1ae567b2d2e1d0d7240a187223964/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L261)
Opens Beekeeper wallet object owned by this session
#### Parameters
......@@ -213,3 +223,7 @@ the opened Beekeeper wallet object (may be unlocked if it has been previously un
#### Throws
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/programs/beekeeper/beekeeper_wasm/-/blob/25efa2eeae885a5354e59e1097c6483fd46dede6/programs/beekeeper/beekeeper_wasm/src/detailed/interfaces.ts#L261)