API Documentation
\
Gomoob
Pushwoosh
Client
Exception
Model
Notification
Request
Response

\Gomoob\Pushwoosh\ClientPushwoosh

Class which defines a Pushwoosh client.

Summary

Methods
Properties
Constants
create()
createMessage()
deleteMessage()
getApplication()
getApplicationsGroup()
getAuth()
getNearestZone()
pushStat()
registerDevice()
setApplication()
setApplicationsGroup()
setAuth()
setBadge()
setTags()
unregisterDevice()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
pwCall()
$application
$applicationsGroup
$auth
N/A

Properties

$application

$application : string

The the Pushwoosh application ID to be used by default by all the requests performed by the Pushwoosh client.

This identifier can be overwritten by request if needed.

Type

string

$applicationsGroup

$applicationsGroup : string

The Pushwoosh applications group code to be used to defautl by all the requests performed by the Pushwoosh client

. This identifier can be overwritten by requests if needed.

WARNING: If the application is defined then the applications groups must not be defined.

Type

string

$auth

$auth : string

The API access token from the Pushwoosh control panel (create this token at https://cp.pushwoosh.com/api_access).

Type

string

Methods

create()

create() : \Gomoob\Pushwoosh\Client\Pushwoosh

Utility function used to create a new instance of the Pushwoosh client.

Returns

\Gomoob\Pushwoosh\Client\Pushwoosh —

the new created instance.

deleteMessage()

deleteMessage()

{@inheritDoc}

getApplication()

getApplication()

{@inheritDoc}

getApplicationsGroup()

getApplicationsGroup()

{@inheritDoc}

getAuth()

getAuth()

{@inheritDoc}

getNearestZone()

getNearestZone()

{@inheritDoc}

pushStat()

pushStat()

{@inheritDoc}

setApplication()

setApplication( $application)

{@inheritDoc}

Parameters

$application

setApplicationsGroup()

setApplicationsGroup( $applicationsGroup)

{@inheritDoc}

Parameters

$applicationsGroup

setAuth()

setAuth( $auth)

{@inheritDoc}

Parameters

$auth

setBadge()

setBadge()

{@inheritDoc}

pwCall()

pwCall( $method,  $data)

Parameters

$method
$data