Interface ScheduledAction

Hierarchy

Properties

action entity environment? error? payload? scheduledFor sys

Methods

delete toPlainObject update

Properties

action

action: SchedulableActionType

entity

entity: Link<SchedulableEntityType>

Optional environment

environment?: {
    sys: MetaLinkProps;
}

Type declaration

Optional error

error?: ScheduledActionFailedError

The Contentful-style error that occurred during execution if sys.status is failed

Example

{
   *   sys: {
   *     type: 'Error',
   *     id: 'InvalidEntry'
   *   },
   *   message: 'Entry is invalid',
   *   details: {
   *     errors: [...]
   *   }
   * }

Optional payload

payload?: ScheduledActionPayloadProps

scheduledFor

scheduledFor: {
    datetime: string;
    timezone?: string;
}

Type declaration

sys

sys: ScheduledActionSysProps

Methods

delete

toPlainObject

update

Settings

Member Visibility

Theme