|
123 | 123 | | [`action_input`](#oban-triggers-trigger-action_input){: #oban-triggers-trigger-action_input } | `map` | | Static inputs to supply to the update/destroy action when it is called. Any metadata produced by `read_metadata` will overwrite these values. | |
124 | 124 | | [`extra_args`](#oban-triggers-trigger-extra_args){: #oban-triggers-trigger-extra_args } | `map \| (any -> any)` | | Additional arguments to merge into the job's arguments map. Can either be a map or a function that takes the record and returns a map. | |
125 | 125 | | [`actor_persister`](#oban-triggers-trigger-actor_persister){: #oban-triggers-trigger-actor_persister } | `:none \| module` | | An `AshOban.PersistActor` to use to store the actor. Defaults to to the configured `config :ash_oban, :actor_persister`. Set to `:none` to override the configured default. | |
| 126 | +| [`default_actor`](#oban-triggers-trigger-default_actor){: #oban-triggers-trigger-default_actor } | `any` | | A default actor (literal value) used when no actor is supplied via job args. Useful for system-actor flows that don't need an `actor_persister`. Cron-fired schedulers run with this actor, and worker jobs fall back to it when nothing was stored. Applied when no actor was supplied to `AshOban.schedule/3` or `AshOban.run_trigger/3`, or when the configured persister resolves the stored actor to `nil`. | |
126 | 127 | | [`list_tenants`](#oban-triggers-trigger-list_tenants){: #oban-triggers-trigger-list_tenants } | `list(any) \| (-> any) \| module` | | A list of tenants or a function behaviour that returns a list of tenants a trigger should be run for. | |
127 | 128 | | [`scheduler_queue`](#oban-triggers-trigger-scheduler_queue){: #oban-triggers-trigger-scheduler_queue } | `atom` | | The queue to place the scheduler job in. The same queue as job is used by default (but with a priority of 1 so schedulers run first). | |
128 | 129 | | [`debug?`](#oban-triggers-trigger-debug?){: #oban-triggers-trigger-debug? } | `boolean` | `false` | If set to `true`, detailed debug logging will be enabled for this trigger. You can also set `config :ash_oban, debug_all_triggers?: true` to enable debug logging for all triggers. If the action has `transaction?: false` this is automatically false. | |
@@ -267,6 +268,7 @@ schedule name, cron |
267 | 268 | | [`list_tenants`](#oban-scheduled_actions-schedule-list_tenants){: #oban-scheduled_actions-schedule-list_tenants } | `list(any) \| (-> any) \| module` | | A list of tenants or a function behaviour that returns a list of tenants this scheduled action should be run for. The action will be called once for each tenant. Falls back to the global `list_tenants` setting in the `oban` section if not set. | |
268 | 269 | | [`action`](#oban-scheduled_actions-schedule-action){: #oban-scheduled_actions-schedule-action } | `atom` | | The generic or create action to call when the schedule is triggered. | |
269 | 270 | | [`actor_persister`](#oban-scheduled_actions-schedule-actor_persister){: #oban-scheduled_actions-schedule-actor_persister } | `:none \| module` | | An `AshOban.PersistActor` to use to store the actor. Defaults to to the configured `config :ash_oban, :actor_persister`. Set to `:none` to override the configured default. | |
| 271 | +| [`default_actor`](#oban-scheduled_actions-schedule-default_actor){: #oban-scheduled_actions-schedule-default_actor } | `any` | | A default actor (literal value) used when no actor is supplied via job args. Useful for system-actor flows that don't need an `actor_persister`. Applied when no actor was supplied to `AshOban.schedule/3`, or when the configured persister resolves the stored actor to `nil`. | |
270 | 272 | | [`worker_module_name`](#oban-scheduled_actions-schedule-worker_module_name){: #oban-scheduled_actions-schedule-worker_module_name } | `module` | | The module name to be used for the generated worker. | |
271 | 273 | | [`queue`](#oban-scheduled_actions-schedule-queue){: #oban-scheduled_actions-schedule-queue } | `atom` | | The queue to place the job in. Defaults to the resources short name plus the name of the scheduled action (not the action name). | |
272 | 274 | | [`state`](#oban-scheduled_actions-schedule-state){: #oban-scheduled_actions-schedule-state } | `:active \| :paused \| :deleted` | `:active` | Describes the state of the cron job. See the getting started guide for more information. The most important thing is that you *do not remove a scheduled action from a resource if you are using oban pro*. | |
|
0 commit comments