ApiReactInterfaces
Interface: SpacesState
Defined in: packages/react/src/use-spaces.ts:5
Properties
| Property | Modifier | Type | Defined in |
|---|---|---|---|
error | readonly | string | null | packages/react/src/use-spaces.ts:8 |
loading | readonly | boolean | packages/react/src/use-spaces.ts:7 |
spaces | readonly | readonly SpaceSummary[] | packages/react/src/use-spaces.ts:6 |
Methods
create()
create(params): Promise<
| SpaceSummary
| null>;Defined in: packages/react/src/use-spaces.ts:11
Makes a space; null when it failed, with error saying why
Parameters
| Parameter | Type |
|---|---|
params | NewSpace |
Returns
Promise<
| SpaceSummary
| null>
join()
join(invite): Promise<
| SpaceSummary
| null>;Defined in: packages/react/src/use-spaces.ts:13
Joins from an invite; null when it failed
Parameters
| Parameter | Type |
|---|---|
invite | string |
Returns
Promise<
| SpaceSummary
| null>
leave()
leave(spaceId): Promise<void>;Defined in: packages/react/src/use-spaces.ts:15
Forgets a space on this device
Parameters
| Parameter | Type |
|---|---|
spaceId | string |
Returns
Promise<void>
refresh()
refresh(): Promise<void>;Defined in: packages/react/src/use-spaces.ts:9
Returns
Promise<void>