Class PendingAccessRequest

constructor

• new PendingAccessRequest(model): PendingAccessRequest

• Parameters

  • model: {
        agent: Agent<Service>;
        audience: `did:${string}:${string}`;
        expiration: number;
        provider: `did:web:${string}`;
        request: Link<unknown, number, number, 1>;
    }

    • agent: Agent<Service>

      • Agent handling interaction.

    • audience: `did:${string}:${string}`

      • Principal requesting an access.

    • expiration: number

      • Seconds in UTC.

    • provider: `did:web:${string}`

      • Provider handling request.

    • request: Link<unknown, number, number, 1>

      • Link to the access/authorize invocation.

  Returns PendingAccessRequest

model

agent

• get agent(): Agent<Service>

• Returns Agent<Service>

audience

• get audience(): `did:${string}:${string}`

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

expiration

• get expiration(): Date

• Returns Date

provider

• get provider(): `did:web:${string}`

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

request

• get request(): Link<any, number, number, 1>

• Returns Link<any, number, number, 1>

claim

• claim(options?): Promise<Result<GrantedAccess, Error>>

• Continuously polls delegations until this request is approved or expired. Returns a GrantedAccess object (view over the delegations) that can be used in the invocations or can be saved in the agent (store) using .save() method.

  Parameters

  • Optional options: {
        interval?: number;
        signal?: AbortSignal;
    }

    • Optional interval?: number

    • Optional signal?: AbortSignal

  Returns Promise<Result<GrantedAccess, Error>>

poll

• poll(): Promise<Result<Delegation<Capabilities>[], InvocationError | AccessClaimFailure | RequestExpired>>

• Low level method and most likely you want to use .claim instead. This method will poll fetch delegations just once and will return proofs matching to this request. Please note that there may not be any matches in which case result will be { ok: [] }.

  If you do want to continuously poll until request is approved or expired, you should use .claim method instead.

  Returns Promise<Result<Delegation<Capabilities>[], InvocationError | AccessClaimFailure | RequestExpired>>