Class DwnApi

Returns DwnApi

Returns {
    grant: ((request) => Promise<PermissionGrant>);
    queryGrants: ((request?) => Promise<PermissionGrant[]>);
    queryRequests: ((request?) => Promise<PermissionRequest[]>);
    request: ((request) => Promise<PermissionRequest>);
}

• grant: ((request) => Promise<PermissionGrant>)

  Grant permission for a specific scope to a grantee DID.

  • • (request): Promise<PermissionGrant>

    • Parameters

      • request: Omit<CreateGrantParams, "author">

      Returns Promise<PermissionGrant>

• queryGrants: ((request?) => Promise<PermissionGrant[]>)

  Query permission grants. You can filter by grantee, grantor, protocol and specify if you want to query a remote DWN.

  • • (request?): Promise<PermissionGrant[]>

    • Parameters

      • request: FetchGrantsRequest = {}

      Returns Promise<PermissionGrant[]>

• queryRequests: ((request?) => Promise<PermissionRequest[]>)

  Query permission requests. You can filter by protocol and specify if you want to query a remote DWN.

  • • (request?): Promise<PermissionRequest[]>

    • Parameters

      • request: FetchRequestsRequest = {}

      Returns Promise<PermissionRequest[]>

• request: ((request) => Promise<PermissionRequest>)

  Request permission for a specific scope.

  • • (request): Promise<PermissionRequest>

    • Parameters

      • request: Omit<CreateRequestParams, "author">

      Returns Promise<PermissionRequest>

Returns {
    configure: ((request) => Promise<ProtocolsConfigureResponse>);
    query: ((request) => Promise<ProtocolsQueryResponse>);
}

• configure: ((request) => Promise<ProtocolsConfigureResponse>)

  Configure method, used to setup a new protocol (or update) with the passed definitions

  • • (request): Promise<ProtocolsConfigureResponse>

    • Parameters

      • request: ProtocolsConfigureRequest

      Returns Promise<ProtocolsConfigureResponse>

• query: ((request) => Promise<ProtocolsQueryResponse>)

  Query the available protocols

  • • (request): Promise<ProtocolsQueryResponse>

    • Parameters

      • request: ProtocolsQueryRequest

      Returns Promise<ProtocolsQueryResponse>

Returns {
    create: ((request) => Promise<RecordsWriteResponse>);
    createFrom: ((request) => Promise<RecordsWriteResponse>);
    delete: ((request) => Promise<DwnResponseStatus>);
    query: ((request) => Promise<RecordsQueryResponse>);
    read: ((request) => Promise<RecordsReadResponse>);
    subscribe: ((request) => Promise<RecordsSubscribeResponse>);
    write: ((request) => Promise<RecordsWriteResponse>);
}

• create: ((request) => Promise<RecordsWriteResponse>)

  Alias for the write method

  • • (request): Promise<RecordsWriteResponse>

    • Parameters

      • request: RecordsWriteRequest

      Returns Promise<RecordsWriteResponse>

• createFrom: ((request) => Promise<RecordsWriteResponse>)

  Write a record based on an existing one (useful for updating an existing record)

  • • (request): Promise<RecordsWriteResponse>

    • Parameters

      • request: RecordsCreateFromRequest

      Returns Promise<RecordsWriteResponse>

• delete: ((request) => Promise<DwnResponseStatus>)

  Delete a record

  • • (request): Promise<DwnResponseStatus>

    • Parameters

      • request: RecordsDeleteRequest

      Returns Promise<DwnResponseStatus>

• query: ((request) => Promise<RecordsQueryResponse>)

  Query a single or multiple records based on the given filter

  • • (request): Promise<RecordsQueryResponse>

    • Parameters

      • request: RecordsQueryRequest

      Returns Promise<RecordsQueryResponse>

• read: ((request) => Promise<RecordsReadResponse>)

  Read a single record based on the given filter

  • • (request): Promise<RecordsReadResponse>

    • Parameters

      • request: RecordsReadRequest

      Returns Promise<RecordsReadResponse>

• subscribe: ((request) => Promise<RecordsSubscribeResponse>)

  Subscribes to records based on the given filter and emits events to the subscriptionHandler.

  Returns

  the subscription status and the subscription object used to close the subscription.

  • • (request): Promise<RecordsSubscribeResponse>

    • Parameters

      • request: RecordsSubscribeRequest

        must include the message with the subscription filter and the subscriptionHandler to process the events.

      Returns Promise<RecordsSubscribeResponse>

• write: ((request) => Promise<RecordsWriteResponse>)

  Writes a record to the DWN

  As a convenience, the Record instance returned will cache a copy of the data. This is done to maintain consistency with other DWN methods, like RecordsQuery, that include relatively small data payloads when returning RecordsWrite message properties. Regardless of data size, methods such as record.data.stream() will return the data when called even if it requires fetching from the DWN datastore.

  • • (request): Promise<RecordsWriteResponse>

    • Parameters

      • request: RecordsWriteRequest

      Returns Promise<RecordsWriteResponse>