Documentation

Google_Service_Cih_UserInteraction 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.
$contactGaiaId  : mixed
$detailedDescription  : mixed
$detailedDescriptionTruncated  : mixed
$interactionOrigin  : mixed
$interactionType  : mixed
$kind  : mixed
$language  : mixed
$metaType  : mixed
$sourceSystemPrimaryKey  : mixed
$summary  : mixed
$summaryTruncated  : mixed
$timestamp  : mixed
$adoptionInteractionDataType  : mixed
$adoptionInteractionType  : mixed
$advertiserExperienceDataDataType  : mixed
$advertiserExperienceDataType  : mixed
$casesDataDataType  : mixed
$casesDataType  : mixed
$chatInteractionDataType  : mixed
$chatInteractionType  : mixed
$collection_key  : mixed
$customerDataType  : mixed
$customerType  : mixed
$emailInteractionDataType  : mixed
$emailInteractionType  : mixed
$entityDataType  : mixed
$entityType  : mixed
$gammaDataDataType  : mixed
$gammaDataType  : mixed
$genieDataDataType  : mixed
$genieDataType  : mixed
$goalInteractionDataType  : mixed
$goalInteractionType  : mixed
$googlerDataType  : mixed
$googlerType  : mixed
$greenTeaDataDataType  : mixed
$greenTeaDataType  : mixed
$grmDataDataType  : mixed
$grmDataType  : mixed
$hangoutInteractionDataType  : mixed
$hangoutInteractionType  : mixed
$helpcenterDataDataType  : mixed
$helpcenterDataType  : mixed
$incentiveInteractionDataType  : mixed
$incentiveInteractionType  : mixed
$incentivesDataDataType  : mixed
$incentivesDataType  : mixed
$initiatorDataType  : mixed
$initiatorType  : mixed
$internal_gapi_mappings  : mixed
$marketingEmailInteractionDataType  : mixed
$marketingEmailInteractionType  : mixed
$meetingInteractionDataType  : mixed
$meetingInteractionType  : mixed
$modelData  : mixed
$noteInteractionDataType  : mixed
$noteInteractionType  : mixed
$otherParticipantDataType  : mixed
$otherParticipantType  : mixed
$partnerSearchDataDataType  : mixed
$partnerSearchDataType  : mixed
$phoneInteractionDataType  : mixed
$phoneInteractionType  : mixed
$processed  : mixed
$taskInteractionDataType  : mixed
$taskInteractionType  : mixed
$traxDataDataType  : mixed
$traxDataType  : mixed
$traxInteractionDataType  : mixed
$traxInteractionType  : mixed
$userCommDataDataType  : mixed
$userCommDataType  : 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
getAdoptionInteraction()  : mixed
getAdvertiserExperienceData()  : mixed
getCasesData()  : mixed
getChatInteraction()  : mixed
getContactGaiaId()  : mixed
getCustomer()  : mixed
getDetailedDescription()  : mixed
getDetailedDescriptionTruncated()  : mixed
getEmailInteraction()  : mixed
getEntity()  : mixed
getGammaData()  : mixed
getGenieData()  : mixed
getGoalInteraction()  : mixed
getGoogler()  : mixed
getGreenTeaData()  : mixed
getGrmData()  : mixed
getHangoutInteraction()  : mixed
getHelpcenterData()  : mixed
getIncentiveInteraction()  : mixed
getIncentivesData()  : mixed
getInitiator()  : mixed
getInteractionOrigin()  : mixed
getInteractionType()  : mixed
getKind()  : mixed
getLanguage()  : mixed
getMarketingEmailInteraction()  : mixed
getMeetingInteraction()  : mixed
getMetaType()  : mixed
getNoteInteraction()  : mixed
getOtherParticipant()  : mixed
getPartnerSearchData()  : mixed
getPhoneInteraction()  : mixed
getSourceSystemPrimaryKey()  : mixed
getSummary()  : mixed
getSummaryTruncated()  : mixed
getTaskInteraction()  : mixed
getTimestamp()  : mixed
getTraxData()  : mixed
getTraxInteraction()  : mixed
getUserCommData()  : mixed
key()  : mixed
next()  : mixed
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
rewind()  : mixed
setAdoptionInteraction()  : mixed
setAdvertiserExperienceData()  : mixed
setCasesData()  : mixed
setChatInteraction()  : mixed
setContactGaiaId()  : mixed
setCustomer()  : mixed
setDetailedDescription()  : mixed
setDetailedDescriptionTruncated()  : mixed
setEmailInteraction()  : mixed
setEntity()  : mixed
setGammaData()  : mixed
setGenieData()  : mixed
setGoalInteraction()  : mixed
setGoogler()  : mixed
setGreenTeaData()  : mixed
setGrmData()  : mixed
setHangoutInteraction()  : mixed
setHelpcenterData()  : mixed
setIncentiveInteraction()  : mixed
setIncentivesData()  : mixed
setInitiator()  : mixed
setInteractionOrigin()  : mixed
setInteractionType()  : mixed
setKind()  : mixed
setLanguage()  : mixed
setMarketingEmailInteraction()  : mixed
setMeetingInteraction()  : mixed
setMetaType()  : mixed
setNoteInteraction()  : mixed
setOtherParticipant()  : mixed
setPartnerSearchData()  : mixed
setPhoneInteraction()  : mixed
setSourceSystemPrimaryKey()  : mixed
setSummary()  : mixed
setSummaryTruncated()  : mixed
setTaskInteraction()  : mixed
setTimestamp()  : mixed
setTraxData()  : mixed
setTraxInteraction()  : mixed
setUserCommData()  : 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

