AeontelAeontel Docs

Element Versions hooks

Hand-written shim. Implementation is generated; see ./element-versions.gen.

Hooks

useCreateElementVersion mutation

Create an element version.

TypeScript
useCreateElementVersion(options?: MutationOpts<ElementVersion, CreateElementVersionParams>)

Types: ElementVersion · CreateElementVersionParams

useDeleteElementVersion mutation

Soft-delete an element version.

TypeScript
useDeleteElementVersion(options?: MutationOpts<SuccessResponse, string>)

Types: SuccessResponse

useListElementVersions query

List element versions.

TypeScript
useListElementVersions(params?: Omit<ListElementVersionsParams, | > & { filter?: ElementVersionFilter; orderBy?: ElementVersionOrderBy[]; } & ElementVersionShorthands, options?: QueryOpts<Page<ElementVersion>>)

Types: ListElementVersionsParams · ElementVersionFilter · ElementVersionOrderBy · ElementVersionShorthands · Page · ElementVersion

usePurgeElementVersion composite

Permanently delete a soft-deleted element version.

TypeScript
usePurgeElementVersion(options?: MutationOpts<SuccessResponse, PurgeElementVersionParams>)

Types: SuccessResponse · PurgeElementVersionParams

useRestoreElementVersion composite

Restore a soft-deleted element version.

TypeScript
useRestoreElementVersion(options?: MutationOpts<ElementVersion, string>)

Types: ElementVersion

useRetrieveElementVersion query

Get an element version by ID.

TypeScript
useRetrieveElementVersion(id: string, options?: QueryOpts<ElementVersion>)

Types: ElementVersion