class StackMob::Push

Constants

BROADCAST_PATH
DEFAULT_BADGE
DEFAULT_SOUND
DEVICE_TOKEN_PATH
GET_USERS_TOKEN_PATH
PUSH_SVC
PUSH_TOKENS_PATH
PUSH_USERS_PATH
REMOVE_DEVICE_TOKEN

Attributes

client[RW]

Public Class Methods

new(cl) click to toggle source
# File lib/stackmob/push.rb, line 31
def initialize(cl)
  self.client = cl
end

Public Instance Methods

aps_data(opts) click to toggle source
# File lib/stackmob/push.rb, line 48
def aps_data(opts)
  alert = opts[:alert] || (raise ArgumentError.new("Push requires alert message"))
  badge = opts[:badge] || DEFAULT_BADGE
  sound = opts[:sound] || DEFAULT_SOUND
  
  {:badge => badge, :sound => sound, :alert => alert}
end
broadcast(opts) click to toggle source
# File lib/stackmob/push.rb, line 43
def broadcast(opts)
  payload = { :kvPairs => opts }
  self.client.request(:post, PUSH_SVC, BROADCAST_PATH, payload)
end
get_tokens_for_users(to) click to toggle source
# File lib/stackmob/push.rb, line 76
def get_tokens_for_users(to)
  payload = {:userIds => Array(to).join(",") }
  response = self.client.request(:get, PUSH_SVC, GET_USERS_TOKEN_PATH, payload)
end
register(user_id, device_token) click to toggle source
# File lib/stackmob/push.rb, line 35
def register(user_id, device_token)
  self.client.request(:post, PUSH_SVC, DEVICE_TOKEN_PATH, :userId => user_id, :token => device_token) # using non-convential symbols to conform to StackMob Push API
end
remove(device_token) click to toggle source
# File lib/stackmob/push.rb, line 39
def remove(device_token)
  self.client.request(:post, PUSH_SVC, REMOVE_DEVICE_TOKEN, device_token)
end
send_message(to, opts) click to toggle source

Deprecated

# File lib/stackmob/push.rb, line 57
def send_message(to, opts)
  warn "[DEPRECATION] `send_message` is deprecated and does not support android, please use `send_message_to_tokens` or `send_message_to_users`"
  recipients_are_device_tokens = (opts[:recipients_are_users]) ? false : true
  payload = {:recipients => Array(to), :aps => aps_data(opts), :areRecipientsDeviceTokens => recipients_are_device_tokens, :exclude_tokens => []}

  self.client.request(:post, PUSH_SVC, "/push", payload)
end
send_message_to_tokens(to, opts) click to toggle source
# File lib/stackmob/push.rb, line 65
def send_message_to_tokens(to, opts)
  to = [to] if to.is_a? Hash
  payload = {:tokens => Array(to), :payload => { :kvPairs => opts }}
  self.client.request(:post, PUSH_SVC, PUSH_TOKENS_PATH, payload)
end
send_message_to_users(to, opts) click to toggle source
# File lib/stackmob/push.rb, line 71
def send_message_to_users(to, opts)
  payload = {:userIds => Array(to), :kvPairs => opts}
  self.client.request(:post, PUSH_SVC, PUSH_USERS_PATH, payload)
end