instance method
enqueue
Ruby on Rails 7.0.10
Since v4.2.9Signature
enqueue(options = {})Enqueues the job to be performed by the queue adapter.
Options
-
:wait- Enqueues the job with the specified delay -
:wait_until- Enqueues the job at the time specified -
:queue- Enqueues the job on the specified queue -
:priority- Enqueues the job with the specified priority
Examples
my_job_instance.enqueue my_job_instance.enqueue wait: 5.minutes my_job_instance.enqueue queue: :important my_job_instance.enqueue wait_until: Date.tomorrow.midnight my_job_instance.enqueue priority: 10
Parameters
-
optionsopt = {}
Source
# File activejob/lib/active_job/enqueuing.rb, line 59
def enqueue(options = {})
set(options)
self.successfully_enqueued = false
run_callbacks :enqueue do
if scheduled_at
queue_adapter.enqueue_at self, scheduled_at
else
queue_adapter.enqueue self
end
self.successfully_enqueued = true
rescue EnqueueError => e
self.enqueue_error = e
end
if successfully_enqueued?
self
else
false
end
end
Defined in activejob/lib/active_job/enqueuing.rb line 59
· View on GitHub
· Improve this page
· Find usages on GitHub
Defined in ActiveJob::Enqueuing