module Caffeinate::Dripper::Subscriber::ClassMethods

Public Instance Methods

subscribe(subscriber, **args) click to toggle source

Subscribes to the campaign.

OrderDripper.subscribe(order, user: order.user)

@param [ActiveRecord::Base] subscriber The object subscribing @option [ActiveRecord::Base] :user The associated user (optional)

@return [Caffeinate::CampaignSubscriber] the created CampaignSubscriber

# File lib/caffeinate/dripper/subscriber.rb, line 26
def subscribe(subscriber, **args)
  caffeinate_campaign.subscribe!(subscriber, **args)
end
subscriptions() click to toggle source

Returns the Campaign’s ‘Caffeinate::CampaignSubscriber`

# File lib/caffeinate/dripper/subscriber.rb, line 14
def subscriptions
  caffeinate_campaign.caffeinate_campaign_subscriptions
end
unsubscribe(subscriber, **args) click to toggle source

Unsubscribes from the campaign. Returns false if something’s wrong.

OrderDripper.unsubscribe(order, user: order.user)

@param [ActiveRecord::Base] subscriber The object subscribing @option [ActiveRecord::Base] :user The associated user (optional)

@return [Caffeinate::CampaignSubscriber] the CampaignSubscriber

# File lib/caffeinate/dripper/subscriber.rb, line 38
def unsubscribe(subscriber, **args)
  caffeinate_campaign.unsubscribe(subscriber, **args)
end
unsubscribe!(subscriber, **args) click to toggle source

Unsubscribes from the campaign. Raises error if somerthing’s wrong.

OrderDripper.unsubscribe(order, user: order.user)

@param [ActiveRecord::Base] subscriber The object subscribing @option [ActiveRecord::Base] :user The associated user (optional)

@return [Caffeinate::CampaignSubscriber] the CampaignSubscriber

# File lib/caffeinate/dripper/subscriber.rb, line 50
def unsubscribe!(subscriber, **args)
  caffeinate_campaign.unsubscribe!(subscriber, **args)
end