Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

bug/retry authenticate #766

Merged
merged 1 commit into from
Jul 25, 2024
Merged

bug/retry authenticate #766

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 31 additions & 27 deletions docs/api/classes/modules_assets.AssetsService.md
View file
Open in desktop
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

don't really know why so many changes in the documentation. May be typedoc was updated

Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ assetsService.registerAsset();

### constructor

• **new AssetsService**(`_signerService`, `_cacheClient`)
• **new AssetsService**(`_signerService`, `_cacheClient`): [`AssetsService`](modules_assets.AssetsService.md)

#### Parameters

Expand All @@ -46,11 +46,15 @@ assetsService.registerAsset();
| `_signerService` | [`SignerService`](modules_signer.SignerService.md) |
| `_cacheClient` | [`CacheClient`](modules_cache_client.CacheClient.md) |

#### Returns

[`AssetsService`](modules_assets.AssetsService.md)

## Methods

### acceptAssetOffer

▸ **acceptAssetOffer**(`options`): `Promise`<`void`\>
▸ **acceptAssetOffer**(`options`): `Promise`\<`void`\>

Accept an offered asset.

Expand All @@ -68,13 +72,13 @@ assetsService.acceptAssetOffer({

#### Returns

`Promise`<`void`\>
`Promise`\<`void`\>

___

### cancelAssetOffer

▸ **cancelAssetOffer**(`options`): `Promise`<`void`\>
▸ **cancelAssetOffer**(`options`): `Promise`\<`void`\>

Cancel an asset offer.

Expand All @@ -92,13 +96,13 @@ assetsService.cancelAssetOffer({

#### Returns

`Promise`<`void`\>
`Promise`\<`void`\>

___

### getAssetById

▸ **getAssetById**(`options`): `Promise`<[`Asset`](../interfaces/modules_assets.Asset.md)\>
▸ **getAssetById**(`options`): `Promise`\<[`Asset`](../interfaces/modules_assets.Asset.md)\>

Retrieve asset by id.

Expand All @@ -116,15 +120,15 @@ assetsService.getAssetById({

#### Returns

`Promise`<[`Asset`](../interfaces/modules_assets.Asset.md)\>
`Promise`\<[`Asset`](../interfaces/modules_assets.Asset.md)\>

asset

___

### getAssetHistory

▸ **getAssetHistory**(`options`): `Promise`<[`AssetHistory`](../interfaces/modules_assets.AssetHistory.md)[]\>
▸ **getAssetHistory**(`options`): `Promise`\<[`AssetHistory`](../interfaces/modules_assets.AssetHistory.md)[]\>

Retrieve history of a given asset DID

Expand All @@ -146,15 +150,15 @@ assetsService.getAssetHistory({

#### Returns

`Promise`<[`AssetHistory`](../interfaces/modules_assets.AssetHistory.md)[]\>
`Promise`\<[`AssetHistory`](../interfaces/modules_assets.AssetHistory.md)[]\>

asset history

___

### getAssetOwner

▸ **getAssetOwner**(`id`): `Promise`<`string`\>
▸ **getAssetOwner**(`id`): `Promise`\<`string`\>

Retrieve DID of the asset owner of the given asset DID.

Expand All @@ -170,15 +174,15 @@ assetsService.getAssetOwner('did:ethr:volta:0x000...1');

#### Returns

`Promise`<`string`\>
`Promise`\<`string`\>

asset owner DID

___

### getOfferedAssets

▸ **getOfferedAssets**(`options?`): `Promise`<[`Asset`](../interfaces/modules_assets.Asset.md)[]\>
▸ **getOfferedAssets**(`options?`): `Promise`\<[`Asset`](../interfaces/modules_assets.Asset.md)[]\>

Retrieve assets offered to the given user.

Expand All @@ -196,15 +200,15 @@ assetsService.getOfferedAssets({

#### Returns

`Promise`<[`Asset`](../interfaces/modules_assets.Asset.md)[]\>
`Promise`\<[`Asset`](../interfaces/modules_assets.Asset.md)[]\>

offered assets

___

### getOwnedAssets

▸ **getOwnedAssets**(`options?`): `Promise`<[`Asset`](../interfaces/modules_assets.Asset.md)[]\>
▸ **getOwnedAssets**(`options?`): `Promise`\<[`Asset`](../interfaces/modules_assets.Asset.md)[]\>

Retrieve owned assets of the given user.

Expand All @@ -222,15 +226,15 @@ assetsService.getOwnedAssets({

#### Returns

`Promise`<[`Asset`](../interfaces/modules_assets.Asset.md)[]\>
`Promise`\<[`Asset`](../interfaces/modules_assets.Asset.md)[]\>

owned assets

___

### getPreviouslyOwnedAssets

▸ **getPreviouslyOwnedAssets**(`options`): `Promise`<[`Asset`](../interfaces/modules_assets.Asset.md)[]\>
▸ **getPreviouslyOwnedAssets**(`options`): `Promise`\<[`Asset`](../interfaces/modules_assets.Asset.md)[]\>

Retrieve previously owned assets of the given user.

Expand All @@ -248,25 +252,25 @@ assetsService.getPreviouslyOwnedAssets({

#### Returns

`Promise`<[`Asset`](../interfaces/modules_assets.Asset.md)[]\>
`Promise`\<[`Asset`](../interfaces/modules_assets.Asset.md)[]\>

previously owned assets

___

### init

▸ **init**(): `Promise`<`void`\>
▸ **init**(): `Promise`\<`void`\>

#### Returns

`Promise`<`void`\>
`Promise`\<`void`\>

___

### offerAsset

▸ **offerAsset**(`options`): `Promise`<`void`\>
▸ **offerAsset**(`options`): `Promise`\<`void`\>

Send an asset offer transfer to a given address

Expand All @@ -285,13 +289,13 @@ assetsService.offerAsset({

#### Returns

`Promise`<`void`\>
`Promise`\<`void`\>

___

### registerAsset

▸ **registerAsset**(): `Promise`<`string`\>
▸ **registerAsset**(): `Promise`\<`string`\>

Register a new asset to the user.

Expand All @@ -301,15 +305,15 @@ assetsService.registerAsset();

#### Returns

`Promise`<`string`\>
`Promise`\<`string`\>

asset address

___

### rejectAssetOffer

▸ **rejectAssetOffer**(`options`): `Promise`<`void`\>
▸ **rejectAssetOffer**(`options`): `Promise`\<`void`\>

Reject an offered asset.

Expand All @@ -327,13 +331,13 @@ assetsService.rejectAssetOffer({

#### Returns

`Promise`<`void`\>
`Promise`\<`void`\>

___

### create

▸ `Static` **create**(`signerService`, `cacheClient`): `Promise`<[`AssetsService`](modules_assets.AssetsService.md)\>
▸ **create**(`signerService`, `cacheClient`): `Promise`\<[`AssetsService`](modules_assets.AssetsService.md)\>

#### Parameters

Expand All @@ -344,4 +348,4 @@ ___

#### Returns

`Promise`<[`AssetsService`](modules_assets.AssetsService.md)\>
`Promise`\<[`AssetsService`](modules_assets.AssetsService.md)\>
Loading
Loading