API Documentation
\
Gomoob
Pushwoosh
Client
Exception
Model
Notification
Request
Response

\Gomoob\Pushwoosh\Model\RequestCreateMessageRequest

Class which represents Pushwoosh '/createMessage' request.

Summary

Methods
Properties
Constants
create()
addNotification()
getApplication()
getApplicationsGroup()
getAuth()
getNotifications()
setApplication()
setApplicationsGroup()
setAuth()
setNotifications()
toJSON()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$application
$applicationsGroup
$auth
$notifications
N/A

Properties

$application

$application : string

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

Type

string

$applicationsGroup

$applicationsGroup : string

The Pushwoosh Application group code (cannot be used together with "application").

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

$notifications

$notifications : \Gomoob\Pushwoosh\Model\Notification\Notification[]

The Pushwoosh notifications to attach to the create message request.

Type

\Gomoob\Pushwoosh\Model\Notification\Notification[]

Methods

getApplication()

getApplication() : string

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

.

Returns

string —

the Pushwoosh application ID where to send the message to (cannot be used together with

    "applicationsGroup").

getApplicationsGroup()

getApplicationsGroup() : string

Gets the Pushwoosh Application group code (cannot be used together with "application").

Returns

string —

the Pushwoosh Application group code (cannot be used together with "application").

getAuth()

getAuth() : string

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

Returns

string —

the API access token from the Pushwoosh control panel (create this token at

    https://cp.pushwoosh.com/api_access).

getNotifications()

getNotifications() : \Gomoob\Pushwoosh\Model\Notification\Notification[]

Gets the Pushwoosh notifications to attach to the create message request.

Returns

\Gomoob\Pushwoosh\Model\Notification\Notification[] —

the Pushwoosh notifications to attach to the create

    message request.

setApplication()

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

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

.

Parameters

string $application

the Pushwoosh application ID where to send the message to (cannot be used together

   with "applicationsGroup").

Returns

\Gomoob\Pushwoosh\Model\Request\CreateMessageRequest —

this instance.

setApplicationsGroup()

setApplicationsGroup(string $applicationsGroup) : \Gomoob\Pushwoosh\Model\Request\CreateMessageRequest

Sets the Pushwoosh Application group code (cannot be used together with "application").

Parameters

string $applicationsGroup

the Pushwoosh Application group code (cannot be used together with

   "application").

Returns

\Gomoob\Pushwoosh\Model\Request\CreateMessageRequest —

this instance.

setAuth()

setAuth(string $auth) : \Gomoob\Pushwoosh\Model\Request\CreateMessageRequest

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

Parameters

string $auth

the API access token from the Pushwoosh control panel (create this token at

   https://cp.pushwoosh.com/api_access).

Returns

\Gomoob\Pushwoosh\Model\Request\CreateMessageRequest —

this instance.

setNotifications()

setNotifications(\Gomoob\Pushwoosh\Model\Notification\Notification[] $notifications) : \Gomoob\Pushwoosh\Model\Request\CreateMessageRequest

Sets the Pushwoosh notifications to attach to the create message request.

Parameters

\Gomoob\Pushwoosh\Model\Notification\Notification[] $notifications

the Pushwoosh notifications to attach to

   the create message request.

Returns

\Gomoob\Pushwoosh\Model\Request\CreateMessageRequest —

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.