$detailedDescriptionTruncated

public mixed $detailedDescriptionTruncated

$adoptionInteractionDataType

protected mixed $adoptionInteractionDataType = ''

$adoptionInteractionType

protected mixed $adoptionInteractionType = 'Google_Service_Cih_AdoptionInteraction'

$advertiserExperienceDataDataType

protected mixed $advertiserExperienceDataDataType = ''

$advertiserExperienceDataType

protected mixed $advertiserExperienceDataType = 'Google_Service_Cih_AdvertiserExperienceData'

$casesDataType

protected mixed $casesDataType = 'Google_Service_Cih_CasesData'

$chatInteractionDataType

protected mixed $chatInteractionDataType = ''

$chatInteractionType

protected mixed $chatInteractionType = 'Google_Service_Cih_ChatInteraction'

$collection_key

protected mixed $collection_key = 'otherParticipant'

$customerType

protected mixed $customerType = 'Google_Service_Cih_Participant'

$emailInteractionDataType

protected mixed $emailInteractionDataType = ''

$emailInteractionType

protected mixed $emailInteractionType = 'Google_Service_Cih_EmailInteraction'

$entityType

protected mixed $entityType = 'Google_Service_Cih_Entity'

$gammaDataType

protected mixed $gammaDataType = 'Google_Service_Cih_GammaData'

$genieDataType

protected mixed $genieDataType = 'Google_Service_Cih_GenieData'

$goalInteractionDataType

protected mixed $goalInteractionDataType = ''

$goalInteractionType

protected mixed $goalInteractionType = 'Google_Service_Cih_GoalInteraction'

$googlerType

protected mixed $googlerType = 'Google_Service_Cih_Participant'

$greenTeaDataType

protected mixed $greenTeaDataType = 'Google_Service_Cih_GreenTeaData'

$grmDataType

protected mixed $grmDataType = 'Google_Service_Cih_GrmData'

$hangoutInteractionDataType

protected mixed $hangoutInteractionDataType = ''

$hangoutInteractionType

protected mixed $hangoutInteractionType = 'Google_Service_Cih_HangoutInteraction'

$helpcenterDataDataType

protected mixed $helpcenterDataDataType = ''

$helpcenterDataType

protected mixed $helpcenterDataType = 'Google_Service_Cih_HelpcenterData'

$incentiveInteractionDataType

protected mixed $incentiveInteractionDataType = ''

$incentiveInteractionType

protected mixed $incentiveInteractionType = 'Google_Service_Cih_IncentiveInteraction'

$incentivesDataDataType

protected mixed $incentivesDataDataType = ''

$incentivesDataType

protected mixed $incentivesDataType = 'Google_Service_Cih_IncentivesData'

$initiatorType

protected mixed $initiatorType = 'Google_Service_Cih_Participant'

$internal_gapi_mappings

protected mixed $internal_gapi_mappings = array()

$marketingEmailInteractionDataType

protected mixed $marketingEmailInteractionDataType = ''

$marketingEmailInteractionType

protected mixed $marketingEmailInteractionType = 'Google_Service_Cih_MarketingEmailInteraction'

$meetingInteractionDataType

protected mixed $meetingInteractionDataType = ''

$meetingInteractionType

protected mixed $meetingInteractionType = 'Google_Service_Cih_MeetingInteraction'

$modelData

protected mixed $modelData = array()

$noteInteractionDataType

protected mixed $noteInteractionDataType = ''

$noteInteractionType

protected mixed $noteInteractionType = 'Google_Service_Cih_NoteInteraction'

$otherParticipantDataType

protected mixed $otherParticipantDataType = 'array'

$otherParticipantType

protected mixed $otherParticipantType = 'Google_Service_Cih_Participant'

$partnerSearchDataDataType

protected mixed $partnerSearchDataDataType = ''

$partnerSearchDataType

protected mixed $partnerSearchDataType = 'Google_Service_Cih_PartnerSearchData'

$phoneInteractionDataType

protected mixed $phoneInteractionDataType = ''

$phoneInteractionType

protected mixed $phoneInteractionType = 'Google_Service_Cih_PhoneInteraction'

$processed

protected mixed $processed = array()

$taskInteractionDataType

protected mixed $taskInteractionDataType = ''

$taskInteractionType

protected mixed $taskInteractionType = 'Google_Service_Cih_TaskInteraction'

$traxDataType

protected mixed $traxDataType = 'Google_Service_Cih_TraxData'

