Interface BuilderFactory

Functions that permit the creation of Builder objects.

interface BuilderFactory {
    fromArchive: (archive: Blob, settings?: Settings) => Promise<Builder>;
    fromDefinition: (
        definition: ManifestDefinition,
        settings?: Settings,
    ) => Promise<Builder>;
    new: (settings?: Settings) => Promise<Builder>;
}

Index

Properties

fromArchive fromDefinition new

Properties

fromArchive

fromArchive: (archive: Blob, settings?: Settings) => Promise<Builder>

Create a Builder from a builder archive (created from Builder.toArchive).

Type Declaration

- (archive: Blob, settings?: Settings): Promise<Builder>
- Parameters
  - archive: Blob
    Builder archive as a blob.
  - Optionalsettings: Settings
    Optional context settings for the builder. Will override any values inherited by the top-level settings passed to createC2pa.
  Returns Promise<Builder>
  A Builder object.

fromDefinition

fromDefinition: (
definition: ManifestDefinition,
settings?: Settings,
) => Promise<Builder>

Create a Builder from a ManifestDefinition.

Type Declaration

- (definition: ManifestDefinition, settings?: Settings): Promise<Builder>
- Parameters
  - definition: ManifestDefinition
    The ManifestDefinition to be used as the builder's initial state.
  - Optionalsettings: Settings
    Optional context settings for the builder. Will override any values inherited by the top-level settings passed to createC2pa.
  Returns Promise<Builder>
  A Builder object.

new

new: (settings?: Settings) => Promise<Builder>

Create a Builder with a minimal manifest definition as its initial state.

Type Declaration

- (settings?: Settings): Promise<Builder>
- Parameters
  - Optionalsettings: Settings
    Optional context settings for the builder. Will override any values inherited by the top-level settings passed to createC2pa.
  Returns Promise<Builder>
  A Builder object.