Class OwnedSpace

constructor

• new OwnedSpace(model): OwnedSpace

• Parameters

  • model: Model

  Returns OwnedSpace

model

name

• get name(): string

• Returns string

signer

• get signer(): EdSigner

• Returns EdSigner

createAuthorization

• createAuthorization(agent, input?): Promise<Delegation<Capabilities>>

• Creates (UCAN) delegation that gives specified agent an access to specified ability (passed as access.can field) on the this space. Optionally, you can specify access.expiration field to set the

  Parameters

  • agent: Principal<`did:${string}:${string}`>

  • Optional input: {
        access?: Access;
        expiration?: number;
    }

    • Optional access?: Access

    • Optional expiration?: number

  Returns Promise<Delegation<Capabilities>>

createRecovery

• createRecovery(account): Promise<Delegation<Capabilities>>

• Creates a (UCAN) delegation that gives full access to the space to the specified account. At the moment we only allow did:mailto principal to be used as an account.

  Parameters

  • account: `did:mailto:${string}`

  Returns Promise<Delegation<Capabilities>>

did

• did(): `did:key:${string}`

• Returns `did:key:${string}`

provision

• provision(authorization, options?): Promise<Result<{}, Failure | HandlerNotFound | HandlerExecutionError | InvalidAudience | Unauthorized>> | {
      error: Failure;
      ok?: undefined;
  }

• Parameters

  • authorization: Authorization

  • Optional options: {
        agent?: Agent<Service>;
    }

    • Optional agent?: Agent<Service>

  Returns Promise<Result<{}, Failure | HandlerNotFound | HandlerExecutionError | InvalidAudience | Unauthorized>> | {
      error: Failure;
      ok?: undefined;
  }

save

• save(input?): Promise<Result<Unit, Error>>

• Saves account in the agent store so it can be accessed across sessions.

  Parameters

  • Optional input: {
        agent?: Agent<Service>;
    }

    • Optional agent?: Agent<Service>

  Returns Promise<Result<Unit, Error>>

toMnemonic

• toMnemonic(): string

• Derives BIP39 mnemonic that can be used to recover the space.

  Returns string

withName

• withName(name): OwnedSpace

• Creates a renamed version of this space.

  Parameters

  • name: string

  Returns OwnedSpace