$traxInteractionDataType

protected mixed $traxInteractionDataType = ''

$traxInteractionType

protected mixed $traxInteractionType = 'Google_Service_Cih_TraxInteraction'

$userCommDataType

protected mixed $userCommDataType = 'Google_Service_Cih_UserCommData'

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 —

getAdoptionInteraction()

public getAdoptionInteraction() : mixed
Return values
mixed —

getAdvertiserExperienceData()

public getAdvertiserExperienceData() : mixed
Return values
mixed —

getCasesData()

public getCasesData() : mixed
Return values
mixed —

getChatInteraction()

public getChatInteraction() : mixed
Return values
mixed —

getContactGaiaId()

public getContactGaiaId() : mixed
Return values
mixed —

getDetailedDescription()

public getDetailedDescription() : mixed
Return values
mixed —

getDetailedDescriptionTruncated()

public getDetailedDescriptionTruncated() : mixed
Return values
mixed —

getEmailInteraction()

public getEmailInteraction() : mixed
Return values
mixed —

getGammaData()

public getGammaData() : mixed
Return values
mixed —

getGenieData()

public getGenieData() : mixed
Return values
mixed —

getGoalInteraction()

public getGoalInteraction() : mixed
Return values
mixed —

getGreenTeaData()

public getGreenTeaData() : mixed
Return values
mixed —

getHangoutInteraction()

public getHangoutInteraction() : mixed
Return values
mixed —

getHelpcenterData()

public getHelpcenterData() : mixed
Return values
mixed —

getIncentiveInteraction()

public getIncentiveInteraction() : mixed
Return values
mixed —

getIncentivesData()

public getIncentivesData() : mixed
Return values
mixed —

getInitiator()

public getInitiator() : mixed
Return values
mixed —

getInteractionOrigin()

public getInteractionOrigin() : mixed
Return values
mixed —

getInteractionType()

public getInteractionType() : mixed
Return values
mixed —

getMarketingEmailInteraction()

public getMarketingEmailInteraction() : mixed
Return values
mixed —

getMeetingInteraction()

public getMeetingInteraction() : mixed
Return values
mixed —

getNoteInteraction()

public getNoteInteraction() : mixed
Return values
mixed —

getOtherParticipant()

public getOtherParticipant() : mixed
Return values
mixed —

getPartnerSearchData()

public getPartnerSearchData() : mixed
Return values
mixed —

getPhoneInteraction()

public getPhoneInteraction() : mixed
Return values
mixed —

getSourceSystemPrimaryKey()

public getSourceSystemPrimaryKey() : mixed
Return values
mixed —

getSummaryTruncated()

public getSummaryTruncated() : mixed
Return values
mixed —

getTaskInteraction()

public getTaskInteraction() : mixed
Return values
mixed —

getTimestamp()

public getTimestamp() : mixed
Return values
mixed —

getTraxInteraction()

public getTraxInteraction() : mixed
Return values
mixed —

getUserCommData()

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

setContactGaiaId()

public setContactGaiaId(mixed $contactGaiaId) : mixed
Parameters
$contactGaiaId : mixed
Return values
mixed —

setCustomer()

public setCustomer(mixed $customer) : mixed
Parameters
$customer : mixed
Return values
mixed —

setDetailedDescription()

public setDetailedDescription(mixed $detailedDescription) : mixed
Parameters
$detailedDescription : mixed
Return values
mixed —

setDetailedDescriptionTruncated()

public setDetailedDescriptionTruncated(mixed $detailedDescriptionTruncated) : mixed
Parameters
$detailedDescriptionTruncated : mixed
Return values
mixed —

setGoogler()

public setGoogler(mixed $googler) : mixed
Parameters
$googler : mixed
Return values
mixed —

setInteractionOrigin()

public setInteractionOrigin(mixed $interactionOrigin) : mixed
Parameters
$interactionOrigin : mixed
Return values
mixed —

setInteractionType()

public setInteractionType(mixed $interactionType) : mixed
Parameters
$interactionType : mixed
Return values
mixed —

setKind()

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

setLanguage()

public setLanguage(mixed $language) : mixed
Parameters
$language : mixed
Return values
mixed —

setMetaType()

public setMetaType(mixed $metaType) : mixed
Parameters
$metaType : mixed
Return values
mixed —

setOtherParticipant()

public setOtherParticipant(mixed $otherParticipant) : mixed
Parameters
$otherParticipant : mixed
Return values
mixed —

setSourceSystemPrimaryKey()

public setSourceSystemPrimaryKey(mixed $sourceSystemPrimaryKey) : mixed
Parameters
$sourceSystemPrimaryKey : mixed
Return values
mixed —

setSummary()

public setSummary(mixed $summary) : mixed
Parameters
$summary : mixed
Return values
mixed —

setSummaryTruncated()

public setSummaryTruncated(mixed $summaryTruncated) : mixed
Parameters
$summaryTruncated : mixed
Return values
mixed —

setTimestamp()

public setTimestamp(mixed $timestamp) : mixed
Parameters
$timestamp : 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