Class: RubyPushNotifications::APNS::APNSNotification

Inherits:
Object
  • Object
show all
Defined in:
lib/ruby-push-notifications/apns/apns_notification.rb

Overview

Represents a APNS Notification. Manages the conversion of the notification to APNS binary format for each of the destinations. By default sets maximum expiration date (4 weeks).

Author:

  • Carlos Alonso

Constant Summary collapse

WEEKS_4 = 
2419200

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(tokens, data) ⇒ APNSNotification

Initializes the APNS Notification

Parameters:

  • . (Array) —

    Array containing all destinations for the notification

  • . (Hash) —

    Hash with the data to use as payload.



24
25
26
27
 
# File 'lib/ruby-push-notifications/apns/apns_notification.rb', line 24

def initialize(tokens, data)
  @tokens = tokens
  @data = data
end

Instance Attribute Details

#results ⇒ Array

Returns . Array with the results from sending this notification.

Returns:

  • (Array) —

    . Array with the results from sending this notification



18
19
20
 
# File 'lib/ruby-push-notifications/apns/apns_notification.rb', line 18

def results
  @results
end

Instance Method Details

#count ⇒ Integer

Returns . The number of binaries this notification will send. One for each receiver.

Returns:

  • (Integer) —

    . The number of binaries this notification will send. One for each receiver.



54
55
56
 
# File 'lib/ruby-push-notifications/apns/apns_notification.rb', line 54

def count
  @tokens.count
end

#each_message(starting_id) {|.| ... } ⇒ Object

Method that yields the notification’s binary for each of the receivers.

(developer.apple.com/library/ios/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/Chapters/CommunicatingWIthAPS.html#//apple_ref/doc/uid/TP40008194-CH101-SW4)

Parameters:

  • starting_id (Integer) —

    . Every notification encodes a unique ID for further reference. This parameter represents the first id the first notification of this group should use.

Yield Parameters:

  • . (String) —

    APNS binary’s representation of this notification. Consisting of:

    Notification = 2(1), FrameLength(4), items(FrameLength)
Item = ItemID(1), ItemLength(2), data(ItemLength)
Items:
  Device Token => Id: 1, length: 32, data: binary device token
  Payload => Id: 2, length: ??, data: json formatted payload
  Notification ID => Id: 3, length: 4, data: notif id as int
  Expiration Date => Id: 4, length: 4, data: Unix timestamp as int
  Priority => Id: 5, length: 1, data: 10 as 1 byte int



45
46
47
48
49
50
 
# File 'lib/ruby-push-notifications/apns/apns_notification.rb', line 45

def each_message(starting_id)
  @tokens.each_with_index do |token, i|
    bytes = device_token(token) + payload + notification_id(starting_id + i) + expiration_date + priority
    yield [2, bytes.bytesize, bytes].pack 'cNa*'
  end
end