Interface ScheduledAction

interface ScheduledAction {
    action: SchedulableActionType;
    entity: Link<SchedulableEntityType>;
    environment?: {
        sys: MetaLinkProps;
    };
    error?: ScheduledActionFailedError;
    payload?: ScheduledActionPayloadProps;
    scheduledFor: {
        datetime: string;
        timezone?: string;
    };
    sys: ScheduledActionSysProps;
    delete(): Promise<ScheduledAction>;
    toPlainObject(): ScheduledActionProps;
    update(): Promise<ScheduledAction>;
}

Hierarchy (view full)

Properties

action entity environment? error? payload? scheduledFor sys

Methods

delete toPlainObject update

Properties

action

action: SchedulableActionType

entity

entity: Link<SchedulableEntityType>

Optionalenvironment

environment?: {
    sys: MetaLinkProps;
}

Optionalerror

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: [...]
   *   }
   * }

Optionalpayload

payload?: ScheduledActionPayloadProps

scheduledFor

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

Type declaration

sys

sys: ScheduledActionSysProps

Methods

delete

toPlainObject

update

Settings

Member Visibility

On This Page

Properties
Methods