docs: API reference for all packages (initial)

decentralized-identity · Mar 2, 2020 · 3dd0165 · 3dd0165
1 parent 63b9c23
commit 3dd0165
Show file tree

Hide file tree

Showing 146 changed files with 2,689 additions and 4 deletions.
diff --git a/docs/api/daf-debug.actionhandler.handleaction.md b/docs/api/daf-debug.actionhandler.handleaction.md
@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [daf-debug](./daf-debug.md) &gt; [ActionHandler](./daf-debug.actionhandler.md) &gt; [handleAction](./daf-debug.actionhandler.handleaction.md)
+
+## ActionHandler.handleAction() method
+
+<b>Signature:</b>
+
+```typescript
+handleAction(action: Action, core: Core): Promise<any>;
+```
+
+## Parameters
+
+| Parameter | Type                | Description |
+| --------- | ------------------- | ----------- |
+| action    | <code>Action</code> |             |
+| core      | <code>Core</code>   |             |
+
+<b>Returns:</b>
+
+`Promise<any>`
diff --git a/docs/api/daf-debug.actionhandler.md b/docs/api/daf-debug.actionhandler.md
@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [daf-debug](./daf-debug.md) &gt; [ActionHandler](./daf-debug.actionhandler.md)
+
+## ActionHandler class
+
+<b>Signature:</b>
+
+```typescript
+export declare class ActionHandler extends AbstractActionHandler
+```
+
+## Methods
+
+| Method                                                                  | Modifiers | Description |
+| ----------------------------------------------------------------------- | --------- | ----------- |
+| [handleAction(action, core)](./daf-debug.actionhandler.handleaction.md) |           |             |
diff --git a/docs/api/daf-debug.md b/docs/api/daf-debug.md
@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [daf-debug](./daf-debug.md)
+
+## daf-debug package
+
+## Classes
+
+| Class                                               | Description |
+| --------------------------------------------------- | ----------- |
+| [ActionHandler](./daf-debug.actionhandler.md)       |             |
+| [MessageValidator](./daf-debug.messagevalidator.md) |             |
diff --git a/docs/api/daf-debug.messagevalidator.md b/docs/api/daf-debug.messagevalidator.md
@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [daf-debug](./daf-debug.md) &gt; [MessageValidator](./daf-debug.messagevalidator.md)
+
+## MessageValidator class
+
+<b>Signature:</b>
+
+```typescript
+export declare class MessageValidator extends AbstractMessageValidator
+```
+
+## Methods
+
+| Method                                                              | Modifiers | Description |
+| ------------------------------------------------------------------- | --------- | ----------- |
+| [validate(message, core)](./daf-debug.messagevalidator.validate.md) |           |             |
diff --git a/docs/api/daf-debug.messagevalidator.validate.md b/docs/api/daf-debug.messagevalidator.validate.md
@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [daf-debug](./daf-debug.md) &gt; [MessageValidator](./daf-debug.messagevalidator.md) &gt; [validate](./daf-debug.messagevalidator.validate.md)
+
+## MessageValidator.validate() method
+
+<b>Signature:</b>
+
+```typescript
+validate(message: Message, core: Core): Promise<Message>;
+```
+
+## Parameters
+
+| Parameter | Type                 | Description |
+| --------- | -------------------- | ----------- |
+| message   | <code>Message</code> |             |
+| core      | <code>Core</code>    |             |
+
+<b>Returns:</b>
+
+`Promise<Message>`
diff --git a/docs/api/daf-did-jwt.md b/docs/api/daf-did-jwt.md
@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [daf-did-jwt](./daf-did-jwt.md)
+
+## daf-did-jwt package
+
+## Classes
+
+| Class                                                 | Description |
+| ----------------------------------------------------- | ----------- |
+| [MessageValidator](./daf-did-jwt.messagevalidator.md) |             |
diff --git a/docs/api/daf-did-jwt.messagevalidator.md b/docs/api/daf-did-jwt.messagevalidator.md
@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [daf-did-jwt](./daf-did-jwt.md) &gt; [MessageValidator](./daf-did-jwt.messagevalidator.md)
+
+## MessageValidator class
+
+<b>Signature:</b>
+
+```typescript
+export declare class MessageValidator extends AbstractMessageValidator
+```
+
+## Methods
+
+| Method                                                                | Modifiers | Description |
+| --------------------------------------------------------------------- | --------- | ----------- |
+| [validate(message, core)](./daf-did-jwt.messagevalidator.validate.md) |           |             |
diff --git a/docs/api/daf-did-jwt.messagevalidator.validate.md b/docs/api/daf-did-jwt.messagevalidator.validate.md
@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [daf-did-jwt](./daf-did-jwt.md) &gt; [MessageValidator](./daf-did-jwt.messagevalidator.md) &gt; [validate](./daf-did-jwt.messagevalidator.validate.md)
+
+## MessageValidator.validate() method
+
+<b>Signature:</b>
+
+```typescript
+validate(message: Message, core: Core): Promise<Message>;
+```
+
+## Parameters
+
+| Parameter | Type                 | Description |
+| --------- | -------------------- | ----------- |
+| message   | <code>Message</code> |             |
+| core      | <code>Core</code>    |             |
+
+<b>Returns:</b>
+
+`Promise<Message>`
diff --git a/docs/api/daf-ethr-did.identity._constructor_.md b/docs/api/daf-ethr-did.identity._constructor_.md
@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [daf-ethr-did](./daf-ethr-did.md) &gt; [Identity](./daf-ethr-did.identity.md) &gt; [(constructor)](./daf-ethr-did.identity._constructor_.md)
+
+## Identity.(constructor)
+
+Constructs a new instance of the `Identity` class
+
+<b>Signature:</b>
+
+```typescript
+constructor(options: {
+        identityProviderType: string;
+        serializedIdentity: SerializedIdentity;
+        kms: AbstractKeyManagementSystem;
+        identityController: AbstractIdentityController;
+    });
+```
+
+## Parameters
+
+| Parameter | Type                                                                                                                                                                                                                                                               | Description |
+| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------- |
+| options   | <code>{</code><br/><code> identityProviderType: string;</code><br/><code> serializedIdentity: SerializedIdentity;</code><br/><code> kms: AbstractKeyManagementSystem;</code><br/><code> identityController: AbstractIdentityController;</code><br/><code> }</code> |             |
diff --git a/docs/api/daf-ethr-did.identity.did.md b/docs/api/daf-ethr-did.identity.did.md
@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [daf-ethr-did](./daf-ethr-did.md) &gt; [Identity](./daf-ethr-did.identity.md) &gt; [did](./daf-ethr-did.identity.did.md)
+
+## Identity.did property
+
+<b>Signature:</b>
+
+```typescript
+readonly did: string;
+```
diff --git a/docs/api/daf-ethr-did.identity.identitycontroller.md b/docs/api/daf-ethr-did.identity.identitycontroller.md
@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [daf-ethr-did](./daf-ethr-did.md) &gt; [Identity](./daf-ethr-did.identity.md) &gt; [identityController](./daf-ethr-did.identity.identitycontroller.md)
+
+## Identity.identityController property
+
+<b>Signature:</b>
+
+```typescript
+readonly identityController: AbstractIdentityController;
+```
diff --git a/docs/api/daf-ethr-did.identity.identityprovidertype.md b/docs/api/daf-ethr-did.identity.identityprovidertype.md
@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [daf-ethr-did](./daf-ethr-did.md) &gt; [Identity](./daf-ethr-did.identity.md) &gt; [identityProviderType](./daf-ethr-did.identity.identityprovidertype.md)
+
+## Identity.identityProviderType property
+
+<b>Signature:</b>
+
+```typescript
+readonly identityProviderType: string;
+```
diff --git a/docs/api/daf-ethr-did.identity.keybyid.md b/docs/api/daf-ethr-did.identity.keybyid.md
@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [daf-ethr-did](./daf-ethr-did.md) &gt; [Identity](./daf-ethr-did.identity.md) &gt; [keyById](./daf-ethr-did.identity.keybyid.md)
+
+## Identity.keyById() method
+
+<b>Signature:</b>
+
+```typescript
+keyById(kid: string): Promise<import("daf-core").AbstractKey>;
+```
+
+## Parameters
+
+| Parameter | Type                | Description |
+| --------- | ------------------- | ----------- |
+| kid       | <code>string</code> |             |
+
+<b>Returns:</b>
+
+`Promise<import("daf-core").AbstractKey>`
diff --git a/docs/api/daf-ethr-did.identity.keybytype.md b/docs/api/daf-ethr-did.identity.keybytype.md
@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [daf-ethr-did](./daf-ethr-did.md) &gt; [Identity](./daf-ethr-did.identity.md) &gt; [keyByType](./daf-ethr-did.identity.keybytype.md)
+
+## Identity.keyByType() method
+
+<b>Signature:</b>
+
+```typescript
+keyByType(type: string): Promise<import("daf-core").AbstractKey>;
+```
+
+## Parameters
+
+| Parameter | Type                | Description |
+| --------- | ------------------- | ----------- |
+| type      | <code>string</code> |             |
+
+<b>Returns:</b>
+
+`Promise<import("daf-core").AbstractKey>`
diff --git a/docs/api/daf-ethr-did.identity.md b/docs/api/daf-ethr-did.identity.md
@@ -0,0 +1,32 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [daf-ethr-did](./daf-ethr-did.md) &gt; [Identity](./daf-ethr-did.identity.md)
+
+## Identity class
+
+<b>Signature:</b>
+
+```typescript
+export declare class Identity extends AbstractIdentity
+```
+
+## Constructors
+
+| Constructor                                                        | Modifiers | Description                                                  |
+| ------------------------------------------------------------------ | --------- | ------------------------------------------------------------ |
+| [(constructor)(options)](./daf-ethr-did.identity._constructor_.md) |           | Constructs a new instance of the <code>Identity</code> class |
+
+## Properties
+
+| Property                                                                | Modifiers | Type                                    | Description |
+| ----------------------------------------------------------------------- | --------- | --------------------------------------- | ----------- |
+| [did](./daf-ethr-did.identity.did.md)                                   |           | <code>string</code>                     |             |
+| [identityController](./daf-ethr-did.identity.identitycontroller.md)     |           | <code>AbstractIdentityController</code> |             |
+| [identityProviderType](./daf-ethr-did.identity.identityprovidertype.md) |           | <code>string</code>                     |             |
+
+## Methods
+
+| Method                                                  | Modifiers | Description |
+| ------------------------------------------------------- | --------- | ----------- |
+| [keyById(kid)](./daf-ethr-did.identity.keybyid.md)      |           |             |
+| [keyByType(type)](./daf-ethr-did.identity.keybytype.md) |           |             |
diff --git a/docs/api/daf-ethr-did.identityprovider._constructor_.md b/docs/api/daf-ethr-did.identityprovider._constructor_.md
@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [daf-ethr-did](./daf-ethr-did.md) &gt; [IdentityProvider](./daf-ethr-did.identityprovider.md) &gt; [(constructor)](./daf-ethr-did.identityprovider._constructor_.md)
+
+## IdentityProvider.(constructor)
+
+Constructs a new instance of the `IdentityProvider` class
+
+<b>Signature:</b>
+
+```typescript
+constructor(options: {
+        kms: AbstractKeyManagementSystem;
+        identityStore: AbstractIdentityStore;
+        network: string;
+        rpcUrl: string;
+        resolver: Resolver;
+    });
+```
+
+## Parameters
+
+| Parameter | Type                                                                                                                                                                                                                                                      | Description |
+| --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
+| options   | <code>{</code><br/><code> kms: AbstractKeyManagementSystem;</code><br/><code> identityStore: AbstractIdentityStore;</code><br/><code> network: string;</code><br/><code> rpcUrl: string;</code><br/><code> resolver: Resolver;</code><br/><code> }</code> |             |
diff --git a/docs/api/daf-ethr-did.identityprovider.createidentity.md b/docs/api/daf-ethr-did.identityprovider.createidentity.md
@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [daf-ethr-did](./daf-ethr-did.md) &gt; [IdentityProvider](./daf-ethr-did.identityprovider.md) &gt; [createIdentity](./daf-ethr-did.identityprovider.createidentity.md)
+
+## IdentityProvider.createIdentity() method
+
+<b>Signature:</b>
+
+```typescript
+createIdentity(): Promise<AbstractIdentity>;
+```
+
+<b>Returns:</b>
+
+`Promise<AbstractIdentity>`
diff --git a/docs/api/daf-ethr-did.identityprovider.deleteidentity.md b/docs/api/daf-ethr-did.identityprovider.deleteidentity.md
@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [daf-ethr-did](./daf-ethr-did.md) &gt; [IdentityProvider](./daf-ethr-did.identityprovider.md) &gt; [deleteIdentity](./daf-ethr-did.identityprovider.deleteidentity.md)
+
+## IdentityProvider.deleteIdentity() method
+
+<b>Signature:</b>
+
+```typescript
+deleteIdentity(did: string): Promise<boolean>;
+```
+
+## Parameters
+
+| Parameter | Type                | Description |
+| --------- | ------------------- | ----------- |
+| did       | <code>string</code> |             |
+
+<b>Returns:</b>
+
+`Promise<boolean>`
diff --git a/docs/api/daf-ethr-did.identityprovider.description.md b/docs/api/daf-ethr-did.identityprovider.description.md
@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [daf-ethr-did](./daf-ethr-did.md) &gt; [IdentityProvider](./daf-ethr-did.identityprovider.md) &gt; [description](./daf-ethr-did.identityprovider.description.md)
+
+## IdentityProvider.description property
+
+<b>Signature:</b>
+
+```typescript
+description: string
+```
diff --git a/docs/api/daf-ethr-did.identityprovider.getidentities.md b/docs/api/daf-ethr-did.identityprovider.getidentities.md
@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [daf-ethr-did](./daf-ethr-did.md) &gt; [IdentityProvider](./daf-ethr-did.identityprovider.md) &gt; [getIdentities](./daf-ethr-did.identityprovider.getidentities.md)
+
+## IdentityProvider.getIdentities() method
+
+<b>Signature:</b>
+
+```typescript
+getIdentities(): Promise<AbstractIdentity[]>;
+```
+
+<b>Returns:</b>
+
+`Promise<AbstractIdentity[]>`
diff --git a/docs/api/daf-ethr-did.identityprovider.getidentity.md b/docs/api/daf-ethr-did.identityprovider.getidentity.md
@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [daf-ethr-did](./daf-ethr-did.md) &gt; [IdentityProvider](./daf-ethr-did.identityprovider.md) &gt; [getIdentity](./daf-ethr-did.identityprovider.getidentity.md)
+
+## IdentityProvider.getIdentity() method
+
+<b>Signature:</b>
+
+```typescript
+getIdentity(did: string): Promise<AbstractIdentity>;
+```
+
+## Parameters
+
+| Parameter | Type                | Description |
+| --------- | ------------------- | ----------- |
+| did       | <code>string</code> |             |
+
+<b>Returns:</b>
+
+`Promise<AbstractIdentity>`