Interface UseSubmissionValue

The return type of the useSubmission hook.

Hierarchy

  • UseSubmissionValue

Properties

approve approveSubmission deleteSubmission fetched isPending push pushSubmission refetch reject rejectSubmission reset setDescription setFiles setId setName setPostTitle setSchemaId setState submission uploadPendingAfterTimeout

Properties

approve

approve: (() => void)

Type declaration

    • (): void

    • Function to approve the submission, optionally adding a comment.

      Returns void

approveSubmission

approveSubmission: (() => void)

Type declaration

    • (): void

    • Alias for the approve method.

      Returns void

deleteSubmission

deleteSubmission: ((submissionId?) => Promise<void>)

Type declaration

    • (submissionId?): Promise<void>

    • Function to delete the submission by ID or use the current submission ID.

      Parameters

      • Optional submissionId: any

      Returns Promise<void>

fetched

fetched: boolean

Boolean indicating whether the submission data has been fetched.

isPending

isPending: null | boolean

Boolean indicating if the submission is in a pending state, or null if the state is unknown.

push

push: ((updatedSubmission?) => Promise<void>)

Type declaration

    • (updatedSubmission?): Promise<void>

    • Function to push updated submission data to the backend.

      Parameters

      • Optional updatedSubmission: any

      Returns Promise<void>

pushSubmission

pushSubmission: ((updatedSubmission?) => Promise<void>)

Type declaration

    • (updatedSubmission?): Promise<void>

    • Alias for the push method.

      Parameters

      • Optional updatedSubmission: any

      Returns Promise<void>

refetch

refetch: ((quiet) => void)

Type declaration

    • (quiet): void

    • Function to refetch the submission data from the backend. Pass quiet to avoid triggering loading indicators.

      Parameters

      • quiet: boolean

      Returns void

reject

reject: (() => void)

Type declaration

    • (): void

    • Function to reject the submission, optionally adding a comment.

      Returns void

rejectSubmission

rejectSubmission: (() => void)

Type declaration

    • (): void

    • Alias for the reject method.

      Returns void

reset

reset: (() => void)

Type declaration

    • (): void

    • Function to reset the submission state to default values.

      Returns void

setDescription

setDescription: ((description) => void)

Type declaration

    • (description): void

    • Function to update the description of the submission.

      Parameters

      • description: string

      Returns void

setFiles

setFiles: ((files) => void)

Type declaration

    • (files): void

    • Function to update the files associated with the submission.

      Parameters

      • files: any

      Returns void

setId

setId: ((id) => void)

Type declaration

    • (id): void

    • Function to update the ID of the submission and trigger a refetch.

      Parameters

      • id: string

      Returns void

setName

setName: ((name) => void)

Type declaration

    • (name): void

    • Function to update the name of the submission.

      Parameters

      • name: string

      Returns void

setPostTitle

setPostTitle: ((postTitle) => void)

Type declaration

    • (postTitle): void

    • Function to update the post title of the submission.

      Parameters

      • postTitle: string

      Returns void

setSchemaId

setSchemaId: ((schemaId) => void)

Type declaration

    • (schemaId): void

    • Function to update the schema ID of the submission.

      Parameters

      • schemaId: string

      Returns void

setState

setState: ((state) => void)

Type declaration

    • (state): void

    • Function to update the state of the submission.

      Parameters

      • state: string

      Returns void

submission

submission: any

The current submission object containing all submission details.

uploadPendingAfterTimeout

uploadPendingAfterTimeout: boolean

Boolean indicating if the submission upload is still pending after exceeding the timeout period.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc