Class OneBlinkDownloader

constructor

• new OneBlinkDownloader(props): OneBlinkDownloader

• Example

  import { OneBlinkDownloader } from '@oneblink/storage'
  
  const downloader = new OneBlinkDownloader({
    apiOrigin: 'https://auth-api.blinkm.io',
    region: 'ap-southeast-2',
    getBearerToken: () => getAccessToken(),
  })
  Copy

  Parameters

  • props: StorageConstructorOptions

  Returns OneBlinkDownloader

apiOrigin

getBearerToken

region

downloadDraftSubmission

• downloadDraftSubmission(data): Promise<undefined | S3SubmissionData>

• Download a draft form submission.

  Example

  const result = await downloader.downloadDraftSubmission({
    formSubmissionDraftVersionId: '5ad46e62-f466-451c-8cd6-29ba23ac50b7',
    formId: 1,
    abortSignal: new AbortController().signal,
  })
  Copy

  Parameters

  • data: DownloadOptions & {
        formSubmissionDraftVersionId: string;
    }

    The submission upload data and options

  Returns Promise<undefined | S3SubmissionData>

  The submission

downloadPrefillData

• downloadPrefillData<T>(data): Promise<undefined | T>

• Download pre-fill form submission data.

  Example

  const result = await downloader.downloadPrefillData({
    preFillFormDataId: '5ad46e62-f466-451c-8cd6-29ba23ac50b7',
    formId: 1,
    abortSignal: new AbortController().signal,
  })
  Copy

  Type Parameters

  • T extends Record<string, unknown>

  Parameters

  • data: DownloadOptions & {
        formId: number;
        preFillFormDataId: string;
    }

    The submission upload data and options

  Returns Promise<undefined | T>

  The submission

downloadSubmission

• downloadSubmission(data): Promise<undefined | S3SubmissionData>

• Download a form submission.

  Example

  const result = await downloader.downloadSubmission({
    submissionId: '5ad46e62-f466-451c-8cd6-29ba23ac50b7',
    formId: 1,
    abortSignal: new AbortController().signal,
  })
  Copy

  Parameters

  • data: DownloadOptions & {
        formId: number;
        submissionId: string;
    }

    The submission upload data and options

  Returns Promise<undefined | S3SubmissionData>

  The submission