Blockchain Commons XID TypeScript Library - v1.0.0-alpha.13
    Preparing search index...

    Class XIDDocument

    Represents an XID document.

    Implements

    • EnvelopeEncodable
    Index

    Methods

    • Add a resolution method.

      Parameters

      • method: string

      Returns void

    • Remove a resolution method.

      Parameters

      • method: string

      Returns boolean

    • Find a key by its public keys.

      Parameters

      • publicKeys: PublicKeys

      Returns Key | undefined

    • Find a key by its reference.

      Parameters

      • reference: Reference

      Returns Key | undefined

    • Remove a key.

      Parameters

      • publicKeys: PublicKeys

      Returns void

    • Check if the given public keys is the inception signing key.

      Parameters

      • publicKeys: PublicKeys

      Returns boolean

    • Get the inception private keys, if available.

      Returns PrivateKeys | undefined

    • Check if the document is empty (no keys, delegates, services, or provenance).

      Returns boolean

    • Check if any service references the given key.

      Parameters

      • publicKeys: PublicKeys

      Returns boolean

    • Check if any service references the given delegate.

      Parameters

      Returns boolean

    • Get the provenance mark.

      Returns ProvenanceMark | undefined

    • Get the provenance generator.

      Returns ProvenanceMarkGenerator | undefined

    • Set the provenance.

      Parameters

      • provenance: ProvenanceMark | undefined

      Returns void

    • Set provenance with generator.

      Parameters

      • generator: ProvenanceMarkGenerator
      • mark: ProvenanceMark

      Returns void

    • Advance the provenance mark using the embedded generator.

      Parameters

      • Optionalpassword: Uint8Array<ArrayBufferLike>
      • Optionaldate: Date
      • Optionalinfo: Cbor

      Returns void

    • Advance the provenance mark using a provided generator.

      Parameters

      • generator: ProvenanceMarkGenerator
      • Optionaldate: Date
      • Optionalinfo: Cbor

      Returns void

    • Create a signed envelope.

      Parameters

      • signingKey: Signer

      Returns Envelope$1