Skip to content

Commit

Permalink
Add new docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ThetaSinner committed Apr 26, 2024
1 parent 8859ce7 commit 0b1e0b4
Show file tree
Hide file tree
Showing 32 changed files with 1,139 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/client.adminapi.issueappauthenticationtoken.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [AdminApi](./client.adminapi.md) &gt; [issueAppAuthenticationToken](./client.adminapi.issueappauthenticationtoken.md)

## AdminApi.issueAppAuthenticationToken property

**Signature:**

```typescript
issueAppAuthenticationToken: Requester<IssueAppAuthenticationTokenRequest, IssueAppAuthenticationTokenResponse>;
```
11 changes: 11 additions & 0 deletions docs/client.adminwebsocket.issueappauthenticationtoken.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [AdminWebsocket](./client.adminwebsocket.md) &gt; [issueAppAuthenticationToken](./client.adminwebsocket.issueappauthenticationtoken.md)

## AdminWebsocket.issueAppAuthenticationToken property

**Signature:**

```typescript
issueAppAuthenticationToken: Requester<IssueAppAuthenticationTokenRequest, IssueAppAuthenticationTokenResponse>;
```
54 changes: 54 additions & 0 deletions docs/client.appauthenticationrequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [AppAuthenticationRequest](./client.appauthenticationrequest.md)

## AppAuthenticationRequest interface


**Signature:**

```typescript
export interface AppAuthenticationRequest
```

## Properties

<table><thead><tr><th>

Property


</th><th>

Modifiers


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

[token](./client.appauthenticationrequest.token.md)


</td><td>


</td><td>

[AppAuthenticationToken](./client.appauthenticationtoken.md)


</td><td>


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

[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [AppAuthenticationRequest](./client.appauthenticationrequest.md) &gt; [token](./client.appauthenticationrequest.token.md)

## AppAuthenticationRequest.token property

**Signature:**

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

[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [AppAuthenticationToken](./client.appauthenticationtoken.md)

## AppAuthenticationToken type


**Signature:**

```typescript
export type AppAuthenticationToken = number[];
```
14 changes: 14 additions & 0 deletions docs/client.appcallzomerequest.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; [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)

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

[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [AppClient](./client.appclient.md) &gt; [appInfo](./client.appclient.appinfo.md)

## AppClient.appInfo() method

**Signature:**

```typescript
appInfo(): Promise<AppInfoResponse>;
```
**Returns:**

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

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

[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [AppClient](./client.appclient.md) &gt; [callZome](./client.appclient.callzome.md)

## AppClient.callZome() method

**Signature:**

```typescript
callZome(args: AppCallZomeRequest, timeout?: number): Promise<any>;
```

## Parameters

<table><thead><tr><th>

Parameter


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

args


</td><td>

[AppCallZomeRequest](./client.appcallzomerequest.md)


</td><td>


</td></tr>
<tr><td>

timeout


</td><td>

number


</td><td>

_(Optional)_


</td></tr>
</tbody></table>
**Returns:**

Promise&lt;any&gt;

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

[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [AppClient](./client.appclient.md) &gt; [createCloneCell](./client.appclient.createclonecell.md)

## AppClient.createCloneCell() method

**Signature:**

```typescript
createCloneCell(args: AppCreateCloneCellRequest): Promise<CreateCloneCellResponse>;
```

## Parameters

<table><thead><tr><th>

Parameter


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

args


</td><td>

[AppCreateCloneCellRequest](./client.appcreateclonecellrequest.md)


</td><td>


</td></tr>
</tbody></table>
**Returns:**

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

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

[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [AppClient](./client.appclient.md) &gt; [disableCloneCell](./client.appclient.disableclonecell.md)

## AppClient.disableCloneCell() method

**Signature:**

```typescript
disableCloneCell(args: AppDisableCloneCellRequest): Promise<DisableCloneCellResponse>;
```

## Parameters

<table><thead><tr><th>

Parameter


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

args


</td><td>

[AppDisableCloneCellRequest](./client.appdisableclonecellrequest.md)


</td><td>


</td></tr>
</tbody></table>
**Returns:**

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

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

[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [AppClient](./client.appclient.md) &gt; [enableCloneCell](./client.appclient.enableclonecell.md)

## AppClient.enableCloneCell() method

**Signature:**

```typescript
enableCloneCell(args: AppEnableCloneCellRequest): Promise<EnableCloneCellResponse>;
```

## Parameters

<table><thead><tr><th>

Parameter


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

args


</td><td>

[AppEnableCloneCellRequest](./client.appenableclonecellrequest.md)


</td><td>


</td></tr>
</tbody></table>
**Returns:**

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

Loading

0 comments on commit 0b1e0b4

Please sign in to comment.