Skip to content
This repository was archived by the owner on Aug 9, 2021. It is now read-only.

Commit 0ff1bc6

Browse files
oedJoel Torstensson
authored andcommitted
docs: generate readme
1 parent 48e42d7 commit 0ff1bc6

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -214,6 +214,8 @@ const { profileGraphQL, getProfile, getProfiles, getVerifiedAccounts } = require
214214
* _static_
215215
* [.getProfile(address, opts)](#Box.getProfile) ⇒ <code>Object</code>
216216
* [.getProfiles(address, opts)](#Box.getProfiles) ⇒ <code>Object</code>
217+
* [.getSpace(address, name, opts)](#Box.getSpace) ⇒ <code>Object</code>
218+
* [.listSpaces(address, opts)](#Box.listSpaces) ⇒ <code>Object</code>
217219
* [.profileGraphQL(query, opts)](#Box.profileGraphQL) ⇒ <code>Object</code>
218220
* [.getVerifiedAccounts(profile)](#Box.getVerifiedAccounts) ⇒ <code>Object</code>
219221
* [.openBox(address, ethereumProvider, opts)](#Box.openBox)[<code>Box</code>](#Box)
@@ -329,6 +331,35 @@ Get a list of public profiles for given addresses. This relies on 3Box profile A
329331
| opts | <code>Object</code> | Optional parameters |
330332
| opts.profileServer | <code>String</code> | URL of Profile API server |
331333

334+
<a name="Box.getSpace"></a>
335+
336+
#### Box.getSpace(address, name, opts) ⇒ <code>Object</code>
337+
Get the public data in a space of a given address with the given name
338+
339+
**Kind**: static method of [<code>Box</code>](#Box)
340+
**Returns**: <code>Object</code> - a json object with the public space data
341+
342+
| Param | Type | Description |
343+
| --- | --- | --- |
344+
| address | <code>String</code> | An ethereum address |
345+
| name | <code>String</code> | A space name |
346+
| opts | <code>Object</code> | Optional parameters |
347+
| opts.profileServer | <code>String</code> | URL of Profile API server |
348+
349+
<a name="Box.listSpaces"></a>
350+
351+
#### Box.listSpaces(address, opts) ⇒ <code>Object</code>
352+
Get the names of all spaces a user has
353+
354+
**Kind**: static method of [<code>Box</code>](#Box)
355+
**Returns**: <code>Object</code> - an array with all spaces as strings
356+
357+
| Param | Type | Description |
358+
| --- | --- | --- |
359+
| address | <code>String</code> | An ethereum address |
360+
| opts | <code>Object</code> | Optional parameters |
361+
| opts.profileServer | <code>String</code> | URL of Profile API server |
362+
332363
<a name="Box.profileGraphQL"></a>
333364

334365
#### Box.profileGraphQL(query, opts) ⇒ <code>Object</code>

0 commit comments

Comments
 (0)