adobe-firefly-sdk
    Preparing search index...

    Type Alias BaseJobRequest

    The base job request for any job.

    type BaseJobRequest = {
        assets: InputAsset[];
        params?: {
            generalSettings?: {
                appLogs?: { logsRelativePath?: string };
                fonts?: { fontsDirectories?: string[] };
                links?: {
                    replaceLinks?: {
                        mapping: {
                            currentURI?: string;
                            linkID?: number;
                            newAssetRelativePath: string;
                        }[];
                        targetDocument: string;
                    }[];
                };
            };
        };
    }
    Index

    Properties

    Properties

    assets: InputAsset[]

    Information about the assets, which will be used to process the job.

    params?: {
        generalSettings?: {
            appLogs?: { logsRelativePath?: string };
            fonts?: { fontsDirectories?: string[] };
            links?: {
                replaceLinks?: {
                    mapping: {
                        currentURI?: string;
                        linkID?: number;
                        newAssetRelativePath: string;
                    }[];
                    targetDocument: string;
                }[];
            };
        };
    }

    Type Declaration

    • OptionalgeneralSettings?: {
          appLogs?: { logsRelativePath?: string };
          fonts?: { fontsDirectories?: string[] };
          links?: {
              replaceLinks?: {
                  mapping: {
                      currentURI?: string;
                      linkID?: number;
                      newAssetRelativePath: string;
                  }[];
                  targetDocument: string;
              }[];
          };
      }

      General settings.

      • OptionalappLogs?: { logsRelativePath?: string }

        Describes parameters regarding application logs.

        • OptionallogsRelativePath?: string

          This provides a path to a file, relative to the temporary base directory (working directory). This file is where the application's logs are to be dumped.

      • Optionalfonts?: { fontsDirectories?: string[] }

        Settings related to fonts. It is recommended to include fonts to avoid missing fonts warnings when processing the job.

        • OptionalfontsDirectories?: string[]

          This lists the font directories for the input InDesign documents. "Document Fonts" in parallel to the document will continue to work even without specifying them.

          If none are specified, a temporary base directory (working directory) will be considered as a font directory.

      • Optionallinks?: {
            replaceLinks?: {
                mapping: {
                    currentURI?: string;
                    linkID?: number;
                    newAssetRelativePath: string;
                }[];
                targetDocument: string;
            }[];
        }

        Settings related to links.