Documentation

Google_Service_Books_Notification 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
$crmExperimentIds  : mixed
$docId  : mixed
$docType  : mixed
$dontShowNotification  : mixed
$iconUrl  : mixed
$isDocumentMature  : mixed
$kind  : mixed
$notificationGroup  : mixed
$notificationType  : mixed
$pcampaignId  : mixed
$reason  : mixed
$showNotificationSettingsAction  : mixed
$targetUrl  : mixed
$timeToExpireMs  : mixed
$title  : mixed
$collection_key  : mixed
$internal_gapi_mappings  : 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
getCrmExperimentIds()  : mixed
getDocId()  : mixed
getDocType()  : mixed
getDontShowNotification()  : mixed
getIconUrl()  : mixed
getIsDocumentMature()  : mixed
getKind()  : mixed
getNotificationGroup()  : mixed
getNotificationType()  : mixed
getPcampaignId()  : mixed
getReason()  : mixed
getShowNotificationSettingsAction()  : mixed
getTargetUrl()  : mixed
getTimeToExpireMs()  : mixed
getTitle()  : mixed
key()  : mixed
next()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
rewind()  : mixed
setBody()  : mixed
setCrmExperimentIds()  : mixed
setDocId()  : mixed
setDocType()  : mixed
setDontShowNotification()  : mixed
setIconUrl()  : mixed
setIsDocumentMature()  : mixed
setKind()  : mixed
setNotificationGroup()  : mixed
setNotificationType()  : mixed
setPcampaignId()  : mixed
setReason()  : mixed
setShowNotificationSettingsAction()  : mixed
setTargetUrl()  : mixed
setTimeToExpireMs()  : mixed
setTitle()  : 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

$dontShowNotification

public mixed $dontShowNotification

$showNotificationSettingsAction

public mixed $showNotificationSettingsAction

$collection_key

protected mixed $collection_key = 'crmExperimentIds'

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array("docId" => "doc_id", "docType" => "doc_type", "dontShowNotification" => "dont_show_notification", "isDocumentMature" => "is_document_mature", "notificationType" => "notification_type", "pcampaignId" => "pcampaign_id", "showNotificationSettingsAction" => "show_notification_settings_action")

$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 —

getBody()

public getBody() : mixed
Return values
mixed —

getCrmExperimentIds()

public getCrmExperimentIds() : mixed
Return values
mixed —

getDocId()

public getDocId() : mixed
Return values
mixed —

getDocType()

public getDocType() : mixed
Return values
mixed —

getDontShowNotification()

public getDontShowNotification() : mixed
Return values
mixed —

getIconUrl()

public getIconUrl() : mixed
Return values
mixed —

getIsDocumentMature()

public getIsDocumentMature() : mixed
Return values
mixed —

getKind()

public getKind() : mixed
Return values
mixed —

getNotificationGroup()

public getNotificationGroup() : mixed
Return values
mixed —

getNotificationType()

public getNotificationType() : mixed
Return values
mixed —

getPcampaignId()

public getPcampaignId() : mixed
Return values
mixed —

getReason()

public getReason() : mixed
Return values
mixed —

getShowNotificationSettingsAction()

public getShowNotificationSettingsAction() : mixed
Return values
mixed —

getTargetUrl()

public getTargetUrl() : mixed
Return values
mixed —

getTimeToExpireMs()

public getTimeToExpireMs() : mixed
Return values
mixed —

getTitle()

public getTitle() : 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 —

setCrmExperimentIds()

public setCrmExperimentIds(mixed $crmExperimentIds) : mixed
Parameters
$crmExperimentIds : mixed
Return values
mixed —

setDocId()

public setDocId(mixed $docId) : mixed
Parameters
$docId : mixed
Return values
mixed —

setDocType()

public setDocType(mixed $docType) : mixed
Parameters
$docType : mixed
Return values
mixed —

setDontShowNotification()

public setDontShowNotification(mixed $dontShowNotification) : mixed
Parameters
$dontShowNotification : mixed
Return values
mixed —

setIconUrl()

public setIconUrl(mixed $iconUrl) : mixed
Parameters
$iconUrl : mixed
Return values
mixed —

setIsDocumentMature()

public setIsDocumentMature(mixed $isDocumentMature) : mixed
Parameters
$isDocumentMature : mixed
Return values
mixed —

setKind()

public setKind(mixed $kind) : mixed
Parameters
$kind : mixed
Return values
mixed —

setNotificationGroup()

public setNotificationGroup(mixed $notificationGroup) : mixed
Parameters
$notificationGroup : mixed
Return values
mixed —

setNotificationType()

public setNotificationType(mixed $notificationType) : mixed
Parameters
$notificationType : mixed
Return values
mixed —

setPcampaignId()

public setPcampaignId(mixed $pcampaignId) : mixed
Parameters
$pcampaignId : mixed
Return values
mixed —

setReason()

public setReason(mixed $reason) : mixed
Parameters
$reason : mixed
Return values
mixed —

setShowNotificationSettingsAction()

public setShowNotificationSettingsAction(mixed $showNotificationSettingsAction) : mixed
Parameters
$showNotificationSettingsAction : mixed
Return values
mixed —

setTargetUrl()

public setTargetUrl(mixed $targetUrl) : mixed
Parameters
$targetUrl : mixed
Return values
mixed —

setTimeToExpireMs()

public setTimeToExpireMs(mixed $timeToExpireMs) : mixed
Parameters
$timeToExpireMs : mixed
Return values
mixed —

setTitle()

public setTitle(mixed $title) : mixed
Parameters
$title : 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