Skip to content
DocsReference
DocsReferenceGitHub

Search Ridu documentation

tab controls

Loading search…

Search will be ready in a moment.

No matching results

Try a different term or search every section.

Loading search.

Preparing index…View all results →↑↓ move↵ openesc close
Get started
Modules/@riducms/sdk
MRiduClient.unpublish

Go packages

riducorefieldqueryschemastorestoragemigrationmigration/payloadprotocol (Go)plugintestconformance

Official adapters

postgressqlitemongodbstorage/localstorage/s3

Official plugins

graphqlmcprichtextseoformbuilder@riducms/plugin-richtext@riducms/plugin-seo@riducms/plugin-form-builder

TypeScript packages

@riducms/sdk@riducms/protocol@riducms/plugin@riducms/build@riducms/ui@riducms/admin@riducms/translations@riducms/cli/run

Tooling

ridu CLI
All@riducms/sdkriducorefieldqueryschemastorestoragemigrationmigration/payloadprotocol (Go)plugintestpostgressqlitemongodbgraphqlmcprichtextseoformbuilderstorage/localstorage/s3conformance@riducms/protocol@riducms/plugin@riducms/build@riducms/ui@riducms/plugin-richtext@riducms/plugin-seo@riducms/plugin-form-builder@riducms/admin@riducms/translations@riducms/cli/runridu CLI
All 137RiduClient.preferenceRiduClient.cancelScheduledPublishRiduClient.publishRiduClient.publishChangesRiduClient.unpublishRiduClient.restoreRiduClient.bulkRestoreDeletedRiduClient.bulkDeletePermanent

method

RiduClient.unpublish

RiduClient.unpublish<Slug extends DraftCollectionSlug<Config>>( collection: Slug, id: string, options?: MutationOptions<LocaleFor<Config>>, ): Promise<OutputFor<Config, Slug>>

Return a published draft-enabled document to draft.

Source packages/sdk/src/types.ts:1017

@param collection
The collection value.
@param id
The id value.
@param options
The options value.
@returns
The declared result.

Related types

  • DraftCollectionSlug

    Collection slugs with the generated drafts capability.

  • MutationOptions

    Localized mutation options with optimistic concurrency.

  • OutputFor

    Resolve a collection document output type.