WonderPush PHP library
  • Namespace
  • Class
Navigation
  • Namespace
  • Class
Namespaces
  • WonderPush
    • Api
    • Errors
    • Net
    • Obj
    • Params
    • Util
Classes
  • Application
  • ApplicationCollection
  • BaseObject
  • Collection
  • DeliveriesCreateResponse
  • Event
  • GeoLocation
  • Installation
  • InstallationApplication
  • InstallationApplicationApple
  • InstallationCollection
  • InstallationDevice
  • InstallationDeviceCapabilities
  • InstallationDeviceConfiguration
  • InstallationPreferences
  • InstallationPushToken
  • Notification
  • NotificationAlert
  • NotificationAlertAndroid
  • NotificationAlertAndroidButton
  • NotificationAlertIos
  • NotificationAlertIosAttachment
  • NotificationAlertIosForeground
  • NotificationAlertWeb
  • NotificationAlertWebButton
  • NotificationButton
  • NotificationButtonAction
  • NotificationButtonActionEvent
  • NotificationInApp
  • NotificationInAppButton
  • NotificationInAppMap
  • NotificationInAppMapPlace
  • NotificationPush
  • NotificationPushAndroid
  • NotificationPushIos
  • NotificationPushWeb
  • NullObject
  • Pagination
  • SuccessResponse
  • User
  • WebSdkInitOptions

Class NotificationAlertAndroid

DTO part for notification.alert.android.

WonderPush\Obj\BaseObject implements WonderPush\Util\JsonSerializable
┗ WonderPush\Obj\NotificationAlert
┗ WonderPush\Obj\NotificationAlertAndroid
Namespace: WonderPush\Obj
See: WonderPush\Obj\NotificationAlert
Codecoverageignore
Located at Obj/NotificationAlertAndroid.php

Methods summary

public getType( void ) : string

Returns

string
public setType( string $type ) :

Parameters

$type

Returns


$this
public getChannel( void ) : string

Returns

string
public setChannel( string $channel ) :

Parameters

$channel

Returns


$this
public getHtml( void ) : boolean

Returns

boolean
public setHtml( boolean $html ) :

Parameters

$html

Returns


$this
public getSubText( void ) : string

Returns

string
public setSubText( string $subText ) :

Parameters

$subText

Returns


$this
public getInfo( void ) : string

Returns

string
public setInfo( string $info ) :

Parameters

$info

Returns


$this
public getTicker( void ) : string

Returns

string
public setTicker( string $ticker ) :

Parameters

$ticker

Returns


$this
public getTag( void ) : string|WonderPush\Obj\NullObject|null

Returns

string|WonderPush\Obj\NullObject|null
public setTag( string|WonderPush\Obj\NullObject|null $tag ) :

Parameters

$tag

Returns


$this
public getPriority( void ) : integer

Returns

integer
public setPriority( integer $priority ) :

Parameters

$priority

Returns


$this
public getAutoOpen( void ) : boolean

Returns

boolean
public setAutoOpen( boolean $autoOpen ) :

Parameters

$autoOpen

Returns


$this
public getAutoDrop( void ) : boolean

Returns

boolean
public setAutoDrop( boolean $autoDrop ) :

Parameters

$autoDrop

Returns


$this
public getPersons( void ) : string[]

Returns

string[]
public setPersons( string[] $persons ) :

Parameters

$persons

Returns


$this
public getCategory( void ) : string

Returns

string
public setCategory( string $category ) :

Parameters

$category

Returns


$this
public getColor( void ) : string

Returns

string
public setColor( string $color ) :

Parameters

$color

Returns


$this
public getGroup( void ) : string

Returns

string
public setGroup( string $group ) :

Parameters

$group

Returns


$this
public getSortKey( void ) : string

Returns

string
public setSortKey( string $sortKey ) :

Parameters

$sortKey

Returns


$this
public getLocalOnly( void ) : boolean

Returns

boolean
public setLocalOnly( boolean $localOnly ) :

Parameters

$localOnly

Returns


$this
public getNumber( void ) : integer

Returns

integer
public setNumber( integer $number ) :

Parameters

$number

Returns


$this
public getOnlyAlertOnce( void ) : boolean

Returns

boolean
public setOnlyAlertOnce( boolean $onlyAlertOnce ) :

Parameters

$onlyAlertOnce

Returns


$this
public getWhen( void ) : integer

Returns

integer
Timestamp in milliseconds
public setWhen( integer $when ) :

Parameters

$when
Timestamp in milliseconds

Returns


$this
public getShowWhen( void ) : boolean

Returns

