@oneblink/sdk
    Preparing search index...

    Class PDF

    Hierarchy

    • default
      • PDF
    Index

    Constructors

    constructor

    Methods

    generateFormSubmissionPDF generatePDF generatePdfFromSubmissionData

    Constructors

    • Parameters

      Returns PDF

      import * as OneBlink from '@oneblink/sdk'
        const options = {
          accessKey: '123455678901ABCDEFGHIJKL',
          secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
        }
        const pdf = new OneBlink.PDF(options)

    Methods

    • Submission Data Key Supported

      Key must be assigned to the form that was submitted.

      Minimum Role Permission

      Submission Data: Read Only

      Parameters

      • options: { formId: number; isDraft?: boolean; submissionId: string } & Omit<
            PDFConfiguration,
            "fileName",
        >

        An object containing all parameters to be passed into the function.

        • formId: number

          The exact identifier of the form you wish to generate a pdf for

        • OptionalisDraft?: boolean

          true if the submission is a draft submission, otherwise false

        • submissionId: string

          The submission identifier generated after a successful form submission

      Returns Promise<Buffer<ArrayBufferLike>>

      import fs from 'fs'
        import util from 'util'

        const writeFileAsync = util.promisify(fs.writeFile)

        async function run() {
          const buffer = await pdf.generateFormSubmissionPDF({
            formId: 1,
            submissionId: 'c63ec3ac-12ab-447c-951c-2815d0e6fc24',
            isDraft: false,
            includeSubmissionIdInPdf: false,
            includeExternalIdInPdf: false,
            excludedElementIds: ['1ae6d5f5-eade-411c-b85a-45fe40fe469e'],
          })
          await writeFileAsync('./submission.pdf', buffer, 'binary')
        }

    • Minimum Role Permission

      PDF Generation: On

      Parameters

      Returns Promise<Buffer<ArrayBufferLike>>

      import fs from 'fs'
        import util from 'util'

        const writeFileAsync = util.promisify(fs.writeFile)

        async function run() {
          const buffer = await pdf.generatePDF({
            body: {
              html: `
                <p>I will be in the middle</p>
              `,
            },
            header: {
              html: `
              <div style="font-size: 9px; margin: 0 15px; width: 100%; text-align: center;">
                I will be at the top of every page
              </div>
              `,
            },
            footer: {
              html: `
              <div style="font-size: 9px; margin: 0 15px; width: 100%; text-align: center;">
                I will be at the bottom of every page ({_BLINK_PAGE_NO_}/{_BLINK_PAGES_})
              </div>
              `,
            },
            page: {
              orientation: 'Portrait',
              size: 'A4',
              margins: {
                top: '15mm',
                right: '5mm',
                bottom: '15mm',
                left: '5mm',
              },
            },
          })
          await writeFileAsync('./custom.pdf', buffer, 'binary')
        }

    • Minimum Role Permission

      PDF Generation: On

      Parameters

      • options: {
            excludedCSSClasses?: string[];
            excludedElementIds?: string[];
            includeExternalIdInPdf?: boolean;
            submissionData: S3SubmissionData;
            usePagesBreaks?: boolean;
        }

        An object containing all parameters to be passed into the function.

      Returns Promise<Buffer<ArrayBufferLike>>

      import fs from 'fs'
        import util from 'util'

        const writeFileAsync = util.promisify(fs.writeFile)

        async function run() {
          const buffer = await pdf.generatePdfFromSubmissionData({
            submissionData: {
              submission: {
                myElementName: 'text 123',
              },
              definition: {}, // form definition
              submissionTimestamp: new Date().toISOString(),
              formsAppId: 1,
            },
            excludedElementIds: ['1ae6d5f5-eade-411c-b85a-45fe40fe469e'],
            usePagesBreaks: true,
            excludedCSSClasses: [],
            includeExternalIdInPdf: false,
          })
          await writeFileAsync('./submission.pdf', buffer, 'binary')
        }

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods