\Gomoob\PushwooshIPushwoosh

Interface which defines a Pushwoosh client.

Summary

Methods
Constants
createMessage()
deleteMessage()
getApplication()
getApplicationsGroup()
getAuth()
getNearestZone()
pushStat()
registerDevice()
setApplication()
setApplicationsGroup()
setAuth()
setBadge()
setTags()
unregisterDevice()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

createMessage()

createMessage(\Gomoob\Pushwoosh\Model\Request\CreateMessageRequest $createMessageRequest) : \Gomoob\Pushwoosh\Model\Response\CreateMessageResponse

Function used to create a Pushwoosh message using a '/createMessage' request.

Parameters

\Gomoob\Pushwoosh\Model\Request\CreateMessageRequest $createMessageRequest

the '/createMessage' request

   used to create the Pushwoosh message.

Returns

\Gomoob\Pushwoosh\Model\Response\CreateMessageResponse

the resulting create message response.

deleteMessage()

deleteMessage()

Function used to delete a Pushwoosh message using a '/deleteMessage' request.

getApplication()

getApplication() : string

Gets 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.

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

Returns

string —

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

    client.

getApplicationsGroup()

getApplicationsGroup() : string

Gets 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.

Returns

string —

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

    Pushwoosh client.

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).

getNearestZone()

getNearestZone()

pushStat()

pushStat()

registerDevice()

registerDevice(\Gomoob\Pushwoosh\Model\Request\RegisterDeviceRequest $registerDeviceRequest) : \Gomoob\Pushwoosh\Model\Response\RegisterDeviceResponse

Function used to register a device for an application using a '/registerDevice' request.

Parameters

\Gomoob\Pushwoosh\Model\Request\RegisterDeviceRequest $registerDeviceRequest

the register device request

   used to register a device for the application.

Returns

\Gomoob\Pushwoosh\Model\Response\RegisterDeviceResponse

the resulting register device response.

setApplication()

setApplication(string $application) : \Gommob\Pushwoosh\IPushwoosh

Sets 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.

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

Parameters

string $application

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.

Returns

\Gommob\Pushwoosh\IPushwoosh —

this instance.

setApplicationsGroup()

setApplicationsGroup(string $applicationsGroup) : \Gommob\Pushwoosh\IPushwoosh

Sets 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.

Parameters

string $applicationsGroup

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

   performed by the Pushwoosh client.

Returns

\Gommob\Pushwoosh\IPushwoosh —

this instance.

setAuth()

setAuth(string $auth) : \Gommob\Pushwoosh\IPushwoosh

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

\Gommob\Pushwoosh\IPushwoosh —

this instance.

setBadge()

setBadge()

unregisterDevice()

unregisterDevice(\Gomoob\Pushwoosh\Model\Request\UnregisterDeviceRequest $unregisterDeviceRequest)

Function used to remove a device from an application using a '/unregisterDevice' request.

Parameters

\Gomoob\Pushwoosh\Model\Request\UnregisterDeviceRequest $unregisterDeviceRequest

the unergister device

   request used to unregister a device from an application.