scheduledActions

For use with Netlify Visual Editor only.

connector.scheduledActions(opts)

Used to add support in Visual Editor for scheduled publishing with your data source.

After you define the functions for creating and modifying scheduled events on your data source, Netlify will expose a models.ScheduledAction interface that you can use in connector.sync().

Note that this only works if your data source offers support for scheduled publishing or scheduled actions.

Takes an object where the keys are functions defined by your connector. The object contains the following properties:

Parameter	Description
`create`	Used to create a new scheduled event in your data source.
`delete`	Used to delete a previously scheduled event in your data source.
`update`	Used to update a previously scheduled event in your data source.

create

Receives a function to create a new scheduled event in your data source. The function is passed an object as the first parameter with the following properties:

Property	Description
`scheduledAction`	Object representing the action to schedule.
`state`	Object containing data stored in `initState` when `addConnector` runs.

Usage example

const connector = extension.addConnector({
  initState: () => {
    const myCMSClient = new MyCMSClient();
    return { myCMSClient };
  },
});

connector.scheduledActions({
  create: ({ scheduledAction, state: { myCMSClient } }) => {
    const result = await state.apiClient.createScheduledAction({
      action: scheduledAction.action,
      documentIds: scheduledAction.documentIds,
      executeAt: scheduledAction.executeAt,
      name: scheduledAction.name,
    });
    return { id: result.id };
  },
});

delete

Receives a function to delete a previously scheduled event in your data source. The function is passed an object as the first parameter with the following properties:

Property	Description
`scheduledAction`	Object representing the action to delete.
`state`	Object containing data stored in `initState` when `addConnector` runs.

Usage example

const connector = extension.addConnector({
  initState: () => {
    const myCMSClient = new MyCMSClient();
    return { myCMSClient };
  },
});

connector.scheduledActions({
  delete: ({ scheduledAction, state: { myCMSClient } }) => {
    const result = await state.apiClient.deleteScheduledAction({
      id: scheduledAction.id,
    });
    return { id: result.id };
  },
});

update

Receives a function to update a previously scheduled event in your data source. The function is passed an object as the first parameter with the following properties:

Property	Description
`scheduledAction`	Object representing the action to update.
`state`	Object containing data stored in `initState` when `addConnector` runs.

Usage example

const connector = extension.addConnector({
  initState: () => {
    const myCMSClient = new MyCMSClient();
    return { myCMSClient };
  },
});

connector.scheduledActions({
  update: ({ scheduledAction, state: { myCMSClient } }) => {
    const result = await state.apiClient.updateScheduledAction({
      id: scheduledAction.id,
      documentIds: scheduledAction.documentIds,
      executeAt: scheduledAction.executeAt,
      name: scheduledAction.name,
    });
    return { id: result.id };
  },
});