692 lines
9.9 KiB
Markdown
692 lines
9.9 KiB
Markdown
# Merged API Reference
|
|||
|
|
|
||
|
|
*Combined from documentation and code analysis*
|
||
|
|
|
||
|
|
#### `ArrayUtility`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `ArrayUtility.byteArraysEqual`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `ArrayUtility.every`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `Cid`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `DataStream`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `DataStream.Promise`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `DataStream.on`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `DataStream.toBytes`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `DwnConstant`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `DwnError`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `DwnError.constructor`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `Encoder`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `Encoder.base64UrlToBytes`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `Encoder.baseDecode`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `Encryption`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `Encryption.Readable`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `Encryption.aes256CtrEncrypt`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `Encryption.createCipheriv`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `FilterSelector`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `FilterSelector.keys`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `FilterSelector.reduceFilter`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `FilterUtility`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `FilterUtility.matchAnyFilter`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `GeneralJwsBuilder`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `GeneralJwsBuilder.constructor`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `GeneralJwsVerifier`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `GeneralJwsVerifier.MemoryCache`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `GeneralJwsVerifier.constructor`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `GrantAuthorization`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `HdKey`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `HdKey.derivePrivateKey`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `HdKey.derivePrivateKeyBytes`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `HdKey.privateJwkToBytes`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `HdKey.privateKeyToJwk`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `IndexLevel`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `IndexLevel.constructor`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `Jws`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `Jws.getKid`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `Message`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `Message.getAuthor`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `Messages`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `Messages.filters`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `Messages.normalizeFilters`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `Messages.normalizeProtocolUrl`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `MessagesGrantAuthorization`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `PermissionGrant`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `PermissionGrant.PermissionGrant`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `PermissionGrant.parse`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `PermissionRequest`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `PermissionRequest.PermissionRequest`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `PermissionRequest.parse`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `PermissionsProtocol`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `ProtocolAuthorization`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `Protocols`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `Protocols.addEncryptionProperty`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `Protocols.deriveAndInjectPublicEncryptionKeys`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `Protocols.derivePrivateKey`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `Protocols.getPublicJwk`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `Protocols.parse`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `Protocols.set`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `ProtocolsGrantAuthorization`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `Records`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `Records.isRecordsWrite`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `RecordsGrantAuthorization`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `ResumableTaskManager`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `Secp256k1`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `Secp256r1`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `StorageController`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `Time`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `Time.Promise`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `Time.sleep`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `addEncryptionProperty`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `authenticate`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `isEmptyObject`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `lexicographicalCompare`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `messageReplyFromError`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `normalizeProtocolUrl`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `normalizeSchemaUrl`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `normalizeUrl`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `publicKeyToJwk`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `removeEmptyObjects`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `removeTrailingSlash`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `removeUndefinedProperties`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `validateKey`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `validateProtocolUrlNormalized`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
#### `validateSchemaUrlNormalized`
|
||
|
|
|
||
|
|
⚠️ **Conflict**: This API exists in code but is not documented
|
||
|
|
|
||
|
|
*Source: code*
|
||
|
|
|
||
|
|
---
|
||
|
|
|