Class AccessClient

Client for interacting with the access/* capabilities.

Hierarchy

Base
- AccessClient

Index

Constructors

constructor

new AccessClient(agentData, options?): AccessClient
Parameters
- agentData: AgentData
- Optional options: {
  receiptsEndpoint: undefined | URL;
  serviceConf: undefined | ServiceConf;
  } = {}
  - receiptsEndpoint: undefined | URL
  - serviceConf: undefined | ServiceConf
Returns AccessClient
Inherited from Base.constructor
- Defined in packages/w3up-client/src/base.js:23

Properties

`Protected` _agent

_agent: Agent<Service>

_receiptsEndpoint

_receiptsEndpoint: string | URL

`Protected` _serviceConf

_serviceConf: ServiceConf

Accessors

agent

get agent(): Agent<Service>
The current user agent (this device).

Returns Agent<Service>
Inherited from Base.agent
- Defined in packages/w3up-client/src/base.js:39

Methods

`Protected` _invocationConfig

_invocationConfig(abilities): Promise<{
    audience: Principal<`did:${string}:${string}`>;
    issuer: Signer<`did:key:${string}`, SigAlg>;
    proofs: Delegation<Capabilities>[];
    with: `did:key:${string}`;
}>
Protected
Parameters
- abilities: Ability[]
Returns Promise<{
    audience: Principal<`did:${string}:${string}`>;
    issuer: Signer<`did:key:${string}`, SigAlg>;
    proofs: Delegation<Capabilities>[];
    with: `did:key:${string}`;
}>
Inherited from Base._invocationConfig
- Defined in packages/w3up-client/src/base.js:47

authorize

authorize(email, options?): Promise<Tuple<Delegation<Capabilities>>>
Authorize the current agent to use capabilities granted to the passed email account.
Parameters
- email: `${string}@${string}`
- Optional options: {
      capabilities: undefined | Iterable<{
          can: Ability;
      }>;
      signal: undefined | AbortSignal;
  }
  - capabilities: undefined | Iterable<{
    can: Ability;
    }>
  - signal: undefined | AbortSignal
Returns Promise<Tuple<Delegation<Capabilities>>>
Deprecated
Use request instead.
- Defined in packages/w3up-client/src/capability/access.js:26

claim

claim(input?): Promise<Tuple<Delegation<Capabilities>>>
Claim delegations granted to the account associated with this agent.
Parameters
- Optional input: {
  audience: undefined | `did:${string}:${string}`;
  }
  - audience: undefined | `did:${string}:${string}`
Returns Promise<Tuple<Delegation<Capabilities>>>
- Defined in packages/w3up-client/src/capability/access.js:42

delegate

delegate(input): Promise<{
error: Failure;
ok?: undefined;
} | Result<Unit, HandlerNotFound | HandlerExecutionError | InvalidAudience | Unauthorized | AccessDelegateFailure>>
Shares access with delegates.
Parameters
- input: {
      delegations: Delegation<Capabilities>[];
      proofs: undefined | Delegation<Capabilities>[];
      space: undefined | `did:key:${string}`;
  }
  - delegations: Delegation<Capabilities>[]
  - proofs: undefined | Delegation<Capabilities>[]
  - space: undefined | `did:key:${string}`
Returns Promise<{
error: Failure;
ok?: undefined;
} | Result<Unit, HandlerNotFound | HandlerExecutionError | InvalidAudience | Unauthorized | AccessDelegateFailure>>
- Defined in packages/w3up-client/src/capability/access.js:68

request

request(input): Promise<Result<PendingAccessRequest, InvocationError | AccessAuthorizeFailure>>
Requests specified access level from the account from the given account.
Parameters
- input: {
      access: undefined | Access;
      account: `did:mailto:${string}`;
      signal: undefined | AbortSignal;
  }
  - access: undefined | Access
  - account: `did:mailto:${string}`
  - signal: undefined | AbortSignal
Returns Promise<Result<PendingAccessRequest, InvocationError | AccessAuthorizeFailure>>
- Defined in packages/w3up-client/src/capability/access.js:56

Class AccessClient

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

agentData: AgentData

Optional options: { receiptsEndpoint: undefined | URL; serviceConf: undefined | ServiceConf; } = {}

receiptsEndpoint: undefined | URL

serviceConf: undefined | ServiceConf

Returns AccessClient

Properties

Protected _agent

_receiptsEndpoint

Protected _serviceConf

Accessors

agent

Returns Agent<Service>

Methods

Protected _invocationConfig

Parameters

abilities: Ability[]

Returns Promise<{ audience: Principal<`did:${string}:${string}`>; issuer: Signer<`did:key:${string}`, SigAlg>; proofs: Delegation<Capabilities>[]; with: `did:key:${string}`; }>

authorize

Parameters

email: `${string}@${string}`

Optional options: { capabilities: undefined | Iterable<{ can: Ability; }>; signal: undefined | AbortSignal; }

capabilities: undefined | Iterable<{ can: Ability; }>

signal: undefined | AbortSignal

Returns Promise<Tuple<Delegation<Capabilities>>>

Deprecated

claim

Parameters

Optional input: { audience: undefined | `did:${string}:${string}`; }

audience: undefined | `did:${string}:${string}`

Returns Promise<Tuple<Delegation<Capabilities>>>

delegate

Parameters

input: { delegations: Delegation<Capabilities>[]; proofs: undefined | Delegation<Capabilities>[]; space: undefined | `did:key:${string}`; }

delegations: Delegation<Capabilities>[]

proofs: undefined | Delegation<Capabilities>[]

space: undefined | `did:key:${string}`

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

request

Parameters

input: { access: undefined | Access; account: `did:mailto:${string}`; signal: undefined | AbortSignal; }

access: undefined | Access

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

signal: undefined | AbortSignal

Returns Promise<Result<PendingAccessRequest, InvocationError | AccessAuthorizeFailure>>

Settings

Member Visibility

Theme

On This Page

`Optional` options: {
receiptsEndpoint: undefined | URL;
serviceConf: undefined | ServiceConf;
} = {}

`Protected` _agent

`Protected` _serviceConf

`Protected` _invocationConfig

Returns Promise<{
audience: Principal<`did:${string}:${string}`>;
issuer: Signer<`did:key:${string}`, SigAlg>;
proofs: Delegation<Capabilities>[];
with: `did:key:${string}`;
}>

`Optional` options: {
capabilities: undefined | Iterable<{
can: Ability;
}>;
signal: undefined | AbortSignal;
}

capabilities: undefined | Iterable<{
can: Ability;
}>

`Optional` input: {
audience: undefined | `did:${string}:${string}`;
}

input: {
delegations: Delegation<Capabilities>[];
proofs: undefined | Delegation<Capabilities>[];
space: undefined | `did:key:${string}`;
}

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

input: {
access: undefined | Access;
account: `did:mailto:${string}`;
signal: undefined | AbortSignal;
}