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.

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

Feat/appagent networkinfo #206

Merged
merged 3 commits into from
Sep 19, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions docs/client.appagentclient.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,6 @@ export interface AppAgentClient
| [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) | |

22 changes: 22 additions & 0 deletions docs/client.appagentclient.networkinfo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [AppAgentClient](./client.appagentclient.md) &gt; [networkInfo](./client.appagentclient.networkinfo.md)

## AppAgentClient.networkInfo() method

**Signature:**

```typescript
networkInfo(args: AppAgentNetworkInfoRequest): Promise<NetworkInfoResponse>;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| args | [AppAgentNetworkInfoRequest](./client.appagentnetworkinforequest.md) | |

**Returns:**

Promise&lt;[NetworkInfoResponse](./client.networkinforesponse.md)<!-- -->&gt;

14 changes: 14 additions & 0 deletions docs/client.appagentnetworkinforequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [AppAgentNetworkInfoRequest](./client.appagentnetworkinforequest.md)

## AppAgentNetworkInfoRequest type


**Signature:**

```typescript
export type AppAgentNetworkInfoRequest = Omit<NetworkInfoRequest, "agent_pub_key">;
```
**References:** [NetworkInfoRequest](./client.networkinforequest.md)

1 change: 1 addition & 0 deletions docs/client.appagentwebsocket.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,6 @@ export declare class AppAgentWebsocket implements AppAgentClient
| [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. |

26 changes: 26 additions & 0 deletions docs/client.appagentwebsocket.networkinfo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [AppAgentWebsocket](./client.appagentwebsocket.md) &gt; [networkInfo](./client.appagentwebsocket.networkinfo.md)

## AppAgentWebsocket.networkInfo() method

Request network info about gossip status.

**Signature:**

```typescript
networkInfo(args: AppAgentNetworkInfoRequest): Promise<NetworkInfoResponse>;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| args | [AppAgentNetworkInfoRequest](./client.appagentnetworkinforequest.md) | Specify the DNAs for which you want network info |

**Returns:**

Promise&lt;[NetworkInfoResponse](./client.networkinforesponse.md)<!-- -->&gt;

Network info for the specified DNAs

1 change: 1 addition & 0 deletions docs/client.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,7 @@
| [AnyDhtHash](./client.anydhthash.md) | |
| [AnyDhtHashB64](./client.anydhthashb64.md) | |
| [AppAgentCallZomeRequest](./client.appagentcallzomerequest.md) | |
| [AppAgentNetworkInfoRequest](./client.appagentnetworkinforequest.md) | |
| [AppBundle](./client.appbundle.md) | |
| [AppBundleSource](./client.appbundlesource.md) | |
| [AppCreateCloneCellRequest](./client.appcreateclonecellrequest.md) | |
Expand Down
Loading