API Documentation
\
Gomoob
Pushwoosh
Client
Exception
Model
Notification
Request
Response

\Gomoob\Pushwoosh\Model\RequestSetBadgeRequest

Class which represents Pushwoosh '/setBadge' request.

Summary

Methods
Properties
Constants
create()
getApplication()
getBadge()
getHwid()
setApplication()
setBadge()
setHwid()
toJSON()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$application
$badge
$hwid
N/A

Properties

$application

$application : string

The Pushwoosh application ID where to send the message to (cannot be used together with "applicationsGroup").

Type

string

$badge

$badge : int

The current badge on the application to use with auto-incrementing badges.

Type

int

$hwid

$hwid : string

The hardware device id used in registerDevice function call.

Type

string

Methods

create()

create() : \Gomoob\Pushwoosh\Model\Request\SetBadgeRequest

Utility function used to create a new instance of the <tt>SetBadgeRequest</tt>.

Returns

\Gomoob\Pushwoosh\Model\Request\SetBadgeRequest —

the new created instance.

getApplication()

getApplication() : string

Gets the Pushwoosh application ID where you send the message to.

Returns

string —

Pushwoosh application ID where you send the message to.

getBadge()

getBadge() : int

Gets the current badge on the application to use with auto-incrementing badges.

Returns

int —

the current badge on the application to use with auto-incrementing badges.

getHwid()

getHwid() : string

Gets the hardware device id used in registerDevice function call.

Returns

string —

the hardware device id used in registerDevice function call.

setApplication()

setApplication(string $application) : \Gomoob\Pushwoosh\Model\Request\GetNearestZoneRequest

Sets the Pushwoosh application ID where you send the message to.

Parameters

string $application

Pushwoosh application ID where you send the message to.

Returns

\Gomoob\Pushwoosh\Model\Request\GetNearestZoneRequest —

this instance.

setBadge()

setBadge(int $badge)

Sets the current badge on the application to use with auto-incrementing badges.

Parameters

int $badge

the current badge on the application to use with auto-incrementing badges.

setHwid()

setHwid(string $hwid) : \Gomoob\Pushwoosh\Model\Request\GetNearestZoneRequest

Sets the hardware device id used in registerDevice function call.

Parameters

string $hwid

the the hardware device id used in registerDevice function call.

Returns

\Gomoob\Pushwoosh\Model\Request\GetNearestZoneRequest —

this instance.

toJSON()

toJSON() : array

Creates a JSON representation of this request.

Returns

array —

a PHP which can be passed to the 'json_encode' PHP method.