Class: APN::Notification

Inherits:
Base
  • Object
show all
Extended by:
ActionView::Helpers::TextHelper
Includes:
ActionView::Helpers::TextHelper
Defined in:
lib/apn_on_rails/app/models/apn/notification.rb

Overview

Represents the message you wish to send. An APN::Notification belongs to an APN::Device.

Example:

apn = APN::Notification.new
apn.badge = 5
apn.sound = 'my_sound.aiff'
apn.alert = 'Hello!'
apn.device = APN::Device.find(1)
apn.save

To deliver call the following method:

APN::Notification.send_notifications

As each APN::Notification is sent the sent_at column will be timestamped, so as to not be sent again.

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

table_name

Class Method Details

.send_notifications ⇒ Object 



88
89
90
91
 
# File 'lib/apn_on_rails/app/models/apn/notification.rb', line 88

def self.send_notifications
  ActiveSupport::Deprecation.warn("The method APN::Notification.send_notifications is deprecated.  Use APN::App.send_notifications instead.")
  APN::App.send_notifications
end

Instance Method Details

#alert=(message) ⇒ Object

Stores the text alert message you want to send to the device.

If the message is over 150 characters long it will get truncated to 150 characters with a ...



29
30
31
32
33
34
 
# File 'lib/apn_on_rails/app/models/apn/notification.rb', line 29

def alert=(message)
  if !message.blank? && message.size > 150
    message = truncate(message, :length => 150)
  end
  write_attribute('alert', message)
end

#apple_hash ⇒ Object

Creates a Hash that will be the payload of an APN.

Example:

apn = APN::Notification.new
apn.badge = 5
apn.sound = 'my_sound.aiff'
apn.alert = 'Hello!'
apn.apple_hash # => {"aps" => {"badge" => 5, "sound" => "my_sound.aiff", "alert" => "Hello!"}}

Example 2: 

apn = APN::Notification.new
apn.badge = 0
apn.sound = true
apn.custom_properties = {"typ" => 1}
apn.apple_hash # => {"aps" => {"badge" => 0, "sound" => "1.aiff"}, "typ" => "1"}



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/apn_on_rails/app/models/apn/notification.rb', line 51

def apple_hash
  result = {}
  result['aps'] = {}
  result['aps']['alert'] = self.alert if self.alert
  result['aps']['badge'] = self.badge.to_i if self.badge
  if self.sound
    result['aps']['sound'] = self.sound if self.sound.is_a? String
    result['aps']['sound'] = "1.aiff" if self.sound.is_a?(TrueClass)
  end
  if self.custom_properties
    self.custom_properties.each do |key,value|
      result["#{key}"] = "#{value}"
    end
  end
  result
end

#message_for_sending ⇒ Object

Creates the binary message needed to send to Apple.

Raises:



81
82
83
84
85
86
 
# File 'lib/apn_on_rails/app/models/apn/notification.rb', line 81

def message_for_sending
  json = self.to_apple_json
  message = "\0\0 #{self.device.to_hexa}\0#{json.length.chr}#{json}"
  raise APN::Errors::ExceededMessageSizeError.new(message) if message.size.to_i > 256
  message
end

#to_apple_json ⇒ Object

Creates the JSON string required for an APN message.

Example:

apn = APN::Notification.new
apn.badge = 5
apn.sound = 'my_sound.aiff'
apn.alert = 'Hello!'
apn.to_apple_json # => '{"aps":{"badge":5,"sound":"my_sound.aiff","alert":"Hello!"}}'



76
77
78
 
# File 'lib/apn_on_rails/app/models/apn/notification.rb', line 76

def to_apple_json
  self.apple_hash.to_json
end