diff --git a/docs/client.adminapi.issueappauthenticationtoken.md b/docs/client.adminapi.issueappauthenticationtoken.md new file mode 100644 index 00000000..e671f8b7 --- /dev/null +++ b/docs/client.adminapi.issueappauthenticationtoken.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@holochain/client](./client.md) > [AdminApi](./client.adminapi.md) > [issueAppAuthenticationToken](./client.adminapi.issueappauthenticationtoken.md) + +## AdminApi.issueAppAuthenticationToken property + +**Signature:** + +```typescript +issueAppAuthenticationToken: Requester; +``` diff --git a/docs/client.adminapi.md b/docs/client.adminapi.md index 63dbd534..643641a5 100644 --- a/docs/client.adminapi.md +++ b/docs/client.adminapi.md @@ -254,6 +254,23 @@ Description + + + +[issueAppAuthenticationToken](./client.adminapi.issueappauthenticationtoken.md) + + + + + + + +[Requester](./client.requester.md)<[IssueAppAuthenticationTokenRequest](./client.issueappauthenticationtokenrequest.md), [IssueAppAuthenticationTokenResponse](./client.issueappauthenticationtokenresponse.md)> + + + + + diff --git a/docs/client.adminwebsocket.issueappauthenticationtoken.md b/docs/client.adminwebsocket.issueappauthenticationtoken.md new file mode 100644 index 00000000..ffe21604 --- /dev/null +++ b/docs/client.adminwebsocket.issueappauthenticationtoken.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@holochain/client](./client.md) > [AdminWebsocket](./client.adminwebsocket.md) > [issueAppAuthenticationToken](./client.adminwebsocket.issueappauthenticationtoken.md) + +## AdminWebsocket.issueAppAuthenticationToken property + +**Signature:** + +```typescript +issueAppAuthenticationToken: Requester; +``` diff --git a/docs/client.adminwebsocket.md b/docs/client.adminwebsocket.md index 1a4da905..718bd477 100644 --- a/docs/client.adminwebsocket.md +++ b/docs/client.adminwebsocket.md @@ -358,6 +358,23 @@ Grant a zome call capability for an agent, to be used for signing zome calls. Install the specified app into Holochain. + + + +[issueAppAuthenticationToken](./client.adminwebsocket.issueappauthenticationtoken.md) + + + + + + + +[Requester](./client.requester.md)<[IssueAppAuthenticationTokenRequest](./client.issueappauthenticationtokenrequest.md), [IssueAppAuthenticationTokenResponse](./client.issueappauthenticationtokenresponse.md)> + + + + + diff --git a/docs/client.appagentwebsocket.appinfo.md b/docs/client.appagentwebsocket.appinfo.md deleted file mode 100644 index db1725bd..00000000 --- a/docs/client.appagentwebsocket.appinfo.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppAgentWebsocket](./client.appagentwebsocket.md) > [appInfo](./client.appagentwebsocket.appinfo.md) - -## AppAgentWebsocket.appInfo() method - -Request the app's info, including all cell infos. - -**Signature:** - -```typescript -appInfo(): Promise; -``` -**Returns:** - -Promise<[AppInfo](./client.appinfo.md)> - -The app's [AppInfo](./client.appinfo.md). - diff --git a/docs/client.appagentwebsocket.appwebsocket.md b/docs/client.appagentwebsocket.appwebsocket.md deleted file mode 100644 index d9c4be09..00000000 --- a/docs/client.appagentwebsocket.appwebsocket.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppAgentWebsocket](./client.appagentwebsocket.md) > [appWebsocket](./client.appagentwebsocket.appwebsocket.md) - -## AppAgentWebsocket.appWebsocket property - -**Signature:** - -```typescript -readonly appWebsocket: AppWebsocket; -``` diff --git a/docs/client.appagentwebsocket.callzome.md b/docs/client.appagentwebsocket.callzome.md deleted file mode 100644 index 336763b3..00000000 --- a/docs/client.appagentwebsocket.callzome.md +++ /dev/null @@ -1,71 +0,0 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppAgentWebsocket](./client.appagentwebsocket.md) > [callZome](./client.appagentwebsocket.callzome.md) - -## AppAgentWebsocket.callZome() method - -Call a zome. - -**Signature:** - -```typescript -callZome(request: AppAgentCallZomeRequest, timeout?: number): Promise; -``` - -## Parameters - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -request - - - - -[AppAgentCallZomeRequest](./client.appagentcallzomerequest.md) - - - - -The zome call arguments. - - -
- -timeout - - - - -number - - - - -_(Optional)_ A timeout to override the default. - - -
-**Returns:** - -Promise<[CallZomeResponse](./client.callzomeresponse.md)> - -The zome call's response. - diff --git a/docs/client.appagentwebsocket.connect.md b/docs/client.appagentwebsocket.connect.md deleted file mode 100644 index ff3f5755..00000000 --- a/docs/client.appagentwebsocket.connect.md +++ /dev/null @@ -1,71 +0,0 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppAgentWebsocket](./client.appagentwebsocket.md) > [connect](./client.appagentwebsocket.connect.md) - -## AppAgentWebsocket.connect() method - -Instance factory for creating AppAgentWebsockets. - -**Signature:** - -```typescript -static connect(installed_app_id: InstalledAppId, options?: WebsocketConnectionOptions): Promise; -``` - -## Parameters - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -installed\_app\_id - - - - -[InstalledAppId](./client.installedappid.md) - - - - -ID of the App to link to. - - -
- -options - - - - -[WebsocketConnectionOptions](./client.websocketconnectionoptions.md) - - - - -_(Optional)_ [WebsocketConnectionOptions](./client.websocketconnectionoptions.md) - - -
-**Returns:** - -Promise<[AppAgentWebsocket](./client.appagentwebsocket.md)> - -A new instance of an AppAgentWebsocket. - diff --git a/docs/client.appagentwebsocket.createclonecell.md b/docs/client.appagentwebsocket.createclonecell.md deleted file mode 100644 index de4cbd4a..00000000 --- a/docs/client.appagentwebsocket.createclonecell.md +++ /dev/null @@ -1,55 +0,0 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppAgentWebsocket](./client.appagentwebsocket.md) > [createCloneCell](./client.appagentwebsocket.createclonecell.md) - -## AppAgentWebsocket.createCloneCell() method - -Clone an existing provisioned cell. - -**Signature:** - -```typescript -createCloneCell(args: AppCreateCloneCellRequest): Promise; -``` - -## Parameters - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -args - - - - -[AppCreateCloneCellRequest](./client.appcreateclonecellrequest.md) - - - - -Specify the cell to clone. - - -
-**Returns:** - -Promise<[CreateCloneCellResponse](./client.createclonecellresponse.md)> - -The created clone cell. - diff --git a/docs/client.appagentwebsocket.disableclonecell.md b/docs/client.appagentwebsocket.disableclonecell.md deleted file mode 100644 index fd914d85..00000000 --- a/docs/client.appagentwebsocket.disableclonecell.md +++ /dev/null @@ -1,53 +0,0 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppAgentWebsocket](./client.appagentwebsocket.md) > [disableCloneCell](./client.appagentwebsocket.disableclonecell.md) - -## AppAgentWebsocket.disableCloneCell() method - -Disable an enabled clone cell. - -**Signature:** - -```typescript -disableCloneCell(args: AppDisableCloneCellRequest): Promise; -``` - -## Parameters - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -args - - - - -[AppDisableCloneCellRequest](./client.appdisableclonecellrequest.md) - - - - -Specify the clone cell to disable. - - -
-**Returns:** - -Promise<[DisableCloneCellResponse](./client.disableclonecellresponse.md)> - diff --git a/docs/client.appagentwebsocket.emitter.md b/docs/client.appagentwebsocket.emitter.md deleted file mode 100644 index 445dbbd0..00000000 --- a/docs/client.appagentwebsocket.emitter.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppAgentWebsocket](./client.appagentwebsocket.md) > [emitter](./client.appagentwebsocket.emitter.md) - -## AppAgentWebsocket.emitter property - -**Signature:** - -```typescript -readonly emitter: Emittery; -``` diff --git a/docs/client.appagentwebsocket.enableclonecell.md b/docs/client.appagentwebsocket.enableclonecell.md deleted file mode 100644 index c8ce6e72..00000000 --- a/docs/client.appagentwebsocket.enableclonecell.md +++ /dev/null @@ -1,55 +0,0 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppAgentWebsocket](./client.appagentwebsocket.md) > [enableCloneCell](./client.appagentwebsocket.enableclonecell.md) - -## AppAgentWebsocket.enableCloneCell() method - -Enable a disabled clone cell. - -**Signature:** - -```typescript -enableCloneCell(args: AppEnableCloneCellRequest): Promise; -``` - -## Parameters - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -args - - - - -[AppEnableCloneCellRequest](./client.appenableclonecellrequest.md) - - - - -Specify the clone cell to enable. - - -
-**Returns:** - -Promise<[EnableCloneCellResponse](./client.enableclonecellresponse.md)> - -The enabled clone cell. - diff --git a/docs/client.appagentwebsocket.installedappid.md b/docs/client.appagentwebsocket.installedappid.md deleted file mode 100644 index 40e573b8..00000000 --- a/docs/client.appagentwebsocket.installedappid.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppAgentWebsocket](./client.appagentwebsocket.md) > [installedAppId](./client.appagentwebsocket.installedappid.md) - -## AppAgentWebsocket.installedAppId property - -**Signature:** - -```typescript -installedAppId: InstalledAppId; -``` diff --git a/docs/client.appagentwebsocket.md b/docs/client.appagentwebsocket.md deleted file mode 100644 index a708aec2..00000000 --- a/docs/client.appagentwebsocket.md +++ /dev/null @@ -1,278 +0,0 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppAgentWebsocket](./client.appagentwebsocket.md) - -## AppAgentWebsocket class - -A class to establish a websocket connection to an App interface, for a specific agent and app. - -**Signature:** - -```typescript -export declare class AppAgentWebsocket implements AppAgentClient -``` -**Implements:** [AppAgentClient](./client.appagentclient.md) - -## Properties - - - - - - - -
- -Property - - - - -Modifiers - - - - -Type - - - - -Description - - -
- -[appWebsocket](./client.appagentwebsocket.appwebsocket.md) - - - - -`readonly` - - - - -[AppWebsocket](./client.appwebsocket.md) - - - - - -
- -[cachedAppInfo?](./client.appagentwebsocket.cachedappinfo.md) - - - - - - - -[AppInfo](./client.appinfo.md) \| null - - - - -_(Optional)_ - - -
- -[emitter](./client.appagentwebsocket.emitter.md) - - - - -`readonly` - - - - -Emittery<[AppAgentEvents](./client.appagentevents.md)> - - - - - -
- -[installedAppId](./client.appagentwebsocket.installedappid.md) - - - - - - - -[InstalledAppId](./client.installedappid.md) - - - - - -
- -[myPubKey](./client.appagentwebsocket.mypubkey.md) - - - - - - - -[AgentPubKey](./client.agentpubkey.md) - - - - - -
- -## Methods - - - - - - - - - - - -
- -Method - - - - -Modifiers - - - - -Description - - -
- -[appInfo()](./client.appagentwebsocket.appinfo.md) - - - - - - - -Request the app's info, including all cell infos. - - -
- -[callZome(request, timeout)](./client.appagentwebsocket.callzome.md) - - - - - - - -Call a zome. - - -
- -[connect(installed\_app\_id, options)](./client.appagentwebsocket.connect.md) - - - - -`static` - - - - -Instance factory for creating AppAgentWebsockets. - - -
- -[createCloneCell(args)](./client.appagentwebsocket.createclonecell.md) - - - - - - - -Clone an existing provisioned cell. - - -
- -[disableCloneCell(args)](./client.appagentwebsocket.disableclonecell.md) - - - - - - - -Disable an enabled clone cell. - - -
- -[enableCloneCell(args)](./client.appagentwebsocket.enableclonecell.md) - - - - - - - -Enable a disabled clone cell. - - -
- -[getCellIdFromRoleName(roleName, appInfo)](./client.appagentwebsocket.getcellidfromrolename.md) - - - - - - - -Get a cell id by its role name or clone id. - - -
- -[networkInfo(args)](./client.appagentwebsocket.networkinfo.md) - - - - - - - -Request network info about gossip status. - - -
- -[on(eventName, listener)](./client.appagentwebsocket.on.md) - - - - - - - -Register an event listener for signals. - - -
diff --git a/docs/client.appagentwebsocket.mypubkey.md b/docs/client.appagentwebsocket.mypubkey.md deleted file mode 100644 index 1f9e1901..00000000 --- a/docs/client.appagentwebsocket.mypubkey.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppAgentWebsocket](./client.appagentwebsocket.md) > [myPubKey](./client.appagentwebsocket.mypubkey.md) - -## AppAgentWebsocket.myPubKey property - -**Signature:** - -```typescript -myPubKey: AgentPubKey; -``` diff --git a/docs/client.appagentwebsocket.networkinfo.md b/docs/client.appagentwebsocket.networkinfo.md deleted file mode 100644 index 3a2770c2..00000000 --- a/docs/client.appagentwebsocket.networkinfo.md +++ /dev/null @@ -1,55 +0,0 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppAgentWebsocket](./client.appagentwebsocket.md) > [networkInfo](./client.appagentwebsocket.networkinfo.md) - -## AppAgentWebsocket.networkInfo() method - -Request network info about gossip status. - -**Signature:** - -```typescript -networkInfo(args: AppAgentNetworkInfoRequest): Promise; -``` - -## Parameters - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -args - - - - -[AppAgentNetworkInfoRequest](./client.appagentnetworkinforequest.md) - - - - -Specify the DNAs for which you want network info - - -
-**Returns:** - -Promise<[NetworkInfoResponse](./client.networkinforesponse.md)> - -Network info for the specified DNAs - diff --git a/docs/client.appapi.disableclonecell.md b/docs/client.appapi.disableclonecell.md deleted file mode 100644 index bd504560..00000000 --- a/docs/client.appapi.disableclonecell.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppApi](./client.appapi.md) > [disableCloneCell](./client.appapi.disableclonecell.md) - -## AppApi.disableCloneCell property - -**Signature:** - -```typescript -disableCloneCell: Requester; -``` diff --git a/docs/client.appapi.enableclonecell.md b/docs/client.appapi.enableclonecell.md deleted file mode 100644 index 34731bbf..00000000 --- a/docs/client.appapi.enableclonecell.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppApi](./client.appapi.md) > [enableCloneCell](./client.appapi.enableclonecell.md) - -## AppApi.enableCloneCell property - -**Signature:** - -```typescript -enableCloneCell: Requester; -``` diff --git a/docs/client.appapi.md b/docs/client.appapi.md deleted file mode 100644 index 64e719eb..00000000 --- a/docs/client.appapi.md +++ /dev/null @@ -1,105 +0,0 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppApi](./client.appapi.md) - -## AppApi interface - - -**Signature:** - -```typescript -export interface AppApi -``` - -## Properties - - - - - - -
- -Property - - - - -Modifiers - - - - -Type - - - - -Description - - -
- -[appInfo](./client.appapi.appinfo.md) - - - - - - - -[Requester](./client.requester.md)<[AppInfoRequest](./client.appinforequest.md), [AppInfoResponse](./client.appinforesponse.md)> - - - - - -
- -[callZome](./client.appapi.callzome.md) - - - - - - - -[Requester](./client.requester.md)<[CallZomeRequest](./client.callzomerequest.md), [CallZomeResponse](./client.callzomeresponse.md)> - - - - - -
- -[disableCloneCell](./client.appapi.disableclonecell.md) - - - - - - - -[Requester](./client.requester.md)<[DisableCloneCellRequest](./client.disableclonecellrequest.md), [DisableCloneCellResponse](./client.disableclonecellresponse.md)> - - - - - -
- -[enableCloneCell](./client.appapi.enableclonecell.md) - - - - - - - -[Requester](./client.requester.md)<[EnableCloneCellRequest](./client.enableclonecellrequest.md), [EnableCloneCellResponse](./client.enableclonecellresponse.md)> - - - - - -
diff --git a/docs/client.appauthenticationrequest.md b/docs/client.appauthenticationrequest.md new file mode 100644 index 00000000..649ed1ea --- /dev/null +++ b/docs/client.appauthenticationrequest.md @@ -0,0 +1,54 @@ + + +[Home](./index.md) > [@holochain/client](./client.md) > [AppAuthenticationRequest](./client.appauthenticationrequest.md) + +## AppAuthenticationRequest interface + + +**Signature:** + +```typescript +export interface AppAuthenticationRequest +``` + +## Properties + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[token](./client.appauthenticationrequest.token.md) + + + + + + + +[AppAuthenticationToken](./client.appauthenticationtoken.md) + + + + + +
diff --git a/docs/client.appauthenticationrequest.token.md b/docs/client.appauthenticationrequest.token.md new file mode 100644 index 00000000..f4847b15 --- /dev/null +++ b/docs/client.appauthenticationrequest.token.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@holochain/client](./client.md) > [AppAuthenticationRequest](./client.appauthenticationrequest.md) > [token](./client.appauthenticationrequest.token.md) + +## AppAuthenticationRequest.token property + +**Signature:** + +```typescript +token: AppAuthenticationToken; +``` diff --git a/docs/client.appapi.appinfo.md b/docs/client.appauthenticationtoken.md similarity index 53% rename from docs/client.appapi.appinfo.md rename to docs/client.appauthenticationtoken.md index ca0dc2b0..c83beef3 100644 --- a/docs/client.appapi.appinfo.md +++ b/docs/client.appauthenticationtoken.md @@ -1,11 +1,12 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppApi](./client.appapi.md) > [appInfo](./client.appapi.appinfo.md) - -## AppApi.appInfo property - -**Signature:** - -```typescript -appInfo: Requester; -``` + + +[Home](./index.md) > [@holochain/client](./client.md) > [AppAuthenticationToken](./client.appauthenticationtoken.md) + +## AppAuthenticationToken type + + +**Signature:** + +```typescript +export type AppAuthenticationToken = number[]; +``` diff --git a/docs/client.appagentcallzomerequest.md b/docs/client.appcallzomerequest.md similarity index 65% rename from docs/client.appagentcallzomerequest.md rename to docs/client.appcallzomerequest.md index 87cce3c4..e53605a2 100644 --- a/docs/client.appagentcallzomerequest.md +++ b/docs/client.appcallzomerequest.md @@ -1,14 +1,14 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppAgentCallZomeRequest](./client.appagentcallzomerequest.md) - -## AppAgentCallZomeRequest type - - -**Signature:** - -```typescript -export type AppAgentCallZomeRequest = NonProvenanceCallZomeRequest | RoleNameCallZomeRequest | CallZomeRequestSigned | RoleNameCallZomeRequestSigned; -``` -**References:** [NonProvenanceCallZomeRequest](./client.nonprovenancecallzomerequest.md), [RoleNameCallZomeRequest](./client.rolenamecallzomerequest.md), [CallZomeRequestSigned](./client.callzomerequestsigned.md), [RoleNameCallZomeRequestSigned](./client.rolenamecallzomerequestsigned.md) - + + +[Home](./index.md) > [@holochain/client](./client.md) > [AppCallZomeRequest](./client.appcallzomerequest.md) + +## AppCallZomeRequest type + + +**Signature:** + +```typescript +export type AppCallZomeRequest = NonProvenanceCallZomeRequest | RoleNameCallZomeRequest | CallZomeRequestSigned | RoleNameCallZomeRequestSigned; +``` +**References:** [NonProvenanceCallZomeRequest](./client.nonprovenancecallzomerequest.md), [RoleNameCallZomeRequest](./client.rolenamecallzomerequest.md), [CallZomeRequestSigned](./client.callzomerequestsigned.md), [RoleNameCallZomeRequestSigned](./client.rolenamecallzomerequestsigned.md) + diff --git a/docs/client.appagentclient.appinfo.md b/docs/client.appclient.appinfo.md similarity index 67% rename from docs/client.appagentclient.appinfo.md rename to docs/client.appclient.appinfo.md index 6a723110..6c55abf8 100644 --- a/docs/client.appagentclient.appinfo.md +++ b/docs/client.appclient.appinfo.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppAgentClient](./client.appagentclient.md) > [appInfo](./client.appagentclient.appinfo.md) - -## AppAgentClient.appInfo() method - -**Signature:** - -```typescript -appInfo(): Promise; -``` -**Returns:** - -Promise<[AppInfoResponse](./client.appinforesponse.md)> - + + +[Home](./index.md) > [@holochain/client](./client.md) > [AppClient](./client.appclient.md) > [appInfo](./client.appclient.appinfo.md) + +## AppClient.appInfo() method + +**Signature:** + +```typescript +appInfo(): Promise; +``` +**Returns:** + +Promise<[AppInfoResponse](./client.appinforesponse.md)> + diff --git a/docs/client.appagentclient.callzome.md b/docs/client.appclient.callzome.md similarity index 59% rename from docs/client.appagentclient.callzome.md rename to docs/client.appclient.callzome.md index b7bbffb9..8fe0d04b 100644 --- a/docs/client.appagentclient.callzome.md +++ b/docs/client.appclient.callzome.md @@ -1,65 +1,65 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppAgentClient](./client.appagentclient.md) > [callZome](./client.appagentclient.callzome.md) - -## AppAgentClient.callZome() method - -**Signature:** - -```typescript -callZome(args: AppAgentCallZomeRequest, timeout?: number): Promise; -``` - -## Parameters - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -args - - - - -[AppAgentCallZomeRequest](./client.appagentcallzomerequest.md) - - - - - -
- -timeout - - - - -number - - - - -_(Optional)_ - - -
-**Returns:** - -Promise<any> - + + +[Home](./index.md) > [@holochain/client](./client.md) > [AppClient](./client.appclient.md) > [callZome](./client.appclient.callzome.md) + +## AppClient.callZome() method + +**Signature:** + +```typescript +callZome(args: AppCallZomeRequest, timeout?: number): Promise; +``` + +## Parameters + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +args + + + + +[AppCallZomeRequest](./client.appcallzomerequest.md) + + + + + +
+ +timeout + + + + +number + + + + +_(Optional)_ + + +
+**Returns:** + +Promise<any> + diff --git a/docs/client.appagentclient.createclonecell.md b/docs/client.appclient.createclonecell.md similarity index 75% rename from docs/client.appagentclient.createclonecell.md rename to docs/client.appclient.createclonecell.md index 4351cb7c..6453995d 100644 --- a/docs/client.appagentclient.createclonecell.md +++ b/docs/client.appclient.createclonecell.md @@ -1,49 +1,49 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppAgentClient](./client.appagentclient.md) > [createCloneCell](./client.appagentclient.createclonecell.md) - -## AppAgentClient.createCloneCell() method - -**Signature:** - -```typescript -createCloneCell(args: AppCreateCloneCellRequest): Promise; -``` - -## Parameters - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -args - - - - -[AppCreateCloneCellRequest](./client.appcreateclonecellrequest.md) - - - - - -
-**Returns:** - -Promise<[CreateCloneCellResponse](./client.createclonecellresponse.md)> - + + +[Home](./index.md) > [@holochain/client](./client.md) > [AppClient](./client.appclient.md) > [createCloneCell](./client.appclient.createclonecell.md) + +## AppClient.createCloneCell() method + +**Signature:** + +```typescript +createCloneCell(args: AppCreateCloneCellRequest): Promise; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +args + + + + +[AppCreateCloneCellRequest](./client.appcreateclonecellrequest.md) + + + + + +
+**Returns:** + +Promise<[CreateCloneCellResponse](./client.createclonecellresponse.md)> + diff --git a/docs/client.appagentclient.disableclonecell.md b/docs/client.appclient.disableclonecell.md similarity index 75% rename from docs/client.appagentclient.disableclonecell.md rename to docs/client.appclient.disableclonecell.md index 2784cdee..df4166e3 100644 --- a/docs/client.appagentclient.disableclonecell.md +++ b/docs/client.appclient.disableclonecell.md @@ -1,49 +1,49 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppAgentClient](./client.appagentclient.md) > [disableCloneCell](./client.appagentclient.disableclonecell.md) - -## AppAgentClient.disableCloneCell() method - -**Signature:** - -```typescript -disableCloneCell(args: AppDisableCloneCellRequest): Promise; -``` - -## Parameters - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -args - - - - -[AppDisableCloneCellRequest](./client.appdisableclonecellrequest.md) - - - - - -
-**Returns:** - -Promise<[DisableCloneCellResponse](./client.disableclonecellresponse.md)> - + + +[Home](./index.md) > [@holochain/client](./client.md) > [AppClient](./client.appclient.md) > [disableCloneCell](./client.appclient.disableclonecell.md) + +## AppClient.disableCloneCell() method + +**Signature:** + +```typescript +disableCloneCell(args: AppDisableCloneCellRequest): Promise; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +args + + + + +[AppDisableCloneCellRequest](./client.appdisableclonecellrequest.md) + + + + + +
+**Returns:** + +Promise<[DisableCloneCellResponse](./client.disableclonecellresponse.md)> + diff --git a/docs/client.appagentclient.enableclonecell.md b/docs/client.appclient.enableclonecell.md similarity index 75% rename from docs/client.appagentclient.enableclonecell.md rename to docs/client.appclient.enableclonecell.md index bbfef50a..5d287236 100644 --- a/docs/client.appagentclient.enableclonecell.md +++ b/docs/client.appclient.enableclonecell.md @@ -1,49 +1,49 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppAgentClient](./client.appagentclient.md) > [enableCloneCell](./client.appagentclient.enableclonecell.md) - -## AppAgentClient.enableCloneCell() method - -**Signature:** - -```typescript -enableCloneCell(args: AppEnableCloneCellRequest): Promise; -``` - -## Parameters - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -args - - - - -[AppEnableCloneCellRequest](./client.appenableclonecellrequest.md) - - - - - -
-**Returns:** - -Promise<[EnableCloneCellResponse](./client.enableclonecellresponse.md)> - + + +[Home](./index.md) > [@holochain/client](./client.md) > [AppClient](./client.appclient.md) > [enableCloneCell](./client.appclient.enableclonecell.md) + +## AppClient.enableCloneCell() method + +**Signature:** + +```typescript +enableCloneCell(args: AppEnableCloneCellRequest): Promise; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +args + + + + +[AppEnableCloneCellRequest](./client.appenableclonecellrequest.md) + + + + + +
+**Returns:** + +Promise<[EnableCloneCellResponse](./client.enableclonecellresponse.md)> + diff --git a/docs/client.appagentclient.md b/docs/client.appclient.md similarity index 52% rename from docs/client.appagentclient.md rename to docs/client.appclient.md index a69d4d32..e3f84486 100644 --- a/docs/client.appagentclient.md +++ b/docs/client.appclient.md @@ -1,132 +1,132 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppAgentClient](./client.appagentclient.md) - -## AppAgentClient interface - - -**Signature:** - -```typescript -export interface AppAgentClient -``` - -## Properties - - - -
- -Property - - - - -Modifiers - - - - -Type - - - - -Description - - -
- -[myPubKey](./client.appagentclient.mypubkey.md) - - - - - - - -[AgentPubKey](./client.agentpubkey.md) - - - - - -
- -## Methods - - - - - - - - - -
- -Method - - - - -Description - - -
- -[appInfo()](./client.appagentclient.appinfo.md) - - - - - -
- -[callZome(args, timeout)](./client.appagentclient.callzome.md) - - - - - -
- -[createCloneCell(args)](./client.appagentclient.createclonecell.md) - - - - - -
- -[disableCloneCell(args)](./client.appagentclient.disableclonecell.md) - - - - - -
- -[enableCloneCell(args)](./client.appagentclient.enableclonecell.md) - - - - - -
- -[networkInfo(args)](./client.appagentclient.networkinfo.md) - - - - - -
- -[on(eventName, listener)](./client.appagentclient.on.md) - - - - - -
+ + +[Home](./index.md) > [@holochain/client](./client.md) > [AppClient](./client.appclient.md) + +## AppClient interface + + +**Signature:** + +```typescript +export interface AppClient +``` + +## Properties + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[myPubKey](./client.appclient.mypubkey.md) + + + + + + + +[AgentPubKey](./client.agentpubkey.md) + + + + + +
+ +## Methods + + + + + + + + + +
+ +Method + + + + +Description + + +
+ +[appInfo()](./client.appclient.appinfo.md) + + + + + +
+ +[callZome(args, timeout)](./client.appclient.callzome.md) + + + + + +
+ +[createCloneCell(args)](./client.appclient.createclonecell.md) + + + + + +
+ +[disableCloneCell(args)](./client.appclient.disableclonecell.md) + + + + + +
+ +[enableCloneCell(args)](./client.appclient.enableclonecell.md) + + + + + +
+ +[networkInfo(args)](./client.appclient.networkinfo.md) + + + + + +
+ +[on(eventName, listener)](./client.appclient.on.md) + + + + + +
diff --git a/docs/client.appagentclient.mypubkey.md b/docs/client.appclient.mypubkey.md similarity index 58% rename from docs/client.appagentclient.mypubkey.md rename to docs/client.appclient.mypubkey.md index 3dc02637..e549571b 100644 --- a/docs/client.appagentclient.mypubkey.md +++ b/docs/client.appclient.mypubkey.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppAgentClient](./client.appagentclient.md) > [myPubKey](./client.appagentclient.mypubkey.md) - -## AppAgentClient.myPubKey property - -**Signature:** - -```typescript -myPubKey: AgentPubKey; -``` + + +[Home](./index.md) > [@holochain/client](./client.md) > [AppClient](./client.appclient.md) > [myPubKey](./client.appclient.mypubkey.md) + +## AppClient.myPubKey property + +**Signature:** + +```typescript +myPubKey: AgentPubKey; +``` diff --git a/docs/client.appagentclient.networkinfo.md b/docs/client.appclient.networkinfo.md similarity index 58% rename from docs/client.appagentclient.networkinfo.md rename to docs/client.appclient.networkinfo.md index 0fe5b15d..e33e0f9b 100644 --- a/docs/client.appagentclient.networkinfo.md +++ b/docs/client.appclient.networkinfo.md @@ -1,49 +1,49 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppAgentClient](./client.appagentclient.md) > [networkInfo](./client.appagentclient.networkinfo.md) - -## AppAgentClient.networkInfo() method - -**Signature:** - -```typescript -networkInfo(args: AppAgentNetworkInfoRequest): Promise; -``` - -## Parameters - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -args - - - - -[AppAgentNetworkInfoRequest](./client.appagentnetworkinforequest.md) - - - - - -
-**Returns:** - -Promise<[NetworkInfoResponse](./client.networkinforesponse.md)> - + + +[Home](./index.md) > [@holochain/client](./client.md) > [AppClient](./client.appclient.md) > [networkInfo](./client.appclient.networkinfo.md) + +## AppClient.networkInfo() method + +**Signature:** + +```typescript +networkInfo(args: AppNetworkInfoRequest): Promise; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +args + + + + +[AppNetworkInfoRequest](./client.appnetworkinforequest.md) + + + + + +
+**Returns:** + +Promise<[NetworkInfoResponse](./client.networkinforesponse.md)> + diff --git a/docs/client.appagentclient.on.md b/docs/client.appclient.on.md similarity index 64% rename from docs/client.appagentclient.on.md rename to docs/client.appclient.on.md index 8aa8d994..52dc2302 100644 --- a/docs/client.appagentclient.on.md +++ b/docs/client.appclient.on.md @@ -1,63 +1,63 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppAgentClient](./client.appagentclient.md) > [on](./client.appagentclient.on.md) - -## AppAgentClient.on() method - -**Signature:** - -```typescript -on(eventName: Name | readonly Name[], listener: AppSignalCb): UnsubscribeFunction; -``` - -## Parameters - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -eventName - - - - -Name \| readonly Name\[\] - - - - - -
- -listener - - - - -[AppSignalCb](./client.appsignalcb.md) - - - - - -
-**Returns:** - -UnsubscribeFunction - + + +[Home](./index.md) > [@holochain/client](./client.md) > [AppClient](./client.appclient.md) > [on](./client.appclient.on.md) + +## AppClient.on() method + +**Signature:** + +```typescript +on(eventName: Name | readonly Name[], listener: AppSignalCb): UnsubscribeFunction; +``` + +## Parameters + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +eventName + + + + +Name \| readonly Name\[\] + + + + + +
+ +listener + + + + +[AppSignalCb](./client.appsignalcb.md) + + + + + +
+**Returns:** + +UnsubscribeFunction + diff --git a/docs/client.appagentevents.md b/docs/client.appevents.md similarity index 68% rename from docs/client.appagentevents.md rename to docs/client.appevents.md index bb032667..0b6a275f 100644 --- a/docs/client.appagentevents.md +++ b/docs/client.appevents.md @@ -1,54 +1,54 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppAgentEvents](./client.appagentevents.md) - -## AppAgentEvents interface - - -**Signature:** - -```typescript -export interface AppAgentEvents -``` - -## Properties - - - -
- -Property - - - - -Modifiers - - - - -Type - - - - -Description - - -
- -[signal](./client.appagentevents.signal.md) - - - - - - - -[AppSignal](./client.appsignal.md) - - - - - -
+ + +[Home](./index.md) > [@holochain/client](./client.md) > [AppEvents](./client.appevents.md) + +## AppEvents interface + + +**Signature:** + +```typescript +export interface AppEvents +``` + +## Properties + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[signal](./client.appevents.signal.md) + + + + + + + +[AppSignal](./client.appsignal.md) + + + + + +
diff --git a/docs/client.appagentevents.signal.md b/docs/client.appevents.signal.md similarity index 59% rename from docs/client.appagentevents.signal.md rename to docs/client.appevents.signal.md index c0a985df..0361ce4c 100644 --- a/docs/client.appagentevents.signal.md +++ b/docs/client.appevents.signal.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppAgentEvents](./client.appagentevents.md) > [signal](./client.appagentevents.signal.md) - -## AppAgentEvents.signal property - -**Signature:** - -```typescript -signal: AppSignal; -``` + + +[Home](./index.md) > [@holochain/client](./client.md) > [AppEvents](./client.appevents.md) > [signal](./client.appevents.signal.md) + +## AppEvents.signal property + +**Signature:** + +```typescript +signal: AppSignal; +``` diff --git a/docs/client.appinforequest.md b/docs/client.appinforequest.md deleted file mode 100644 index afad6612..00000000 --- a/docs/client.appinforequest.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppInfoRequest](./client.appinforequest.md) - -## AppInfoRequest type - - -**Signature:** - -```typescript -export type AppInfoRequest = { - installed_app_id: InstalledAppId; -}; -``` -**References:** [InstalledAppId](./client.installedappid.md) - diff --git a/docs/client.appagentnetworkinforequest.md b/docs/client.appnetworkinforequest.md similarity index 55% rename from docs/client.appagentnetworkinforequest.md rename to docs/client.appnetworkinforequest.md index e2b0c798..3d76e861 100644 --- a/docs/client.appagentnetworkinforequest.md +++ b/docs/client.appnetworkinforequest.md @@ -1,14 +1,14 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppAgentNetworkInfoRequest](./client.appagentnetworkinforequest.md) - -## AppAgentNetworkInfoRequest type - - -**Signature:** - -```typescript -export type AppAgentNetworkInfoRequest = Omit; -``` -**References:** [NetworkInfoRequest](./client.networkinforequest.md) - + + +[Home](./index.md) > [@holochain/client](./client.md) > [AppNetworkInfoRequest](./client.appnetworkinforequest.md) + +## AppNetworkInfoRequest type + + +**Signature:** + +```typescript +export type AppNetworkInfoRequest = Omit; +``` +**References:** [NetworkInfoRequest](./client.networkinforequest.md) + diff --git a/docs/client.appwebsocket._requester.md b/docs/client.appwebsocket._requester.md deleted file mode 100644 index dd268722..00000000 --- a/docs/client.appwebsocket._requester.md +++ /dev/null @@ -1,65 +0,0 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppWebsocket](./client.appwebsocket.md) > [\_requester](./client.appwebsocket._requester.md) - -## AppWebsocket.\_requester() method - -**Signature:** - -```typescript -_requester(tag: string, transformer?: Transformer): (req: ReqI, timeout?: number | undefined) => Promise; -``` - -## Parameters - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -tag - - - - -string - - - - - -
- -transformer - - - - -[Transformer](./client.transformer_2.md)<ReqI, ReqO, ResI, ResO> - - - - -_(Optional)_ - - -
-**Returns:** - -(req: ReqI, timeout?: number \| undefined) => Promise<ResO> - diff --git a/docs/client.appwebsocket.appinfo.md b/docs/client.appwebsocket.appinfo.md index 6cdc98d5..74af74ee 100644 --- a/docs/client.appwebsocket.appinfo.md +++ b/docs/client.appwebsocket.appinfo.md @@ -2,12 +2,54 @@ [Home](./index.md) > [@holochain/client](./client.md) > [AppWebsocket](./client.appwebsocket.md) > [appInfo](./client.appwebsocket.appinfo.md) -## AppWebsocket.appInfo property +## AppWebsocket.appInfo() method Request the app's info, including all cell infos. **Signature:** ```typescript -appInfo: Requester; +appInfo(timeout?: number): Promise; ``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +timeout + + + + +number + + + + +_(Optional)_ A timeout to override the default. + + +
+**Returns:** + +Promise<[AppInfo](./client.appinfo.md)> + +The app's [AppInfo](./client.appinfo.md). + diff --git a/docs/client.appagentwebsocket.cachedappinfo.md b/docs/client.appwebsocket.cachedappinfo.md similarity index 55% rename from docs/client.appagentwebsocket.cachedappinfo.md rename to docs/client.appwebsocket.cachedappinfo.md index 630ed40b..c8a228a5 100644 --- a/docs/client.appagentwebsocket.cachedappinfo.md +++ b/docs/client.appwebsocket.cachedappinfo.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppAgentWebsocket](./client.appagentwebsocket.md) > [cachedAppInfo](./client.appagentwebsocket.cachedappinfo.md) - -## AppAgentWebsocket.cachedAppInfo property - -**Signature:** - -```typescript -cachedAppInfo?: AppInfo | null; -``` + + +[Home](./index.md) > [@holochain/client](./client.md) > [AppWebsocket](./client.appwebsocket.md) > [cachedAppInfo](./client.appwebsocket.cachedappinfo.md) + +## AppWebsocket.cachedAppInfo property + +**Signature:** + +```typescript +cachedAppInfo?: AppInfo | null; +``` diff --git a/docs/client.appwebsocket.callzome.md b/docs/client.appwebsocket.callzome.md index 15521928..58c82a94 100644 --- a/docs/client.appwebsocket.callzome.md +++ b/docs/client.appwebsocket.callzome.md @@ -2,12 +2,70 @@ [Home](./index.md) > [@holochain/client](./client.md) > [AppWebsocket](./client.appwebsocket.md) > [callZome](./client.appwebsocket.callzome.md) -## AppWebsocket.callZome property +## AppWebsocket.callZome() method Call a zome. **Signature:** ```typescript -callZome: Requester; +callZome(request: AppCallZomeRequest, timeout?: number): Promise; ``` + +## Parameters + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +request + + + + +[AppCallZomeRequest](./client.appcallzomerequest.md) + + + + +The zome call arguments. + + +
+ +timeout + + + + +number + + + + +_(Optional)_ A timeout to override the default. + + +
+**Returns:** + +Promise<[CallZomeResponse](./client.callzomeresponse.md)> + +The zome call's response. + diff --git a/docs/client.appwebsocket.connect.md b/docs/client.appwebsocket.connect.md index f2f2ed0b..2289dd8f 100644 --- a/docs/client.appwebsocket.connect.md +++ b/docs/client.appwebsocket.connect.md @@ -4,12 +4,12 @@ ## AppWebsocket.connect() method -Instance factory for creating AppWebsockets. +Instance factory for creating an [AppWebsocket](./client.appwebsocket.md). **Signature:** ```typescript -static connect(options?: WebsocketConnectionOptions): Promise; +static connect(token: AppAuthenticationToken, options?: WebsocketConnectionOptions): Promise; ``` ## Parameters @@ -32,6 +32,22 @@ Description +token + + + + +[AppAuthenticationToken](./client.appauthenticationtoken.md) + + + + +A token to authenticate the websocket connection. Get a token using AdminWebsocket\#issueAppAuthenticationToken. + + + + + options diff --git a/docs/client.appwebsocket.createclonecell.md b/docs/client.appwebsocket.createclonecell.md index e937298b..3eaf8010 100644 --- a/docs/client.appwebsocket.createclonecell.md +++ b/docs/client.appwebsocket.createclonecell.md @@ -2,12 +2,54 @@ [Home](./index.md) > [@holochain/client](./client.md) > [AppWebsocket](./client.appwebsocket.md) > [createCloneCell](./client.appwebsocket.createclonecell.md) -## AppWebsocket.createCloneCell property +## AppWebsocket.createCloneCell() method Clone an existing provisioned cell. **Signature:** ```typescript -createCloneCell: Requester; +createCloneCell(args: AppCreateCloneCellRequest): Promise; ``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +args + + + + +[AppCreateCloneCellRequest](./client.appcreateclonecellrequest.md) + + + + +Specify the cell to clone. + + +
+**Returns:** + +Promise<[CreateCloneCellResponse](./client.createclonecellresponse.md)> + +The created clone cell. + diff --git a/docs/client.appwebsocket.defaulttimeout.md b/docs/client.appwebsocket.defaulttimeout.md deleted file mode 100644 index a28adc39..00000000 --- a/docs/client.appwebsocket.defaulttimeout.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppWebsocket](./client.appwebsocket.md) > [defaultTimeout](./client.appwebsocket.defaulttimeout.md) - -## AppWebsocket.defaultTimeout property - -**Signature:** - -```typescript -defaultTimeout: number; -``` diff --git a/docs/client.appwebsocket.disableclonecell.md b/docs/client.appwebsocket.disableclonecell.md index e50b7f59..0ec7b5ba 100644 --- a/docs/client.appwebsocket.disableclonecell.md +++ b/docs/client.appwebsocket.disableclonecell.md @@ -2,12 +2,52 @@ [Home](./index.md) > [@holochain/client](./client.md) > [AppWebsocket](./client.appwebsocket.md) > [disableCloneCell](./client.appwebsocket.disableclonecell.md) -## AppWebsocket.disableCloneCell property +## AppWebsocket.disableCloneCell() method Disable an enabled clone cell. **Signature:** ```typescript -disableCloneCell: Requester; +disableCloneCell(args: AppDisableCloneCellRequest): Promise; ``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +args + + + + +[AppDisableCloneCellRequest](./client.appdisableclonecellrequest.md) + + + + +Specify the clone cell to disable. + + +
+**Returns:** + +Promise<[DisableCloneCellResponse](./client.disableclonecellresponse.md)> + diff --git a/docs/client.appwebsocket.enableclonecell.md b/docs/client.appwebsocket.enableclonecell.md index 818b85f7..6329d0ab 100644 --- a/docs/client.appwebsocket.enableclonecell.md +++ b/docs/client.appwebsocket.enableclonecell.md @@ -2,12 +2,54 @@ [Home](./index.md) > [@holochain/client](./client.md) > [AppWebsocket](./client.appwebsocket.md) > [enableCloneCell](./client.appwebsocket.enableclonecell.md) -## AppWebsocket.enableCloneCell property +## AppWebsocket.enableCloneCell() method Enable a disabled clone cell. **Signature:** ```typescript -enableCloneCell: Requester; +enableCloneCell(args: AppEnableCloneCellRequest): Promise; ``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +args + + + + +[AppEnableCloneCellRequest](./client.appenableclonecellrequest.md) + + + + +Specify the clone cell to enable. + + +
+**Returns:** + +Promise<[EnableCloneCellResponse](./client.enableclonecellresponse.md)> + +The enabled clone cell. + diff --git a/docs/client.appagentwebsocket.getcellidfromrolename.md b/docs/client.appwebsocket.getcellidfromrolename.md similarity index 75% rename from docs/client.appagentwebsocket.getcellidfromrolename.md rename to docs/client.appwebsocket.getcellidfromrolename.md index 9a5c13c5..fae52cfc 100644 --- a/docs/client.appagentwebsocket.getcellidfromrolename.md +++ b/docs/client.appwebsocket.getcellidfromrolename.md @@ -1,71 +1,71 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppAgentWebsocket](./client.appagentwebsocket.md) > [getCellIdFromRoleName](./client.appagentwebsocket.getcellidfromrolename.md) - -## AppAgentWebsocket.getCellIdFromRoleName() method - -Get a cell id by its role name or clone id. - -**Signature:** - -```typescript -getCellIdFromRoleName(roleName: RoleName, appInfo: AppInfo): CellId; -``` - -## Parameters - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -roleName - - - - -[RoleName](./client.rolename.md) - - - - -The role name or clone id of the cell. - - -
- -appInfo - - - - -[AppInfo](./client.appinfo.md) - - - - -The app info containing all cell infos. - - -
-**Returns:** - -[CellId](./client.cellid.md) - -The cell id or throws an error if not found. - + + +[Home](./index.md) > [@holochain/client](./client.md) > [AppWebsocket](./client.appwebsocket.md) > [getCellIdFromRoleName](./client.appwebsocket.getcellidfromrolename.md) + +## AppWebsocket.getCellIdFromRoleName() method + +Get a cell id by its role name or clone id. + +**Signature:** + +```typescript +getCellIdFromRoleName(roleName: RoleName, appInfo: AppInfo): CellId; +``` + +## Parameters + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +roleName + + + + +[RoleName](./client.rolename.md) + + + + +The role name or clone id of the cell. + + +
+ +appInfo + + + + +[AppInfo](./client.appinfo.md) + + + + +The app info containing all cell infos. + + +
+**Returns:** + +[CellId](./client.cellid.md) + +The cell id or throws an error if not found. + diff --git a/docs/client.appwebsocket.md b/docs/client.appwebsocket.md index 06a98bdc..1402277b 100644 --- a/docs/client.appwebsocket.md +++ b/docs/client.appwebsocket.md @@ -4,16 +4,14 @@ ## AppWebsocket class -A class to establish a websocket connection to an App interface of a Holochain conductor. +A class to establish a websocket connection to an App interface, for a specific agent and app. **Signature:** ```typescript -export declare class AppWebsocket extends Emittery implements AppApi +export declare class AppWebsocket implements AppClient ``` -**Extends:** Emittery - -**Implements:** [AppApi](./client.appapi.md) +**Implements:** [AppClient](./client.appclient.md) ## Properties @@ -40,7 +38,7 @@ Description -[appInfo](./client.appwebsocket.appinfo.md) +[cachedAppInfo?](./client.appwebsocket.cachedappinfo.md) @@ -48,37 +46,37 @@ Description -[Requester](./client.requester.md)<[AppInfoRequest](./client.appinforequest.md), [AppInfoResponse](./client.appinforesponse.md)> +[AppInfo](./client.appinfo.md) \| null -Request the app's info, including all cell infos. +_(Optional)_ -[callZome](./client.appwebsocket.callzome.md) +[client](./client.appwebsocket.client.md) +`readonly` + -[Requester](./client.requester.md)<[CallZomeRequest](./client.callzomerequest.md) \| [CallZomeRequestSigned](./client.callzomerequestsigned.md), [CallZomeResponse](./client.callzomeresponse.md)> +[WsClient](./client.wsclient.md) -Call a zome. - -[client](./client.appwebsocket.client.md) +[myPubKey](./client.appwebsocket.mypubkey.md) @@ -88,35 +86,36 @@ Call a zome. -[WsClient](./client.wsclient.md) +[AgentPubKey](./client.agentpubkey.md) - + -[createCloneCell](./client.appwebsocket.createclonecell.md) +## Methods + - + + -
- +Method - + -[Requester](./client.requester.md)<[CreateCloneCellRequest](./client.createclonecellrequest.md), [CreateCloneCellResponse](./client.createclonecellresponse.md)> +Modifiers - + -Clone an existing provisioned cell. +Description -
+
-[defaultTimeout](./client.appwebsocket.defaulttimeout.md) +[appInfo(timeout)](./client.appwebsocket.appinfo.md) @@ -124,73 +123,57 @@ Clone an existing provisioned cell. -number - - - +Request the app's info, including all cell infos.
-[disableCloneCell](./client.appwebsocket.disableclonecell.md) - - - +[callZome(request, timeout)](./client.appwebsocket.callzome.md) -[Requester](./client.requester.md)<[DisableCloneCellRequest](./client.disableclonecellrequest.md), [DisableCloneCellResponse](./client.disableclonecellresponse.md)> - -Disable an enabled clone cell. +Call a zome.
-[enableCloneCell](./client.appwebsocket.enableclonecell.md) - - - +[connect(token, options)](./client.appwebsocket.connect.md) -[Requester](./client.requester.md)<[EnableCloneCellRequest](./client.enableclonecellrequest.md), [EnableCloneCellResponse](./client.enableclonecellresponse.md)> +`static` -Enable a disabled clone cell. +Instance factory for creating an [AppWebsocket](./client.appwebsocket.md).
-[networkInfo](./client.appwebsocket.networkinfo.md) - - - +[createCloneCell(args)](./client.appwebsocket.createclonecell.md) -[Requester](./client.requester.md)<[NetworkInfoRequest](./client.networkinforequest.md), [NetworkInfoResponse](./client.networkinforesponse.md)> - -Request network info about gossip status. +Clone an existing provisioned cell.
-[overrideInstalledAppId?](./client.appwebsocket.overrideinstalledappid.md) +[disableCloneCell(args)](./client.appwebsocket.disableclonecell.md) @@ -198,38 +181,41 @@ Request network info about gossip status. -[InstalledAppId](./client.installedappid.md) +Disable an enabled clone cell. - +
-_(Optional)_ +[enableCloneCell(args)](./client.appwebsocket.enableclonecell.md) -
+ -## Methods - + - + diff --git a/docs/client.appapi.callzome.md b/docs/client.appwebsocket.mypubkey.md similarity index 52% rename from docs/client.appapi.callzome.md rename to docs/client.appwebsocket.mypubkey.md index f7191213..4a67aeab 100644 --- a/docs/client.appapi.callzome.md +++ b/docs/client.appwebsocket.mypubkey.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppApi](./client.appapi.md) > [callZome](./client.appapi.callzome.md) - -## AppApi.callZome property - -**Signature:** - -```typescript -callZome: Requester; -``` + + +[Home](./index.md) > [@holochain/client](./client.md) > [AppWebsocket](./client.appwebsocket.md) > [myPubKey](./client.appwebsocket.mypubkey.md) + +## AppWebsocket.myPubKey property + +**Signature:** + +```typescript +readonly myPubKey: AgentPubKey; +``` diff --git a/docs/client.appwebsocket.networkinfo.md b/docs/client.appwebsocket.networkinfo.md index 1603f85f..c60b19be 100644 --- a/docs/client.appwebsocket.networkinfo.md +++ b/docs/client.appwebsocket.networkinfo.md @@ -2,12 +2,54 @@ [Home](./index.md) > [@holochain/client](./client.md) > [AppWebsocket](./client.appwebsocket.md) > [networkInfo](./client.appwebsocket.networkinfo.md) -## AppWebsocket.networkInfo property +## AppWebsocket.networkInfo() method Request network info about gossip status. **Signature:** ```typescript -networkInfo: Requester; +networkInfo(args: AppNetworkInfoRequest): Promise; ``` + +## Parameters + +
+ -Method +Enable a disabled clone cell. - +
-Modifiers +[getCellIdFromRoleName(roleName, appInfo)](./client.appwebsocket.getcellidfromrolename.md) - + -Description + + +Get a cell id by its role name or clone id. -
-[\_requester(tag, transformer)](./client.appwebsocket._requester.md) +
+ +[networkInfo(args)](./client.appwebsocket.networkinfo.md) @@ -237,21 +223,21 @@ Description +Request network info about gossip status. +
-[connect(options)](./client.appwebsocket.connect.md) +[on(eventName, listener)](./client.appwebsocket.on.md) -`static` - -Instance factory for creating AppWebsockets. +Register an event listener for signals.
+ +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +args + + + + +[AppNetworkInfoRequest](./client.appnetworkinforequest.md) + + + + +Specify the DNAs for which you want network info + + +
+**Returns:** + +Promise<[NetworkInfoResponse](./client.networkinforesponse.md)> + +Network info for the specified DNAs + diff --git a/docs/client.appagentwebsocket.on.md b/docs/client.appwebsocket.on.md similarity index 69% rename from docs/client.appagentwebsocket.on.md rename to docs/client.appwebsocket.on.md index 9ff3e129..6cc27a9f 100644 --- a/docs/client.appagentwebsocket.on.md +++ b/docs/client.appwebsocket.on.md @@ -1,71 +1,71 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppAgentWebsocket](./client.appagentwebsocket.md) > [on](./client.appagentwebsocket.on.md) - -## AppAgentWebsocket.on() method - -Register an event listener for signals. - -**Signature:** - -```typescript -on(eventName: Name | readonly Name[], listener: AppSignalCb): UnsubscribeFunction; -``` - -## Parameters - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -eventName - - - - -Name \| readonly Name\[\] - - - - -Event name to listen to (currently only "signal"). - - -
- -listener - - - - -[AppSignalCb](./client.appsignalcb.md) - - - - -The function to call when event is triggered. - - -
-**Returns:** - -UnsubscribeFunction - -A function to unsubscribe the event listener. - + + +[Home](./index.md) > [@holochain/client](./client.md) > [AppWebsocket](./client.appwebsocket.md) > [on](./client.appwebsocket.on.md) + +## AppWebsocket.on() method + +Register an event listener for signals. + +**Signature:** + +```typescript +on(eventName: Name | readonly Name[], listener: AppSignalCb): UnsubscribeFunction; +``` + +## Parameters + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +eventName + + + + +Name \| readonly Name\[\] + + + + +Event name to listen to (currently only "signal"). + + +
+ +listener + + + + +[AppSignalCb](./client.appsignalcb.md) + + + + +The function to call when event is triggered. + + +
+**Returns:** + +UnsubscribeFunction + +A function to unsubscribe the event listener. + diff --git a/docs/client.appwebsocket.overrideinstalledappid.md b/docs/client.appwebsocket.overrideinstalledappid.md deleted file mode 100644 index 8b159f79..00000000 --- a/docs/client.appwebsocket.overrideinstalledappid.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppWebsocket](./client.appwebsocket.md) > [overrideInstalledAppId](./client.appwebsocket.overrideinstalledappid.md) - -## AppWebsocket.overrideInstalledAppId property - -**Signature:** - -```typescript -overrideInstalledAppId?: InstalledAppId; -``` diff --git a/docs/client.createclonecellrequest.app_id.md b/docs/client.createclonecellrequest.app_id.md deleted file mode 100644 index bfa2fe46..00000000 --- a/docs/client.createclonecellrequest.app_id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [CreateCloneCellRequest](./client.createclonecellrequest.md) > [app\_id](./client.createclonecellrequest.app_id.md) - -## CreateCloneCellRequest.app\_id property - -The app id that the DNA to clone belongs to - -**Signature:** - -```typescript -app_id: InstalledAppId; -``` diff --git a/docs/client.createclonecellrequest.md b/docs/client.createclonecellrequest.md index 61c2c9be..5c7b27c0 100644 --- a/docs/client.createclonecellrequest.md +++ b/docs/client.createclonecellrequest.md @@ -36,25 +36,6 @@ Description -[app\_id](./client.createclonecellrequest.app_id.md) - - - - - - - -[InstalledAppId](./client.installedappid.md) - - - - -The app id that the DNA to clone belongs to - - - - - [membrane\_proof?](./client.createclonecellrequest.membrane_proof.md) diff --git a/docs/client.disableclonecellrequest.app_id.md b/docs/client.deleteclonecellrequest.app_id.md similarity index 58% rename from docs/client.disableclonecellrequest.app_id.md rename to docs/client.deleteclonecellrequest.app_id.md index ef1e8d19..44301209 100644 --- a/docs/client.disableclonecellrequest.app_id.md +++ b/docs/client.deleteclonecellrequest.app_id.md @@ -1,13 +1,13 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [DisableCloneCellRequest](./client.disableclonecellrequest.md) > [app\_id](./client.disableclonecellrequest.app_id.md) - -## DisableCloneCellRequest.app\_id property - -The app id that the clone cell belongs to - -**Signature:** - -```typescript -app_id: InstalledAppId; -``` + + +[Home](./index.md) > [@holochain/client](./client.md) > [DeleteCloneCellRequest](./client.deleteclonecellrequest.md) > [app\_id](./client.deleteclonecellrequest.app_id.md) + +## DeleteCloneCellRequest.app\_id property + +The app id that the clone cell belongs to + +**Signature:** + +```typescript +app_id: InstalledAppId; +``` diff --git a/docs/client.deleteclonecellrequest.clone_cell_id.md b/docs/client.deleteclonecellrequest.clone_cell_id.md new file mode 100644 index 00000000..fb6e6cf5 --- /dev/null +++ b/docs/client.deleteclonecellrequest.clone_cell_id.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@holochain/client](./client.md) > [DeleteCloneCellRequest](./client.deleteclonecellrequest.md) > [clone\_cell\_id](./client.deleteclonecellrequest.clone_cell_id.md) + +## DeleteCloneCellRequest.clone\_cell\_id property + +The clone id or cell id of the clone cell + +**Signature:** + +```typescript +clone_cell_id: RoleName | CellId; +``` diff --git a/docs/client.deleteclonecellrequest.md b/docs/client.deleteclonecellrequest.md index fe1300be..33469921 100644 --- a/docs/client.deleteclonecellrequest.md +++ b/docs/client.deleteclonecellrequest.md @@ -2,13 +2,74 @@ [Home](./index.md) > [@holochain/client](./client.md) > [DeleteCloneCellRequest](./client.deleteclonecellrequest.md) -## DeleteCloneCellRequest type +## DeleteCloneCellRequest interface **Signature:** ```typescript -export type DeleteCloneCellRequest = DisableCloneCellRequest; +export interface DeleteCloneCellRequest ``` -**References:** [DisableCloneCellRequest](./client.disableclonecellrequest.md) +## Properties + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[app\_id](./client.deleteclonecellrequest.app_id.md) + + + + + + + +[InstalledAppId](./client.installedappid.md) + + + + +The app id that the clone cell belongs to + + +
+ +[clone\_cell\_id](./client.deleteclonecellrequest.clone_cell_id.md) + + + + + + + +[RoleName](./client.rolename.md) \| [CellId](./client.cellid.md) + + + + +The clone id or cell id of the clone cell + + +
diff --git a/docs/client.disableclonecellrequest.md b/docs/client.disableclonecellrequest.md index 96b7daf7..298fc17a 100644 --- a/docs/client.disableclonecellrequest.md +++ b/docs/client.disableclonecellrequest.md @@ -36,25 +36,6 @@ Description -[app\_id](./client.disableclonecellrequest.app_id.md) - - - - - - - -[InstalledAppId](./client.installedappid.md) - - - - -The app id that the clone cell belongs to - - - - - [clone\_cell\_id](./client.disableclonecellrequest.clone_cell_id.md) diff --git a/docs/client.issueappauthenticationtokenrequest.expiry_seconds.md b/docs/client.issueappauthenticationtokenrequest.expiry_seconds.md new file mode 100644 index 00000000..515c8313 --- /dev/null +++ b/docs/client.issueappauthenticationtokenrequest.expiry_seconds.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@holochain/client](./client.md) > [IssueAppAuthenticationTokenRequest](./client.issueappauthenticationtokenrequest.md) > [expiry\_seconds](./client.issueappauthenticationtokenrequest.expiry_seconds.md) + +## IssueAppAuthenticationTokenRequest.expiry\_seconds property + +**Signature:** + +```typescript +expiry_seconds?: number; +``` diff --git a/docs/client.issueappauthenticationtokenrequest.installed_app_id.md b/docs/client.issueappauthenticationtokenrequest.installed_app_id.md new file mode 100644 index 00000000..015f4a27 --- /dev/null +++ b/docs/client.issueappauthenticationtokenrequest.installed_app_id.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@holochain/client](./client.md) > [IssueAppAuthenticationTokenRequest](./client.issueappauthenticationtokenrequest.md) > [installed\_app\_id](./client.issueappauthenticationtokenrequest.installed_app_id.md) + +## IssueAppAuthenticationTokenRequest.installed\_app\_id property + +**Signature:** + +```typescript +installed_app_id: InstalledAppId; +``` diff --git a/docs/client.issueappauthenticationtokenrequest.md b/docs/client.issueappauthenticationtokenrequest.md new file mode 100644 index 00000000..79a8fc9b --- /dev/null +++ b/docs/client.issueappauthenticationtokenrequest.md @@ -0,0 +1,92 @@ + + +[Home](./index.md) > [@holochain/client](./client.md) > [IssueAppAuthenticationTokenRequest](./client.issueappauthenticationtokenrequest.md) + +## IssueAppAuthenticationTokenRequest interface + + +**Signature:** + +```typescript +export interface IssueAppAuthenticationTokenRequest +``` + +## Properties + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[expiry\_seconds?](./client.issueappauthenticationtokenrequest.expiry_seconds.md) + + + + + + + +number + + + + +_(Optional)_ + + +
+ +[installed\_app\_id](./client.issueappauthenticationtokenrequest.installed_app_id.md) + + + + + + + +[InstalledAppId](./client.installedappid.md) + + + + + +
+ +[single\_use?](./client.issueappauthenticationtokenrequest.single_use.md) + + + + + + + +boolean + + + + +_(Optional)_ + + +
diff --git a/docs/client.issueappauthenticationtokenrequest.single_use.md b/docs/client.issueappauthenticationtokenrequest.single_use.md new file mode 100644 index 00000000..9e2dc6f0 --- /dev/null +++ b/docs/client.issueappauthenticationtokenrequest.single_use.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@holochain/client](./client.md) > [IssueAppAuthenticationTokenRequest](./client.issueappauthenticationtokenrequest.md) > [single\_use](./client.issueappauthenticationtokenrequest.single_use.md) + +## IssueAppAuthenticationTokenRequest.single\_use property + +**Signature:** + +```typescript +single_use?: boolean; +``` diff --git a/docs/client.issueappauthenticationtokenresponse.expires_at.md b/docs/client.issueappauthenticationtokenresponse.expires_at.md new file mode 100644 index 00000000..b7ab209c --- /dev/null +++ b/docs/client.issueappauthenticationtokenresponse.expires_at.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@holochain/client](./client.md) > [IssueAppAuthenticationTokenResponse](./client.issueappauthenticationtokenresponse.md) > [expires\_at](./client.issueappauthenticationtokenresponse.expires_at.md) + +## IssueAppAuthenticationTokenResponse.expires\_at property + +**Signature:** + +```typescript +expires_at?: Timestamp; +``` diff --git a/docs/client.issueappauthenticationtokenresponse.md b/docs/client.issueappauthenticationtokenresponse.md new file mode 100644 index 00000000..c13289d8 --- /dev/null +++ b/docs/client.issueappauthenticationtokenresponse.md @@ -0,0 +1,73 @@ + + +[Home](./index.md) > [@holochain/client](./client.md) > [IssueAppAuthenticationTokenResponse](./client.issueappauthenticationtokenresponse.md) + +## IssueAppAuthenticationTokenResponse interface + + +**Signature:** + +```typescript +export interface IssueAppAuthenticationTokenResponse +``` + +## Properties + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[expires\_at?](./client.issueappauthenticationtokenresponse.expires_at.md) + + + + + + + +[Timestamp](./client.timestamp.md) + + + + +_(Optional)_ + + +
+ +[token](./client.issueappauthenticationtokenresponse.token.md) + + + + + + + +[AppAuthenticationToken](./client.appauthenticationtoken.md) + + + + + +
diff --git a/docs/client.issueappauthenticationtokenresponse.token.md b/docs/client.issueappauthenticationtokenresponse.token.md new file mode 100644 index 00000000..406b1786 --- /dev/null +++ b/docs/client.issueappauthenticationtokenresponse.token.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@holochain/client](./client.md) > [IssueAppAuthenticationTokenResponse](./client.issueappauthenticationtokenresponse.md) > [token](./client.issueappauthenticationtokenresponse.token.md) + +## IssueAppAuthenticationTokenResponse.token property + +**Signature:** + +```typescript +token: AppAuthenticationToken; +``` diff --git a/docs/client.md b/docs/client.md index 5fab3939..1054a6da 100644 --- a/docs/client.md +++ b/docs/client.md @@ -27,17 +27,6 @@ Description A class for interacting with a conductor's Admin API. - - - -[AppAgentWebsocket](./client.appagentwebsocket.md) - - - - -A class to establish a websocket connection to an App interface, for a specific agent and app. - - @@ -46,7 +35,7 @@ A class to establish a websocket connection to an App interface, for a specific -A class to establish a websocket connection to an App interface of a Holochain conductor. +A class to establish a websocket connection to an App interface, for a specific agent and app. @@ -512,7 +501,7 @@ Description -[AppAgentClient](./client.appagentclient.md) +[AppAuthenticationRequest](./client.appauthenticationrequest.md) @@ -522,7 +511,7 @@ Description -[AppAgentEvents](./client.appagentevents.md) +[AppClient](./client.appclient.md) @@ -532,7 +521,7 @@ Description -[AppApi](./client.appapi.md) +[AppEvents](./client.appevents.md) @@ -699,6 +688,16 @@ Description + + + +[DeleteCloneCellRequest](./client.deleteclonecellrequest.md) + + + + + + @@ -829,6 +828,26 @@ Description + + + +[IssueAppAuthenticationTokenRequest](./client.issueappauthenticationtokenrequest.md) + + + + + + + + + +[IssueAppAuthenticationTokenResponse](./client.issueappauthenticationtokenresponse.md) + + + + + + @@ -1237,7 +1256,7 @@ This type is meant to be opaque -[AppAgentCallZomeRequest](./client.appagentcallzomerequest.md) +[AppAuthenticationToken](./client.appauthenticationtoken.md) @@ -1247,7 +1266,7 @@ This type is meant to be opaque -[AppAgentNetworkInfoRequest](./client.appagentnetworkinforequest.md) +[AppBundle](./client.appbundle.md) @@ -1257,7 +1276,7 @@ This type is meant to be opaque -[AppBundle](./client.appbundle.md) +[AppBundleSource](./client.appbundlesource.md) @@ -1267,7 +1286,7 @@ This type is meant to be opaque -[AppBundleSource](./client.appbundlesource.md) +[AppCallZomeRequest](./client.appcallzomerequest.md) @@ -1327,7 +1346,7 @@ This type is meant to be opaque -[AppInfoRequest](./client.appinforequest.md) +[AppInfoResponse](./client.appinforesponse.md) @@ -1337,7 +1356,7 @@ This type is meant to be opaque -[AppInfoResponse](./client.appinforesponse.md) +[AppManifest](./client.appmanifest.md) @@ -1347,7 +1366,7 @@ This type is meant to be opaque -[AppManifest](./client.appmanifest.md) +[AppNetworkInfoRequest](./client.appnetworkinforequest.md) @@ -1554,16 +1573,6 @@ This type is meant to be opaque - - - -[DeleteCloneCellRequest](./client.deleteclonecellrequest.md) - - - - - - diff --git a/docs/client.wsclient.authenticate.md b/docs/client.wsclient.authenticate.md new file mode 100644 index 00000000..8c1af80b --- /dev/null +++ b/docs/client.wsclient.authenticate.md @@ -0,0 +1,55 @@ + + +[Home](./index.md) > [@holochain/client](./client.md) > [WsClient](./client.wsclient.md) > [authenticate](./client.wsclient.authenticate.md) + +## WsClient.authenticate() method + +Authenticate the client with the conductor. + +This is only relevant for app websockets. + +**Signature:** + +```typescript +authenticate(request: AppAuthenticationRequest): Promise; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +request + + + + +[AppAuthenticationRequest](./client.appauthenticationrequest.md) + + + + +The authentication request, containing an app authentication token. + + +
+**Returns:** + +Promise<void> + diff --git a/docs/client.wsclient.connect.md b/docs/client.wsclient.connect.md index 6d0dcff2..b677fb1d 100644 --- a/docs/client.wsclient.connect.md +++ b/docs/client.wsclient.connect.md @@ -58,7 +58,7 @@ options -_(Optional)_ +_(Optional)_ Options for the WsClient. diff --git a/docs/client.wsclient.md b/docs/client.wsclient.md index 6db76e0d..f9e80aab 100644 --- a/docs/client.wsclient.md +++ b/docs/client.wsclient.md @@ -145,6 +145,22 @@ Description +[authenticate(request)](./client.wsclient.authenticate.md) + + + + + + + +Authenticate the client with the conductor. + +This is only relevant for app websockets. + + + + + [close(code)](./client.wsclient.close.md) diff --git a/package.json b/package.json index 0cf1fdba..202bcd03 100644 --- a/package.json +++ b/package.json @@ -1,8 +1,8 @@ { "name": "@holochain/client", - "version": "0.17.0-dev.9", + "version": "0.17.0-dev.10", "description": "A JavaScript client for the Holochain Conductor API", - "author": "Holochain Foundation (http://holochain.org)", + "author": "Holochain Foundation (https://holochain.org)", "license": "CAL-1.0", "repository": { "type": "git", diff --git a/src/api/admin/types.ts b/src/api/admin/types.ts index 2094d765..38fb5501 100644 --- a/src/api/admin/types.ts +++ b/src/api/admin/types.ts @@ -830,6 +830,9 @@ export interface IssueAppAuthenticationTokenRequest { single_use?: boolean; } +/** + * @public + */ export type AppAuthenticationToken = number[]; /** diff --git a/src/api/app/websocket.ts b/src/api/app/websocket.ts index 4ecb8257..652c0da5 100644 --- a/src/api/app/websocket.ts +++ b/src/api/app/websocket.ts @@ -157,7 +157,7 @@ export class AppWebsocket implements AppClient { /** * Instance factory for creating an {@link AppWebsocket}. * - * @param token - A token to authenticate the websocket connection. Get a token using {@link AdminApi#issueAppAuthenticationToken}. + * @param token - A token to authenticate the websocket connection. Get a token using AdminWebsocket#issueAppAuthenticationToken. * @param options - {@link (WebsocketConnectionOptions:interface)} * @returns A new instance of an AppWebsocket. */ diff --git a/src/api/client.ts b/src/api/client.ts index 3fe15742..9391727a 100644 --- a/src/api/client.ts +++ b/src/api/client.ts @@ -19,7 +19,10 @@ interface HolochainRequest { reject: RequestRejecter; } -interface AppAuthenticationRequest { +/** + * @public + */ +export interface AppAuthenticationRequest { token: AppAuthenticationToken; } @@ -170,7 +173,7 @@ export class WsClient extends Emittery { * * This is only relevant for app websockets. * - * @param request The authentication request, containing an app authentication token. + * @param request - The authentication request, containing an app authentication token. */ async authenticate(request: AppAuthenticationRequest): Promise { return this.exchange(request, (request, resolve) => { diff --git a/src/api/index.ts b/src/api/index.ts index ebb5b37d..a7b12457 100644 --- a/src/api/index.ts +++ b/src/api/index.ts @@ -1,7 +1,7 @@ export { hashZomeCall } from "@holochain/serialization"; export * from "./admin/index.js"; export * from "./app/index.js"; -export { IsoWebSocket, WsClient } from "./client.js"; +export { IsoWebSocket, WsClient, AppAuthenticationRequest } from "./client.js"; export { CloneId, HolochainError,