\UrbanAirshipAirship

Summary

Methods
Properties
Constants
__construct()
listChannels()
listDeviceTokens()
listAPIDs()
channelLookup()
deviceTokenLookup()
apidLookup()
push()
scheduledPush()
buildUrl()
request()
$key
$secret
BASE_URL
VERSION_STRING
USER_AGENT_KEY
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Constants

BASE_URL

BASE_URL

VERSION_STRING

VERSION_STRING

USER_AGENT_KEY

USER_AGENT_KEY

Properties

$key

$key : 

Type

$secret

$secret : 

Type

Methods

__construct()

__construct(  $appKey,   $masterSecret) 

Parameters

$appKey
$masterSecret

listChannels()

listChannels(integer  $limit = null) : \UrbanAirship\Devices\DeviceListing\ChannelList

Return a list of channels for the app. The ChannelList implements an Iterator.

Parameters

integer $limit

Limit on channels returned

Returns

\UrbanAirship\Devices\DeviceListing\ChannelList

listDeviceTokens()

listDeviceTokens(integer  $limit = null) : \UrbanAirship\Devices\DeviceListing\DeviceTokenList

Return a list of device tokens for the app. The DeviceTokenList implements an Iterator.

Parameters

integer $limit

Limit on tokens returned

Returns

\UrbanAirship\Devices\DeviceListing\DeviceTokenList

listAPIDs()

listAPIDs(integer  $limit = null) : \UrbanAirship\Devices\DeviceListing\APIDList

Return a list of APIDs

Parameters

integer $limit

Limit on tokens returned

Returns

\UrbanAirship\Devices\DeviceListing\APIDList

scheduledPush()

scheduledPush() : \UrbanAirship\Push\ScheduledPushRequest

Return a ScheduledPushRequest that can be used to setup a scheduled push.

Returns

\UrbanAirship\Push\ScheduledPushRequest

buildUrl()

buildUrl(string  $path, mixed  $args = null) : string

Build a url against the BASE_URL with the given path and args.

Parameters

string $path

Path for URL, such as '/api/push/ $path

mixed $args

Args for URL

Returns

string —

URL

request()

request(string  $method, mixed  $body, string  $uri, string  $contentType = null, integer  $version = 3, mixed  $request = null) : \Httpful\associative|string

Send an authenticated request to the Urban Airship API. The request is authenticated with the key and secret.

Parameters

string $method

REST method for request

mixed $body

Body of request, optional

string $uri

URI for this request

string $contentType

Content type for the request, optional

integer $version

version # for API, optional, default is 3

mixed $request

Request object for this operation (PushRequest, etc) optional

Throws

\UrbanAirship\AirshipException

Returns

\Httpful\associative|string