method

App.ScheduleUnpublish

ScheduleUnpublish queues an unpublish for one exact authenticated identity.

Arguments

ArgumentTypeDescription
ctxcontext.ContextThe ctx value.
collectionstringThe collection value.
documentIDstringThe documentID value.
runAttime.TimeThe runAt value.
optionsPublicationScheduleOptionsThe options value.
identity*AuthIdentityThe identity value.

Returns

The declared result.

(store.ScheduledPublication, error)

Full signature

func (application *App) ScheduleUnpublish( ctx context.Context, collection, documentID string, runAt time.Time, options PublicationScheduleOptions, identity *AuthIdentity, ) (store.ScheduledPublication, error)

Source core/publishing.go:36

Related types

  • App

    A resolved application bound to operation services.

  • PublicationScheduleOptions

    PublicationScheduleOptions controls revision fencing and the saved display timezone. TimeZone is optional; it never changes the instant supplied in runAt.

  • AuthIdentity

    An exact authenticated collection and actor document.

  • ScheduledPublication

    Adapter-neutral revision-fenced future publish record.