@combeenation/custom-code-sdk
    Preparing search index...

    Type Alias DocumentConvertTask

    DocumentConvertTask:
        | {
            assetPath: string;
            bundleAliasName: string;
            context: object;
            name: string;
            type: PdfAsset;
        }
        | { assetPath: string; bundleAliasName: string; name: string; type: Asset }
        | { inputTaskNames: string[]; name: string; type: Merge }
        | {
            cfgnFileDisplayName?: string;
            cfgnFileExtension: string;
            cfgnFileName: string;
            inputTaskName: string;
            name: string;
            type: OutputToCfgnFile;
        }
        | {
            cfgnFileDisplayName?: string;
            cfgnFileExtension: string;
            inputTaskName: string;
            name: string;
            type: OutputToTempCfgnFile;
        }

    Type Declaration

    • {
          assetPath: string;
          bundleAliasName: string;
          context: object;
          name: string;
          type: PdfAsset;
      }
      • assetPath: string

        Dot seperated path, e.g. 'MyPDFFolder.MyPDFAsset'

      • bundleAliasName: string

        Alias name, as set in the asset bundle assignment dialog

      • context: object

        Custom object which must represent the context, as defined in the PDF asset

      • name: string
      • type: PdfAsset
    • { assetPath: string; bundleAliasName: string; name: string; type: Asset }
      • assetPath: string

        Dot seperated path, e.g. 'MyPDFFolder.MyStaticAsset'

      • bundleAliasName: string

        Alias name, as set in the asset bundle assignment dialog

      • name: string
      • type: Asset
    • { inputTaskNames: string[]; name: string; type: Merge }
      • inputTaskNames: string[]

        Names of the tasks which should be merged in the given order

      • name: string
      • type: Merge
    • {
          cfgnFileDisplayName?: string;
          cfgnFileExtension: string;
          cfgnFileName: string;
          inputTaskName: string;
          name: string;
          type: OutputToCfgnFile;
      }
      • OptionalcfgnFileDisplayName?: string

        Optional name which will be used when downloading the file

      • cfgnFileExtension: string
      • cfgnFileName: string

        Name of the generated cfgn file

      • inputTaskName: string
      • name: string
      • type: OutputToCfgnFile
    • {
          cfgnFileDisplayName?: string;
          cfgnFileExtension: string;
          inputTaskName: string;
          name: string;
          type: OutputToTempCfgnFile;
      }
      • OptionalcfgnFileDisplayName?: string

        Optional name which will be used when downloading the file

      • cfgnFileExtension: string
      • inputTaskName: string
      • name: string
      • type: OutputToTempCfgnFile