class SmsCarrier::MessageDelivery
The SmsCarrier::MessageDelivery
class is used by SmsCarrier::Base
when creating a new carrier. MessageDelivery
is a wrapper (Delegator
subclass) around a lazy created Sms
. You can get direct access to the Sms
, deliver the SMS or schedule the SMS to be sent through Active Job.
Notifier.welcome(User.first) # an SmsCarrier::MessageDelivery object Notifier.welcome(User.first).deliver_now # sends the email Notifier.welcome(User.first).deliver_later # enqueue email delivery as a job through Active Job Notifier.welcome(User.first).message # a Sms object
Public Instance Methods
Enqueues the SMS to be delivered through Active Job. When the job runs it will send the SMS using deliver_now
.
Notifier.welcome(User.first).deliver_later Notifier.welcome(User.first).deliver_later(wait: 1.hour) Notifier.welcome(User.first).deliver_later(wait_until: 10.hours.from_now)
Options:
-
:wait
- Enqueue the SMS to be delivered with a delay. -
:wait_until
- Enqueue the SMS to be delivered at (after) a specific date / time. -
:queue
- Enqueue the SMS on the specified queue.
# File lib/sms_carrier/message_delivery.rb, line 65 def deliver_later(options={}) enqueue_delivery :deliver_now, options end
Enqueues the SMS to be delivered through Active Job. When the job runs it will send the SMS using deliver_now!
. That means that the message will be sent bypassing checking perform_deliveries
and raise_delivery_errors
, so use with caution.
Notifier.welcome(User.first).deliver_later! Notifier.welcome(User.first).deliver_later!(wait: 1.hour) Notifier.welcome(User.first).deliver_later!(wait_until: 10.hours.from_now)
Options:
-
:wait
- Enqueue the SMS to be delivered with a delay -
:wait_until
- Enqueue the SMS to be delivered at (after) a specific date / time -
:queue
- Enqueue the SMS on the specified queue
# File lib/sms_carrier/message_delivery.rb, line 49 def deliver_later!(options={}) enqueue_delivery :deliver_now!, options end
Delivers an SMS:
Notifier.welcome(User.first).deliver_now
# File lib/sms_carrier/message_delivery.rb, line 82 def deliver_now message.deliver end
Delivers an SMS without checking perform_deliveries
and raise_delivery_errors
, so use with caution.
Notifier.welcome(User.first).deliver_now!
# File lib/sms_carrier/message_delivery.rb, line 74 def deliver_now! message.deliver! end
Returns the Message object
# File lib/sms_carrier/message_delivery.rb, line 31 def message __getobj__ end
Private Instance Methods
# File lib/sms_carrier/message_delivery.rb, line 88 def enqueue_delivery(delivery_method, options={}) args = @carrier.name, @sms_method.to_s, delivery_method.to_s, *@args SmsCarrier::DeliveryJob.set(options).perform_later(*args) end