Overview

Namespaces

  • PushWoosh

Classes

  • PushWoosh
  • Overview
  • Namespace
  • Class
  • Tree

Class PushWoosh

The PushWoosh class is a class for interacting with the PushWoosh push notification service.

The constructor of the PushWoosh class takes parameters for the application ID, username and password.

Namespace: PushWoosh
Package: PushWoosh
Category: library
License: http://opensource.org/licenses/MIT
Author: Matthew Daly matthew@astutech.com
Version: 0.0.2
Since: 2014-02-27
Example:
$push = new PushWoosh($appId, $username, $password);
$push->createMessage($users, 'now', null);
Located at PushWoosh/PushWoosh.php
Methods summary
public PushWoosh\PushWoosh
# __construct( string $appId, string $username, string $password )

Constructor for the PushWoosh object

Constructor for the PushWoosh object

Parameters

$appId
string
$appId The PushWoosh app ID to use
$username
string
$username The PushWoosh username to use
$password
string
$password The PushWoosh password to use

Returns

PushWoosh\PushWoosh

Author

Matthew Daly matthew@astutech.com

Since

2014-02-27
public boolean
# createMessage( array $pushes, string $sendDate = 'now', string $link = null, integer $ios_badges = 0 )

Creates a push message using PushWoosh

Creates a push message using PushWoosh

Parameters

$pushes
array
$pushes An array of messages to be sent. Each message in the array should be an associative array, with the key 'content' representing the content of the message to be sent, and the key 'devices' representing the device token to send that message to. Leave 'devices' empty to send that message to all users
$sendDate
string
$sendDate Send date of the message. Defaults to right now
$link
string
$link A link to follow when the push notification is clicked. Defaults to null
$ios_badges
integer
$ios_badges The iOS badge number. Defaults to 1

Returns

boolean
Confirms whether the method executed successfully

Author

Matthew Daly matthew@astutech.com

Since

2014-02-27
Properties summary
protected array $config
#

The configuration settings. Should consist of an array with three keys: application, username and password

The configuration settings. Should consist of an array with three keys: application, username and password

Pushwoosh PHP Library API documentation generated by ApiGen 2.8.0