boolean
public setShowWhen( boolean $showWhen ) :

Parameters

$showWhen

Returns


$this
public getUsesChronometer( void ) : boolean

Returns

boolean
public setUsesChronometer( boolean $usesChronometer ) :

Parameters

$usesChronometer

Returns


$this
public getVisibility( void ) : string

Returns

string
public setVisibility( string $visibility ) :

Parameters

$visibility

Returns


$this
public getLights( void ) : boolean|array

Returns

boolean|array
{color: string, on: integer, off: integer}
public setLights( boolean|array $lights ) :

Parameters

$lights
{color: string, on: integer, off: integer}

Returns


$this
public getVibrate( void ) : boolean|integer[]

Returns

boolean|integer[]
public setVibrate( boolean|integer[] $vibrate ) :

Parameters

$vibrate

Returns


$this
public getSound( void ) : boolean|string

Returns

boolean|string
public setSound( boolean|string $sound ) :

Parameters

$sound

Returns


$this
public getOngoing( void ) : boolean

Returns

boolean
public setOngoing( boolean $ongoing ) :

Parameters

$ongoing

Returns


$this
public getProgress( void ) : boolean|integer

Returns

boolean|integer
public setProgress( boolean|integer $progress ) :

Parameters

$progress

Returns


$this
public getSmallIcon( void ) : string

Returns

string
public setSmallIcon( string $smallIcon ) :

Parameters

$smallIcon

Returns


$this
public getLargeIcon( void ) : string

Returns

string
public setLargeIcon( string $largeIcon ) :

Parameters

$largeIcon

Returns


$this
public getButtons( void ) : WonderPush\Obj\NotificationAlertAndroidButton[]

Returns

WonderPush\Obj\NotificationAlertAndroidButton[]
public setButtons( WonderPush\Obj\NotificationAlertAndroidButton[] $buttons ) :

Parameters

$buttons

Returns


$this
public getForeground( void ) : WonderPush\Obj\NotificationAlertAndroid

Returns

WonderPush\Obj\NotificationAlertAndroid
public setForeground( WonderPush\Obj\NotificationAlertAndroid $foreground ) : WonderPush\Obj\NotificationAlertAndroid

Parameters

$foreground

Returns

WonderPush\Obj\NotificationAlertAndroid
public getBigTitle( void ) : string

Valid for types: bigText, bigPicture, inbox.

Valid for types: bigText, bigPicture, inbox.

Returns

string
public setBigTitle( string $bigTitle ) :

Valid for types: bigText, bigPicture, inbox.

Valid for types: bigText, bigPicture, inbox.

Parameters

$bigTitle

Returns


$this
public getBigText( void ) : string

Valid for types: bigText.

Valid for types: bigText.

Returns

string
public setBigText( string $bigText ) :

Valid for types: bigText.

Valid for types: bigText.

Parameters

$bigText

Returns


$this
public getSummaryText( void ) : string

Valid for types: bigText, bigPicture, inbox.

Valid for types: bigText, bigPicture, inbox.

Returns

string
public setSummaryText( string $summaryText ) :

Valid for types: bigText, bigPicture, inbox.

Valid for types: bigText, bigPicture, inbox.

Parameters

$summaryText

Returns


$this
public getBigLargeIcon( void ) : string

Valid for types: bigPicture.

Valid for types: bigPicture.

Returns

string
public setBigLargeIcon( string $bigLargeIcon ) :

Valid for types: bigPicture.

Valid for types: bigPicture.

Parameters

$bigLargeIcon

Returns


$this
public getBigPicture( void ) : string

Valid for types: bigPicture.

Valid for types: bigPicture.

Returns

string
public setBigPicture( string $bigPicture ) :

Valid for types: bigPicture.

Valid for types: bigPicture.

Parameters

$bigPicture

Returns


$this
public getLines( void ) : string[]

Valid for types: inbox.

Valid for types: inbox.

Returns

string[]
public setLines( string[] $lines ) :

Valid for types: inbox.

Valid for types: inbox.

Parameters

$lines

Returns


$this

Methods inherited from WonderPush\Obj\NotificationAlert

getActions(), getAndroid(), getIos(), getReceiveActions(), getTargetUrl(), getText(), getTitle(), getWeb(), setActions(), setAndroid(), setIos(), setReceiveActions(), setTargetUrl(), setText(), setTitle(), setWeb()

Methods inherited from WonderPush\Obj\BaseObject

__construct(), __toString(), _new(), clearAllFields(), deepClone(), jsonSerialize(), toArray(), toData()

WonderPush PHP library API documentation generated by ApiGen