Documentation

Google_Service_FirebaseCloudMessaging_AndroidNotification extends Google_Collection
in package

Extension to the regular Google_Model that automatically exposes the items array for iteration, so you can just iterate over the object rather than a reference inside.

Table of Contents

NULL_VALUE  = "{}gapi-php-null"
If you need to specify a NULL JSON value, use Google_Model::NULL_VALUE instead - it will be replaced when converting to JSON with a real null.
$body  : mixed
$bodyLocArgs  : mixed
$bodyLocKey  : mixed
$channelId  : mixed
$clickAction  : mixed
$color  : mixed
$defaultLightSettings  : mixed
$defaultSound  : mixed
$defaultVibrateTimings  : mixed
$eventTime  : mixed
$icon  : mixed
$image  : mixed
$localOnly  : mixed
$notificationCount  : mixed
$notificationPriority  : mixed
$sound  : mixed
$sticky  : mixed
$tag  : mixed
$ticker  : mixed
$title  : mixed
$titleLocArgs  : mixed
$titleLocKey  : mixed
$vibrateTimings  : mixed
$visibility  : mixed
$collection_key  : mixed
$internal_gapi_mappings  : mixed
$lightSettingsDataType  : mixed
$lightSettingsType  : mixed
$modelData  : mixed
$processed  : mixed
__construct()  : mixed
Polymorphic - accepts a variable number of arguments dependent on the type of the model subclass.
__get()  : mixed
Getter that handles passthrough access to the data array, and lazy object creation.
__isset()  : mixed
__unset()  : mixed
assertIsArray()  : mixed
Verify if $obj is an array.
count()  : mixed
current()  : mixed
getBody()  : mixed
getBodyLocArgs()  : mixed
getBodyLocKey()  : mixed
getChannelId()  : mixed
getClickAction()  : mixed
getColor()  : mixed
getDefaultLightSettings()  : mixed
getDefaultSound()  : mixed
getDefaultVibrateTimings()  : mixed
getEventTime()  : mixed
getIcon()  : mixed
getImage()  : mixed
getLightSettings()  : Google_Service_FirebaseCloudMessaging_LightSettings
getLocalOnly()  : mixed
getNotificationCount()  : mixed
getNotificationPriority()  : mixed
getSound()  : mixed
getSticky()  : mixed
getTag()  : mixed
getTicker()  : mixed
getTitle()  : mixed
getTitleLocArgs()  : mixed
getTitleLocKey()  : mixed
getVibrateTimings()  : mixed
getVisibility()  : mixed
key()  : mixed
next()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
rewind()  : mixed
setBody()  : mixed
setBodyLocArgs()  : mixed
setBodyLocKey()  : mixed
setChannelId()  : mixed
setClickAction()  : mixed
setColor()  : mixed
setDefaultLightSettings()  : mixed
setDefaultSound()  : mixed
setDefaultVibrateTimings()  : mixed
setEventTime()  : mixed
setIcon()  : mixed
setImage()  : mixed
setLightSettings()  : mixed
setLocalOnly()  : mixed
setNotificationCount()  : mixed
setNotificationPriority()  : mixed
setSound()  : mixed
setSticky()  : mixed
setTag()  : mixed
setTicker()  : mixed
setTitle()  : mixed
setTitleLocArgs()  : mixed
setTitleLocKey()  : mixed
setVibrateTimings()  : mixed
setVisibility()  : mixed
toSimpleObject()  : mixed
Create a simplified object suitable for straightforward conversion to JSON. This is relatively expensive due to the usage of reflection, but shouldn't be called a whole lot, and is the most straightforward way to filter.
valid()  : mixed
dataType()  : mixed
gapiInit()  : mixed
Blank initialiser to be used in subclasses to do post-construction initialisation - this avoids the need for subclasses to have to implement the variadics handling in their constructors.
isAssociativeArray()  : bool
Returns true only if the array is associative.
keyType()  : mixed
mapTypes()  : void
Initialize this object's properties from an array.
camelCase()  : string
Convert a string to camelCase
coerceType()  : mixed
getMappedName()  : mixed
If there is an internal name mapping, use that.
getSimpleValue()  : mixed
Handle different types of values, primarily other objects and map and array data types.
nullPlaceholderCheck()  : mixed
Check whether the value is the null placeholder and return true null.

Constants

NULL_VALUE

If you need to specify a NULL JSON value, use Google_Model::NULL_VALUE instead - it will be replaced when converting to JSON with a real null.

public mixed NULL_VALUE = "{}gapi-php-null"

Properties

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$lightSettingsType

protected mixed $lightSettingsType = 'Google_Service_FirebaseCloudMessaging_LightSettings'

$modelData

protected mixed $modelData = array()

$processed

protected mixed $processed = array()

Methods

__construct()

Polymorphic - accepts a variable number of arguments dependent on the type of the model subclass.

public final __construct() : mixed
Return values
mixed —

__get()

Getter that handles passthrough access to the data array, and lazy object creation.

public __get(string $key) : mixed
Parameters
$key : string

Property name.

Return values
mixed —

The value if any, or null.

__isset()

