method

RiduClient.scheduleUnpublish

Schedule a versioned collection document to unpublish at a future instant.

Arguments

Argument	Type	Description
`collection`	`Slug`	The collection value.
`id`	`string`	The id value.
`runAt`	`string \| Date`	The runAt value.
`options`	`PublicationScheduleOptions \| undefined`	The options value.

Returns

The declared result.

Promise<ScheduledPublication>

Full signature

RiduClient.scheduleUnpublish<Slug extends DraftCollectionSlug<Config>>(
	collection: Slug,
	id: string,
	runAt: string | Date,
	options?: PublicationScheduleOptions,
): Promise<ScheduledPublication>

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

Related types

DraftCollectionSlug
Collection slugs with the generated drafts capability.
PublicationScheduleOptions
Revision fence and display timezone for a scheduled publication change.
ScheduledPublication
A durable scheduled-publication job returned by publishing methods.