Interface ScheduledAction

Hierarchy

{ action: SchedulableActionType; entity: Link<SchedulableEntityType>; environment?: undefined | { sys: MetaLinkProps }; error?: ScheduledActionFailedError; scheduledFor: { datetime: ISO8601Timestamp; timezone?: undefined | string }; sys: ScheduledActionSysProps }
DefaultElements<ScheduledActionProps>
{ delete: any; update: any }
- ScheduledAction

Index

Properties

Methods

Properties

action

action: SchedulableActionType

entity

entity: Link<SchedulableEntityType>

Optional environment

environment: undefined | { sys: MetaLinkProps }

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

scheduledFor

scheduledFor: { datetime: ISO8601Timestamp; timezone?: undefined | string }

Type declaration

datetime: ISO8601Timestamp
Optional timezone?: undefined | string

A valid IANA timezone Olson identifier

see

https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

example

'Asia/Kolkata'

sys

sys: ScheduledActionSysProps

Methods

delete

delete(): Promise<ScheduledAction>

Inherited from __type.delete
- Defined in lib/entities/scheduled-action.ts:114
Returns Promise<ScheduledAction>

toPlainObject

toPlainObject(): ScheduledActionProps

Inherited from AppBundle.toPlainObject
- Defined in lib/common-types.ts:84
Returns ScheduledActionProps

update

update(): Promise<ScheduledAction>

Inherited from __type.update
- Defined in lib/entities/scheduled-action.ts:115
Returns Promise<ScheduledAction>