public __isset(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed —

__unset()

public __unset(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed —

assertIsArray()

Verify if $obj is an array.

public assertIsArray(array<string|int, mixed> $obj, string $method) : mixed
Parameters
$obj : array<string|int, mixed>

Items that should be validated.

$method : string

Method expecting an array as an argument.

Tags
throws
Google_Exception

Thrown if $obj isn't an array.

Return values
mixed —

count()

public count() : mixed
Return values
mixed —

current()

public current() : mixed
Return values
mixed —

getDefaultLightSettings()

public getDefaultLightSettings() : mixed
Return values
mixed —

getDefaultVibrateTimings()

public getDefaultVibrateTimings() : mixed
Return values
mixed —

getNotificationCount()

public getNotificationCount() : mixed
Return values
mixed —

getNotificationPriority()

public getNotificationPriority() : mixed
Return values
mixed —

key()

public key() : mixed
Return values
mixed —

next()

public next() : mixed
Return values
mixed —

offsetExists()

public offsetExists(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed —

offsetGet()

public offsetGet(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed —

offsetSet()

public offsetSet(mixed $offset, mixed $value) : mixed
Parameters
$offset : mixed
$value : mixed
Return values
mixed —

offsetUnset()

public offsetUnset(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed —

rewind()

public rewind() : mixed
Return values
mixed —

setBody()

public setBody(mixed $body) : mixed
Parameters
$body : mixed
Return values
mixed —

setBodyLocArgs()

public setBodyLocArgs(mixed $bodyLocArgs) : mixed
Parameters
$bodyLocArgs : mixed
Return values
mixed —

setBodyLocKey()

public setBodyLocKey(mixed $bodyLocKey) : mixed
Parameters
$bodyLocKey : mixed
Return values
mixed —

setChannelId()

public setChannelId(mixed $channelId) : mixed
Parameters
$channelId : mixed
Return values
mixed —

setClickAction()

public setClickAction(mixed $clickAction) : mixed
Parameters
$clickAction : mixed
Return values
mixed —

setColor()

public setColor(mixed $color) : mixed
Parameters
$color : mixed
Return values
mixed —

setDefaultLightSettings()

public setDefaultLightSettings(mixed $defaultLightSettings) : mixed
Parameters
$defaultLightSettings : mixed
Return values
mixed —

setDefaultSound()

public setDefaultSound(mixed $defaultSound) : mixed
Parameters
$defaultSound : mixed
Return values
mixed —

setDefaultVibrateTimings()

public setDefaultVibrateTimings(mixed $defaultVibrateTimings) : mixed
Parameters
$defaultVibrateTimings : mixed
Return values
mixed —

setEventTime()

public setEventTime(mixed $eventTime) : mixed
Parameters
$eventTime : mixed
Return values
mixed —

setIcon()

public setIcon(mixed $icon) : mixed
Parameters
$icon : mixed
Return values
mixed —

setImage()

public setImage(mixed $image) : mixed
Parameters
$image : mixed
Return values
mixed —

setLocalOnly()

public setLocalOnly(mixed $localOnly) : mixed
Parameters
$localOnly : mixed
Return values
mixed —

setNotificationCount()

public setNotificationCount(mixed $notificationCount) : mixed
Parameters
$notificationCount : mixed
Return values
mixed —

setNotificationPriority()

public setNotificationPriority(mixed $notificationPriority) : mixed
Parameters
$notificationPriority : mixed
Return values
mixed —

setSound()

public setSound(mixed $sound) : mixed
Parameters
$sound : mixed
Return values
mixed —

setSticky()

public setSticky(mixed $sticky) : mixed
Parameters
$sticky : mixed
Return values
mixed —

setTag()

public setTag(mixed $tag) : mixed
Parameters
$tag : mixed
Return values
mixed —

setTicker()

public setTicker(mixed $ticker) : mixed
Parameters
$ticker : mixed
Return values
mixed —

setTitle()

public setTitle(mixed $title) : mixed
Parameters
$title : mixed
Return values
mixed —

setTitleLocArgs()

public setTitleLocArgs(mixed $titleLocArgs) : mixed
Parameters
$titleLocArgs : mixed
Return values
mixed —

setTitleLocKey()

public setTitleLocKey(mixed $titleLocKey) : mixed
Parameters
$titleLocKey : mixed
Return values
mixed —

setVibrateTimings()

public setVibrateTimings(mixed $vibrateTimings) : mixed
Parameters
$vibrateTimings : mixed
Return values
mixed —

setVisibility()

public setVisibility(mixed $visibility) : mixed
Parameters
$visibility : mixed
Return values
mixed —

toSimpleObject()

Create a simplified object suitable for straightforward conversion to JSON. This is relatively expensive due to the usage of reflection, but shouldn't be called a whole lot, and is the most straightforward way to filter.

public toSimpleObject() : mixed
Return values
mixed —

valid()

public valid() : mixed
Return values
mixed —

dataType()

protected dataType(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed —

gapiInit()

Blank initialiser to be used in subclasses to do post-construction initialisation - this avoids the need for subclasses to have to implement the variadics handling in their constructors.

protected gapiInit() : mixed
Return values
mixed —

isAssociativeArray()

Returns true only if the array is associative.

protected isAssociativeArray(array<string|int, mixed> $array) : bool
Parameters
$array : array<string|int, mixed>
Return values
bool —

True if the array is associative.

keyType()

protected keyType(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed —

mapTypes()

Initialize this object's properties from an array.

protected mapTypes(array<string|int, mixed> $array) : void
Parameters
$array : array<string|int, mixed>

Used to seed this object's properties.

Return values
void —

camelCase()

Convert a string to camelCase

private camelCase(string $value) : string
Parameters
$value : string
Return values
string —

coerceType()

private coerceType(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed —

getMappedName()

If there is an internal name mapping, use that.

private getMappedName(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed —

getSimpleValue()

Handle different types of values, primarily other objects and map and array data types.

private getSimpleValue(mixed $value) : mixed
Parameters
$value : mixed
Return values
mixed —

nullPlaceholderCheck()

Check whether the value is the null placeholder and return true null.

private nullPlaceholderCheck(mixed $value) : mixed
Parameters
$value : mixed
Return values
mixed —

Search results