Class PermissionGrantRevocationBeta

The PermissionGrantRevocation class encapsulates a permissions protocol grant/revocation record, providing a more developer-friendly interface for working with Decentralized Web Node (DWN) records.

Methods are provided to manage the grant revocation's lifecycle, including writing to remote DWNs.

Implements

Constructors

constructor

Properties

_connectedDid _message _permissions

Accessors

agent author rawMessage

Methods

send store parse

Constructors

Private constructor

Properties

Private _connectedDid

_connectedDid: string

The DID to use as the author and default target for the underlying revocation

Private _message

_message: DataEncodedRecordsWriteMessage

The DWN RecordsWrite message, along with encodedData that represents the revocation

Private _permissions

_permissions: AgentPermissionsApi

The PermissionsAPI used to interact with the underlying revocation

Accessors

Private agent

  • get agent(): Web5Agent

  • The agent to use for this instantiation of the grant revocation

    Returns Web5Agent

author

  • get author(): string

  • The author of the underlying revocation message

    Returns string

rawMessage

  • get rawMessage(): DataEncodedRecordsWriteMessage

  • The raw RecordsWrite DWN message with encoded data that was used to instantiate this grant revocation

    Returns DataEncodedRecordsWriteMessage

Methods

send

  • send(target?): Promise<DwnResponseStatus>
  • Beta

    Send the current grant revocation to a remote DWN by specifying their DID If no DID is specified, the target is assumed to be the owner (connectedDID).

    Parameters

    • Optional target: string

      the optional DID to send the grant revocation to, if none is set it is sent to the connectedDid

    Returns Promise<DwnResponseStatus>

    the status of the send grant revocation request

store

  • store(importRevocation?): Promise<DwnResponseStatus>
  • Beta

    Stores the current grant revocation to the owner's DWN.

    Parameters

    • Optional importRevocation: boolean

    Returns Promise<DwnResponseStatus>

    the status of the store request

Static parse

  • parse(__namedParameters): Promise<PermissionGrantRevocation>

  • parses the grant revocation given am agent, connectedDid and data encoded records write message

    Parameters

    • __namedParameters: {
          agent: Web5Agent;
          connectedDid: string;
          message: DataEncodedRecordsWriteMessage;
      }
      • agent: Web5Agent
      • connectedDid: string
      • message: DataEncodedRecordsWriteMessage

    Returns Promise<PermissionGrantRevocation>

Settings

Member Visibility

Theme

On This Page

constructor_connectedDid_message_permissionsagentauthorrawMessagesendstoreparse