Type alias PendingSubmissionsContextValue

PendingSubmissionsContextValue: {
    deletePendingSubmission: ((pendingTimestamp) => unknown);
    hideFailedNotification: (() => unknown);
    hideSuccessNotification: (() => unknown);
    isLoading: boolean;
    isProcessingPendingQueue: boolean;
    isShowingFailedNotification: boolean;
    isShowingSuccessNotification: boolean;
    loadError: Error | null;
    pendingSubmissions: submissionService.PendingFormSubmission[];
    processPendingQueue: (() => unknown);
    reloadPendingSubmissions: (() => unknown);
}

The value returned from usePendingSubmissions() hook

Type declaration

  • deletePendingSubmission: ((pendingTimestamp) => unknown)
      • (pendingTimestamp): unknown
      • A function to remove a submission from the pending submissions

        Parameters

        • pendingTimestamp: string

        Returns unknown

  • hideFailedNotification: (() => unknown)
      • (): unknown
      • A function to hide the notification when a submission fails to process

        Returns unknown

  • hideSuccessNotification: (() => unknown)
      • (): unknown
      • A function to hide the notification after a submission completed successfully

        Returns unknown

  • isLoading: boolean

    true if the pending submissions are currently loading

  • isProcessingPendingQueue: boolean

    true submissions that where submitted offline are being processed

  • isShowingFailedNotification: boolean

    true if a submission being processed fails

  • isShowingSuccessNotification: boolean

    true if a submission being processed completes successfully.

  • loadError: Error | null

    An Error object if loading pending submissions fails

  • pendingSubmissions: submissionService.PendingFormSubmission[]

    The submissions that were submitted offline and can be processed when back online

  • processPendingQueue: (() => unknown)
      • (): unknown
      • A function to trigger processing of the pending queue

        Returns unknown

  • reloadPendingSubmissions: (() => unknown)
      • (): unknown
      • A function to trigger loading of the submissions that were submitted offline

        Returns unknown