Class APNS

Description

Begin Document

Located in /classes/class_APNS.php (line 34)


	
			
Method Summary
APNS __construct (object $db, [array $args = NULL])
void addMessageAlert ([ $alert = NULL], [ $actionlockey = NULL], [ $lockey = NULL], [ $locargs = NULL], int $number)
void addMessageBadge ([int $number = NULL])
void addMessageCustom ([string $key = NULL], [mixed $value = NULL])
void addMessageSound ([string $sound = NULL])
void newMessage (mixed $fk_device, [string $delivery = NULL])
void processQueue ()
void queueMessage ()
Methods
Constructor __construct (line 163)

Constructor.

Initializes a database connection and perfoms any tasks that have been assigned.

Create a new PHP file named apns.php on your website...

  1.  <?php
  2.  $db new DbConnect();
  3.  $db->show_errors();
  4.  $apns new APNS($db);
  5.  ?>

Your iPhone App Delegate.m file will point to a PHP file with this APNS Object. The url will end up looking something like: https://secure.yourwebsite.com/apns.php?task=register&appname=My%20App&appversion=1.0.1&deviceuid=e018c2e46efe185d6b1107aa942085a59bb865d9&devicetoken=43df9e97b09ef464a6cf7561f9f339cb1b6ba38d8dc946edd79f1596ac1b0f66&devicename=My%20Awesome%20iPhone&devicemodel=iPhone&deviceversion=3.1.2&pushbadge=enabled&pushalert=disabled&pushsound=enabled

  • access: public
APNS __construct (object $db, [array $args = NULL])
  • object $db: Database Object
  • array $args: Optional arguments passed through $argv or $_GET
addMessageAlert (line 702)

Add Message Alert

  1.  <?php
  2.  $db new DbConnect();
  3.  $db->show_errors();
  4.  $apns new APNS($db);
  5.  
  6.  // SIMPLE ALERT
  7.  $apns->newMessage(1'2010-01-01 00:00:00');
  8.  $apns->addMessageAlert('Message received from Bob')// MAKES DEFAULT BUTTON WITH BOTH 'Close' AND 'View' BUTTONS
  9.  $apns->queueMessage();
  10.  
  11.  // CUSTOM 'View' BUTTON
  12.  $apns->newMessage(1'2010-01-01 00:00:00');
  13.  $apns->addMessageAlert('Bob wants to play poker''PLAY')// MAKES THE 'View' BUTTON READ 'PLAY'
  14.  $apns->queueMessage();
  15.  
  16.  // NO 'View' BUTTON
  17.  $apns->newMessage(1'2010-01-01 00:00:00');
  18.  $apns->addMessageAlert('Bob wants to play poker''')// MAKES AN ALERT WITH JUST AN 'OK' BUTTON
  19.  $apns->queueMessage();
  20.  
  21.  // CUSTOM LOCALIZATION STRING FOR YOUR APP
  22.  $apns->newMessage(1'2010-01-01 00:00:00');
  23.  $apns->addMessageAlert(NULLNULL'GAME_PLAY_REQUEST_FORMAT'array('Jenna''Frank'));
  24.  $apns->queueMessage();
  25.  ?>

  • access: public
void addMessageAlert ([ $alert = NULL], [ $actionlockey = NULL], [ $lockey = NULL], [ $locargs = NULL], int $number)
  • int $number
  • $alert
  • $actionlockey
  • $lockey
  • $locargs
addMessageBadge (line 750)

Add Message Badge

  1.  <?php
  2.  $db new DbConnect();
  3.  $db->show_errors();
  4.  $apns new APNS($db);
  5.  $apns->newMessage(1'2010-01-01 00:00:00');
  6.  $apns->addMessageBadge(9)// HAS TO BE A NUMBER
  7.  $apns->queueMessage();
  8.  ?>

  • access: public
void addMessageBadge ([int $number = NULL])
  • int $number
addMessageCustom (line 778)

Add Message Custom

  1.  <?php
  2.  $db new DbConnect();
  3.  $db->show_errors();
  4.  $apns new APNS($db);
  5.  $apns->newMessage(1'2010-01-01 00:00:00');
  6.  $apns->addMessageCustom('acme1'42)// CAN BE NUMBER...
  7.  $apns->addMessageCustom('acme2''foo')// ... STRING
  8.  $apns->addMessageCustom('acme3'array('bang''whiz'))// OR ARRAY
  9.  $apns->queueMessage();
  10.  ?>

  • access: public
void addMessageCustom ([string $key = NULL], [mixed $value = NULL])
  • string $key: Name of Custom Object you want to pass back to your iPhone App
  • mixed $value: Mixed Value you want to pass back. Can be int, bool, string, or array.
addMessageSound (line 807)

Add Message Sound

  1.  <?php
  2.  $db new DbConnect();
  3.  $db->show_errors();
  4.  $apns new APNS($db);
  5.  $apns->newMessage(1'2010-01-01 00:00:00');
  6.  $apns->addMessageSound('bingbong.aiff')// STRING OF FILE NAME
  7.  $apns->queueMessage();
  8.  ?>

  • access: public
void addMessageSound ([string $sound = NULL])
  • string $sound: Name of sound file in your Resources Directory
newMessage (line 556)

Start a New Message

  1.  <?php
  2.  $db new DbConnect();
  3.  $db->show_errors();
  4.  $apns new APNS($db)// CREATE THE OBJECT
  5.  $apns->newMessage(1'2010-01-01 00:00:00')// START A MESSAGE... SECOND ARGUMENT ACCEPTS ANY DATETIME STRING
  6.  $apns->addMessageAlert('You got your emails.')// ALERTS ARE TRICKY... SEE EXAMPLES
  7.  $apns->addMessageBadge(9)// PASS A NUMBER
  8.  $apns->addMessageSound('bingbong.aiff')// ADD A SOUND
  9.  $apns->queueMessage()// AND SEND IT ON IT'S WAY
  10.  
  11.  $apns->newMessage(array(1,3,4,5,8,15,16))// SEND MESSAGE TO MORE THAN ONE USER
  12.  $apns->addMessageAlert('Greetings Everyone!');
  13.  $apns->queueMessage();
  14.  ?>

  • access: public
void newMessage (mixed $fk_device, [string $delivery = NULL])
  • mixed $fk_device: Foreign Key, or Array of Foreign Keys to the device you want to send a message to.
  • string $delivery: Possible future date to send the message.
processQueue (line 832)

Process all queued messages

  1.  <?php
  2.  $db new DbConnect();
  3.  $db->show_errors();
  4.  $apns new APNS($db);
  5.  $apns->newMessage(1'2010-01-01 00:00:00');
  6.  $apns->addMessageSound('bingbong.aiff');
  7.  $apns->queueMessage();
  8.  $apns->processQueue()// SEND ALL MESSAGES NOW
  9.  ?>

  • access: public
void processQueue ()
queueMessage (line 586)

Queue Message for Delivery

  1.  <?php
  2.  $db new DbConnect();
  3.  $db->show_errors();
  4.  $apns new APNS($db);
  5.  $apns->newMessage(1'2010-01-01 00:00:00');
  6.  $apns->addMessageAlert('You got your emails.');
  7.  $apns->addMessageBadge(9);
  8.  $apns->addMessageSound('bingbong.aiff');
  9.  $apns->queueMessage()// ADD THE MESSAGE TO QUEUE
  10.  ?>

  • access: public
void queueMessage ()

Documentation generated on Tue, 05 Jan 2010 11:25:59 -0600 by phpDocumentor 1.4.3