Interface: SpaceManager

Defined in: packages/core/src/space/space-manager.ts:135

MethodsCopy Anchor Link

addKeys()Copy Anchor Link

addKeys(
   spaceId, 
   keys, 
   current
): Promise<void>;

Defined in: packages/core/src/space/space-manager.ts:156

Adds keys of a space to what this node holds, and makes current the one it writes with. Keys already held are kept.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<void>

clearInvite()Copy Anchor Link

clearInvite(spaceId): Promise<void>;

Defined in: packages/core/src/space/space-manager.ts:149

Forgets an invite's secret once it has been used

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<void>

create()Copy Anchor Link

create(params): Promise<SpaceRecord>;

Defined in: packages/core/src/space/space-manager.ts:136

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<SpaceRecord>

createInvite()Copy Anchor Link

createInvite(
   spaceId, 
   signer, 
   options?
): Promise<string>;

Defined in: packages/core/src/space/space-manager.ts:141

Signs an invitation to a space, with its key if private, and writes it with an invite's secret if given

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<string>

get()Copy Anchor Link

get(spaceId): Promise<SpaceRecord | null>;

Defined in: packages/core/src/space/space-manager.ts:137

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<SpaceRecord | null>

join()Copy Anchor Link

join(invite): Promise<SpaceRecord>;

Defined in: packages/core/src/space/space-manager.ts:147

Stores a space received as an invite, so it can be opened and synced. Refuses a space whose id does not match what it says about itself, and a key that does not belong to it. An invite's secret is held until it is used.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<SpaceRecord>

list()Copy Anchor Link

list(): Promise<readonly SpaceRecord[]>;

Defined in: packages/core/src/space/space-manager.ts:138

ReturnsCopy Anchor Link

Promise<readonly SpaceRecord[]>

remove()Copy Anchor Link

remove(spaceId): Promise<void>;

Defined in: packages/core/src/space/space-manager.ts:139

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<void>

setMemberKey()Copy Anchor Link

setMemberKey(spaceId, memberKey): Promise<void>;

Defined in: packages/core/src/space/space-manager.ts:158

Keeps this account's member key for a space (SpaceRecord.memberKey)

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<void>

setRelays()Copy Anchor Link

setRelays(spaceId, relays): Promise<void>;

Defined in: packages/core/src/space/space-manager.ts:160

Keeps where the space's members meet (SpaceRecord.relays)

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<void>

setRole()Copy Anchor Link

setRole(spaceId, role): Promise<void>;

Defined in: packages/core/src/space/space-manager.ts:151

Remembers the role this account holds, for listing

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<void>